KartoffelChipss/MCRun
1
1
Fork 0
Code Issues Pull Requests Actions Releases 2 Activity

Update config table in README

Browse Source
This commit is contained in:
KartoffelChipss
2026-05-24 22:58:27 +02:00
parent 2b56362174
commit 3fa4e518ac
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -3
View File
@@ -63,17 +63,18 @@ This will:
All options go inside the `<configuration>` block of the plugin declaration. All options go inside the `<configuration>` block of the plugin declaration.
| Option | Default | Description | | Option | Default | Description |
|---|---|---------------------------------------------------------------------------------------------------------------------------------| |---|---|---|
| `mcVersion` | *(required)* | The Minecraft version to run, e.g. `1.21.4` | | `mcVersion` | *(required)* | The Minecraft version to run, e.g. `1.21.4` |
| `acceptEula` | `false` | Automatically accept the [Minecraft EULA](https://aka.ms/MinecraftEULA). By setting this to `true` you confirm your acceptance. | | `acceptEula` | `false` | Automatically accept the [Minecraft EULA](https://aka.ms/MinecraftEULA). By setting this to `true` you confirm your acceptance. |
| `serverSoftware` | `paper` | Server software to use. Supported values: `paper`, `spigot` | | `serverSoftware` | `paper` | Server software to use. Supported values: `paper`, `spigot` |
| `serverDirectory` | `./server` | Folder where the server files will be created | | `serverDirectory` | `./server` | Folder where the server files will be created |
| `serverJarName` | `server.jar` | File name for the server jar inside `serverDirectory` | | `serverJarName` | `server.jar` | File name for the server jar inside `serverDirectory` |
| `memory` | `2G` | RAM allocated to the server (used for both `-Xmx` and `-Xms`), e.g. `2G`, `512M` | | `minMemory` | `512M` | Minimum RAM allocated to the server (`-Xms`), e.g. `512M`, `1G` |
| `maxMemory` | `2G` | Maximum RAM allocated to the server (`-Xmx`), e.g. `2G`, `4G` |
| `port` | *(Minecraft default)* | Port the server listens on | | `port` | *(Minecraft default)* | Port the server listens on |
| `remoteDebug` | `false` | Enable remote JVM debugging so you can attach your IDE's debugger | | `remoteDebug` | `false` | Enable remote JVM debugging so you can attach your IDE's debugger |
| `debugPort` | `5005` | Port used for remote debugging (only relevant if `remoteDebug` is `true`) | | `debugPort` | `5005` | Port used for remote debugging (only relevant if `remoteDebug` is `true`) |
| `jvmArgs` | *(none)* | Extra JVM flags passed to the server process (see below) | | `jvmArgs` | *(none)* | Extra JVM flags passed to the server process |
| `pluginJar` | *(your built jar)* | Path to the plugin jar to deploy. You rarely need to change this | | `pluginJar` | *(your built jar)* | Path to the plugin jar to deploy. You rarely need to change this |
### Full configuration example ### Full configuration example