#project #task #storytellrsuite

![[storyteller.base]]

Storyteller Suite - Project Overview

What Is This?

Storyteller Suite is a comprehensive Obsidian plugin for worldbuilding and story management. It provides tools for managing characters, locations, events, items, chapters, scenes, maps, timelines, and more—all stored as Markdown files with YAML frontmatter.

Related Concepts: Software engineering | Data Structures | Collections

Key Information

Goals & Milestones

• Goal 1: Make the plugin ✅ 2025-08-09
• Goal 2: "Reference" tab ✅ 2025-08-09
• Goal 3: Add a "Chapters" tab ✅ 2025-08-09
• Goal 4: Add a Scenes tab ✅ 2025-08-14
• Goal 5: Fix issue with adding and removing characters from groups ✅ 2025-12-03
• Goal 6: Add new time parsing ✅
• Goal 7: Canvas storyboard export - auto-lay out scene cards on an Obsidian Canvas with thumbnails, tags, and color by POV
• 🔼 Goal 8: AI-Powered Writing Assistant Integration
  • Character Consistency Checker - Analyze story notes and flag when character traits, appearances, or backgrounds contradict earlier descriptions
  • Plot Hole Detector - Scan linked events, chapters, and scenes for timeline inconsistencies or unresolved plot threads
  • Writing Prompts Generator - Based on existing characters/locations/events, generate scene ideas or plot developments
  • Character Voice Analyzer - Help maintain consistent dialogue patterns for each character
• Goal 9: Interactive Relationship Network Graph ✅ 2025-10-29
  • Visual graph showing connections between characters, locations, events, and items ✅ 2025-10-29
  • Click nodes to navigate to entities ✅ 2025-10-29
  • Color-coded by relationship type (allies, enemies, family, rivals) ✅ 2025-10-29
  • Filter by story arc, timeline period, or groups ✅ 2025-10-29
  • Export as image for sharing or reference ✅ 2025-10-29
• 🔽 Goal 10: World-Building Templates & Generators ✅ 2025-12-03
  • Pre-built templates for common genres (fantasy kingdoms, sci-fi universes, mystery settings)
  • Magic system builder with rules consistency checking ✅ 2025-11-16
  • Culture/society generator (customs, holidays, government structures) ✅ 2025-11-16
  • Quick-fill questionnaires that auto-populate entity fields ✅ 2025-11-16
• ⏫ Goal 11: Advanced Timeline Features ✅ 2026-01-17
  • Multiple Timeline Tracks - Personal timelines per character, location-specific timelines, global timeline ✅ 2025-11-25
  • Timeline Conflicts Detector - Flag when a character is in two places at once ✅ 2025-11-25
  • Era/Period Grouping - Organize events into story arcs or time periods ✅ 2025-11-25
  • Visual Timeline View - Gantt-chart style visualization with drag-to-reorder ✅ 2026-01-17
  • Flashback/Flash-forward Markers - Track non-linear storytelling ✅ 2025-11-25
  • Allow for timeline events to be created based on user-set tags, generating a timeline view
• Goal 12: Export & Publishing Suite ✅ 2026-01-04
  • Export to common formats (PDF, DOCX, EPUB, MOBI) with customizable templates ✅ 2026-01-04
  • Auto-format manuscript based on industry standards (e.g., Shunn) ✅ 2026-01-04
  • Synopsis & query letter generator using AI to summarize plot points
  • Integration with publishing platforms like KDP or Draft2Digital
• Goal 13: Collaboration & Feedback Tools
  • Share projects or specific chapters with read-only or comment-only permissions
  • In-line commenting and suggestion tracking (accept/reject changes)
  • Version history for key documents (chapters, character sheets) with rollback options
  • Create a feedback dashboard to track comments from beta readers/editors
• Goal 14: Productivity & Gamification
  • Project and session word count trackers with daily/weekly/monthly goals
  • Integrated Pomodoro timer and writing sprint tools
  • Achievements/badges for hitting writing milestones
  • Personal writing statistics dashboard (writing speed, most productive times, etc.)

Core Features

Entity Management

• Characters - Profiles with descriptions, backstories, relationships, custom fields, tags, and images
• Locations - Places with descriptions, history, parent/child hierarchy, and metadata
• Events - Timeline-aware events with dates, outcomes, character involvement
• Plot Items - Artifacts/items with owners, locations, and plot-critical flags
• References - Miscellaneous notes with categories and tags
• Chapters & Scenes - Narrative structure with status, priority, beats
• Groups - Collections of entities with color coding

Visual Tools

• Dashboard - Unified view for all entities with filtering and search
• Timeline View - Interactive event timeline with Gantt chart support
• Network Graph - Cytoscape.js-powered relationship visualization
• Map System - Leaflet-based maps with entity markers

Story Management

• Multi-Story Support - Isolated data folders per story
• One Story Mode - Flat, single-story layout option
• Custom Folders - Configurable folder structure
• Gallery System - Image management with entity linking

Import/Export

• Document Import - Parse DOCX, EPUB, PDF, Markdown, RTF, ODT, HTML, Fountain, JSON
• Compile Engine - Export manuscripts with customizable workflows
• Entity Extraction - Auto-detect characters/locations from imported text

Templates

• Prebuilt Templates - Fantasy Kingdom, Cyberpunk Metropolis, Murder Mystery, etc.
• Custom Templates - Save and reuse entity configurations
• Variable Substitution - Dynamic {{variable}} placeholders

Technology Stack

Data Model

All entities are stored as Markdown files with YAML frontmatter:

---
name: "Character Name"
description: "Brief description"
tags: [protagonist, warrior]
customFields:
  weapon: "Sword"
  allegiance: "Kingdom"
---

## Description
Full description goes here...

## Backstory
Character history...

Architecture Highlights

1. Plugin Entry (main.ts) - StorytellerSuitePlugin extends Obsidian's Plugin class
2. Settings - Managed via StorytellerSuiteSettingTab with extensive options
3. Modals - ResponsiveModal base class for mobile-friendly dialogs
4. Services - LocationService, MapManager, etc. for entity operations
5. Views - AnalyticsDashboardView, TimelineView, NetworkGraphView
6. i18n - Multi-language support with strings.ts and locale JSON files

Quick Start for Developers

# Install dependencies
npm install

# Development build (watch mode)
npm run dev

# Production build
npm run build

# Run tests
npm run test

Key Directories

src/
├── main.ts           # Plugin entry point
├── types.ts          # TypeScript interfaces
├── modals/           # All modal dialogs
├── views/            # Dashboard, Timeline, Network views
├── compile/          # Manuscript compilation
├── import/           # Document parsing
├── templates/        # Template system
├── leaflet/          # Map integration
├── i18n/             # Internationalization
└── utils/            # Utility functions

Roadmap

@card
time: 2024-12-12
title: Beta
content:
Plug in launched into beta

@card [color-red]
time: 2024-12-12
title: Launch
content:
Plug accepted into obsidian store

@card [color-green]
time: 2024-12-12
title: Launch
content:
Plug accepted into obsidian store

@card [color-blue]
time: 2024-12-12
title: Launch
content:
Plug accepted into obsidian store

Resources & Links

• 01-Project-Structure - Detailed file organization
• 02-Core-Plugin-Architecture - Main plugin class and settings
• 03-Entity-Management - Entity types and operations
• 04-Modals-System - Modal dialog patterns
• 05-Timeline-System - Timeline and Gantt features
• 06-Map-System - Leaflet map integration
• 07-Template-System - Template creation and usage
• 08-Import-Export - Document parsing and compilation
• 09-Internationalization - Translation system
• 10-Build-And-Testing - Development workflow