minecraft/README.md

43 lines
1.3 KiB
Markdown
Raw Normal View History

2024-05-09 08:25:35 +00:00
# Minecraft Docker Image
This Dockerfile sets up a Minecraft server based on the `debian-slim` image.
2024-05-09 08:25:35 +00:00
## Quick Start
By running the following and building this image, you are agreeing to
[Minecraft's EULA](https://www.minecraft.net/en-us/eula):
```
echo "EULA=true" > .env
```
2024-05-09 08:25:35 +00:00
Build the image using the Makefile:
```
make build
```
Optionally, build _and_ run to test it:
```
make install
```
Feel free to use `docker compose` directly to build and test:
2024-05-09 08:25:35 +00:00
```
docker compose build
docker compose up -d
docker logs -f minecraft-minecraft-1
2024-05-09 08:25:35 +00:00
```
## Copyright and License
Copyright (C) 2024 Kris Lamoureux
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
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, 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/>.