Example Index Files

Real-world examples of index.codex.yaml files for various use cases

Last updated: 2025-10-15

Example Index Files

Real-world examples of index.codex.yaml files for different project types. Copy and adapt these for your own projects.

Example 1: Character-Focused Story Bible

Use Case: Novel with emphasis on character development

codexVersion: "1.0"
name: "The Hero's Journey - Character Bible"
description: "Character profiles and relationships for epic fantasy novel"
mainFile: "README.md"

structure:
  - path: "Characters/"
    title: "Character Profiles"
    expanded: true
    order: 1

  - path: "Characters/Protagonists/"
    title: "Main Characters"
    expanded: true
    order: 1

  - path: "Characters/Antagonists/"
    title: "Villains"
    order: 2

  - path: "Characters/Supporting/"
    title: "Supporting Cast"
    order: 3

  - path: "Relationships/"
    title: "Character Relationships"
    order: 2

  - path: "Character-Arcs/"
    title: "Development & Arcs"
    order: 3

files:
  - path: "README.md"
    title: "Overview"
    order: 1

  - path: "Characters/Protagonists/Hero.codex.yaml"
    title: "The Hero"
    description: "Reluctant hero destined to save the world"
    order: 1

  - path: "Characters/Protagonists/Mentor.codex.yaml"
    title: "The Wise Mentor"
    order: 2

  - path: "Characters/Antagonists/DarkLord.codex.yaml"
    title: "The Dark Lord"
    order: 1

patterns:
  exclude:
    - "_drafts/**"
    - "**/*.backup"

display:
  sortBy: "order"
  groupBy: "folder"

metadata:
  version: "1.0"
  tags: ["fantasy", "character-driven"]

Example 2: World-Building Focus

Use Case: Complex sci-fi universe with detailed world-building

codexVersion: "1.0"
name: "Cosmic Empire - Universe Bible"
description: "Complete world-building documentation for space opera series"
mainFile: "universe-overview.md"

structure:
  - path: "Overview/"
    expanded: true
    order: 1

  - path: "Galaxy-Map/"
    title: "Galactic Geography"
    order: 2

  - path: "Galaxy-Map/Core-Worlds/"
    title: "Core Systems"
    order: 1

  - path: "Galaxy-Map/Outer-Rim/"
    title: "Frontier Worlds"
    order: 2

  - path: "Factions/"
    title: "Empires & Factions"
    expanded: true
    order: 3

  - path: "Technology/"
    title: "Tech & Science"
    order: 4

  - path: "Technology/FTL/"
    title: "Faster-Than-Light Travel"

  - path: "Technology/Weapons/"
    title: "Military Technology"

  - path: "History/"
    title: "Historical Timeline"
    order: 5

files:
  - path: "universe-overview.md"
    title: "Universe Overview"
    order: 1

  - path: "Galaxy-Map/map.md"
    title: "Galactic Map"
    order: 1

patterns:
  include:
    - "*.codex.yaml"
    - "*.md"
    - "*.json"
  exclude:
    - "archive/**"
    - "_wip/**"

display:
  defaultView: "tree"
  sortBy: "order"
  groupBy: "folder"

Example 3: Multi-Book Series

Use Case: Trilogy with shared world and book-specific content

codexVersion: "1.0"
name: "The Trilogy - Complete Series Bible"
description: "World bible for three-book fantasy series"
mainFile: "series-overview.md"

structure:
  # Series-wide content first
  - path: "Series-Overview/"
    title: "📚 Series Overview"
    expanded: true
    order: 1

  - path: "Shared-World/"
    title: "🌍 Shared Universe"
    expanded: true
    order: 2

  - path: "Shared-World/Geography/"
    title: "Locations"

  - path: "Shared-World/Magic/"
    title: "Magic System"

  - path: "Shared-World/History/"
    title: "Historical Background"

  # Book-specific content
  - path: "Book-1-Dawn/"
    title: "📖 Book 1: Dawn"
    order: 10

  - path: "Book-1-Dawn/Characters/"
  - path: "Book-1-Dawn/Plot/"
  - path: "Book-1-Dawn/Locations/"

  - path: "Book-2-Rising/"
    title: "📖 Book 2: Rising"
    order: 20

  - path: "Book-2-Rising/Characters/"
  - path: "Book-2-Rising/Plot/"

  - path: "Book-3-Culmination/"
    title: "📖 Book 3: Culmination"
    order: 30

  - path: "Book-3-Culmination/Characters/"
  - path: "Book-3-Culmination/Plot/"

display:
  sortBy: "order"
  groupBy: "folder"

metadata:
  series: "The Trilogy"
  books: 3
  genre: "Epic Fantasy"

Example 4: Game Design Documentation

Use Case: Video game lore and character documentation

codexVersion: "1.0"
name: "Project Starfall - Game Design Bible"
description: "Complete lore and character documentation for RPG game"
mainFile: "README.md"

structure:
  - path: "Game-Overview/"
    title: "🎮 Game Overview"
    expanded: true
    order: 1

  - path: "Playable-Characters/"
    title: "👥 Playable Characters"
    expanded: true
    order: 2

  - path: "NPCs/"
    title: "NPCs & Quest Givers"
    order: 3

  - path: "Locations/"
    title: "🗺️ Game World"
    order: 4

  - path: "Locations/Cities/"
    title: "Major Cities"

  - path: "Locations/Dungeons/"
    title: "Dungeons & Instances"

  - path: "Quests/"
    title: "📜 Quest Database"
    order: 5

  - path: "Quests/Main-Story/"
    title: "Main Storyline"

  - path: "Quests/Side-Quests/"
    title: "Side Quests"

  - path: "Items-Equipment/"
    title: "⚔️ Items & Equipment"
    order: 6

  - path: "Game-Mechanics/"
    title: "⚙️ Game Mechanics"
    order: 7

patterns:
  include:
    - "*.codex.yaml"
    - "*.md"
    - "*.json"
  exclude:
    - "old-versions/**"
    - "**/*.psd"
    - "**/*.blend"

display:
  sortBy: "order"
  groupBy: "folder"

metadata:
  project: "Project Starfall"
  genre: "Action RPG"
  platform: "PC, Console"

Example 5: Historical Timeline Project

Use Case: Historical documentation organized chronologically

codexVersion: "1.0"
name: "Ancient Empire Timeline"
description: "Complete historical documentation organized by era"
mainFile: "timeline-overview.md"

structure:
  - path: "00-Mythical-Age/"
    title: "Mythical Age (Before Records)"
    order: 1

  - path: "01-Foundation/"
    title: "Foundation Era (Year 0-500)"
    order: 2

  - path: "02-Expansion/"
    title: "Age of Expansion (500-1000)"
    order: 3

  - path: "03-Golden-Age/"
    title: "Golden Age (1000-1500)"
    order: 4

  - path: "04-Decline/"
    title: "The Decline (1500-1800)"
    order: 5

  - path: "05-Modern/"
    title: "Modern Era (1800-Present)"
    order: 6

  - path: "Key-Figures/"
    title: "Historical Figures"
    order: 100

  - path: "Artifacts/"
    title: "Historical Artifacts"
    order: 101

display:
  sortBy: "order"
  groupBy: "folder"

metadata:
  timespan: "3000 years"
  focus: "political-history"

Example 6: Minimalist Index

Use Case: Small project, just need basic organization

codexVersion: "1.0"
name: "Short Story Collection"

structure:
  - path: "Stories/"
    order: 1
  - path: "Characters/"
    order: 2
  - path: "Notes/"
    order: 3

patterns:
  exclude:
    - "_drafts/**"

Example 7: Reference Documentation

Use Case: Technical/reference documentation with lots of categories

codexVersion: "1.0"
name: "RPG System Reference"
description: "Complete reference for tabletop RPG system"
mainFile: "index.md"

structure:
  # Core Rules
  - path: "Core-Rules/"
    title: "Core Rulebook"
    expanded: true
    order: 1

  - path: "Core-Rules/Character-Creation/"
    title: "Character Creation"
    order: 1

  - path: "Core-Rules/Combat/"
    title: "Combat Rules"
    order: 2

  - path: "Core-Rules/Magic/"
    title: "Magic System"
    order: 3

  # Expansions
  - path: "Expansions/"
    title: "Expansion Content"
    order: 2

  # Reference
  - path: "Spells/"
    title: "Spell Database"
    order: 3

  - path: "Items/"
    title: "Item Catalog"
    order: 4

  - path: "Monsters/"
    title: "Monster Manual"
    order: 5

  # GM Resources
  - path: "GM-Resources/"
    title: "Game Master Resources"
    order: 10

display:
  sortBy: "order"
  groupBy: "folder"
  defaultView: "tree"

metadata:
  system: "Fantasy RPG"
  edition: "2.0"
  license: "OGL 1.0a"

Example 8: Academic Research Project

Use Case: Literary analysis and research notes

codexVersion: "1.0"
name: "Tolkien Works Analysis"
description: "Academic analysis of J.R.R. Tolkien's literary works"
mainFile: "research-overview.md"

structure:
  - path: "Primary-Sources/"
    title: "Primary Works"
    order: 1

  - path: "Character-Analysis/"
    title: "Character Studies"
    order: 2

  - path: "Thematic-Analysis/"
    title: "Themes & Motifs"
    order: 3

  - path: "Historical-Context/"
    title: "Historical Context"
    order: 4

  - path: "Comparative-Literature/"
    title: "Comparative Analysis"
    order: 5

  - path: "Bibliography/"
    title: "References & Citations"
    order: 100

patterns:
  include:
    - "*.md"
    - "*.codex.yaml"
    - "*.bib"
  exclude:
    - "_drafts/**"
    - "personal-notes/**"

display:
  sortBy: "order"
  groupBy: "folder"

metadata:
  author: "Research Team"
  institution: "University Name"
  project: "Tolkien Analysis"

Example 9: Podcast/Media Project

Use Case: Episodic content with guests and topics

codexVersion: "1.0"
name: "Fantasy Lore Podcast"
description: "Episode guides and guest information"
mainFile: "podcast-info.md"

structure:
  - path: "Episodes/"
    title: "Episodes"
    expanded: true
    order: 1

  - path: "Episodes/Season-1/"
    title: "Season 1"
    order: 1

  - path: "Episodes/Season-2/"
    title: "Season 2"
    order: 2

  - path: "Guests/"
    title: "Guest Profiles"
    order: 2

  - path: "Topics/"
    title: "Discussion Topics"
    order: 3

  - path: "Show-Notes/"
    title: "Show Notes & References"
    order: 4

files:
  - path: "podcast-info.md"
    title: "About the Podcast"
    order: 1

display:
  sortBy: "order"
  groupBy: "folder"

metadata:
  show: "Fantasy Lore Podcast"
  seasons: 2
  episodes: 45

Example 10: Simple Personal Project

Use Case: Personal notes and ideas, minimal structure

name: "Story Ideas"
mainFile: "README.md"

files:
  - path: "README.md"
  - path: "character-ideas.md"
  - path: "plot-outlines.md"
  - path: "world-notes.md"

patterns:
  exclude:
    - "private/**"