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
|
||||
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<configs>
|
||||
<set xpath="/player/@maxHealth" value="200" />
|
||||
<set xpath="/player/@health" value="200" />
|
||||
</configs>
|
||||
@@ -0,0 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ModInfo>
|
||||
<Name value="Lynda's First Modlet" />
|
||||
<Description value="A simple starting modlet for minor 7 Days to Die modifications." />
|
||||
<Author value="Lynda" />
|
||||
<Version value="1.0.0" />
|
||||
</ModInfo>
|
||||
@@ -0,0 +1,43 @@
|
||||
# Lynda's First Modlet
|
||||
|
||||
A simple starting modlet for minor 7 Days to Die modifications.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
example_modlet/
|
||||
ModInfo.xml
|
||||
Config/
|
||||
example_modlet.xml
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
This modlet uses XPath to modify game settings. The example changes:
|
||||
- Player max health: 200
|
||||
- Player starting health: 200
|
||||
|
||||
## Testing
|
||||
|
||||
1. Copy the entire `example_modlet` folder to:
|
||||
```
|
||||
C:\Steam\steamapps\common\7 Days To Die\Mods\example_modlet
|
||||
```
|
||||
|
||||
2. Launch 7 Days to Die and start a new game.
|
||||
|
||||
3. Verify the changes take effect (player should have 200 health instead of 100).
|
||||
|
||||
## Making Your Own Changes
|
||||
|
||||
Edit `Config/example_modlet.xml` to change different settings. Common XPath targets:
|
||||
- `/player/@maxHealth` - player max health
|
||||
- `/player/@health` - player starting health
|
||||
- `/zombie/@health` - zombie health
|
||||
- `/loot/@quantity` - loot quantities
|
||||
|
||||
## Notes
|
||||
|
||||
- Keep changes small and test one thing at a time.
|
||||
- If something breaks, delete the modlet folder from `C:\Steam\steamapps\common\7 Days To Die\Mods\` to revert.
|
||||
- For more complex mods, consider using the mod launcher's `C:\7D2D\v3\` structure instead.
|
||||
Reference in New Issue
Block a user