Skip to content

@pumpkin-plugins/upnpumpkin API / config/load / loadPluginConfig

Function: loadPluginConfig() ​

loadPluginConfig(files, log): object

Defined in: packages/upnpumpkin/src/config/load.ts:20

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

log ​

Logger

Returns ​

object

The settings to run with.

bedrock ​

bedrock: SectionValues<{ enabled: Field<boolean>; port: Field<number>; }>

java ​

java: SectionValues<{ enabled: Field<boolean>; port: Field<number>; }>

plugins ​

plugins: SectionValues<{ allow_requests: Field<boolean>; max_requests_per_plugin: Field<number>; }>

router ​

router: SectionValues<{ lease_seconds: Field<number>; nat_pmp: Field<boolean>; nat_pmp_gateway: Field<string>; upnp: Field<boolean>; upnp_search: Field<string>; }>

Pumpkin Plugins documentation