ArcAide Documentation
ArcAide Documentation
Section titled “ArcAide Documentation”Core Features
Section titled “Core Features”ArcAide provides everything you need for compelling D&D campaign management:
📖 Arc-Based Storytelling
Section titled “📖 Arc-Based Storytelling”Structure your narratives using our proven six-part framework: Hook, Protagonist, Antagonist, Problem, Key, and Outcome. Create hierarchical arc relationships with parent and child storylines.
🏰 Entity Management
Section titled “🏰 Entity Management”Organize your campaign world with custom entity types (NPCs, Locations, Items, Organizations) and rich descriptions using our powerful editor.
🔍 Smart Search & Discovery
Section titled “🔍 Smart Search & Discovery”Find any content instantly with full-text search across all campaign materials, including fuzzy matching for typos and spell correction.
📤 Publishing & Content Sharing
Section titled “📤 Publishing & Content Sharing”Share your campaign content with players using the publishing system. Control exactly what information is visible with paragraph-level secret content management.
🎯 Campaign Organization
Section titled “🎯 Campaign Organization”Manage multiple campaigns with clear navigation, quick creation tools, and seamless content linking.
Documentation Philosophy
Section titled “Documentation Philosophy”As developers, we believe that good documentation starts with well-written code. If your code is clean, well-structured, and follows best practices, it will be easier to understand and maintain. Documentation should complement the code, not replace it.
We write documentation not for ourselves or our current team, but for future developers who weren’t there when we first wrote this code. Documentation is a living document that should be updated as the code changes.
User Documentation
Section titled “User Documentation”Quick Start
Section titled “Quick Start”- Getting Started Guide - Create your first campaign and learn the arc framework
- Campaign Creation - Set up campaigns and organize storylines
- Arc Framework - Master the six-part storytelling structure
Advanced Features
Section titled “Advanced Features”- Advanced Features - Power user features and advanced techniques
- Publishing System - Share content with players while controlling visibility
- Arc Hierarchies - Create nested storylines and complex narratives
- Entity Management - Organize NPCs, locations, and campaign elements
- View Modes - Switch between editing and presentation modes
- Search & Linking - Find content and create connections between elements
Developer Documentation
Section titled “Developer Documentation”Architecture & Design
Section titled “Architecture & Design”- Overview - Introduction to the developer docs and our standards
- Architecture Overview - System architecture and design patterns
- Technology Stack - Technologies and frameworks used
- Database Design - Schema and data modeling
- Security Model - Authentication and authorization
API Reference
Section titled “API Reference”- API Reference - Comprehensive API documentation
- Arcs API - Arc management endpoints
- Things API - Entity management endpoints
- Error Handling - Error responses and handling
Development
Section titled “Development”- Component Architecture - UI component structure
- State Management - Data flow and state handling
- Development Patterns - Code patterns and conventions
Recent Updates
Section titled “Recent Updates”Latest Changes
ArcAide is actively developed with regular improvements. Check our changelog for detailed update information.
Recent major improvements include:
- Publishing System: Share campaign content with players while controlling sensitive information visibility
- Secret Content Management: Paragraph-level control over what players can see in published content
- Enhanced Search System: Full-text search with fuzzy matching and spell correction
- Internal Linking: Wiki-style content cross-referencing with
[[...]]
syntax - UI/UX Overhaul: D&D-themed interface with view/edit mode switching
- Mobile Optimization: Improved responsive design for all screen sizes
- Performance Improvements: Faster loading and better search performance
Getting Help
Section titled “Getting Help”- Documentation Issues: Report problems with these docs via GitHub issues
- Feature Requests: Submit enhancement ideas through our issue tracker
- Bug Reports: Help us improve by reporting any issues you encounter
- Community: Join discussions about D&D campaign management best practices