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