diff --git a/Home.md b/Home.md index 3c0b29f..05bacd3 100644 --- a/Home.md +++ b/Home.md @@ -13,6 +13,7 @@ Dev builds: Aliases: `javascriptexpansion`, `jsexp`. Commands require the permission node `placeholderapi.js.admin`. + Usage (General): * `/jsexpansion` - Display expansion info. * `/jsexpansion reload` - Reloads the expansion. This command is recommended over /papi reload because it does not interfere with PlaceholderAPI or reloading other expansions. @@ -28,6 +29,25 @@ The following commands require the `github_script_downloads` config option be se * `/jsexpansion git info ` - Display information on a script from our Github collection. * `/jsexpansion git download ` - Download a script from Github to your scripts folder. +## Configuration + +All JS-Expansion configurations will be placed inside your PlaceholderAPI plugin's `config.yml` + +The configuration will look like this: + +```YAML + javascript: + debug: true + github_script_downloads: false + engine: javascript + argument_split: ',' +``` + +* `debug` - Enable/Disable debug messages printed on console +* `github_script_downloads` - Enable this option for downloading scripts from Github. [See more](#community-scripts) +* `engine` - Specify global engine in case of failed engine initialization +* `argument_split`: Specify symbol for splitting arguments, defaulting to `,` if the specified splitting symbol is `_`. [See more](Advanced-Scripts#arguments) + ## Community Scripts Want to try out some pre-made scripts from the community and see what the JavaScript Expansion can do?