From 3fa4e518ac3b1f0bd0771b8c8c5e621629e74671 Mon Sep 17 00:00:00 2001 From: KartoffelChipss Date: Sun, 24 May 2026 22:58:27 +0200 Subject: [PATCH] Update config table in README --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4e80ae1..4d3530e 100644 --- a/README.md +++ b/README.md @@ -62,19 +62,20 @@ This will: All options go inside the `` block of the plugin declaration. -| Option | Default | Description | -|---|---|---------------------------------------------------------------------------------------------------------------------------------| -| `mcVersion` | *(required)* | The Minecraft version to run, e.g. `1.21.4` | +| Option | Default | Description | +|---|---|---| +| `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. | -| `serverSoftware` | `paper` | Server software to use. Supported values: `paper`, `spigot` | -| `serverDirectory` | `./server` | Folder where the server files will be created | -| `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` | -| `port` | *(Minecraft default)* | Port the server listens on | -| `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`) | -| `jvmArgs` | *(none)* | Extra JVM flags passed to the server process (see below) | -| `pluginJar` | *(your built jar)* | Path to the plugin jar to deploy. You rarely need to change this | +| `serverSoftware` | `paper` | Server software to use. Supported values: `paper`, `spigot` | +| `serverDirectory` | `./server` | Folder where the server files will be created | +| `serverJarName` | `server.jar` | File name for the server jar inside `serverDirectory` | +| `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 | +| `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`) | +| `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 | ### Full configuration example