docker-minecraft/README.md

53 lines
1.2 KiB
Markdown
Raw Normal View History

# docker-minecraft
A Dockerfile and some assorted scripts to build a Minecraft Forge server container.
## Usage
Deploy as expected:
```bash
docker run -p 25565:25565 rehashedsalt/minecraft-forge
```
And badda bing, badda boom, you'll have a Minecraft Forge server of whatever the latest stable is.
## Application State
For obvious reasons, you'll want to consult the documentation of any mods you have installed, but a majority of application state lives here-ish:
* `/minecraft/world`
* `/minecraft/ops.json`, `whitelist.json`, `banned-ips.json`, `banned-players.json`, etc.
* `/minecraft/logs`
## Environment Variables
variable|description
---|---
`JRE_XMX`|Maximum amount of heap passed to the main Minecraft process
`JRE_XMS`|Minimum heap size passed to the main Minecraft process
`ARGS`|Any additional arguments to be passed to the JVM
## Useful Arguments
The following arguments may be useful to pass through `$ARGS` from time to time:
* `-Dfml.queryResult=confirm` - Useful when confirming through world corruption
## Weird Defaults
The default `server.properties` contains the following changes to better facilitate usage in a modded environment:
```
allow-flight=true
difficulty=hard
enable-command-block=true
spawn-protection=0
```
## License
MIT