Progress on documentation
This commit is contained in:
@@ -27,7 +27,8 @@ Generate documentation following this exact structure:
|
||||
### 1. Header
|
||||
Format: `# Room ##: [Room Name]`
|
||||
|
||||
**Filename**: `kq4-##-human-readable-name.md`
|
||||
**Directory**: `rooms/kq4-##-human-readable-name/`
|
||||
**Filename inside directory**: `kq4-##-human-readable-name.md`
|
||||
|
||||
### 2. High-Level Summary
|
||||
A paragraph describing the room's purpose, key features, NPCs, and gameplay significance.
|
||||
@@ -187,21 +188,29 @@ Follow the format exactly:
|
||||
5. Scripts table
|
||||
6. Technical notes with state variables
|
||||
|
||||
### Step 7: Save File
|
||||
### Step 7: Generate Visual PNG
|
||||
|
||||
Save to: `rooms/kq4-###-human-readable-name.md`
|
||||
After saving the documentation, generate the room visual:
|
||||
1. Run: `./sci_pic_render <room_number> "<path_to_game>" rooms/kq4-###-human-readable-name/`
|
||||
2. This creates three PNG files:
|
||||
- `pic_###_visual.png` - Background visual
|
||||
- `pic_###_control.png` - Control (walkable areas)
|
||||
- `pic_###_priority.png` - Priority (z-ordering)
|
||||
3. Move the markdown file into the room directory: `mv rooms/kq4-###-human-readable-name.md rooms/kq4-###-human-readable-name/`
|
||||
|
||||
### Step 8: Update README.md
|
||||
|
||||
After saving the room documentation:
|
||||
1. Read the current README.md to find the Progress section
|
||||
2. Find the row for this room number
|
||||
3. Update the Status to `[DONE](./rooms/kq4-###-human-readable-name.md)`
|
||||
3. Update the Status to include embedded PNG and link:
|
||||
- With PNG: ` [DONE](./rooms/kq4-###-human-readable-name/kq4-###-human-readable-name.md)`
|
||||
- Without PNG (if render fails): `[DONE](./rooms/kq4-###-human-readable-name/kq4-###-human-readable-name.md)`
|
||||
4. Fill in the Room Description with a human-readable name (e.g., "Beach", "Fountain Pool", "Cave Entrance")
|
||||
|
||||
## Example Reference
|
||||
|
||||
See `rooms/055-seven-dwarfs-diamond-mine.md` for a complete example following this format.
|
||||
See `rooms/kq4-055-seven-dwarfs-diamond-mine/kq4-055-seven-dwarfs-diamond-mine.md` for a complete example following this format.
|
||||
|
||||
## Command Reference
|
||||
|
||||
@@ -322,5 +331,7 @@ Document all applied regions and check each for additional interactions.
|
||||
- Include full message text in quotes
|
||||
- Organize interactions logically by type
|
||||
- Be thorough but concise in descriptions
|
||||
- Filename must be: `kq4-##-human-readable-name.md` (e.g., `kq4-024-waterfall-and-pool.md`)
|
||||
- After completing the documentation, update README.md with the room description and link
|
||||
- Create directory: `rooms/kq4-##-human-readable-name/`
|
||||
- Save markdown as: `rooms/kq4-##-human-readable-name/kq4-##-human-readable-name.md`
|
||||
- Generate PNGs using sci_pic_render into the room directory
|
||||
- After completing the documentation, update README.md with the room description, embedded PNG thumbnail, and link
|
||||
|
||||
Reference in New Issue
Block a user