- Go 39.9%
- Vue 30%
- JavaScript 22.7%
- Java 4.7%
- Shell 1.6%
- Other 1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
build-bot
9d35b2c236
## [1.23.3](https://code.legionsalliance.com/WritersNotebook/WritersNotebook/compare/v1.23.2...v1.23.3) (2026-09-23) ### Bug Fixes * **build:** expect the installer at the name NSIS actually writes ([ |
||
| .claude | ||
| .forgejo/workflows | ||
| build | ||
| docs | ||
| frontend | ||
| graphify-out | ||
| internal | ||
| references | ||
| scripts | ||
| .env.example | ||
| .gitattributes | ||
| .gitignore | ||
| .releaserc.json | ||
| about_test.go | ||
| app.go | ||
| app_analysis.go | ||
| app_analysis_test.go | ||
| app_backup.go | ||
| app_debug.go | ||
| app_edit_position_test.go | ||
| app_extensions.go | ||
| app_fonts.go | ||
| app_import.go | ||
| app_sprint_sounds.go | ||
| app_sprints.go | ||
| app_sprints_test.go | ||
| app_structure.go | ||
| app_structure_test.go | ||
| app_updates.go | ||
| app_updates_test.go | ||
| callgo_contract_test.go | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| desktop.go | ||
| desktop_test.go | ||
| dmgbuild_settings.py | ||
| EXTENSION_DEV.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| Taskfile.yml | ||
README
Documentation: Writers Notebook Wiki
Extension Development
- Developer guide and schema: EXTENSION_DEV.md
- Extension feature design details: docs/design/extensions-feature.md
Quick Install
- Windows: Jump to Windows install
- Linux: Jump to Linux install
- MacOS: Jump to MacOS Install
About Writers Notebook
Welcome to the Writers Notebook. This tool was designed to help writers gather their thoughts and develop the world, plots, characters, and everything else necessary to bring their creative vision to the page.
This tool, like many stories, is a retelling of several other such tools but mostly inspired by Manuskript.
Binary Installation
For convenience there are several pre-built binaries that you may install or run directly (portable).
NOTE: The binaries are not currently signed so you will likely get warnings from MacOS or Windows.
Apple instructions for unsigned apps
MacOS Installation
- Open the Releases page: https://code.legionsalliance.com/WritersNotebook/WritersNotebook/releases
- Download the latest
*.dmgfile - Double-click the
dmgfile to open it - Accept the license
- Drag and Drop the
Writers Notebookapp into the Applications directory in the finder window (follow the arrow) - Open the App
NOTE: You might get an error trying to open the app after install. Go to System Settings > Privacy and Security and scroll to the bottom. There should be an option to allow the app to open. After accepting, it should work.
Apple instructions for unsigned apps
Windows Installation
- Open the Releases page: https://code.legionsalliance.com/WritersNotebook/WritersNotebook/releases
- Download one of these assets for the latest version:
WritersNotebook-vX.Y.Z-windows-amd64-installer.exe(recommended)WritersNotebook-vX.Y.Z-windows-amd64.exe(portable binary)
- If you downloaded the installer, run it and follow the prompts.
- If you downloaded the portable
.exe, place it somewhere likeC:\Program Files\WritersNotebook\and optionally add that folder to your PATH.
Linux Installation
Use one of the following copy/paste commands to fetch and run the repo installer script:
Linux install with curl
curl -fsSL "https://code.legionsalliance.com/WritersNotebook/WritersNotebook/raw/branch/main/scripts/linux_install" -o /tmp/linux_install && chmod +x /tmp/linux_install && /tmp/linux_install
Linux install with wget
wget -qO /tmp/linux_install "https://code.legionsalliance.com/WritersNotebook/WritersNotebook/raw/branch/main/scripts/linux_install" && chmod +x /tmp/linux_install && /tmp/linux_install
The installer downloads the latest WritersNotebook-vX.Y.Z-linux-amd64 release, renames it to writers-notebook, and installs it to a standard PATH location (/usr/local/bin when possible).
Live Development
To run in live development mode, run wails dev in the project directory. This will run a Vite development
server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser
and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect
to this in your browser, and you can call your Go code from devtools.
Building
To build a redistributable, production mode package, use wails build.
scripts/build.sh
scripts/build.sh wraps the same build/sign/notarize/package steps the release
CI runs (.forgejo/workflows/release.yaml, macos-test-build.yaml) so you can
produce any release artifact locally without pushing a commit:
scripts/build.sh list # see all targets
scripts/build.sh mac-app # unsigned .app
scripts/build.sh mac-dmg # unsigned .app + .dmg installer
scripts/build.sh mac-app-signed --env-file .env # codesigned .app
scripts/build.sh mac-dmg-signed --notarize # signed + notarized + stapled .dmg
scripts/build.sh windows-portable
scripts/build.sh windows-installer
scripts/build.sh linux
scripts/build.sh linux-server
Signing and notarization read SIGN_IDENTITY, ASC_KEY_ID, ASC_ISSUER_ID,
and ASC_KEY_P8 from the environment or a .env file (never committed --
see .gitignore); run scripts/build.sh --help for the full reference and
scripts/build.sh <target> with a var missing to see exactly what it needs.
MacOS DMG Build
To build a MacOS DMG-based installer we'll use the dmgbuild Python utility.
Install the pre-requisites:
pipx install dmgbuild
Build the .app and then the dmg that bundles it:
wails build
dmgbuild -s dmgbuild_settings.py -s dmgbuild_settings.py "Writers Notebook Installer" "Writers Notebook Installer.dmg"