added read me describing the differences between the two current modpacks

2026-08-22 19:36:06 +01:00
parent 60f552ba6a
commit 48ffed7da8
2 changed files with 202 additions and 0 deletions
@@ -0,0 +1,118 @@
+# Forever World
+
+The Forever World pack is the long-lived Minecraft survival modpack.
+
+The goal is to expand Minecraft without turning the world into a disposable modpack save. Mods are selected with long-term compatibility, maintainability and world-save safety in mind.
+
+## Platform
+
+```text
+Minecraft: 1.21.1
+NeoForge:  21.1.248
+Packwiz:   managed
+```
+
+## Philosophy
+
+The pack is intentionally conservative.
+
+Content mods should provide meaningful additions while avoiding unnecessary permanent dependencies on abandoned or experimental mods.
+
+The core gameplay additions currently centre around:
+
+- Create
+- Create: Bells & Whistles
+- Create: Connected
+- Create: Copycats+
+- Farmer's Delight
+- Handcrafted
+
+Additional mods provide mapping, building, performance, diagnostics and quality-of-life improvements.
+
+Axiom is provided through Sinytra Connector and Forgified Fabric API.
+
+## Client and Server Mods
+
+Packwiz `side` metadata determines deployment.
+
+```toml
+side = "client"
+side = "server"
+side = "both"
+```
+
+Pterodactyl installs the server pack using:
+
+```bash
+packwiz-installer-bootstrap.jar -g -s server <pack.toml>
+```
+
+This automatically excludes client-only mods such as Iris and Sodium.
+
+Some optional client-oriented mods are intentionally installed server-side where their server functionality is useful and does not create an undesirable world dependency.
+
+## Development
+
+Current development builds are published at:
+
+```text
+https://mc.ahmza.com/forever/dev/pack.toml
+```
+
+Production uses:
+
+```text
+https://mc.ahmza.com/forever/stable/pack.toml
+```
+
+Changes pushed to `main` are tested against the development/staging server before release.
+
+## Releases
+
+Forever World releases use repository tags:
+
+```text
+forever-v1.0.0
+forever-v1.0.1
+forever-v1.1.0
+```
+
+A tagged release is published to both:
+
+```text
+/forever/releases/v1.x.x/
+/forever/stable/
+```
+
+Release tags and release directories are immutable.
+
+Major mod additions, Minecraft migrations and other potentially disruptive changes should be tested on Playground or a feature branch before being introduced here.
+
+## Updating a Mod
+
+```bash
+cd forever
+
+packwiz update <mod>
+packwiz refresh
+
+git add .
+git commit -m "Update <mod>"
+git push
+```
+
+Test the resulting development deployment before creating a release tag.
+
+## World Safety
+
+Before introducing or removing a content mod, consider:
+
+- Does it add blocks or entities that become part of the world save?
+- Does it modify world generation?
+- What happens if development stops?
+- Can the mod be removed without damaging the world?
+- Is it likely to survive future Minecraft migrations?
+
+The objective is not zero world dependencies; Create and other content mods deliberately become part of the world.
+
+The objective is to keep those dependencies intentional.
@@ -0,0 +1,84 @@
+# Playground
+
+Playground is the experimental Minecraft environment.
+
+Unlike Forever World, this pack is intentionally disposable and exists for testing mods, updates and configuration changes without risking the permanent world.
+
+## Purpose
+
+Use Playground for:
+
+- evaluating new mods
+- testing major mod updates
+- testing Minecraft/NeoForge upgrades
+- experimenting with world generation
+- testing compatibility between mods
+- testing configuration changes
+- reproducing crashes
+- validating potential Forever World changes
+
+The world may be reset or replaced at any time.
+
+## Platform
+
+The Minecraft and NeoForge versions may change depending on what is being tested.
+
+Packwiz remains the source of truth for the pack.
+
+## Deployment
+
+Development builds are published at:
+
+```text
+https://mc.ahmza.com/playground/dev/pack.toml
+```
+
+The Pterodactyl server should normally use:
+
+```text
+PACKWIZ_AUTO_SYNC=1
+```
+
+so restarting Playground synchronises it with the latest published pack.
+
+## Development
+
+Playground changes can normally be committed directly to `main`:
+
+```bash
+cd playground
+
+packwiz add <mod>
+packwiz refresh
+
+git add .
+git commit -m "Test <mod> in Playground"
+git push
+```
+
+Feature branches may be used for larger experiments, but are not required for routine testing.
+
+## Promotion to Forever World
+
+A mod working in Playground does not automatically make it suitable for Forever World.
+
+Before promotion consider:
+
+- stability
+- maintenance activity
+- compatibility
+- world-save impact
+- dependencies
+- performance
+- removal behaviour
+- future Minecraft upgrade prospects
+
+Mods considered suitable should then be added independently to the Forever pack and tested against the Forever staging server.
+
+## Persistence
+
+Nothing in Playground should be considered permanent.
+
+Worlds, configs and mods may be removed or reset as required.
+
+If something matters, move it into the appropriate version-controlled configuration before relying on it.