Added general README

pull/3/head
Jef Roosens 2020-12-30 15:27:57 +01:00
parent ed0f06e797
commit 3e0e544ec7
1 changed files with 28 additions and 0 deletions

28
README.md 100644
View File

@ -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.