Add setup instructions

This commit is contained in:
JeremyStar™ 2024-01-26 00:14:31 +01:00
parent 80c50f557d
commit 93a0efbabd

View file

@ -3,3 +3,24 @@ Runs a Minecraft Server inside a docker container.
# Java Edition only # Java Edition only
This only supports the true version of Minecraft, not that phone and console spinoff named "Bedrock Edition". This only supports the true version of Minecraft, not that phone and console spinoff named "Bedrock Edition".
# Setting up
## Step 1: Installing
This will bootstrap MCSD.
```bash
git clone "https://git.staropensource.de/JeremyStarTM/mcserverdocker.git"
cd mcserverdocker
mkdir server
```
## Step 2: Installing the server software
Rename the jar file of your preferred server software to `server.jar` and move it into the `server/` directory.
## Step 3: Modify the docker-compose.yml
Take a look at the ports and environment variables inside the `docker-compose.yml` file and leave everything else as-is.
## Step 4: Launching the server
You need to start your server two times as we need to generate the `server.properties` file first. MCSD will do this automatically for you.
```plain
# Use this to launch your server every time you need it
docker compose up -d
```