Add CONFIG-REFERENCE.md and workflow guidance
This commit is contained in:
@@ -116,6 +116,16 @@ The following v3 mods are available in the mod launcher (under `C:\7D2D\v3\`):
|
||||
- Welcome to Purgatory
|
||||
- Wild West Mod
|
||||
|
||||
## Finding What to Change
|
||||
|
||||
When Lynda wants to make a specific change but doesn't know which file to edit, use `CONFIG-REFERENCE.md` to identify the relevant XML config file. Common entry points:
|
||||
- **Player/zombie stats**: `archetypes.xml`, `entityclasses.xml`
|
||||
- **Items/crafting**: `items.xml`, `recipes.xml`, `progression.xml`
|
||||
- **Loot/spawning**: `loot.xml`, `spawning.xml`, `entitygroups.xml`
|
||||
- **World/environment**: `biomes.xml`, `worldglobal.xml`, `weathersurvival.xml`
|
||||
- **UI changes**: `XUi_Common/xui.xml`, `XUi_InGame/xui.xml`
|
||||
- **Simple stat tweaks**: Often achievable with a few XPath lines in a modlet
|
||||
|
||||
## Notes
|
||||
|
||||
- The ModLauncher config has stale `SteamPaths` pointing to `e:\steam\steamapps\common\7 Days To Die\` but the actual Steam install is at `C:\Steam\steamapps\common\7 Days To Die`.
|
||||
|
||||
@@ -0,0 +1,108 @@
|
||||
# 7 Days to Die Config Reference
|
||||
|
||||
This document inventories the XML config files found in the vanilla game install and describes what they control. Use this to figure out where to make specific changes.
|
||||
|
||||
## Core Gameplay Configs
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `archetypes.xml` | Base archetype definitions (player, zombie, animal stats) |
|
||||
| `entityclasses.xml` | Entity class definitions (items, blocks, tools, weapons) |
|
||||
| `items.xml` | Item definitions (stats, weight, value, crafting requirements) |
|
||||
| `blocks.xml` | Block definitions (building materials, strength, crafting) |
|
||||
| `materials.xml` | Material definitions (harvesting, repair costs) |
|
||||
| `recipes.xml` | Crafting recipes |
|
||||
| `progression.xml` | Skill/level progression, XP requirements, perks |
|
||||
| `loot.xml` | Loot tables for containers, zombies, world spawns |
|
||||
| `spawning.xml` | Zombie/wildlife spawn rates, biomes, gamestage scaling |
|
||||
|
||||
## World & Environment
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `biomes.xml` | Biome definitions (forest, desert, snow, wasteland) |
|
||||
| `worldglobal.xml` | Global world settings (day/night cycle, weather) |
|
||||
| `weathersurvival.xml` | Weather effects, temperature, survival mechanics |
|
||||
| `rwgmixer.xml` | Random World Generator (RWG) rules for POI placement |
|
||||
| `events.xml` | World events (horde night, wandering hordes) |
|
||||
| `gameevents.xml` | Event timing and triggers |
|
||||
|
||||
## Entities & AI
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `entitygroups.xml` | Entity spawn groups (zombie types per biome/gamestage) |
|
||||
| `gamestages.xml` | Gamestage definitions and scaling |
|
||||
| `utilityai.xml` | NPC/zombie AI behaviors and tasks |
|
||||
| `npc.xml` | NPC definitions (traders, quest givers) |
|
||||
| `vehicles.xml` | Vehicle definitions and stats |
|
||||
| `buffs.xml` | Status effects (poison, bleeding, infection, etc.) |
|
||||
|
||||
## UI & Display
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `ui_display.xml` | UI element positioning and visibility |
|
||||
| `XUi_Common/xui.xml` | Common UI layout definitions |
|
||||
| `XUi_Common/styles.xml` | UI style definitions |
|
||||
| `XUi_Common/templates.xml` | Reusable UI templates |
|
||||
| `XUi_InGame/xui.xml` | In-game UI layout (toolbelt, inventory, map) |
|
||||
| `XUi_InGame/windows.xml` | In-game window definitions |
|
||||
| `XUi_Menu/xui.xml` | Main menu UI layout |
|
||||
| `XUi_Menu/windows.xml` | Main menu window definitions |
|
||||
|
||||
## Other Configs
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `challenges.xml` | Challenge definitions (kill X zombies, etc.) |
|
||||
| `quests.xml` | Quest definitions and rewards |
|
||||
| `traders.xml` | Trader definitions and inventory |
|
||||
| `dialogs.xml` | NPC dialog text and options |
|
||||
| `sounds.xml` | Sound effect definitions |
|
||||
| `music.xml` | Music track definitions |
|
||||
| `painting.xml` | Player painting/decoration system |
|
||||
| `physicsbodies.xml` | Physics body definitions for blocks |
|
||||
| `qualityinfo.xml` | Item quality tiers and durability |
|
||||
| `item_modifiers.xml` | Item attachment modifiers (scopes, silencers, etc.) |
|
||||
| `signs.xml` | Sign definitions and text rendering |
|
||||
| `shapes.xml` | 3D shape/mesh definitions |
|
||||
| `dmscontent.xml` | DMS (Dynamic Music System) content |
|
||||
| `loadingscreen.xml` | Loading screen tips and images |
|
||||
| `twitch.xml` | Twitch integration settings |
|
||||
| `twitch_events.xml` | Twitch event definitions |
|
||||
| `videos.xml` | Video playback definitions |
|
||||
| `misc.xml` | Miscellaneous game settings |
|
||||
| `nav_objects.xml` | Navigation mesh objects |
|
||||
| `subtitles.xml` | Subtitle definitions |
|
||||
| `blockplaceholders.xml` | Block placeholder definitions |
|
||||
|
||||
## How to Find Specific Settings
|
||||
|
||||
When you want to change a specific game mechanic, use these approaches:
|
||||
|
||||
1. **Search for keywords** — Search the entire `Data/Config` folder for terms like "zombie", "health", "damage", etc.
|
||||
2. **Check archetypes.xml first** — Many base stats are defined here
|
||||
3. **Look at entityclasses.xml** — Item and block properties
|
||||
4. **Check progression.xml** — Skill and level changes
|
||||
5. **Search the web** — The 7 Days to Die modding community has extensive documentation
|
||||
|
||||
## Common XPath Targets for Simple Modlets
|
||||
|
||||
For very simple changes, you can use XPath in modlet config files:
|
||||
|
||||
- `/player/@maxHealth` — Player max health
|
||||
- `/player/@health` — Player starting health
|
||||
- `/zombie/@health` — Zombie base health multiplier
|
||||
- `/loot/@quantity` — Loot quantity multiplier
|
||||
- `/day/@length` — Day length in minutes
|
||||
- `/night/@length` — Night length in minutes
|
||||
- `/bloodmoon/@enabled` — Enable/disable blood moon
|
||||
- `/xp/@multiplier` — XP gain multiplier
|
||||
|
||||
## Notes
|
||||
|
||||
- Always back up original XML files before editing
|
||||
- Use the mod launcher for complex mods that modify many files
|
||||
- Use simple modlets for single-file XML changes
|
||||
- Test changes in a new save — existing saves may not pick up config changes
|
||||
@@ -30,4 +30,5 @@ Use 7D2DModLauncherV5 to manage v3 mods under `C:\7D2D\v3\`.
|
||||
## Documentation
|
||||
|
||||
- `ENVIRONMENT.md` — Complete environment and path reference
|
||||
- `CONFIG-REFERENCE.md` — Inventory of game XML config files and what they control
|
||||
- `mods/README.md` — Modlet development guide
|
||||
|
||||
Reference in New Issue
Block a user