summaryrefslogtreecommitdiff
path: root/USAGE.md
diff options
context:
space:
mode:
authorGravatar Jonas Gunz <himself@jonasgunz.de> 2020-10-08 02:20:38 +0200
committerGravatar Jonas Gunz <himself@jonasgunz.de> 2020-10-08 02:20:38 +0200
commit9759550fc56960b928e2a2dd230ce5fff22738b1 (patch)
treeaccd13e74edc9a9e4bbd7eac6f2290233e33dc42 /USAGE.md
parentda77e6977c3a71a751752f85446e3e545a7b69e5 (diff)
downloadminecraft-isekai-9759550fc56960b928e2a2dd230ce5fff22738b1.tar.gz
USAGE
Diffstat (limited to 'USAGE.md')
-rw-r--r--USAGE.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/USAGE.md b/USAGE.md
new file mode 100644
index 0000000..47abd40
--- /dev/null
+++ b/USAGE.md
@@ -0,0 +1,75 @@
+# minecraft-isekai
+
+## builder.sh
+
+### world
+
+#### list
+
+List all available worlds and the instance they are attached to, if applicable.
+
+#### create <WORLD>
+
+Create a new world named <WORLD>
+
+#### assign <WORLD> <INSTANCE>
+
+Assign <WORLD> to <INSTANCE>.
+Sets world in server.properties
+
+#### unassign <WORLD>
+
+TODO
+
+#### clone <WORLD> <CLONED>
+
+TODO
+
+#### backup <WORLD>
+
+TODO
+
+#### restore <WORLD> <BACKUP>
+
+TODO
+
+#### delete <WORLD>
+
+TODO
+
+### instance
+
+#### list
+
+List all available instances and their status.
+
+#### create <INSTANCE>
+
+Create a new empty instance <INSTANCE> and accept Minecraft EULA.
+
+#### delete <INSTANCE>
+
+TODO
+
+#### start <INSTANCE>
+
+#### stop <INSTANCE>
+
+#### status <INSTANCE>
+
+Query an instances status.
+Return code is 0 if running, != 0 otherwise.
+
+### version
+
+#### list
+
+TODO
+
+#### install <VERSION> <INSTANCE>
+
+Install <VERSION> to <INSTANCE>
+
+#### uninstall <VERSION> <INSTANCE>
+
+TODO