Minecraft Server Deployment Tools

Deploy your very own Minecraft server(s) to play with friends, across multiple targets, with just a few commands!

Note that this user guide is targeted towards those deploying everything from a UNIX-alike system, like macOS or GNU/Linux operating systems. You specific results may vary if using Windows and not using the Windows Subsystem for Linux (WSL).

NOTE: Java server support is experimental.

[ IN PROGRESS FROM HERE ]

How to use

Deployments are expected to be managed through the Makefile -- not the least because the default server versions are specified at the top of that file.

Deployment targets available

The following table shows what deployment targets are available for use, as well as how to use them.

Target	How to run
Docker	make docker [ var=value ]
Vagrant	make vagrant [ var=value ]
AWS	See the terraform/aws subdirectory

Most targets support the Makefile variables bedrock_version, java_version, and edition. The Makefile sets defaults if not provided, but they can be overridden by setting them at call-time via e.g. make docker edition=java etc.

Variable name	Default	Definition
edition	bedrock	Which edition of the server to run, i.e. bedrock or java.
bedrock_version	See Makefile	Desired version of the Bedrock server. Specified as MAJOR.MINOR.PATCH.
java_version	See Makefile	Desired version of the Java server. Specified as MAJOR.MINOR, without a PATCH.

If something happens where you need to manually stop the server(s) using the local targets (Docker, Vagrant, etc), run:

make stop

How to use Mods & Addons

Currently, the onus of getting mod/addon files onto your deployment target has some manual requirements in the form of downloading the files themselves using a browser.

Download a desired mod, and place it in a top-level directory in this repo called mods/. Make sure the file(s) ends in a supported extension, like .mcpack. The scripts/init-mods-* script(s) in this repo will take care of extracting the files, putting them where they belong, and collecting the necessary metadata for your server to know about them.

How to update

1. Change any relevant values in your config file
2. Run make <deploy_target> from the repo top-level
3. ???
4. Profit

For setting server Operators ("admins"), you have to wait for people to connect to the server to find their XUIDs to put in your config file. Once you have them, add them to your server-cfg/*/permissions.json file(s), and re-run the deployment steps.

Developer Notes

TBD.

Roadmap

• Java to also deploy a GeyserMC server to translate packets from Bedrock clients