Create a custom configurator
This example extends the Paper/Spigot Standalone configurator with a difficulty and view distance. If your server connects through a proxy, start with the matching proxy configurator instead.1
Create the configurator file
On the serverhost, create Each
options/configurators/paper_survival.yml:options/configurators/paper_survival.yml
path is relative to the server’s own directory. The file can contain several path entries when you need to configure more than one file.2
Select the configurator
Open the group or persistent server in the dashboard, then go to Settings > Blueprint. Under Software Configuration, select Custom, enter
paper_survival, and save.3
Apply the changes
Restart the group or persistent server. SimpleCloud applies the configurator to every server that uses its blueprint before that server starts.
Configurator reference
Each entry underpaths identifies a configuration file, its format, and the values to apply.
Supported file types
Supported file types
Structured files keep values that are not specified in the configurator.
TXT replaces the complete file.Available placeholders
Available placeholders
Use placeholders when a value depends on the server instance.Custom properties from the group or persistent server are also available as placeholders. For example, a property named
Quote placeholders whose resulting value must be text:
motd can be used as %motd%.Troubleshooting
The configurator cannot be found
The configurator cannot be found
Confirm that
options/configurators/{name}.yml exists on every serverhost that can run the server. The custom name in the dashboard must match the filename without .yml.A setting does not change
A setting does not change
Restart the server first. If the value still does not change, check that
path is relative to the server directory, type matches the file format, and the setting is nested correctly under data.A placeholder remains in the file
A placeholder remains in the file
Check the placeholder spelling and use percent syntax such as
%port%. For a custom placeholder, add a property with the same name to the group or persistent server.The server does not start after selecting the configurator
The server does not start after selecting the configurator
Check the serverhost log for a configurator error. Common causes are invalid YAML, an unsupported
type, or a value whose structure does not match the target file.