From 3e0e544ec715cc54ede2b115f61f0c6b847756f6 Mon Sep 17 00:00:00 2001 From: Chewing_Bever Date: Wed, 30 Dec 2020 15:27:57 +0100 Subject: [PATCH] Added general README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b969819 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# karaoke-server +This repository contains the Docker scripts I use to manage our "gaming" VPS. +We mostly use it to play modded Minecraft together. + +# Contents +The repo contains setup guides for the following: + +* Vanilla Minecraft +* Modded Minecraft using Forge +* Modded Minecraft using Fabric +* Vanilla Terraria +* Modded Terraria (coming soon) + +Each directory contains (or will contain) its own `README.md` to aid with the +installation of that specific setup. + +# Docker +All the setups named above use Docker and docker-compose. If you're on a +Linux-based server, you can find both `docker` and `docker-compose` in your +package manager (do note that the Docker package might be called `docker.io`). +Otherwise, the install instructions can be found +[here](https://docs.docker.com/engine/install/). + +# Why did I make this? +Well, I just wanted to put all my knowledge in one basket. this makes it easier +to manage and share with others. I spend a lot of time tweaking these configs +and figuring out how they work best (for me at least), and wanted to share this +with everyone else.