summaryrefslogtreecommitdiff
path: root/minecraft/README.md
diff options
context:
space:
mode:
authorFreya Murphy <freya@freyacat.org>2024-06-06 17:27:05 -0400
committerFreya Murphy <freya@freyacat.org>2024-06-06 17:27:05 -0400
commitdc940d4afeb531b75615c0b552ad0eed8f866644 (patch)
treeab1e51eb2004467fe2bd248f488a1d92fd528d74 /minecraft/README.md
downloadimages-dc940d4afeb531b75615c0b552ad0eed8f866644.tar.gz
images-dc940d4afeb531b75615c0b552ad0eed8f866644.tar.bz2
images-dc940d4afeb531b75615c0b552ad0eed8f866644.zip
initial
Diffstat (limited to 'minecraft/README.md')
-rw-r--r--minecraft/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/minecraft/README.md b/minecraft/README.md
new file mode 100644
index 0000000..daedb32
--- /dev/null
+++ b/minecraft/README.md
@@ -0,0 +1,22 @@
+### images/minecraft
+
+runs a miencraft server, very cool
+
+#### volumes
+
+- /data stores the minecraft server files
+
+#### environment
+
+- MC_TYPE can be `vanilla`,`paper`,`waterfall`,`velocity`,`folia`,`fabric`, or `forge`
+- MC_VERSION is the minecraft version [`latest`,`snapshot`,`<version>`]
+
+extra environment variables include
+- PAPERMC_BUILD
+- FABRIC_LOADER
+- FABRIC_INSTALLER
+- FORGE_VERSION [`recommended`, `latest`, `<version>`]
+
+jvm configuration
+- JVMARGS - overwrites the default jvm args
+- MEMORY - sets the jvm memory amount (default 1G)