Skip to main content
Before a server starts, SimpleCloud uses a configurator to write values such as the assigned port and player limit to the server software’s configuration files. The dashboard selects a built-in configurator when you create a group or persistent server, so a standard setup needs no extra work. Create a custom configurator when you need to add settings that the built-in configurator does not manage. Use templates instead when you only need to copy the same files to your servers.
A custom configurator replaces the selected built-in configurator. Keep the built-in settings that your server needs, especially its port and proxy settings.

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 options/configurators/paper_survival.yml:
options/configurators/paper_survival.yml
Each 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.
If the server can run on multiple serverhosts, add the configurator file to each one.

Configurator reference

Each entry under paths identifies a configuration file, its format, and the values to apply.
Structured files keep values that are not specified in the configurator. TXT replaces the complete file.
Use placeholders when a value depends on the server instance.Quote placeholders whose resulting value must be text:
Custom properties from the group or persistent server are also available as placeholders. For example, a property named motd can be used as %motd%.

Troubleshooting

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.
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.
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.
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.