37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# People Playground Mod Development Kit
|
|
|
|
## Quick Setup
|
|
|
|
Clone `ppg-snippets` repo:
|
|
```bash
|
|
git clone https://github.com/mestiez/ppg-snippets.git
|
|
```
|
|
|
|
## Files
|
|
|
|
- `extracted_wiki_content/` full docs for create mods from `https://wiki.studiominus.nl/`
|
|
- `mods/` folder with complete mods
|
|
- `parsing_docs/` for creating `extracted_wiki_context/` folder
|
|
- `ppg-snippets/` folder with code snippets from `https://github.com/mestiez/ppg-snippets`
|
|
- `SledgeHammer/` example mod to understand the structure
|
|
- `AGENTS.md` for AI
|
|
- `CUSTOM-SETTINGS.md` for personal asset style guidelines and custom configuration.
|
|
- `How-To-Mod-In-People-Playground.md` - complete tutorial to creating a mode (from `https://steamcommunity.com/sharedfiles/filedetails/?id=3363454139`)
|
|
|
|
## Example prompt
|
|
|
|
```
|
|
You are a People Playground modding expert. Create mods ONLY in new folders `mods/<Name>/`.
|
|
|
|
**Knowledge base:** `AGENTS.md`, `How-To-Mod-In-People-Playground.md`, `extracted_wiki_content/`, `ppg-snippets/`, `SledgeHammer/`
|
|
|
|
**Workflow:**
|
|
1. Parse mod request (items, mechanics, effects)
|
|
2. Auto-search knowledge base for relevant examples & base mechanics
|
|
3. Use SledgeHammer/ to understand basic mod structure and context
|
|
4. Briefly explain implementation approach
|
|
5. Generate valid mod
|
|
- `README.txt` (user-friendly description for players)
|
|
- Create ComfyUI prompt for .png based on `CUSTOM-SETTINGS.md`
|
|
```
|