Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@main
with:
node-version: '18'
node-version: '20'

- name: Get yarn cache
id: yarn-cache
Expand Down
2 changes: 1 addition & 1 deletion docs/API/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ If you plan on writing code that leverages the API, you may want to use an IDE e

## API Endpoints {#-api-endpoints}

View all [implemented endpoints](/api/endpoints).
View all [implemented endpoints](/API/endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are 2 options on how to add a forge server to mcss.
This guide will show you how to manually create and an import a forge server.

:::tip Looking for the modpack setup?
You can find the appropriate guide for forge modpacks [here](/basic/create-server/forge/create-a-server-with-a-modpack)
You can find the appropriate guide for forge modpacks [here](/basic/create-server/Forge/create-a-server-with-a-modpack)
:::

## Download Forge {#-download-forge}
Expand Down
4 changes: 4 additions & 0 deletions docs/basic/server-settings/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Server Settings",
"position": 5
}
93 changes: 93 additions & 0 deletions docs/basic/server-settings/accessing-server-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
sidebar_position: 1
title: Accessing server settings
description: How to view and edit the settings of a server in MCSS.
keywords: [import, server, files, existing]
---

import MCserverSettings from '/static/img/docs/server-settings/minecraft-settings.jpg';
import serverSettingsLocation from '/static/img/docs/server-settings/mcss-server-settings-location.jpg';

# How MCSS handles the server settings {#-mcss-handle-settings}

MCSS has two main server settings pages:
- [One for the Minecraft-related settings](#-mcss-minecraft-settings);
- [One for the server execution settings](#-mcss-server-execution-settings).

Both are accessible only in the main MCSS window (and not in the web panel).

## Minecraft-related settings {#-mcss-minecraft-settings}
You can edit Minecraft settings using the ‘Settings’ pane in the dashboard.
<img src={MCserverSettings} alt="Minecraft Server Settings" style={{width: 400}} />
On this page, you’ll find settings usually found in the server.properties file.
You can change settings like difficulty, default gamemode, view distance, MOTD, and more through the UI.

## Server execution settings {#-mcss-server-execution-settings}
To open server execution settings, click the cogwheel icon or navigate to `Server` > `Edit Server` at the top.
<img src={serverSettingsLocation} alt="Where you can find the server execution settings" style={{width: 800}} />
This popup lets you change the following settings for the selected server:
- [Server name and Description](#-mcss-settings-general)
- [Server icon (but only the one that's in the MCSS UI)](#-mcss-settings-general)
- [Assigned RAM (see below for details)](#-mcss-settings-general)
- [Server port](#-mcss-settings-general)
- [Autostart](#-mcss-settings-general)
- [Startup line](#-mcss-settings-advanced)
- [Java version](#-mcss-settings-advanced)
- Keep Online Mode (Crash Handling)
- Update the server

:::tip
Settings on this page are saved only when you click the `Save` button.
:::

:::caution
These settings are generally not backed up. Some changes may prevent your server from starting or could cause data loss. Proceed with caution!
:::

Below we'll cover all pages of this popup.

### General {#-mcss-settings-general}
In this page of the server execution settings you can edit the name, description and more.
The server icon editable in this section only applies to the MCSS app, not to the Minecraft Server List.
The autostart setting allows for a server to be started when MCSS first starts.
Any changes to the port or assigned RAM require a server restart to be applied.

:::caution
Renaming the server folder requires a manual filesystem change, so it’s not recommended unless absolutely necessary.
:::

:::tip
Editing the assigned RAM only applies when the server uses the default Java Startup Line method.
If you're unsure, review [the advanced page](#-mcss-settings-advanced) of the server settings.
:::

### Advanced {#-mcss-settings-advanced}
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.
To apply the assigned RAM in the `General` tab, select the `Java Startup Line` method and set the `-Xmx` flag to `[RAM]M`.
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.
Additional custom logic (such as automatic restarts) is **NOT** supported by MCSS, and therefore should be removed.

:::tip
Wanting to run a modpack that requires the use of a custom .bat file?
Follow the [modpack setup guide](/basic/create-server/Forge/create-a-server-with-a-modpack)!
:::

:::caution
Changing the Java version to one not supported by the server will prevent it from starting.
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.
:::

### Crash Handling {#-mcss-settings-crash}
Here you can set the behavior MCSS should take when it detects that the server has crashed.
With the default setting (`Nothing`), the server will not be restarted automatically after a crash or stop.
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.
The `aggressive` setting will **always** restart the server, even if it was stopped by MCSS.
:::danger
The aggressive setting may cause issues with backups and scheduled tasks, resulting in incomplete or partial backups or data corruption.
:::

### Update Server {#-mcss-settings-update}
Here, you can upload a new .jar file to replace the current one. Stop the server before switching .jar files.
:::caution
This process is not recommended for modded versions, as they require updating external libraries separately.
:::
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ A process on your computer is already using the port your server is trying to us

Start by ensuring you do not already have a server running on this port. If that's the case

Try killing all java processes (refer to [regain-control](#how-do-i-regain-control-of-my-server-if-mcss-crashes)) and start your server again.
Try killing all java processes (refer to [regain-control](#-faq-crash)) and start your server again.

If you added an IP to the 'server-ip' field in the server.properties file make sure to remove it.
If you're running multiple servers make sure they're not using the same port.
Expand Down Expand Up @@ -105,7 +105,7 @@ MCSS runs on your computer. As long as it is online, the server is. So yes, if y

MCSS comes with a web panel to manage your servers remotely. You can find more info about it [here](/webpanel/getting-started).
Please note that the panel is still under development so not all features from the app are included.
There is also a REST API available for developers, you can learn more about it [here](/api/about).
There is also a REST API available for developers, you can learn more about it [here](/API/about).

## Dashboard graphs are stuck to 0% CPU and 1MB of RAM {#-faq-dashboard-stats-stuck}

Expand Down
8 changes: 6 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ const config = {
url: 'https://mcserversoft.github.io',
baseUrl: '/',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
markdown: {
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},
favicon: '/favicon.ico',
organizationName: 'mcserversoft',
projectName: 'documentation',
Expand Down Expand Up @@ -219,7 +223,7 @@ const config = {
},
{
label: 'Developer API',
to: '/api/about',
to: '/API/about',
},
{
label: 'Screenshots',
Expand Down
Loading
Loading