installation guide and resources

README.md

@@ -1,6 +1,33 @@
-server modpack used in my [nix flake](https://git.satr14.my.id/satr14/nix-flake/src/branch/main/modules/system/homelab/mc.nix)
+server modpack used in my [nix flake](https://git.satr14.my.id/satr14/nix-flake/src/branch/main/modules/system/homelab/mc)
 
-# Versions:
+# Installation
+
+If you want a quick start then you can deploy the `scripts/docker-compose.yml` for a server in an instant. Please note that there are some configs you need to change and replace: (all optional, server still boots without them)
+- `REPLACE_SVC_HOST` => `config/voicechat/voicechat-server.properties` for SVC host, personally use playit.gg. empty if your svc host is the same as your mc host.
+- `REPLACE_RP_LINK` => `config/welcomemessage.json5` resource pack application is set to optional due to the sheer size and errors during download. you can host the pack separately and provide a link to it here instead.
+- `REPLACE_DC_BOT_TOKEN` => `config/simple-discord-link/simple-discord-link.toml` discord bot token for crosschat with discord server.
+- `REPLACE_DC_OWNER_ROLE` => `config/simple-discord-link/simple-discord-link.toml` discord owner role for admin commands via discord.
+
+Additionally you would need to download a [packsquash](https://github.com/ComunidadAylas/PackSquash/releases/) binary and place it in `polymer/packsquash` to enable RP compression.
+
+There's also some client side mods that can be installed for QOL:
+- Modflared (if you are behind Cloudflare like how I am hosting this)
+- Too Cheap! (allows for shift-clicking to anvil)
+- Grind Enchantments (for displaying level costs)
+- Xaero's Minimap (so you can see shared waypoints from other members better)
+- Simple Voice Chat
+- Sound Physics Remastered
+- Jade
+- AppleSkin 
+- Roughly Enough Items
+- Effortless Building
+- Do a Barrel Roll
+- Polymer
+- Polymer QOL
+
+All these mods + other QOL content are available in `scripts/mod-sync.json`. Clients can use [Simple Mod Sync](https://modrinth.com/mod/simple-mod-sync) to automatically install these mods by pointing it to the file's raw URL. There's also `scripts/installer.ps1` that downloads the mods and syncs them for you.
+
+# Versions: (with nix-minecraft packwiz hashes)
 <!-- - [Season X.Y](path/to/commitHash/pack.toml): `packHash for nix-minecraft` -->
 - [Season 3.0](https://git.satr14.my.id/satr14/server-modpack/raw/commit/8523f89493ace13087eb68cd9fe3b5eb4f669440/pack.toml): `sha256-xB9Oc/aneogSQ9r7L42vyVM6xwq+QkoTaXYNuUzeo6M=`
 - [Season 3.1](https://git.satr14.my.id/satr14/server-modpack/raw/commit/6dc66117471b4f290e0d6776ac449d9f7f870c90/pack.toml): `sha256-J3KdjRer1d8jOeO84rET05nFdjCXjgz5A7mJysFwu6Q=`