init

minecraft_env_vars.md

@@ -0,0 +1,70 @@
+
+Minecraft Server Docker Environment Variables (itzg/minecraft-server)
+=====================================================================
+
+🧩 Server Configuration
+-----------------------
+EULA: Must be set to "TRUE" to accept the Minecraft EULA.
+VERSION: Specify the Minecraft server version, e.g., "1.20.4".
+TYPE: Server type, such as "VANILLA", "FORGE", "FABRIC", "PAPER", etc.
+MOTD: Message of the day displayed in the server list.
+DIFFICULTY: Game difficulty; options: "peaceful", "easy", "normal", "hard".
+MAX_PLAYERS: Max number of players allowed.
+VIEW_DISTANCE: Number of chunks sent to players around them.
+ALLOW_NETHER: Enable or disable the Nether.
+ENABLE_COMMAND_BLOCK: Enable or disable command blocks.
+FORCE_GAMEMODE: Force players to join in the default game mode.
+GENERATE_STRUCTURES: Enable or disable structure generation.
+HARDCORE: Enable or disable hardcore mode.
+MAX_BUILD_HEIGHT: Max build height.
+SPAWN_ANIMALS: Enable or disable animal spawning.
+SPAWN_MONSTERS: Enable or disable monster spawning.
+SPAWN_NPCS: Enable or disable NPC spawning.
+SPAWN_PROTECTION: Radius of spawn protection for non-ops.
+LEVEL_NAME: Name of the world folder.
+LEVEL_TYPE: "DEFAULT", "FLAT", "LARGEBIOMES", "AMPLIFIED", "CUSTOMIZED".
+LEVEL_SEED: World seed.
+PVP: Enable or disable player combat.
+ONLINE_MODE: Enable/disable Mojang authentication.
+ALLOW_FLIGHT: Allow/disallow flight.
+
+🛡️ Access Control
+-----------------
+WHITELIST: Comma-separated list of usernames.
+OPS: Comma-separated list of operators.
+ENABLE_WHITELIST: Enable/disable whitelist.
+ENFORCE_WHITELIST: Always enforce whitelist.
+
+⚙️ Advanced Settings
+--------------------
+ICON: URL or file path to server icon.
+OVERRIDE_ICON: TRUE to override existing icon.
+ENABLE_RCON: Enable/disable RCON.
+RCON_PASSWORD: RCON password.
+RCON_PORT: Default is 25575.
+ENABLE_QUERY: Enable/disable GameSpy4 query.
+QUERY_PORT: Default is 25565.
+ENABLE_JMX: Enable/disable JMX.
+JMX_PORT: Default is 7091.
+USE_AIKAR_FLAGS: Use Aikar's JVM flags.
+JVM_OPTS, JVM_XX_OPTS, JVM_DD_OPTS: JVM tuning.
+EXTRA_ARGS: Extra server args.
+LOG_TIMESTAMP: Include timestamps in logs.
+ENABLE_ROLLING_LOGS: Enable rolling logs.
+
+🧪 Experimental/Modding
+------------------------
+MODPACK, MODPACK_VERSION: Modpack configs.
+MODRINTH_PROJECT, MODRINTH_VERSION: Modrinth config.
+CURSEFORGE_PROJECT, CURSEFORGE_FILE_ID: CurseForge config.
+AUTODOWNLOAD: Automatically download mods.
+
+🕒 Time and Locale
+------------------
+TZ: Timezone, e.g., "Europe/Prague".
+
+🧰 Custom Properties
+--------------------
+CUSTOM_SERVER_PROPERTIES: Newline-separated key=value for custom settings.
+
+See: https://github.com/itzg/docker-minecraft-server