From 93a0efbabd7ce3d2f6f90bbe23ed31a09c7f67df Mon Sep 17 00:00:00 2001 From: unknown Date: Fri, 26 Jan 2024 00:14:31 +0100 Subject: [PATCH] Add setup instructions --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 703dbbf..f4a8255 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,24 @@ Runs a Minecraft Server inside a docker container. # Java Edition only 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 +```