diff --git a/README.md b/README.md index fcd0caf..1db0824 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ NomiFactory harder config +For installation instructions, see `Playing` section + # Motivation First of all: THERE IS NO "CORRECT" WAY TO PLAY NOMI OR MINECRAFT, IN GENERAL. @@ -44,3 +46,42 @@ Legend: - [ ] No "magic teleportation stuff" (Ender Chests, Dimensional Transcievers), unless: - it's an EIO Telepad - they are used to tranport between the Nether and Overworld, and have a positions that of a vanilla nether portal (identical y, 8-scaled x and z) + +# Playing + +Get yourself Java 8, or operate in the environment where Java 8 is available. Good launchers generally allow you to pick and test the Java installation. + +Get yourself a CurseForge -compatible launcher: +- Curse Forge (obviously) +- Prism Launcher +- Multi MC +- some other launchers exist, this is not a wiki + +Then, import the modpack at: +``` +https://git.dzuchun.ing/api/packages/dzu/generic/nomisuffory/1.0.0/NomiSuffory.zip +``` + +If you want to play with yourself (shush), you are ok to go. + +If you want to join the server I host: +- contact me somehow (if you don't know how, then you probably should not) +- prepare to join `nomi.dzuchun.ing` +- for the first time, you'll need to join while I am at the server + +If you want to host a server on your own, here is simplified docker compose file: +```compose + nomifactory: + image: git.dzuchun.ing/dzu/nomisuffory:main + ports: + - 25565 + volumes: + - ./eula.txt:/srv/eula.txt:ro + - ./world:/srv/world:rw + environment: + MC_MEMORY: 4G +``` + +here, +- `MC_MEMORY` determined the JVM heap size (2G by default) +- `eula.txt` is a file you must create and put `eula=true` into it, to confirm you've accepted the EULA diff --git a/patches/server/launch.sh.patch b/patches/server/launch.sh.patch new file mode 100644 index 0000000..6a41ddd --- /dev/null +++ b/patches/server/launch.sh.patch @@ -0,0 +1,13 @@ +--- launch.sh 2026-05-31 01:54:49.770122460 +0100 ++++ launch.sh 2026-05-31 01:58:57.480121515 +0100 +@@ -13,8 +13,8 @@ + JAVA_PARAMETERS='' + + # these you can edit +-MIN_RAM='2048M' +-MAX_RAM='2048M' ++MIN_RAM="${MC_MEMORY:-2048M}" ++MAX_RAM="${MC_MEMORY:-2048M}" + + # DO NOT EDIT ANYTHING PAST THIS LINE + LAUNCHPARAMS="-server -Xms$MIN_RAM -Xmx$MAX_RAM $JAVA_PARAMETERS -Dlog4j.configurationFile=log4j2_112-116.xml -jar $FORGEJAR nogui"