wordcraft README

The project's README from github.com/storytold/wordcraft. As one markdown file: README.md.

ArtCraft

WordCraft

Writing and document design; an open-source, clean-room reimplementation of Microsoft Word, rebuilt in pure Rust.

A fast, open-source word processor with the Word workflow you already know: the ribbon, styles, tables, track changes, references and mail merge. It reads and writes .docx, runs natively on macOS, Windows, Linux and BSD, and in the browser via WebAssembly.
By the ArtCraft team.

Written in Rust Runs on macOS, Windows, Linux, BSD and the web License: MIT OR Apache-2.0 Agent-drivable over MCP

Join the ArtCraft community on Discord

WordCraft on getartcraft.com · ArtCraft · All Crafting Apps


WordCraft with the Home tab of the ribbon open over a two-page document titled The Open Studio Handbook. The Navigation pane on the left lists the document's headings, the Styles gallery shows live previews of Normal, Heading 1, Title and Subtitle, and a word in the first paragraph is selected.
The Open Studio Handbook, WordCraft's built-in sample: the ribbon, live Styles gallery, rulers and the Navigation pane.

[!NOTE] ArtCraft is a community of artists from all walks of life. Painters, photographers, filmmakers, illustrators, designers, animators, hobbyists, and people who picked up a pencil last week. If you make things, you're one of us. Come say hi on Discord.

A tour · Why WordCraft · What works today · Quick start · For agents · Architecture · Roadmap · Downloads · The Crafting Apps · License and credits

A tour

Every screenshot below is WordCraft itself, rendered offscreen by its own UI test harness (cargo run -p wordcraft-ui-egui --example ui_shot).

The Review tab with Track Changes on: the word forty is inserted in magenta and thirty struck through; three commented phrases are shaded and joined by dashed leader lines to comment balloons in a grey markup area to the right of the page

Review. Track changes, comment balloons in the margin, accept and reject, spelling and grammar as you type.

The References tab with two pages side by side: a table of contents with dotted leaders and page numbers on page one, and a styled table, numbered list and hyperlink on page two

References. Tables of contents, footnotes, citations in APA, MLA, Chicago or IEEE, index and captions.

The Design tab showing style-set previews; the document is set in a serif theme with plum headings underlined by thin rules and a pale diagonal DRAFT watermark behind the text

Design. Themes, style sets, paragraph spacing, watermarks, page colour and borders.

WordCraft in dark mode with the Insert tab open and formatting marks shown: pilcrows at paragraph ends and dots for spaces

Dark mode with formatting marks, and the Insert tab: tables, pictures, shapes, links, headers, footers, fields and symbols.

The Layout tab at 80% zoom: the first paragraph opens with a three-line drop cap E, a dark blue circle sits beside the second section with its paragraph wrapping around it and hyphenating art-ist at the line end, every line is numbered in the left margin and a thin blue border surrounds the page

Layout. Drop caps, text wrapping around pictures and shapes, automatic hyphenation, line numbers and page borders.

The File tab start page with a Good morning greeting, thumbnails of the Blank document, Studio handbook, Letter, Résumé and Report templates, and a list of recent documents

File. Start from a template, open recent documents, edit properties, export to PDF and other formats.

Why WordCraft

What works today

Area Highlights
Writing Fast typing with IME, smart quotes, AutoCorrect, list autoformat (* , 1. ), dashes; word, sentence, paragraph selection; drag-select; clipboard with formatting; undo/redo; find and replace with regex
Formatting Fonts, sizes, bold/italic/underline styles, strike, sub/superscript, caps, highlight, colours, character spacing, Format Painter, Change Case, Clear Formatting
Paragraphs Alignment, indents (draggable on the ruler), spacing, line spacing, tabs with leaders, borders, shading, keep with next, widow/orphan control
Styles Built-in style set, live gallery, Styles pane, create/modify/update styles, style sets, themes
Lists Bullets, numbering, multilevel, restart, set value, custom formats
Tables Insert by grid, merge/split, styles with banded rows, borders, shading, header rows repeated across pages, rows that split across pages, sort, formulas, text ↔ table
Pages Margins, orientation, size, columns, page/column/section breaks, headers and footers (first page, odd/even), page numbers, watermark, page borders, line numbers, vertical alignment, drop caps, automatic hyphenation
Objects Pictures (resize, crop, recolour, brightness/contrast, transparency, background removal, picture styles, rotate), shapes, text boxes, floating position with text wrapping (square, top and bottom, behind or in front of text)
References Table of contents, footnotes and endnotes, citations and bibliography (APA, MLA, Chicago, IEEE), captions, table of figures, cross-references, index, table of authorities
Review Spelling and grammar with suggestions, thesaurus, word count, comments in margin balloons or a pane, track changes, accept/reject, compare documents, restrict editing, accessibility checker, document inspector
Mailings Mail merge from CSV, merge fields, address block, greeting line, rules, preview, finish to a document; envelopes and labels
View Print layout, web layout, draft, read mode, focus, zoom, one/multiple pages, page width, Navigation pane, rulers, gridlines, dark mode; interface in English, 简体中文, 繁體中文, 日本語, Português (Brasil), Español, Українська, Српски / Srpski or Eesti (follows the system language by default)
Files .docx read/write (opens in Word), Word 97-2003 .doc import, PDF export, .odt, .rtf, .html, .md, .tex, .txt import/export, page images

The honest picture, area by area, is in ROADMAP.md, the parity assessment and the generated feature checklist.

Quick start

git clone https://github.com/storytold/wordcraft
cd wordcraft
cargo run --release -p wordcraft -- --sample        # the desktop app with the sample document
cargo run --release -p wordcraft -- report.docx     # open a document

Command line:

wordcraft-cli convert report.docx report.pdf        # docx, pdf, odt, rtf, html, md, tex, txt, png
wordcraft-cli text report.docx                      # plain text
wordcraft-cli inspect report.docx                   # structure as JSON
wordcraft-cli run --template sample \
  --cmd 'select.text={"text":"Membership"}' --cmd format.bold --save out.docx

Web: cd apps/wordcraft-web && trunk serve, then open http://127.0.0.1:8771/?sample.

For agents: CLI and MCP

WordCraft was designed to be driven by people and by AI agents.

claude mcp add wordcraft -- wordcraft-cli mcp                  # headless documents
wordcraft --control 7981 &                                     # or drive the running app…
claude mcp add wordcraft-app -- wordcraft-cli mcp --connect 127.0.0.1:7981

Tools include list_commands, execute, batch, type_text, select_text, inspect_document, render_page, save_document, and, with a running app, screenshot, click and key. Agents can check their work through inspect_document without screenshots. See docs/mcp.md and the control protocol. Macros record any sequence of commands and play it back (tools.recordMacro, tools.macros).

Logs

The desktop app writes its log records to standard error and to logs/wordcraft.log next to its preferences: on Linux $XDG_CONFIG_HOME/wordcraft/logs/ (by default ~/.config/wordcraft/logs/), on macOS ~/Library/Application Support/WordCraft/logs/, on Windows %APPDATA%\WordCraft\logs\. A start from a desktop menu or the Dock has no terminal, so this file is what to attach to a bug report: unreadable parts of a .docx, pictures or fonts a PDF export had to leave out and panics the command guard recovered from land there. Each launch moves the previous log to wordcraft.1.log (and that one to wordcraft.2.log), so the log of a run that crashed survives the next start; a log stops growing at 16 MiB. --version writes no file, and runs with WORDCRAFT_NO_PREFS (agents' test runs) log to standard error only. Document text is never logged; a panic message leaves out the text it quotes.

By default WordCraft's own crates log at info and everything else at warn. RUST_LOG replaces that with env_logger-style directives, for example RUST_LOG=debug, RUST_LOG=warn,wordcraft_docx=trace or RUST_LOG=info,wgpu_core=warn; a directive ending in * covers every target starting with it (wordcraft*=debug). The logger is apps/wordcraft/src/logging.rs.

Architecture

Layer Crate Job
L0 wordcraft-geom units and measurements
L1 wordcraft-doc, wordcraft-fonts, wordcraft-proof document model and editing; fonts and shaping; spelling, grammar, hyphenation
L2 wordcraft-layout, wordcraft-docx, wordcraft-formats line breaking, pagination, tables, notes, hit testing; OOXML; ODT/RTF/HTML/Markdown/TXT
L3 wordcraft-render, wordcraft-pdf rasteriser (vello_cpu); PDF (krilla)
L4 wordcraft-engine session, undo, 422 commands, Word feature catalog
L5 wordcraft-mcp MCP server
L6 wordcraft-ui-egui the Word-style front end (swappable)
apps wordcraft, wordcraft-cli, wordcraft-web desktop, command line, browser

cargo xtask ci runs formatting, clippy, ~800 tests, the asset-attribution check, the layering check and the wasm build. Contributor and agent instructions: AGENTS.md.

Roadmap

WordCraft is in alpha. It covers 88% of Word's ribbon features with commands today; counting depth, file fidelity, stability and the rest, we estimate it is about 60% of the way to replacing all of Word for real work, about 55% for a typical professional's weekly work and about 63% for everyday essentials. Beta needs testing against real-world .docx files, keeping charts and SmartArt through a round trip, pagination closer to Word's, a stability sweep and native printing. Details and estimates: ROADMAP.md and where we fall short.

Downloads

Download WordCraft from GitHub: the latest release has every build listed below, and all releases has earlier versions and their notes. <ver> in the file names is the version number, and SHA256SUMS.txt lists a checksum for every file.

Windows

Build Installer Portable
x64 (64-bit Intel/AMD) wordcraft-<ver>-windows-x64.msi wordcraft-<ver>-windows-x64-portable.zip
arm64 (Snapdragon and other ARM PCs) wordcraft-<ver>-windows-arm64.msi wordcraft-<ver>-windows-arm64-portable.zip
x86 (32-bit) wordcraft-<ver>-windows-x86.msi wordcraft-<ver>-windows-x86-portable.zip

Installers and executables are code-signed.

If the app doesn't open on Windows: the desktop app initializes only DirectX 12 by default. Letting wgpu also create an OpenGL instance can crash some graphics drivers (AMD's atio6axx.dll) before the window appears, so the app would flash in Task Manager and quit. WGPU_BACKEND overrides the default for troubleshooting (for example dx12 or vulkan). In PowerShell, from the folder containing the executable:

$env:WGPU_BACKEND = "vulkan"
& .\wordcraft.exe
Remove-Item Env:WGPU_BACKEND                     # restore the default for later launches

An explicit gl override can bring the driver crash back on affected systems. The macOS, Linux and web backend defaults are unchanged.

If the app is slow on an older Windows PC: when DirectX 12 finds no graphics card with a driver for it (for example Intel 4th-generation graphics on Windows 11), it only offers Microsoft's software renderer, which draws every frame on the processor. In that case WordCraft uses OpenGL instead, without setting anything. The log file records the choice (lines starting with graphics:). WGPU_BACKEND still overrides it, e.g. $env:WGPU_BACKEND = "gl" or "dx12".

macOS

Build File Notes
App, universal (Apple silicon + Intel) wordcraft-<ver>-macos-universal.dmg Signed and notarized
Command-line tool, universal wordcraft-cli-<ver>-macos-universal.zip Signed and notarized

Linux

Format x86_64 aarch64 (ARM64) Notes
AppImage wordcraft-<ver>-linux-x86_64.AppImage wordcraft-<ver>-linux-aarch64.AppImage Runs anywhere; updates itself with AppImageUpdate (.zsync files)
Flatpak wordcraft-<ver>-linux-x86_64.flatpak wordcraft-<ver>-linux-aarch64.flatpak Sandboxed; flatpak install --user <file>
Debian/Ubuntu wordcraft-<ver>-linux-x86_64.deb wordcraft-<ver>-linux-aarch64.deb
Fedora/RHEL/openSUSE wordcraft-<ver>-linux-x86_64.rpm wordcraft-<ver>-linux-aarch64.rpm
Tarball wordcraft-<ver>-linux-x86_64.tar.gz wordcraft-<ver>-linux-aarch64.tar.gz Unpack anywhere

RISC-V (riscv64): wordcraft-<ver>-linux-riscv64.tar.gz, a tarball cross-compiled for glibc 2.39+ (Ubuntu 24.04, Debian 13 and newer).

FreeBSD

Build File
x86_64 wordcraft-<ver>-freebsd-x86_64.tar.gz

Web (WebAssembly)

Build File Notes
Static site wordcraft-web-<ver>.zip Runs in a modern browser; host it on any static server

The Crafting Apps

WordCraft is one of the Crafting Apps: free, open-source creative tools from the ArtCraft team, each written from scratch in Rust and each able to stand on its own.

App What it's for Code Learn more
PhotoCraft Image editing: layers, masks, type and real PSD files GitHub Website
VectorCraft Vector illustration GitHub Website
FilmCraft Video editing, color and sound GitHub Website
LightCraft Photo library and raw development GitHub Website
PdfCraft Reading, organizing and protecting PDFs GitHub Website
EffectCraft Motion graphics and visual effects GitHub Website
DesignCraft Page layout and publishing GitHub Website
WordCraft Writing and document design · you are here GitHub Website

And ArtCraft itself, our AI image and video studio for artists who want real control.


Join the ArtCraft community on Discord

Come make things with us

Our Discord is where artists of every kind hang out: people who paint, shoot, draw, cut film, set type, and people still figuring out what they like to make. Share what you're working on, ask for help, tell us what's broken, or tell us what you wish these tools could do. Whatever your medium and however long you've been at it, you're welcome here.

discord.gg/artcraft · getartcraft.com · The Crafting Apps · WordCraft

License and credits

WordCraft is dual-licensed under MIT or Apache-2.0, at your option. Copyright (c) 2026 ArtCraft Team and the WordCraft contributors. Required notices are in NOTICE.

Bundled fonts, icons, images and other assets keep their own open licenses; each one is listed with its author, source and license in ATTRIBUTION.md.

The spelling dictionary and hyphenation come from Grady Ward's public-domain Moby Hyphenator II word list. The sample documents and templates are original text written for WordCraft.

The ArtCraft name, wordmark and logos in docs/brand/ are trademarks of the ArtCraft Team and are not covered by this license. They may be used only unmodified, and only as part of this repository and WordCraft, under docs/brand/LICENSE-brand.txt. Forks and modified versions must remove them.

Microsoft and Microsoft Word are trademarks of the Microsoft group of companies. Adobe, Photoshop, Illustrator, Premiere Pro, Lightroom, Acrobat, After Effects and InDesign are trademarks or registered trademarks of Adobe Inc. in the United States and/or other countries. WordCraft is an independent, open-source project and is not affiliated with, sponsored by or endorsed by Microsoft Corporation or Adobe Inc.; these names are used only to describe the workflows it is compatible with.

ArtCraft
Made by the ArtCraft team and community.

wordcraft (storytold/wordcraft)

Searching Database…

14.4K ·GitHub
这是什么?WordCraft 是一个开源项目,用纯 Rust 从零重新实现了 Microsoft Word 的功能:这是一款文字处理软件,带有你熟悉的 Word 工作流程——功能区、样式、表格、修订、引用、邮件合并——由 ArtCraft 团队开发。
它是桌面应用,还是能在浏览器里运行?两者都可以,来自同一套 Rust 代码库:macOS、Windows、Linux 和 BSD 的原生应用用 egui 直接在 GPU 上渲染(不依赖 Electron 或 Tauri),另外还有 WebAssembly 版本,可以在任何现代浏览器里运行。
用这个需要装 Microsoft Office 或者订阅吗?不需要。WordCraft 是独立运行的:它自己就能读写 .docx 文件。项目也强调它是独立的,和 Microsoft 没有任何隶属或认可关系——拿 Word 来比较只是为了说明兼容的工作流程。
有什么坑需要注意吗,尤其是在 Windows 上?Windows 版本只以 DirectX 12 启动,部分 AMD 显卡驱动会在窗口出现前崩溃(应用在任务管理器里闪一下就退出);可以通过 WGPUBACKEND 变量(比如 vulkan)强制更换图形后端。没有 DX12 驱动的老电脑会自动回退到 OpenGL。
使用时需要联网吗?不需要——README 强调它注重隐私:拼写、语法检查以及其他所有功能都能离线使用,网页版是一个静态网站,可以托管在任何地方。
那它已经是一个能完全替代 Word 的成品了吗?部分是。README 的 'What works today' 表格列出了写作、排版、样式、列表、表格、页面、对象、引用、审阅、邮件合并和多种视图模式等功能已经可用,ROADMAP.md 里还有一份功能对比评估,如实跟踪其余部分的进展。
它内置了哪些引用和文献工具?目录、脚注和尾注、引文以及支持 APA、MLA、Chicago 或 IEEE 格式的参考文献,还有图表题注、图表目录、交叉引用、索引和判例引注表。
处理超大的文档时速度快吗?很快:段落排版有缓存,在一份 188 页的文档里打字,重新排版大约只需 1.4 毫秒,而且页面是按需渲染的。
ArtCraft 是什么?为什么一个艺术家团队要做文字处理软件?ArtCraft 是一个艺术家社区——包括画家、电影人、设计师和爱好者——致力于打造一系列免费开源的创作工具,每一款都用 Rust 从零编写:PhotoCraft、VectorCraft、FilmCraft、LightCraft、PdfCraft、EffectCraft 和 DesignCraft,其中 WordCraft 负责写作。
Creator
storytold
Size
21.1 MB
Stars
14.4K
Age
12d
Commits · 90 Days