GDDKit v2 feature reference
This reference summarizes the released GDDKit v2 desktop scope. It deliberately excludes CLI, Git workspace, review, enterprise policy, and real-time collaboration work found only on unreleased development branches.
Platform & package matrix
| Platform | Architecture | Package | In-app update behavior |
|---|---|---|---|
| Windows 10/11 | x64 | Setup EXE | Installed Velopack channel. |
| Linux | x64 | AppImage | Platform-specific channel; GTK 3/WebKitGTK 4.1 runtime required. |
| macOS | Apple Silicon | Signed/notarized PKG | Architecture-specific channel. |
| macOS | Intel | Signed/notarized PKG | Architecture-specific channel. |
No released Windows ARM/x86 or Linux ARM build is documented for v2. The source does not state a guaranteed minimum macOS version.
Project capabilities
| Capability | Released v2 behavior |
|---|---|
| Storage | Local, readable JSON .gddkit file. |
| Account | Not required for editing or export. |
| Metadata | Title, tagline, author/studio, multiple genres, PC/Mobile/Console/Web, logo path, version, timestamps. |
| Starter structure | 12 guided GDD sections with sample Markdown and selected Mermaid diagrams. |
| Recent projects | Up to 10 stored paths; invalid paths are hidden but can occupy slots; no manual per-card remove interface. |
| Compatibility | Existing v1 .gddkit files; Windows v1.0.5 settings/recent data preserved; legacy icons mapped. |
| Import | Existing .gddkit only. No general Markdown/PDF/DOCX/HTML import. |
Editor & organization
| Capability | Details |
|---|---|
| Views | Edit, Preview, Split; resizable divider; synchronized relative scrolling. |
| Text | Line numbers, wrapping, active-section word count, save status and time. |
| Formatting | H1–H3 controls, bold, italic, strikethrough, quote, lists, task list, link, image, table, inline/fenced code, rule. |
| Sections | Add, rename, describe, icon, drag reorder, save as preset, delete with confirmation; at least one remains. |
| Built-in add presets | Boss Design, Weapon Spec, Quest Design, Enemy Archetype, Level Brief, UI Screen Spec, plus blank. |
| Saved presets | Global settings; reusable across projects; user presets can be deleted; same-name save replaces. |
| Search | Case-insensitive literal substring, minimum 2 characters, all section Markdown, result snippets/navigation. |
| Search exclusions | Project metadata and changelog. |
| Images | Insert PNG/JPG/JPEG/BMP/GIF; paste image files/bitmaps; relative images/ directory. |
| Mermaid starters | Flowchart, sequence, class, state, ER, Gantt, pie, mindmap. |
Save & data behavior
| Item | Scope | Location/behavior |
|---|---|---|
| Project | Per project | .gddkit; images beside it; logo referenced externally. |
| Autosave | Global interval | 15 s, 30 s default, 1 min, or Off; only while dirty. |
| Save transaction | Per save | Writes .backup, then moves it to main; not permanent history. |
| Preferences | Global | Local application-data GDDKit/settings.json. |
| Recent paths | Global | recent_projects.json, max 10. |
| Saved section presets | Global | Inside settings, not the project. |
| PDF styles | Global | Inside settings, active across all projects. |
| Custom fonts | Global | Local application-data GDDKit/Fonts. |
Export matrix
| Feature | Markdown | |
|---|---|---|
| Project metadata | Yes | Yes, designed cover/headers. |
| Ordered sections | Yes | Yes. |
| Leading section H1 | Removed to avoid duplicate | Removed to avoid duplicate. |
| Changelog | Yes | Yes. |
| Mermaid | Source block preserved | Rendered image or readable fallback. |
| Local section images | Paths preserved; assets not copied | Rendered when resolvable. |
| Remote images | URL preserved | HTTP(S), 8 MB maximum, 10-second timeout. |
| Project logo | Not added | Cover image or GDD fallback. |
| Layout | One .md file; section icon glyphs may need replacement outside GDDKit | A4 portrait, cover, TOC, headers/footers, page numbers. |
| Formats not produced | HTML, DOCX, PDF package | DOCX, HTML, editable source package. |
Built-in PDF styles
Publisher Pitch, Studio Bible, Blueprint, Dark Cinematic, Ink Bloom, Indie Comic, Retro RPG, and Nordic Frost.
Custom PDF style controls
- cover label;
- body and display typefaces;
- 24–64 pt margins;
- cover, metadata, body, quote, code, table, and border colors;
- Mermaid background, node, text, connection, border, and cluster colors;
- optional cover/header/footer SVG;
- imported TTF/OTF;
- reusable custom style list and global active selection.
The Designer preview is a fixed visual mockup. A real PDF export is the rendering reference.
PDF rendering reference
Before approving a custom theme, keep a test project containing:
- short and long titles/taglines;
- H2–H6 hierarchy;
- bold, italic, strikethrough, inline code, and links;
- nested ordered/unordered/task lists;
- aligned tables with long and numeric cells;
- blockquotes and long code lines;
- local, missing, and remote images;
- flowchart plus state/cluster Mermaid cases;
- enough content for several pages and a changelog.
Export it after every substantial theme change and inspect on at least two PDF viewers for an external deliverable.
Update & feedback network behavior
| Workflow | Data/connection |
|---|---|
| Startup/manual update check | Contacts the platform-specific GDDKit release feed. |
| Update download/apply | Requires user confirmation and an installed release; restart is separately confirmed. |
| Feedback | Sends type, title, description, optional name/email, and optional screenshot to gddkit.com. |
| Feedback screenshot | Current app capture or chosen PNG recommended, below 900 KB; see the format caveat in Updates & feedback. |
| Remote preview/PDF image | Contacts the image host. |
| Local Markdown/Mermaid | Uses bundled/local content without a cloud account. |
Keyboard reference
Global/workspace: Ctrl + N, O, S, W, E, and F. Editor: Ctrl + B, I, K, V, X, C, and A. Search: arrow keys, Enter, and Esc.
See Search & keyboard shortcuts for context and macOS modifier behavior.
Explicit non-features in released v2
- no real-time/cloud collaboration, presence, comments, or shared cursors;
- no file locking or merge/conflict interface;
- no CLI or headless export;
- no Git/Perforce workspace UI in the released desktop build;
- no Markdown/PDF/DOCX/HTML import;
- no DOCX or HTML export;
- no per-project PDF theme;
- no embedded project images or logo;
- no permanent automatic revision history;
- no recent-card removal, custom-font removal, changelog-entry editing, or built-in-section restore UI;
- no guaranteed clickable PDF links or Command-key shortcut mapping.
For operational advice around these boundaries, use Troubleshooting & FAQ.