Adds configuration options to the documentation
All checks were successful
KnarCraft/PlaceholderSigns/pipeline/head This commit looks good

This commit is contained in:
Kristian Knarvik 2024-04-30 03:17:13 +02:00
parent f8ca5705a5
commit 0e9985b674

View File

@ -45,4 +45,11 @@ Note that commands have some restrictions in place, so giving the weakest permis
| placeholdersigns.copy.use | false | Allows use of the /copySign and /copySignText commands. | | placeholdersigns.copy.use | false | Allows use of the /copySign and /copySignText commands. |
| placeholdersigns.copy.bypass-waxed | false | Allows pasting a sign copied with /copySign and /copySignText onto a waxed sign. | | placeholdersigns.copy.bypass-waxed | false | Allows pasting a sign copied with /copySign and /copySignText onto a waxed sign. |
| placeholdersigns.unwax | false | Allows use of the /unWaxSign command | | placeholdersigns.unwax | false | Allows use of the /unWaxSign command |
| placeholdersigns.setdelay | false | Allows use of the /setPlaceholderUpdateDelay command | | placeholdersigns.setdelay | false | Allows use of the /setPlaceholderUpdateDelay command |
## Configuration options
| Node | Type | Default | Description |
|------------------------|---------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| language | String | en | The language to use. Only "en" is available, but you can add a custom language by copying src/main/resources/strings.yml into the plugin folder, replacing the "en" in the first line and customizing the strings. |
| defaultSignUpdateTicks | Integer | 100 | The number of ticks to wait between each placeholder sign update. This delay is used for any placeholder signs that haven't been overridden using /setPlaceholderUpdateDelay. 1 second = 20 ticks, so the default is 5 seconds. |