Repository navigation
v1.0.0-beta.1
Pre-release
Pre-release
·
14 commits
to main
since this release
Immutable
release. Only release title and notes can be modified.
The first beta of Inkweld 1.0, a collaborative platform for writing fiction
and building the worlds it happens in. Inkweld is feature complete for 1.0;
the betas focus on testing and bug fixing. From this release on, the aim is
that every release upgrades automatically from any earlier one, with no export,
reset or manual migration. Please report problems on the
issue tracker.
Writing
- Rich-text editor with tables, images, links, find and replace (Ctrl/Cmd+F),
project-wide full-text search (Ctrl+Shift+F), word count and reading time,
zen mode, and optional Markdown typing shortcuts. - Hierarchical project tree of folders, documents and worldbuilding elements,
with drag and drop, tags, pinned items, a quick finder and breadcrumbs. - Scene and note roles for prose, with corkboard and outline views of folders.
- Conversation scenes: write a scene as speech bubbles with each speaker's
portrait and name, and read it back as a screenplay-style script. - Named and automatic snapshots to restore earlier versions of a document.
- Comments with threaded discussions, and documents that pop out into their
own window. - Random name, place and prompt generators.
Collaboration and sync
- Real-time collaborative editing (Yjs) with live presence, cursors and
viewer/editor access levels for collaborators. - Offline-first: projects are kept on the device and sync when a connection
returns. A Browser profile needs no server or account at all, and its
projects can be moved to a server later (signing in with a passkey or a
password). - Profiles for several servers or accounts on one device, each with its own
isolated local data. - Cloud Sync profiles that mirror projects to the user's Dropbox, Google Drive
or Nextcloud, with multi-author support. - Fast "Sync All" that only transfers documents that changed.
- Per-device project activation, writing statistics, an activity feed and a
GitHub-style activity grid on public profiles.
Worldbuilding
- 29 built-in element types (characters, locations, factions and more) and 54
relationship types. - Project templates for worldbuilding, tabletop RPGs and scripts, picked by
what you are making. The tabletop RPG template adds element types for play
(player characters, NPCs, monsters, quests, magic items and more), and a
demo project contains a complete illustrated adventure. - Template (schema) editor that edits a live preview of the element form.
- Per-element schema copies: customise one element's fields in place, and
pull in later changes to the shared template when you choose. - Relationship fields and an interactive relationship graph.
- Timelines with custom time systems, eras and events, built automatically
from element date fields. - Canvases for maps and boards: layered drawing, pins and regions linked to
elements, crop frames and live project covers rendered from a canvas. - Media library with tagging, filtering and image paste, and optional AI image
generation from several providers.
Publishing
- Publish plans that export to EPUB 3 (EPUBCheck-clean, with Kindle-friendly
fallbacks), PDF (Typst), HTML, Markdown and a multi-page website with
worldbuilding pages. - Typography settings with bundled fonts, chapter heading styles, typographic
quotes, an embedded cover and a generated table of contents. - Two-column page layouts, covers that fill the page edge to edge, and
sourcebook-style worldbuilding entries with images in PDF and HTML. - Project archives (
.inkweld.zip) for export, import and backup.
Accounts and security
- Passwordless sign-in with passkeys (WebAuthn) by default. Magic-link
recovery by email, password sign-in and GitHub OAuth can be turned on. - User approval workflow, rate limiting on auth endpoints, CSRF protection and
a Content-Security-Policy. - Self-service account deletion, in the app and on a public
/delete-account
page.
AI (optional, off by default)
- AI stays off unless the server admin turns off the AI kill switch and
the user chooses Allow AI. Each user's No AI / Allow AI choice is offered on
first run and in Settings, and defaults to No AI. - MCP server so AI assistants can read and edit projects, with OAuth 2.1
(dynamic client registration) and per-project consent. - WebMCP: AI agents built into the browser can use Inkweld with the signed-in
user's access, in Browser, Cloud Sync and server profiles alike.
Integrations
- Home Assistant app support: runs behind Home Assistant ingress and signs in
the Home Assistant user automatically. - Installable web app (PWA) on desktop and mobile. The app offers to install
itself on the home screen and in Settings, with Add to Home Screen steps on
iPhone and iPad.
Administration
- Admin settings for users, AI providers, email and site configuration.
- Branding: custom login and home backgrounds, privacy policy and terms pages
with optional acceptance, and custom HTML injection for analytics or consent
tools. - Per-user sync capacity (storage quotas), measured always and enforced when
enabled. - Interface available for translation (Transloco), with English as the source
language.
Self-hosting
- Single Docker image (
ghcr.io/bobbyquantum/inkweld) or a native Bun server
with SQLite and per-project LevelDB storage. - Cloudflare Workers deployment with D1, R2 and Durable Objects.
- Interactive deployment wizard (
bun run deploy).
Getting it
- Hosted app: https://inkweld.app
- Docker:
ghcr.io/bobbyquantum/inkweld:1.0.0-beta.1(or:beta) - Docs: https://inkweld.org