Skip to content

Commit 56b7812

Browse files
authored
Merge pull request #17 from arHSM/manifest-advice
2 parents e28cf46 + b7b85a4 commit 56b7812

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/content/docs/ext-dev/manifest.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ This is an example manifest, with every value filled in:
4242
// see below for the various settings types
4343
"settings": {
4444
"exampleSetting": {
45+
"advice": "none",
4546
"displayName": "Example setting",
4647
"type": "boolean",
4748
"default": true
@@ -74,6 +75,9 @@ There are many settings types that you can use to configure your extension in Mo
7475

7576
All settings types take optional `displayName` and `description` arguments, as well as a `default`. If a default is not provided, and the user hasn't configured the extension, the value returned from `moonlight.getConfigOption` will be undefined.
7677

78+
Settings also take an optional `advice` argument which advices the user to reload the client, restart the client, or do nothing.
79+
If no `advice` is provided the default is to suggest a reload, this is different from setting to to `"reload"` which indicates a required reload.
80+
7781
Note that the type defined is purely for what component to use in Moonbase - it is up to you to ensure that you save the right type to the config file.
7882

7983
### `boolean`

0 commit comments

Comments
 (0)