Updated PaperMC READMe
parent
493db5690e
commit
11029c3b43
|
@ -1,23 +1,3 @@
|
||||||
<!---
|
|
||||||
|
|
||||||
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
|
# Build arguments
|
||||||
Two build arguments are required, namely `MC_VERSION` and `PAPERMC_VERSION`.
|
Two build arguments are required, namely `MC_VERSION` and `PAPERMC_VERSION`.
|
||||||
You can find your required versions [here](https://papermc.io/downloads). The
|
You can find your required versions [here](https://papermc.io/downloads). The
|
||||||
|
@ -36,15 +16,15 @@ Note that the leading `#` doesn't need to be added to the variable.
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
The two possible environment variables are `XMS` and `XMX`. These specify the
|
The two possible environment variables are `XMS` and `XMX`. These specify the
|
||||||
initial RAM & maximum RAM usage respectively. Only `XMS` is required; `XMX` is
|
initial RAM & maximum RAM usage respectively. Only `XMX` is required; `XMS` is
|
||||||
just set to the same value as `XMS` if not specified. You must specify them as
|
just set to the same value as `XMX` if not specified. You must specify them as
|
||||||
a number, e.g. `XMS=4`. This number represents a quantity of gigabytes.
|
a number, e.g. `XMS=4`. This number represents a quantity of gigabytes.
|
||||||
|
|
||||||
# Mount points
|
# Mount points
|
||||||
There a two useful mount points defined:
|
There a two useful mount points defined:
|
||||||
|
|
||||||
* `/mc/config`: this is where all server config files reside.
|
* `/app/config`: this is where all server config files reside.
|
||||||
* `/mc/worlds`: this is where the world files are stored.
|
* `/app/worlds`: this is where the world files are stored.
|
||||||
|
|
||||||
You can mount these directories somewhere in the host file system by specifying
|
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
|
the mount paths in the `.env` file. These can be both absolute or relative
|
||||||
|
@ -65,8 +45,8 @@ end of the `Dockerfile` to the following:
|
||||||
ENTRYPOINT java \
|
ENTRYPOINT java \
|
||||||
-Xms"${XMS}G" \
|
-Xms"${XMS}G" \
|
||||||
-Xmx"${XMX:-$XMS}G" \
|
-Xmx"${XMX:-$XMS}G" \
|
||||||
-jar /mc/server.jar \
|
-jar /app/server.jar \
|
||||||
--universe /mc/worlds \
|
--universe /app/worlds \
|
||||||
--nogui
|
--nogui
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Reference in New Issue