ServerUtilities: Difference between revisions

Content added Content deleted
m (ranks configs, backups, pic)
(summary of what the main config file can do, fixed variables to be SU compliant.)
Line 46: Line 46:


* Trigger a manual backup: <code>/backup start</code>
* Trigger a manual backup: <code>/backup start</code>
* Stop a manual backup in progress: <code>/backup stop</code>


Backup settings:
Backup settings:
Open <code>/''your_instance''/serverutilities/serverutilities.cfg</code>, then
Open <code>/''your_instance''/serverutilities/serverutilities.cfg</code>, then find:
** Find <code>"backup_timer": 2.0,</code> where # is the number of hours ''between'' backups.
** <code>S:backup_folder_path=./backups/</code>, to change the default backup archive location.
** Find <code>"backups_to_keep": 3,</code> change value to number of desired backups.
** <code>S:backup_timer=0.5</code>, where # is the number of hours ''between'' backups. e.g. 0.5 would be every half hour.
** Find <code>"enable_backups"</code>, set to true to enable automatic backups.
** <code>I:backups_to_keep=5</code>, change value to number of desired backups.
** <code>B:enable_backups=true</code>, set to <code>true</code> to enable automatic backups, <code>false</code> to disable.
** <code>B:display_file_size=true</code>, change to <code>false</code> to suppress the display of world size/backup size after saving.
** <code>I:compression_level=1</code>, set between <code>1</code> (fastest) and <code>9</code> (smallest file) compression level.
** <code>B:silent_backup=false</code>, change to <code>true</code> to not show backup notifications.
** <code>B:need_online_players=true</code>, change to <code>false</code> to do backups even when the server is empty.
** <code>B:use_separate_thread=true</code>, sets if the archive will build in a separate CPU thread.

== Config Files ==
The <code>/''your_instance''/serverutilities/serverutilities.cfg</code> file has options for the following:
* AFK Timer / messages
* Auto-Shutdown
* Backups
* Marking of changed nicknames
* Enable/disable specific SU commands
* Debugging (of ServerUtilities)
* Player profile merging
* Replacing the <code>/reload</code> command with SU's version.
* Login messages
* Starter items / welcome package
* Ranks and associated chat colors
* Teams auto-creation/join
* Banlist of dimensions for chunkloading
* Enable/disable chunk loading & claiming
* Disable wall suffocation
* Disable right-click of specific items
* Forcing explosion and PVP settings
* Settings for spawn dimension
* <code>/rtp</code> Request teleport settings
* Hide/show play time
* Unloading of erroring chunks
* Log settings


== Links ==
== Links ==