Add workflow guidance and Git web UI link
This commit is contained in:
+15
-5
@@ -14,20 +14,30 @@
|
||||
## Mod Development Workflow
|
||||
|
||||
### Simple Modlets (vanilla folder)
|
||||
1. Create/update modlet files in `mods/` in this repo
|
||||
2. Run `.kilo/scripts/modlet.ps1 -Action enable` to copy modlets to the Steam `Mods` folder
|
||||
3. Launch the game and start a new save to test
|
||||
4. Run `.kilo/scripts/modlet.ps1 -Action disable` to remove modlets when done
|
||||
5. Run `.kilo/scripts/modlet.ps1 -Action sync` to update already-enabled modlets after making changes
|
||||
1. **Edit** modlet files in `mods/` in this repo
|
||||
2. **Enable/sync**: `.kilo/scripts/modlet.ps1 -Action enable` (first time) or `.kilo/scripts/modlet.ps1 -Action sync` (updates)
|
||||
3. **Test**: Launch the game and start a new save
|
||||
4. **Disable**: `.kilo/scripts/modlet.ps1 -Action disable` when done testing
|
||||
5. **Commit**: `git add mods/ && git commit -m "..." && git push origin main`
|
||||
|
||||
### Full Mods (mod launcher)
|
||||
1. Create/update mod files in this repo
|
||||
2. Copy or sync modified files to the mod launcher's game copy under `C:\7D2D\v3\<mod_name>\`
|
||||
3. Launch via Mod Launcher to test
|
||||
|
||||
## Script Reference
|
||||
|
||||
| Command | Action |
|
||||
|---------|--------|
|
||||
| `.kilo/scripts/modlet.ps1 -Action enable` | Copy all modlets from `mods/` to Steam `Mods` folder |
|
||||
| `.kilo/scripts/modlet.ps1 -Action disable` | Delete all modlets from Steam `Mods` folder |
|
||||
| `.kilo/scripts/modlet.ps1 -Action sync` | Update already-enabled modlets with latest changes |
|
||||
| `.kilo/scripts/modlet.ps1 -Action status` | Show which modlets are enabled/disabled |
|
||||
|
||||
## Current Installed Mods
|
||||
See `ENVIRONMENT.md` for the full list of installed mods and their paths.
|
||||
|
||||
## Notes
|
||||
- Current target version is 3.x
|
||||
- v3 mods are available in the mod launcher under `C:\7D2D\v3\`
|
||||
- Always close the game before enabling/disabling/syncing modlets
|
||||
|
||||
Reference in New Issue
Block a user