Truce Editor

Your documents, shared between your devices and people,
with no server in the middle.

Why Truce

• No central server. Devices sync directly with each other, peer to peer, through Syncthing. There's no account to create and no cloud to trust: your files stay on your devices.
• Works on any network, even offline. Each device syncs with whichever others it can reach right now: at home, across the internet, or just over a private network or a phone's hotspot with no internet at all. As devices come and go, editing carries on.
• Conflicts are caught, never lost. When two devices change the same document at once, Truce notices, shows both versions side by side and lets you choose. Nothing is overwritten behind your back, and backups of the last 7 days let you go back.
• Plain files you own. Documents are ordinary Markdown or text files in your own folders. Truce rewrites only the block you edit (a paragraph, a heading, a list item), in the document's own style where it can; everything else stays exactly as it was, byte for byte, so documents stay readable by any other app.
• Built on a trusted sync tool. Syncthing does the syncing; Truce focuses on editing and conflicts. Support for other sync tools can follow.

What it does today

• Markdown documents and checklists, edited visually (lists, styles, drag and drop), as raw Markdown, or read rendered.
• Plain text files (.txt), edited as text.
• Calendars (.ics, the format other calendar apps use): month, week, day and schedule views, tap or drag to add and move events, events that repeat, events imported from another .ics file, a health calendar with a cycle estimate, and a Calendar tab with the events of all your calendars. Changes from two devices merge event by event, with one tap.
• As many folders as you like, subfolders included, each shared with its own devices and people: say one for you and one for the family shopping.
• Search, pins and colors across all of them.
• Undo and redo while editing, and backups of each document from the last 7 days, to compare and restore.
• Android and Linux (Flatpak).

What's coming

• Assisted merge for Markdown and text: Truce suggests a merged version of a conflict for you to accept (calendars merge with one tap already).
• Calendar alerts that ring.
• More kinds of files beyond Markdown, plain text and calendars.
• Windows, macOS and iOS.

Truce is in early development (0.x), so expect changes between versions.

Install

Grab the APK (Android) or the Flatpak (Linux) from the latest release. You need Syncthing running on your devices, with a shared folder for your documents.

To check a download, compare it with SHA256SUMS from the same release. The APK is signed with the key whose certificate SHA-256 is in app/android/release-certificate-sha256.txt.

sha256sum --check --ignore-missing SHA256SUMS
flatpak install --user truce-editor-vX.Y.Z.flatpak

On Linux, --background starts Truce in the tray, e.g. at login, when "Keep running in tray" is on in Settings:

flatpak run io.github.trucefiles.editor --background

Features in pictures

See docs/features.md: screenshots of the main screens and of each new feature.

Markdown support

See docs/markdown.md for what Truce follows from the Markdown standard and where it differs.

Known limitations

See docs/known-limitations.md.

Contributing and security

Ideas, bug reports and pull requests are welcome: see CONTRIBUTING.md. Found a security issue? Please report it privately, as described in SECURITY.md.

License

GPL-3.0-or-later. See LICENSE.

Development

A Dart pub workspace. Sync plugins live in plugins/, file types in types/, each in a folder of its own:

• core: files, sync-tool interfaces, conflict handling and an open file's file owner. Pure Dart, no UI, nothing specific to one sync tool or file type.
• types/markdown/markdown: Markdown documents, read into a doc tree, edited and written back block-exact, with the editor's owner. Pure Dart, no UI; uses core, which knows nothing of it.
• types/plain_text/plain_text: plain text documents, edited as a whole text, with the editor's owner. Pure Dart, no UI; uses core, which knows nothing of it.
• types/calendar/calendar: calendars (iCalendar, .ics), read and written back block-exact, merged event by event, events imported from another file, with repeats, time zones, health entries, cycle predictions and the editor's owner. Pure Dart, no UI; uses core, which knows nothing of it.
• plugins/syncthing/syncthing: Syncthing's conventions behind core's interfaces. Pure Dart.
• plugins/local_folder/local_folder: local folders, which no sync tool syncs or one Truce doesn't know, behind core's interfaces. Pure Dart.
• folders: the folders the user adds, their files through each sync tool, and how their changes are followed. Pure Dart, no UI; uses core.
• files: the files in those folders, their drafts, settings, backups and conflicts, and the open file's page. Pure Dart, no UI; uses core and folders.
• file_page: what a file type's view gets from the page, and gives it, whatever the type. Flutter; uses files.
• types/document_editor: editing text documents on super_editor (Visual edit, Markdown edit, plain text, Read). Flutter; uses core, files, file_page, markdown and plain_text.
• types/calendar/calendar_editor: the calendar views (month, week, day and schedule, on kalender) for the calendar page and the Calendar tab, the event form and the health view. Flutter; uses core, files, file_page and calendar.
• common_ui: UI parts with no app logic, for use across the app: the lazy masonry grid for the cards (items as tall as their content, in columns) and the page width that keeps settings and forms in one centered column on wide windows. Flutter; knows nothing of files.
• app: the Flutter app (Android, Linux): screens, view models, platform code, and the wiring that picks the file types (markdown, plain_text, calendar) and sync tools (syncthing, local_folder).
• test_support: test doubles shared by the packages' tests (a fake sync tool, an in-memory file store). Only a dev dependency.
• editor_test_support: helpers for the editor's widget tests, shared by the editor's and the app's tests. Only a dev dependency.
• lints: analyzer and lint settings shared by all packages.

Needs Flutter 3.47.7. From the repository root:

flutter pub get --enforce-lockfile
dart format .
flutter analyze --fatal-infos
(cd core && dart test)
(cd types/markdown/markdown && dart test)
(cd types/plain_text/plain_text && dart test)
(cd types/calendar/calendar && dart test)
(cd plugins/syncthing/syncthing && dart test)
(cd plugins/local_folder/local_folder && dart test)
(cd folders && dart test)
(cd files && dart test)
(cd common_ui && flutter test)
(cd types/document_editor && flutter test)
(cd types/calendar/calendar_editor && flutter test)
(cd app && flutter test)