Skip to content

@pumpkin-plugins/bedrock-addon-manager API / config/load / loadPluginConfig

Function: loadPluginConfig() ​

loadPluginConfig(files, log): object

Defined in: packages/bedrock-addon-manager/src/config/load.ts:23

Loads the plugin's config, creating or upgrading the file as needed, and reports what happened. A file that can't be read is never overwritten: the defaults are used until it is fixed.

Parameters ​

files ​

DataFiles

The plugin's data folder.

log ​

Logger

Where to report.

Returns ​

object

The settings to run with.

overrides ​

overrides: TableValues<{ addon_pack: Field<boolean | undefined>; content_id: Field<string | undefined>; content_key: Field<string | undefined>; download_url: Field<string | undefined>; enabled: Field<boolean | undefined>; has_scripts: Field<boolean | undefined>; order: Field<number | undefined>; rtx_enabled: Field<boolean | undefined>; sub_pack_name: Field<string | undefined>; }>

packs ​

packs: SectionValues<{ directory: Field<string>; force: Field<boolean>; }>

web ​

web: SectionValues<{ bind: Field<string>; enabled: Field<boolean>; port: Field<number>; port_forwarding: Field<boolean>; public_url: Field<string>; }>

Pumpkin Plugins documentation