Examples
The plugins on Bläck Studio’s own list are written with the same SDK, and each shows something. Read their source, or start from one.
-
Your books
book-progressin the windowAPI 2On the welcome screen: your recent books with their words against their goals, and for each with a deadline, the days left and the words a day it takes to make it.
Shows in the window: cards on the welcome screen's dashboard, from the writer's library; starting a sprint
library:read -
Characters as you type
cast-suggestsandboxedAPI 1Type @ and the start of a name, and the book's characters and places are offered, by any of their names; Enter or Tab writes it out.
Shows sandboxed: suggestions as you type, kept ready as the binder changes
No permissions beyond reading the book
-
Where you left off
continue-writingin the windowAPI 2On the welcome screen: the book you had open last, the scene you were writing in and how it ends now, and a button to go straight back to it.
Shows in the window: cards on the welcome screen's dashboard, from the writer's library; starting a sprint
library:read -
Dictation
dictationin the windowAPI 4Talk instead of typing: press the microphone in the editor's toolbar, speak, press it again, and what you said is written where the cursor is, in the book's language. Written down on your own device, privately (a computer downloads Whisper's speech model once), or by Groq or OpenAI with your own API key.
Shows in the window: the microphone, speech written down on the device (
app.speech), a toolbar button, a hotkey, a secret setting, a request to a service with the writer's own keymicrophoneproject:writenetwork:api.openai.comnetwork:api.groq.com -
Filter words
filter-wordssandboxedAPI 1Marks the words that put a filter between the reader and the scene (saw, felt, noticed, just, very…), in the languages you choose, and counts them in the document you're in.
Shows sandboxed: marks in the text, settings, a status bar item, events
No permissions beyond reading the book
-
Markdown with front matter
markdown-exportsandboxedAPI 1Compiles the book to Markdown with YAML front matter and real footnotes, for static sites (Hugo, Jekyll), Obsidian and Pandoc.
Shows sandboxed: a format in Compile
No permissions beyond reading the book
-
Name generator
name-generatorin the windowAPI 1Names for characters: English, Swedish or invented. Insert one where you're writing (Ctrl+Alt+N), give a character sheet one, or browse a page of them.
Shows in the window: a view, an inspector tab, a menu entry, a TipTap shortcut, changing the book
project:write -
Pandoc export
pandoc-exportsandboxedAPI 1Compiles the book to whatever Pandoc can make: OpenDocument, LaTeX, Typst, RTF, AsciiDoc and more, each a format in Compile. Needs Pandoc installed (pandoc.org).
Shows sandboxed: running a program, in its temporary folder, with formats that follow its settings
exec:pandoc -
Pomodoro
pomodoroin the windowAPI 1Write in timed stretches with short breaks between, from the status bar: 25 minutes of writing, 5 of rest, or what you choose.
Shows in the window: its own React in the status bar, a hotkey
No permissions beyond reading the book
-
Lately
recent-activityin the windowAPI 2On the welcome screen: the versions of your books saved lately, the latest backups, and any push of a book's history that didn't go through.
Shows in the window: cards on the welcome screen's dashboard, from the writer's library; starting a sprint
library:read -
Series at a glance
series-overviewin the windowAPI 2On the welcome screen: each of your series with its books in order, how far along each one is, and the whole series' words.
Shows in the window: cards on the welcome screen's dashboard, from the writer's library; starting a sprint
library:read -
Today
todayin the windowAPI 2On the welcome screen: the words you've written today in all your books, against the day's goal, and a writing sprint to start in the book you had open last.
Shows in the window: cards on the welcome screen's dashboard, from the writer's library; starting a sprint
library:read -
Writing calendar
writing-calendarin the windowAPI 2On the welcome screen: the last months of your writing, a square a day, darker the more you wrote in all your books; with the days in a row you're on, and your longest run.
Shows in the window: cards on the welcome screen's dashboard, from the writer's library; starting a sprint
library:read