salt/docker-minecraft
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Touch up that README, make it more parseable

Browse Source
This commit is contained in:
Salt 2022-05-17 10:58:51 -05:00
parent f62c82e61a
commit c480cd4abd
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,12 +7,18 @@ A Dockerfile and some assorted scripts to build a Minecraft Forge server contain
Deploy as expected: Deploy as expected:
```bash ```bash
docker run -p 25565:25565 rehashedsalt/minecraft-forge:1.16.5-36.1.4-1.0.0 docker run -p 25565:25565 rehashedsalt/minecraft-forge:1.16.5-36.1.4-openjdk11-jre-1.0.0
``` ```
And badda bing, badda boom, you'll have a Minecraft Forge server of whatever the tag is. And badda bing, badda boom, you'll have a Minecraft Forge server of whatever the tag is.
The "latest" tag of each version of Minecraft is somewhere along the lines of "1.16.5-36.1.14-master". See Dockerhub for more info. The tag looks long and unweildy, but it's just this:
```
rehashedsalt/minecraft-forge:${MINECRAFT_VERSION}-${FORGE_VERSION}-${OPENJDK_VERSION}-${BRANCH_OR_TAG_NAME}
```
You can see what the supported combinations of tags are by looking them up in `build.sh`. Each version only supports one edition of Java and one edition of Forge. Getting CI/CD to automagically determine the latest version of Forge is on the to-do list.
## Server Console ## Server Console
@ -48,6 +54,8 @@ The following arguments may be useful to pass through `$ARGS` from time to time:
* `-Dfml.queryResult=confirm` - Useful when confirming through world corruption * `-Dfml.queryResult=confirm` - Useful when confirming through world corruption
* Consider [this advice from a Forge dev](https://old.reddit.com/r/feedthebeast/comments/5jhuk9/modded_mc_and_memory_usage_a_history_with_a/) (circa 5+ years ago but still pretty relevant)
## Weird Defaults ## Weird Defaults
The default `server.properties` contains the following changes to better facilitate usage in a modded environment: The default `server.properties` contains the following changes to better facilitate usage in a modded environment: