Notebooks for authors - a bookshelf for your projects, a cork board with sticky notes, pins and threads, a timeline, a rich-text editor with comments, attachments and spell checking.
Note
Development Roadmap & Prototyping Notice
All releases up to v2.0.0 represent initial rapid prototyping stages. During this phase, AI tools are heavily leveraged to accelerate development, test feature concepts, and build out functional workflows. Using AI for rapid iteration is a practical necessity for this project: I work full-time in an entirely different field, and balancing development alongside work, family, friends, and everyday life makes AI assistance > essential for making steady progress.
Once the core functionality and feature set are fully finalized, the entire application will undergo a complete human-led rewrite—focusing on code refactoring, performance optimization, and long-term maintainability. Rest assured that backward compatibility will be preserved, ensuring that any projects created during the prototyping phase remain fully supported and functional out of the box with v2.0.0.
In line with the transparency principles of "Ai Transparancy Act", please note that this Software was generated using Anthropic (Claude AI) and DeepSeek AI. All content has been manually reviewed and verified by the maintainer.
Features · Screenshots · Installation · Quick start · Showcase project · Keyboard shortcuts · Languages · Where is my data? · Project layout · Development · Documentation · License · Disclaimer
Organise your library
- 📚 Bookshelf start page - every notebook is a book spine, grouped on named, colourable shelves. Drag books and whole shelves around; the spine gets thicker with your word count and shows a progress bar towards your word goal.
- 🗂 Notebook information - title, author, genre, category, colour, word goal, deadline, description and your own fields.
Plot on a board
- 🗒 Sticky notes with types (character, place, chapter, scene, event, plot, item, idea, research, ...), status dots, tags, free attributes and a content preview.
- 📌 Pins and threads - connect pins by dragging with the right mouse button; coloured, labelled threads ("brother of") run in front of the notes and fade where they cross a note.
- 🎚 Adaptive thread visibility - when zoomed out, threads are hidden by default to keep the board readable; select a note to reveal its connected threads. Threads connected to the selection stay visible and clickable at any zoom. On very large boards threads render as simple strokes.
- 🔒 Locking - lock notes so they stay in place; lock pins so they cannot be dragged inside a note but still follow it.
- 🎯 Focus mode - select a note and everything not connected to it is greyed out.
- 🔎 Search & filters - full text,
#tags, note type, status; the board dims what does not match. - 🧩 Custom note types - per notebook or global for all notebooks (Settings).
- 🏷 Tag auto-completion that remembers the tags of each book.
- 🚀 Scales to large boards - the renderer picks a level of detail per item from the current zoom and the number of visible notes, threads and pins, so panning and zooming stay responsive on boards with thousands of notes and threads.
- 🗃 Group frames - select notes and press
Ctrl+G: a titled, coloured frame moves its notes together. Membership is geometric (the topmost frame containing a note's centre wins), frames can be nested, locked and dimmed with their notes.
Write
- ✍️ Full-size rich-text editor - fonts, bold / italic / underline / strike-through, text colour, highlighter, alignment, lists, links that open in the web browser (Ctrl+click) and images.
- 💬 Comments on words or sentences with a hover pop-up and a Comments tab that lists every comment. A single click in the tab selects and centres the note that holds the comment; a double click opens the editor and jumps to the commented words.
- 📎 Attachments - attach any file or image to a note; everything is stored inside the notebook file.
- ✅ Spell checking for English and German with suggestions and a user dictionary.
See the story
-
🕒 Horizontal timeline - dots in the colour of the note, information bubble on click, zoom and pan. Smooth on boards with thousands of dated notes.
-
📊 Statistics - words per note type, status, tags, longest and most connected notes, daily progress.
-
🧭 FlowView - open any note (right-click → FlowView öffnen, or View → FlowView,
Ctrl+T) for a focused, zoomable view of that note and its neighbours. Walk the graph one hop at a time by clicking the ▶ arrow on any neighbour; the embedded Inspector edits both root and neighbours without leaving the window. -
🗺 FlowView minimap - the whole connected component at a glance in the corner of the FlowView. Filled dots are the current root and its neighbours (click to jump); hollow dots are further notes (click to highlight the shortest path to them). Amber lines show the walk, everything off the path dims so the next step is obvious, and ◀ / ▶ at the bottom-left step you along the path or back through your root history.
-
🔎 FlowView note list - a searchable, resizable list of every note shown on the minimap, docked beside it. Active notes re-root on click; silhouettes toggle the path highlight. The selected silhouette is tinted the same amber as the path.
-
Stay safe
-
↩️ Undo / redo for everything, a save prompt for unsaved changes, autosave with crash recovery (written off the UI thread) and automatic backups.
-
📤 Export - manuscript (Markdown, text, HTML, PDF; HTML/PDF keep formatting and images), outline as Markdown, board as PNG.
-
🌍 Two languages (English / Deutsch) switchable at runtime and easy to extend.
-
📖 Built-in searchable documentation (F1).
Requirements: Python 3.10 or newer.
git clone <your-repository-url> authorboard
cd authorboard
python -m venv venv
# Windows: venv\Scripts\activate macOS / Linux: source venv/bin/activate
pip install -r requirements.txt
python main.pyrequirements.txt contains PySide6 (Qt 6) and the optional pyspellchecker. Without pyspellchecker everything works except the spell check.
- On the bookshelf click + Notebook, give it a title and press Create.
- Double-click the board to create a note - or press Shift+Space and pick a note type.
- Fill in the Inspector (right): title, tags, attributes, text, attachments.
- Double-click a note to open the full-size editor. To add a pin, use the note's right-click menu → Add pin here.
- Hold the right mouse button on a pin and drag it onto another pin to connect them with a thread.
- Press F2 for the full-size editor. Select words, right-click → Add comment ….
- Ctrl+S saves, Ctrl+B returns to the bookshelf, F1 opens the documentation.
The folder showcase/ contains a fully filled example notebook (51 notes, 45 threads, rich text, comments, attachments, locks, custom types) in English and German:
The Ashwood Chronicles (Showcase).jsonDie Chroniken von Aschenwald (Showcase).json
On the bookshelf click Importieren … / Import … and select the file. Book information (title, author, genre, word goal, ...) is imported as well. Regenerate the files with python tools/make_showcase.py.
| Shortcut | Action | Shortcut | Action |
|---|---|---|---|
Shift+Space |
Find note type / new note | Ctrl+S |
Save |
Ctrl+B |
Back to bookshelf | Ctrl+Z / Ctrl+Y |
Undo / redo |
Ctrl+N |
New notebook | Ctrl+D |
Duplicate note |
F2 |
Full-size editor | Ctrl+L |
Lock / unlock note |
Ctrl+F |
Search | Ctrl+0 / Ctrl+1 |
Show all / 100 % |
Ctrl+I |
Statistics | Ctrl+, |
Settings |
F1 |
Documentation | Ctrl+K (editor) |
Insert link |
Ctrl+Alt+M (editor) |
Add comment | F11 (editor) |
Full screen |
Mouse: wheel = zoom, middle button = pan, right-drag pin → pin = thread, double-click board = note, double-click note = big editor.
English and German are included (View → Language, applied immediately). Adding a language takes minutes:
python i18n.py new fr "Français" # creates locales/fr.json with every text
# translate the values in locales/fr.json, optionally copy help/en -> help/fr
python main.py # the language shows up in the menupython i18n.py update fr adds texts that appeared later, python i18n.py check fr lists missing translations.
| What | Where |
|---|---|
| Library and shelves | ~/.authorboard/library.json |
| Notebooks (one self-contained JSON file each, attachments included) | ~/.authorboard/books/ |
| Automatic backups | ~/.authorboard/backups/ |
| Settings, user dictionary, global note types | ~/.authorboard/settings.json |
Set the environment variable AUTHORBOARD_HOME to use another folder. On Windows ~ is your user folder.
main.py application entry point and MainWindow (controller)
canvas.py BoardScene / BoardView: notes, pins, threads, focus mode
note_item.py pin_item.py connection_item.py graphics items of the board
inspector.py property editor of the selected note
rich_text.py rich-text widget: images, links, comments, spell check
editor_dialog.py full-size editor
comments_panel.py comments list + Inspector/Comments tab widget
spellcheck.py spell-check engine (pyspellchecker)
attachments.py in-memory attachment store
shelf.py library.py bookshelf page and library data
timeline.py horizontal timeline widget
models.py storage.py data classes and JSON file format
undo.py snapshot based undo / redo
settings.py settings_dialog.py global settings and note types
help_dialog.py about_dialog.py documentation and About windows
i18n.py locales/ translations (+ CLI tool) help/ manual (en, de)
tools/ showcase and screenshot generators
tests/ headless test suite docs/ mkdocs.yml developer docs
pip install -r requirements.txt -r requirements-dev.txt
python tests/run_all.py # headless test suite (Qt offscreen)
python tools/make_showcase.py # regenerate showcase/*.json
python tools/make_screenshots.py # regenerate docs/images/*.png
mkdocs serve # developer documentation at http://127.0.0.1:8000The code is commented and every module, class and function has a docstring. Start with the Architecture pages of the developer documentation (docs/), they explain how the pieces fit together and how to extend the program (new note types, export formats, languages, ...).
Contributions are welcome - see CONTRIBUTING.md.
- User manual: inside the program (Help → Documentation,
F1) - searchable, English and German. The sources are inhelp/. - Developer documentation:
docs/, built with MkDocs (mkdocs serve).
See -> ROADMAP.md
AuthorBoard is free software, released under the GNU General Public License v3.0 or later (GPL-3.0-or-later). See LICENSE.
This software is provided "as is", without warranty of any kind. Use it at your own risk. No responsibility or liability is accepted for any damage, loss of data, lost work or any other harm resulting from its use. Please back up your work regularly.
AuthorBoard was made in an iterative collaboration between a human and two AI assistants:
-
Concept, direction and oversight — Vibrantic Every feature, layout decision, bug report and performance target came from the human maintainer: what to build, what to keep, what to cut, and when a fix was good enough. Design decisions, UX testing, bug reproduction, performance profiling on real hardware, and final review of every change.
-
Initial implementation, architecture, user manual and showcase — Claude, an AI assistant made by Anthropic. Source code of the original 1.0 release, automated tests, developer documentation, translations, and the showcase project were written in an ongoing conversation with the maintainer, driven by their feedback at each step.
-
Performance work, LOD rendering, timeline rewrite, undo restructuring, and bug fixes — DeepSeek, an AI assistant made by DeepSeek. The performance overhaul (level-of-detail tiers for notes, threads and pins; viewport culling; off-thread autosave; structural-sharing undo snapshots; the O(N) timeline), the adaptive thread-visibility rules, the comment-click and focus-mode fixes, and the cursor-handling work were implemented in this codebase and reviewed by the maintainer at every step.
Built with Python, Qt for Python (PySide6) and pyspellchecker.









