switch to copilot
This commit is contained in:
49
.github/copilot-instructions.md
vendored
Normal file
49
.github/copilot-instructions.md
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
# D&D campaign notes repository instructions
|
||||
|
||||
This repository is the single source of truth for D&D notes across multiple campaigns, worlds, ideas, systems, and players. Prefer edits that preserve structure, reuse existing lore, and keep notes easy to navigate in Obsidian.
|
||||
|
||||
## Core organization
|
||||
|
||||
- Treat `worlds/` as reusable setting context: persistent lore, geography, factions, NPCs, history, and creatures.
|
||||
- Treat `campaigns/` as story-specific overlays on a world: overviews, session notes, campaign-only NPCs, quests, items, and visited locations.
|
||||
- Treat `ideas/` as scratch space for future campaigns, worlds, and mechanics.
|
||||
- Treat `players/` as player-character material.
|
||||
- Treat `systems/` as system references.
|
||||
|
||||
## Relationship rules
|
||||
|
||||
- Worlds are reusable context; campaigns are specific stories within them.
|
||||
- Prefer linking to world notes from campaign notes instead of duplicating shared content.
|
||||
- If a campaign-specific note changes or evolves a world-level person, faction, or location, create a campaign note that links back to the world note.
|
||||
- World NPCs belong in `worlds/<world>/npcs/`; campaign NPCs belong in `campaigns/<campaign>/npcs/`.
|
||||
|
||||
## File and folder conventions
|
||||
|
||||
- Use lowercase with hyphens for folder names, for example `worlds/eldoria/` and `campaigns/shattered-crown/`.
|
||||
- Use Title Case with spaces for note file names, for example `The Lost Artifact.md` and `Continent A.md`.
|
||||
- Keep directory layouts consistent with the existing world and campaign structure.
|
||||
|
||||
## Obsidian conventions
|
||||
|
||||
- Use wiki-links for cross-note references, for example `[[worlds/Eldoria]]` or `[[campaigns/Shattered Crown/overview]]`.
|
||||
- Keep frontmatter consistent when present so notes remain filterable and Dataview-friendly.
|
||||
- Use consistent tags such as `#world`, `#campaign`, `#session`, `#npc`, `#location`, `#faction`, `#item`, `#quest`, `#homebrew`, and `#idea`.
|
||||
- Use Obsidian callouts when helpful, especially:
|
||||
- `> [!info]` for quick-reference blocks
|
||||
- `> [!warning]` for spoilers or DM-only material
|
||||
- `> [!tip]` for DM notes
|
||||
|
||||
## Content expectations
|
||||
|
||||
- Preserve the separation between player-facing content and DM-only secrets.
|
||||
- Prefer `## Secrets` sections or warning callouts for spoiler material.
|
||||
- When creating or updating notes, match the existing note style:
|
||||
- World overviews include cosmology, geography, factions, and history timeline.
|
||||
- Campaign overviews include premise, player characters, active quests, and session log.
|
||||
- NPC notes include appearance, personality, goals and motivations, connections, and secrets.
|
||||
|
||||
## Authoring guidance
|
||||
|
||||
- Link related notes together instead of restating the same information.
|
||||
- Keep metadata, naming, and section structure consistent with neighboring notes.
|
||||
- When adding new world or campaign content, place it in the most specific folder that fits its scope.
|
||||
Reference in New Issue
Block a user