Directories
¶
| Path | Synopsis |
|---|---|
|
Package app is the application bootstrap and dependency injection root.
|
Package app is the application bootstrap and dependency injection root. |
|
Package apperror provides domain-specific error types for Chronicle.
|
Package apperror provides domain-specific error types for Chronicle. |
|
Package concurrency provides optimistic-concurrency primitives shared across plugins.
|
Package concurrency provides optimistic-concurrency primitives shared across plugins. |
|
Package config handles loading application configuration from environment variables.
|
Package config handles loading application configuration from environment variables. |
|
Package database — healthcheck.go Comprehensive startup health checks that run after migrations to catch configuration, schema, and security issues before the server accepts traffic.
|
Package database — healthcheck.go Comprehensive startup health checks that run after migrations to catch configuration, schema, and security issues before the server accepts traffic. |
|
Package extensions — adapters.go bridges external service interfaces to the applier's narrower interfaces.
|
Package extensions — adapters.go bridges external service interfaces to the applier's narrower interfaces. |
|
Package hostinfo reports the identity of the RUNNING Chronicle process: which binary it is, which source revision produced it (when that was recorded at all), when the process started, and how long it has been up.
|
Package hostinfo reports the identity of the RUNNING Chronicle process: which binary it is, which source revision produced it (when that was recorded at all), when the process started, and how long it has been up. |
|
Package middleware provides HTTP middleware for the Chronicle Echo server.
|
Package middleware provides HTTP middleware for the Chronicle Echo server. |
|
Package observability holds Chronicle's in-process self-observation: a small, bounded, in-memory record of recent server errors, readable through the admin diagnostics catalog without shelling into the container.
|
Package observability holds Chronicle's in-process self-observation: a small, bounded, in-memory record of recent server errors, readable through the admin diagnostics catalog without shelling into the container. |
|
Package patch provides three-state JSON fields for partial-update requests: an ABSENT key preserves the stored value, an EXPLICIT null clears it, and a present value replaces it.
|
Package patch provides three-state JSON fields for partial-update requests: an ABSENT key preserves the stored value, an EXPLICIT null clears it, and a present value replaces it. |
|
Package permissions provides shared role constants and permission checks for code that cannot import campaigns (circular dependency).
|
Package permissions provides shared role constants and permission checks for code that cannot import campaigns (circular dependency). |
|
plugins
|
|
|
addons
Package addons manages the extension framework — installable addons (plugins, systems, widgets, integrations) with per-campaign enable/disable controls.
|
Package addons manages the extension framework — installable addons (plugins, systems, widgets, integrations) with per-campaign enable/disable controls. |
|
admin
Package admin — database_health.go defines the admin-local contracts the Database page's Health and Backups tabs render.
|
Package admin — database_health.go defines the admin-local contracts the Database page's Health and Backups tabs render. |
|
ai_workspace/aiexport
Package aiexport renders a campaign's owner-scoped content into a single markdown document for pasting into AI tools.
|
Package aiexport renders a campaign's owner-scoped content into a single markdown document for pasting into AI tools. |
|
ai_workspace/importer
Package importer parses AI-generated markdown into per-page ParsedPage structs, classifies each (full / defaults / conflict / new category / parse error), and prepares the review-screen data the operator inspects before committing.
|
Package importer parses AI-generated markdown into per-page ParsedPage structs, classifies each (full / defaults / conflict / new category / parse error), and prepares the review-screen data the operator inspects before committing. |
|
ai_workspace/importer/htmlconv
Package htmlconv converts sanitized HTML to a Chronicle-shaped ProseMirror JSON document.
|
Package htmlconv converts sanitized HTML to a Chronicle-shaped ProseMirror JSON document. |
|
ai_workspace/prompt
Package prompt builds the "Copy AI Prompt" output for the AI Workspace settings tab.
|
Package prompt builds the "Copy AI Prompt" output for the AI Workspace settings tab. |
|
armory
handler.go provides HTTP endpoints for the Armory gallery.
|
handler.go provides HTTP endpoints for the Armory gallery. |
|
audit
Package audit provides an audit log plugin that records user actions within campaigns.
|
Package audit provides an audit log plugin that records user actions within campaigns. |
|
auth
loghash provides email hashing for debug-log correlation.
|
loghash provides email hashing for debug-log correlation. |
|
backup
Package backup provides the admin-facing UI for triggering whole-database backups and inspecting prior runs.
|
Package backup provides the admin-facing UI for triggering whole-database backups and inspecting prior runs. |
|
bestiary
Package bestiary provides the Community Bestiary plugin for sharing homebrew creatures across a Chronicle instance.
|
Package bestiary provides the Community Bestiary plugin for sharing homebrew creatures across a Chronicle instance. |
|
calendar
Package calendar is, for now, a migrations-and-identity carrier.
|
Package calendar is, for now, a migrations-and-identity carrier. |
|
campaigns
Package campaigns — export.go defines the JSON structure for campaign exports.
|
Package campaigns — export.go defines the JSON structure for campaign exports. |
|
designlab
Package designlab provides the admin-only "Design Lab" page.
|
Package designlab provides the admin-only "Design Lab" page. |
|
entities
block_registry.go provides a self-registering system for entity page block types.
|
block_registry.go provides a self-registering system for entity page block types. |
|
foundry_vtt
Package foundry_vtt is the Foundry-VTT-specific sub-plugin that extends the generic packages plugin via the PostInstallHook extension point.
|
Package foundry_vtt is the Foundry-VTT-specific sub-plugin that extends the generic packages plugin via the PostInstallHook extension point. |
|
maps
Package maps provides the interactive maps addon for campaigns.
|
Package maps provides the interactive maps addon for campaigns. |
|
media
Package media manages file uploads, storage, and serving for Chronicle.
|
Package media manages file uploads, storage, and serving for Chronicle. |
|
npcs
handler.go provides HTTP endpoints for the NPC gallery.
|
handler.go provides HTTP endpoints for the NPC gallery. |
|
packages
Package packages provides the package manager plugin for Chronicle.
|
Package packages provides the package manager plugin for Chronicle. |
|
restore
Package restore provides the admin-facing UI for restoring a previous backup.
|
Package restore provides the admin-facing UI for restoring a previous backup. |
|
sessions
Package sessions provides the game session tracking addon for campaigns.
|
Package sessions provides the game session tracking addon for campaigns. |
|
settings
Package settings manages site-wide configuration and storage limit overrides.
|
Package settings manages site-wide configuration and storage limit overrides. |
|
smtp
Package smtp provides outbound email functionality for Chronicle.
|
Package smtp provides outbound email functionality for Chronicle. |
|
syncapi
egress_sanitize.go — defense-in-depth sanitization on /api/v1/* response payloads.
|
egress_sanitize.go — defense-in-depth sanitization on /api/v1/* response payloads. |
|
timeline
Package timeline provides the timeline addon for campaigns.
|
Package timeline provides the timeline addon for campaigns. |
|
widgetbindings
DOM-id helpers for the re-render seam: a host's widget block lives inside a stable wrapper element so a bind/unbind can target it for an in-place HTMX swap; the picker fragment loads into a separate slot inside that wrapper.
|
DOM-id helpers for the re-render seam: a host's widget block lives inside a stable wrapper element so a bind/unbind can target it for an in-place HTMX swap; the picker fragment loads into a separate slot inside that wrapper. |
|
Package sanitize provides HTML sanitization for user-generated content.
|
Package sanitize provides HTML sanitization for user-generated content. |
|
campaign_system_handler.go adds HTTP endpoints for campaign owners to upload, view, and remove custom game systems.
|
campaign_system_handler.go adds HTTP endpoints for campaign owners to upload, view, and remove custom game systems. |
|
templates
|
|
|
components
Package components provides reusable Templ UI components shared across plugins.
|
Package components provides reusable Templ UI components shared across plugins. |
|
layouts
assets.go provides cache-busted static asset URLs.
|
assets.go provides cache-busted static asset URLs. |
|
Package timeutil provides DST-correct conversions between zone-local wall-clock times and absolute instants, plus helpers for projecting a recurring weekly pattern onto a concrete calendar week in a viewer's zone.
|
Package timeutil provides DST-correct conversions between zone-local wall-clock times and absolute instants, plus helpers for projecting a recurring weekly pattern onto a concrete calendar week in a viewer's zone. |
|
Package websocket provides a campaign-scoped WebSocket hub for real-time bidirectional communication between Chronicle and external clients (Foundry VTT).
|
Package websocket provides a campaign-scoped WebSocket hub for real-time bidirectional communication between Chronicle and external clients (Foundry VTT). |
|
widgets
|
|
|
entity_notes
Package entity_notes implements the player-facing entity-page notes widget.
|
Package entity_notes implements the player-facing entity-page notes widget. |
|
notes
Package notes implements the player notes widget for Chronicle.
|
Package notes implements the player notes widget for Chronicle. |
|
posts
Package posts implements the entity posts widget for Chronicle.
|
Package posts implements the entity posts widget for Chronicle. |
|
relations
Package relations implements the entity relations widget for Chronicle.
|
Package relations implements the entity relations widget for Chronicle. |
|
tags
Package tags implements the tags widget for Chronicle.
|
Package tags implements the tags widget for Chronicle. |
Click to show internal directories.
Click to hide internal directories.