From da1db87be8d81b0f0aa6c0774e74f54b9f7cc78d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ji=C5=99=C3=AD=20=C5=A0tefka?= <jiri.stefka@atlas.cz>
Date: Sun, 26 Feb 2023 22:24:24 +0100
Subject: [PATCH] Add basic readme

---
 README.md | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 msman.sh  |   1 +
 2 files changed, 101 insertions(+), 1 deletion(-)
 create mode 100644 msman.sh

diff --git a/README.md b/README.md
index c2a9699..2d558c2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,101 @@
-# msman.sh
+# MinecraftServerMANager
+
 The best way to quicky spin spin up a Minecraft server
+
+This project is a successor to [start_papermc.sh](https://github.com/jiriks74/start_papermc.sh)
+specifically the [v2.0.0](https://github.com/jiriks74/start_papermc.sh/tree/v2.0.0)
+branch.
+The project grew out of the scope I envisioned at first, surprisingly quickly LOL,
+so I moved all my development here.
+
+This project aims to support more minecraft servers rather than just paper.
+
+## Features
+
+#### Takes care of Java
+
+- Checks for the correct Java version installed
+- Enables you to download a download a portable Java version from [Adoptium](https://adoptium.net/)
+  - The script download's it to `~/.adoptium_java` allowing you to use one
+  Java downlaod across multiple server instances
+  - It also allows you to use multiple Java versions allowing you to run
+  multiple Minecraft servers requiring different Java versions
+
+#### Simple setup
+
+- To setup your server you only need to change some values in `msman.cfg`
+  - If you're starting a server just for you and your friends you don't need to
+  change anything apart from the version and memory usage
+- Values like memory are easy to change without the need to undertand Java flags
+- Asks you if you want to accept the eula so you don't need to mess around with `eula.txt`
+
+#### Sane defaults
+
+- Uses [Aikar's flags](#default-jvm-flags-used)
+
+#### Protections
+
+- Makes sure you really meant to update the Minecraft version
+
+#### Self-update
+
+- This script can self-update itself without the need for user doing it manually
+
+## Currently supported servers
+
+- [Paper](https://papermc.io/)
+
+## Dependencies
+
+- `jq`
+- `awp`
+- `curl`
+
+*Most, if not all, of these should be already available on your system if
+you're running something like Ubuntu.*
+
+## Precautions
+
+> **Warning**
+>
+> It is important to note that this script manages the server's `.jar` file,
+> including its name.
+>
+> Any modifications made to the `.jar` file outside of this script can lead to
+> undefined behavior and may cause the script to crash or perform unexpected actions.
+>
+> I strongly advise against making any modifications to the server's `.jar` file
+> manually, as it may interfere with the proper functioning of this script.
+
+## Basic setup
+
+- [ ] ***TBD***
+
+## Updating the server
+
+### Builds
+
+This script can automatically update to the latest papermc build available for
+the Minecraft version you selected.
+If you want this behaviour, leave the select_build veriable empty.
+Otherwise select the build you want and the script will download it for you.
+
+### Versions
+
+> **Warning**
+>
+> - This script is not made for migrating versions. It won't make sure your plugins
+are working or that your worlds won't get corrupted. It only downloads a new server
+file, nothing else.
+> - **I am not responsible for any lost data**
+
+This script is able to update/downgrade versions as you please. Just change the
+`select_version` variable to the version you want and the script will download
+it for you.
+
+## Default JVM flags used
+
+By default this script uses [Aikar's](https://docs.papermc.io/paper/aikars-flags)
+flags. It's set up so that it automatically modifies them if over 12GB of memory
+is set for the server so you shouldn't need to change them unless you
+want to swap them out for something else.
diff --git a/msman.sh b/msman.sh
new file mode 100644
index 0000000..63ae2c7
--- /dev/null
+++ b/msman.sh
@@ -0,0 +1 @@
+# MinecraftServerMANager