Add mod development environment, docs, and example modlet
This commit is contained in:
@@ -0,0 +1,63 @@
|
||||
# Modlet Management Scripts
|
||||
|
||||
## Quick Start
|
||||
|
||||
Enable all modlets for testing in vanilla 7 Days to Die:
|
||||
```powershell
|
||||
.kilo\scripts\modlet.ps1 -Action enable
|
||||
```
|
||||
|
||||
Disable all modlets:
|
||||
```powershell
|
||||
.kilo\scripts\modlet.ps1 -Action disable
|
||||
```
|
||||
|
||||
Sync changes from repo to Steam (for modlets already enabled):
|
||||
```powershell
|
||||
.kilo\scripts\modlet.ps1 -Action sync
|
||||
```
|
||||
|
||||
Check which modlets are currently enabled:
|
||||
```powershell
|
||||
.kilo\scripts\modlet.ps1 -Action status
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
This script copies modlets from `mods/` into the Steam `Mods` folder. This means:
|
||||
- Edit modlets in `mods/` and run `sync` to update
|
||||
- Enable/disable with a single command
|
||||
- No junctions or special filesystem features required
|
||||
- Works without admin privileges
|
||||
|
||||
## Manual Shortcuts
|
||||
|
||||
You can also create shortcuts on the desktop for quick access:
|
||||
|
||||
### Enable Modlets
|
||||
```powershell
|
||||
powershell.exe -ExecutionPolicy Bypass -File "C:\Users\lynda\Git\lyndas_mod\.kilo\scripts\modlet.ps1" -Action enable
|
||||
```
|
||||
|
||||
### Disable Modlets
|
||||
```powershell
|
||||
powershell.exe -ExecutionPolicy Bypass -File "C:\Users\lynda\Git\lyndas_mod\.kilo\scripts\modlet.ps1" -Action disable
|
||||
```
|
||||
|
||||
### Sync Modlets
|
||||
```powershell
|
||||
powershell.exe -ExecutionPolicy Bypass -File "C:\Users\lynda\Git\lyndas_mod\.kilo\scripts\modlet.ps1" -Action sync
|
||||
```
|
||||
|
||||
## Adding New Modlets
|
||||
|
||||
1. Create a new folder in `mods/`
|
||||
2. Add `ModInfo.xml` and `Config/` files
|
||||
3. Run the enable script to test
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If copies fail:
|
||||
- Ensure 7 Days to Die is not running
|
||||
- Check that the Steam `Mods` folder exists
|
||||
- Run PowerShell as Administrator if needed
|
||||
Reference in New Issue
Block a user