70 lines
2.3 KiB
Markdown
70 lines
2.3 KiB
Markdown
<!---
|
|
|
|
Copyright (C) 2020 Jef Roosens
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
-->
|
|
|
|
|
|
# Build arguments
|
|
Two build arguments are required, namely `MC_VERSION` and `FORGE_VERSION`. You
|
|
can find your required versions [here](https://files.minecraftforge.net/).
|
|
Then, you can specify them in the `.env` file:
|
|
|
|
```
|
|
MC_VERSION=1.16.4
|
|
FORGE_VERSION=35.1.4
|
|
```
|
|
|
|
# Environment variables
|
|
The two possible environment variables are `XMS` and `XMX`. These specify the
|
|
initial RAM & maximum RAM usage respectively. Only `XMS` is required; `XMX` is
|
|
just set to the same value as `XMS` if not specified. You must specify them as
|
|
a number, e.g. `XMS=4`. This number represents a quantity of gigabytes.
|
|
|
|
# Mount points
|
|
There a three useful mount points defined:
|
|
|
|
* `/mc/config`: this is where all server config files reside.
|
|
* `/mc/config/mods`: this is where all mods should be placed.
|
|
* `/mc/worlds`: this is where the world files are stored.
|
|
|
|
You can mount these directories somewhere in the host file system by specifying
|
|
the mount paths in the `.env` file. These can be both absolute or relative
|
|
paths.
|
|
|
|
# Other config variables
|
|
The only other config variable is `PORT`. This specifies on what port your
|
|
server will be discoverable over the internet. The default Minecraft port is
|
|
`25565`.
|
|
|
|
# Java flags
|
|
I use the Java flags defined
|
|
[here](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/).
|
|
If you don't agree with this decision, you can change the `ENTRYPOINT` at the
|
|
end of the `Dockerfile` to the following:
|
|
|
|
```
|
|
ENTRYPOINT java \
|
|
-Xms"${XMS}G" \
|
|
-Xmx"${XMX:-$XMS}G" \
|
|
-jar "$FORGE_JAR" \
|
|
--universe /mc/worlds \
|
|
--nogui
|
|
```
|
|
|
|
This will only use the flags absolutely necessary, while still allowing you to
|
|
tweak the memory variables.
|