|
| 1 | +--- |
| 2 | +sidebar_position: 1 |
| 3 | +title: Accessing server settings |
| 4 | +description: How to view and edit the settings of a server in MCSS. |
| 5 | +keywords: [import, server, files, existing] |
| 6 | +--- |
| 7 | + |
| 8 | +import MCserverSettings from '/static/img/docs/server-settings/minecraft-settings.jpg'; |
| 9 | +import serverSettingsLocation from '/static/img/docs/server-settings/mcss-server-settings-location.jpg'; |
| 10 | + |
| 11 | +# How MCSS handles the server settings {#-mcss-handle-settings} |
| 12 | + |
| 13 | +MCSS has two main server settings pages: |
| 14 | +- [One for the Minecraft-related settings](#-mcss-minecraft-settings); |
| 15 | +- [One for the server execution settings](#-mcss-server-execution-settings). |
| 16 | + |
| 17 | +Both are accessible only in the main MCSS window (and not in the web panel). |
| 18 | + |
| 19 | +## Minecraft-related settings {#-mcss-minecraft-settings} |
| 20 | +You can edit Minecraft settings using the ‘Settings’ pane in the dashboard. |
| 21 | +<img src={MCserverSettings} alt="Minecraft Server Settings" style={{width: 400}} /> |
| 22 | +On this page, you’ll find settings usually found in the server.properties file. |
| 23 | +You can change settings like difficulty, default gamemode, view distance, MOTD, and more through the UI. |
| 24 | + |
| 25 | +## Server execution settings {#-mcss-server-execution-settings} |
| 26 | +To open server execution settings, click the cogwheel icon or navigate to `Server` > `Edit Server` at the top. |
| 27 | +<img src={serverSettingsLocation} alt="Where you can find the server execution settings" style={{width: 800}} /> |
| 28 | +This popup lets you change the following settings for the selected server: |
| 29 | +- [Server name and Description](#-mcss-settings-general) |
| 30 | +- [Server icon (but only the one that's in the MCSS UI)](#-mcss-settings-general) |
| 31 | +- [Assigned RAM (see below for details)](#-mcss-settings-general) |
| 32 | +- [Server port](#-mcss-settings-general) |
| 33 | +- [Autostart](#-mcss-settings-general) |
| 34 | +- [Startup line](#-mcss-settings-advanced) |
| 35 | +- [Java version](#-mcss-settings-advanced) |
| 36 | +- Keep Online Mode (Crash Handling) |
| 37 | +- Update the server |
| 38 | + |
| 39 | +:::tip |
| 40 | +Settings on this page are saved only when you click the `Save` button. |
| 41 | +::: |
| 42 | + |
| 43 | +:::caution |
| 44 | +These settings are generally not backed up. Some changes may prevent your server from starting or could cause data loss. Proceed with caution! |
| 45 | +::: |
| 46 | + |
| 47 | +Below we'll cover all pages of this popup. |
| 48 | + |
| 49 | +### General {#-mcss-settings-general} |
| 50 | +In this page of the server execution settings you can edit the name, description and more. |
| 51 | +The server icon editable in this section only applies to the MCSS app, not to the Minecraft Server List. |
| 52 | +The autostart setting allows for a server to be started when MCSS first starts. |
| 53 | +Any changes to the port or assigned RAM require a server restart to be applied. |
| 54 | + |
| 55 | +:::caution |
| 56 | +Renaming the server folder requires a manual filesystem change, so it’s not recommended unless absolutely necessary. |
| 57 | +::: |
| 58 | + |
| 59 | +:::tip |
| 60 | +Editing the assigned RAM only applies when the server uses the default Java Startup Line method. |
| 61 | +If you're unsure, review [the advanced page](#-mcss-settings-advanced) of the server settings. |
| 62 | +::: |
| 63 | + |
| 64 | +### Advanced {#-mcss-settings-advanced} |
| 65 | +In the `Advanced` section, you can set a custom Java path for this server, change the startup Java line, or set the server to use a .bat file. |
| 66 | +To apply the assigned RAM in the `General` tab, select the `Java Startup Line` method and set the `-Xmx` flag to `[RAM]M`. |
| 67 | +When setting a .bat file as startup, MCSS will run the validator to check for common mistakes. Be sure to remove all `pause` statements from the file. |
| 68 | +Additional custom logic (such as automatic restarts) is **NOT** supported by MCSS, and therefore should be removed. |
| 69 | + |
| 70 | +:::tip |
| 71 | +Wanting to run a modpack that requires the use of a custom .bat file? |
| 72 | +Follow the [modpack setup guide](/basic/create-server/Forge/create-a-server-with-a-modpack)! |
| 73 | +::: |
| 74 | + |
| 75 | +:::caution |
| 76 | +Changing the Java version to one not supported by the server will prevent it from starting. |
| 77 | +Follow the [java version matrix](/advanced/java-version) to ensure compatibility, and the [java path update](/advanced/java-path-update) guide to find the correct java path for your version. |
| 78 | +::: |
| 79 | + |
| 80 | +### Crash Handling {#-mcss-settings-crash} |
| 81 | +Here you can set the behavior MCSS should take when it detects that the server has crashed. |
| 82 | +With the default setting (`Nothing`), the server will not be restarted automatically after a crash or stop. |
| 83 | +The `elevated` setting automatically restarts the server *if it hasn't been shut down by a MCSS input* (via the web panel, by sending a `stop` command in the server console or by clicking on the `stop` or `kill` buttons). This is the safest setting. |
| 84 | +The `aggressive` setting will **always** restart the server, even if it was stopped by MCSS. |
| 85 | +:::danger |
| 86 | +The aggressive setting may cause issues with backups and scheduled tasks, resulting in incomplete or partial backups or data corruption. |
| 87 | +::: |
| 88 | + |
| 89 | +### Update Server {#-mcss-settings-update} |
| 90 | +Here, you can upload a new .jar file to replace the current one. Stop the server before switching .jar files. |
| 91 | +:::caution |
| 92 | +This process is not recommended for modded versions, as they require updating external libraries separately. |
| 93 | +::: |
0 commit comments