kris/minecraft
kris/minecraft
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rewrite README for clarity and accuracy

Browse Source 
- Simplify build steps in README
- Add `make configure` for custom builds
- Recommend using `make paper` for PaperMC server setup
- Advise tagging images for private repository
- Highlight the importance of managing your own compose files
This commit is contained in:
Kris Lamoureux 2024-05-24 20:52:03 -04:00
parent 4ce50becd2
commit 3a943e9397
Signed by: kris
GPG Key ID: 3EDA9C3441EDA925
1 changed files with 71 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
README.md
View File

@ -1,42 +1,79 @@
# Minecraft Docker Image # Minecraft Container Image
This Dockerfile sets up a Minecraft server based on the `debian-slim` image.
## Quick Start ## Quick Start
By running the following and building this image, you are agreeing to Assume a clean repository (i.e., without .env and plugins.json in the top
[Minecraft's EULA](https://www.minecraft.net/en-us/eula): directory), and Docker cache. You can use `make clean` to clear specific
``` default images and prune the unused build cache. However, you'll still need to
echo "EULA=true" > .env inspect all containers and images to ensure you've removed them all.
```
Build the image using the Makefile: - `make clean` only removes certain images and prunes the builder cache.
```
make build ### Steps
```
1. **Configure your build:**
```
make configure
```
This defaults to `make configure BUILD=basic`, but if you have directories
in `./scratch`, you can specify those build names here. Repository-included
builds are in`./builds`, but it's advised to copy `./builds/basic` or
whichever build configuration you are basing off and copy it into
`./scratch/X` to control your settings apart from the repository. This
separation allows you to manage your configurations independently and avoid
overwriting repository defaults.
2. **Build the PaperMC server:**
```
make paper
```
This builds the PaperMC server, which is likely what you want unless you
prefer a 100% vanilla server experience. PaperMC is recommended for its
performance benefits and support for Bukkit API server mods. Both
EssentialsX and WorldGuard suggest using Paper for better performance and
stability.
3. **(Optional) Install for testing:**
Optionally, build _and_ run to test it:
``` ```
make install make install
``` ```
This runs `docker compose up -d` and brings up a `minecraft-minecraft-1`
network/container compose stack using the `.env` and `plugins.json` in the
root of the repository. It includes settings for image overrides, the
`EULA` agreement, and a `DEBUG` option for the custom `entrypoint.sh`
script, Java options (defaulting to `-Xms1G -Xmx2G`), and the ability to
set any `server.properties` file entry using the `SETTINGS_` prefix in the
compose file. The purpose of `make install` is for testing only, and it is
advised not to rely on it for managing an actual server deployment. You
will likely want to add other settings not specified in the
`docker-compose.yml` and manage your own compose files.
Feel free to use `docker compose` directly to build and test: ## Additional Notes
### Image Management
All images are tagged with `localhost/minecraft`, etc. It's acceptable not to
override these default image names and just tag your own versions after
building the `localhost` images. The images will include git hash information
for extra traceability.
After using the quick start, you'll get something like this:
``` ```
docker compose build $ docker image ls
docker compose up -d REPOSITORY TAG IMAGE ID CREATED SIZE
docker logs -f minecraft-minecraft-1 localhost/minecraft 1.20.1-paper 814edda474c4 9 seconds ago 568MB
localhost/minecraft-jre latest 50350d8d3947 30 seconds ago 379MB
``` ```
## Copyright and License It is advisable to tag your own images and push them to a private container
Copyright (C) 2024 Kris Lamoureux repository, as you'll want to avoid pushing these images to a public DockerHub
repository due to the Minecraft EULA with typical proprietary software
non-redistribution rules.
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ```
docker tag localhost/minecraft:1.20.1-paper example.org/minecraft:1.20.1-paper
docker push example.org/minecraft:1.20.1-paper
```
This program is free software: you can redistribute it and/or modify it under ## License
the terms of the GNU General Public License as published by the Free Software This project is licensed under the GPLv3 License. See the LICENSE file for details.
Foundation, version 3 of the License.
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/>.