Skip to content

0.17.0

Choose a tag to compare

@github-actions github-actions released this 06 Aug 08:01
· 55 commits to main since this release

Murmuration Writing Companion 0.17.0 — V2

Version 0.17.0 is the V2 release of Murmuration Writing Companion.

V2 brings manuscript preparation, project readiness, continuity review, Story World analysis, references, visual graphs and safer editorial storage into one connected Obsidian workflow.

Your manuscript, Story World and structural metadata remain ordinary Markdown in your own vault.

Highlights

Understand the project before changing it

Project Readiness inspects the vault and explains whether each Book is ready, can be prepared, or contains a structural conflict.

Opening readiness is read-only. Murmuration Writing Companion does not create editorial storage merely because the plugin or a view has been opened.

Benefit: understand what the plugin has found before allowing it to make changes.

Prepare an existing manuscript safely

The preparation workflow recognises existing Book, Part and Scene structures, previews every proposed metadata change and converts supported legacy ordering into authoritative distributed ordering.

Preparation now includes a clearly labelled immediate Undo action.

Undo restores the original Markdown exactly, including absent properties, formatting and line endings.

Benefit: bring an established manuscript under structured management without rebuilding it or losing control of the source files.

Navigate Books, Parts and Scenes

The Manuscript Navigator presents the authoritative reading order for:

  • Books;
  • Parts;
  • Scenes within Parts;
  • Scenes placed directly beneath a Book.

It also supports safe reordering, structural diagnostics, title and filename alignment, and conservative removal of empty Books and Parts.

Benefit: manage a long manuscript without relying on filename prefixes, folder order or memory.

Build a connected Story World

The Story World Navigator and Entity Inspector support:

  • Characters and intelligences;
  • Locations;
  • Organisations;
  • Technologies;
  • Events;
  • References;
  • Other entities and supporting models.

Relationships remain explicit authored Markdown and can be added, edited, superseded or removed through previewed workflows.

Benefit: keep the people, places, institutions, technologies and sources behind a complex story consistent.

Review continuity with evidence

Continuity Review and Story World Review identify issues including:

  • broken or unresolved references;
  • malformed relationships;
  • chronology conflicts;
  • missing context;
  • classification problems;
  • lookup collisions;
  • provenance issues.

Observations retain the supporting evidence needed to judge whether a finding is a genuine problem.

Benefit: find continuity errors before publication without surrendering editorial judgement to the software.

Explore the Story World visually

The Story World Graph presents:

  • explicit relationships;
  • event and participant links;
  • manuscript-provenance edges;
  • entity-type shapes;
  • event chevrons;
  • provisional status styling;
  • bounded traversal and density controls.

Benefit: understand how the fictional world fits together and trace each connection back to its manuscript source.

Track chronology and manuscript impact

Dated Events and Scenes can be examined through chronology, event–scene mapping and entity-impact views.

Benefit: detect impossible sequences, unexplained gaps, premature references and entities that disappear from the manuscript without resolution.

Manage references and research provenance

Reference entities support author, title, journal, publisher, publication details and links, together with associations to manuscript Scenes and Story World material.

Benefit: keep research evidence connected to the writing it informs.

Generate a printable entity index

The Entity Index report can cover a selected Book or the whole vault, with category filters, canonical entity names and links to relevant Scenes.

Benefit: create an editorial reference document directly from the Story World.

Editorial data and storage safety

Manuscript structure, chapter properties, Story World entities, relationships, event times and references remain authoritative Markdown.

Portable editorial information is stored separately in:

.murmuration/writing-companion/editorial-data.json

V2 adds:

  • no-write clean startup;
  • atomic storage updates;
  • exact state restoration after save failures;
  • actionable malformed-storage diagnostics;
  • protection against unsupported newer schemas;
  • migration from previous storage formats;
  • backup and recovery safeguards.

Validation

V2 was validated through automated and interactive procedures covering:

  • clean installation;
  • same-build reinstall;
  • upgrade from the public 0.16.0 release;
  • existing-manuscript preparation;
  • exact immediate Undo;
  • stale-preview rejection;
  • forced-write rollback;
  • editorial storage failure and retry;
  • malformed and newer-schema storage protection;
  • real manuscript migration and Undo;
  • Linux and Windows Obsidian environments.

Installation and upgrade

This release requires Obsidian 1.5.0 or later.

For a manual installation or upgrade, replace all three plugin files together:

  • main.js
  • manifest.json
  • styles.css

Place them in:

<Vault>/.obsidian/plugins/murmuration-writing-companion/

Restart or reload Obsidian, then enable Murmuration Writing Companion.

Always use the three files published together with the 0.17.0 release.

Documentation and examples

The repository includes:

  • a V2 onboarding guide;
  • command reference;
  • troubleshooting and recovery guidance;
  • prepared and migration example vaults;
  • release-validation procedures;
  • onboarding screenshots.

For the full technical change list, see the changelog. The tagged 0.17.0 changelog identifies V2 manuscript onboarding and preparation, exact Undo, Project Readiness, expanded Story World workflows, and validated Linux and Windows support.