added read me describing the differences between the two current modpacks
This commit is contained in:
@@ -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.
|
||||
Reference in New Issue
Block a user