NovelSmith
pendingby Pal Chung
A comprehensive, Scrivener-inspired writing environment. Features seamless scenes merging, version control, and color-coded scene management.
🖋️ NovelSmith: A Writer's Forge for Obsidian
Hello fellow writers.
I am a novelist who primarily writes on an iPad. Like many of you, I fell in love with Obsidian for its sheer simplicity and focus. But as my manuscripts grew longer and more complex, I found myself longing for the structural power of professional writing software—without sacrificing the clean, distraction-free environment of a local markdown vault.
I couldn't find a tool that perfectly fit this workflow, so I built NovelSmith. It was born out of my own struggles with drafting, organizing, and navigating the messy middle of a book. I’m sharing it here, hoping it might help you forge your stories with a little more peace of mind.
NovelSmith is built entirely on four quiet, but firm, philosophies:
1. 📱 Mobile First
Inspiration doesn’t only strike at a desk. Because my primary writing device is an iPad, I designed NovelSmith’s interface to feel natural and responsive on touch screens. Whether you are dragging scene cards across the Corkboard or swiping through your world-building Wiki, the experience remains fluid. You can take your manuscript to a coffee shop and sculpt your story comfortably on a tablet.
2. ✍️ Writing First
A good writing tool should be invisible until you need it. When you sit down to write, you shouldn't have to fill out complex forms, configure YAML frontmatter, or manage databases. You should just face the page.
You can write thousands of words without even noticing this plugin exists. When you finally feel the need to structure the chaos, simply "Insert Scene Card" (a H6 heading + a callout). NovelSmith quietly wakes up, reads your structure, and offers its help. It adapts to your creative flow, never the other way around.
3. 📝 Markdown First
Your words belong to you. NovelSmith operates with absolute zero lock-in. I don't hide your manuscript or worldbible information inside proprietary JSON files or fragile index documents.
This philosophy extends to the plugin's most powerful features. When you use the global Corkboard to drag a scene into a completely different chapter, or when you reorder entire chapters, NovelSmith isn't just updating a virtual database. It is quietly and safely moving and renaming your actual, native Markdown files in the background. Your native Obsidian file explorer remains the single source of truth — always clean, always accurate, and entirely yours. If you uninstall NovelSmith tomorrow, your book remains perfectly structured.
4. 🤝 Community First
The Obsidian community has already built incredible tools, and NovelSmith respects that ecosystem. Instead of reinventing the wheel with heavy, custom chart libraries, the Dashboard simply generates standard Dataview code. This keeps the plugin remarkably lightweight and allows advanced users to freely customize their writing stats using the tools they already know and love.
This plugin has already submitted to Obsidian and awaiting for their approval. You may find more features of this plugin from below introduction.
Mates, happy writing. Share the world of your masterpieces !
⚔️ NovelSmith (Beta)
Forge your novel, one scene at a time. NovelSmith is a comprehensive, Scrivener-inspired writing environment built directly into Obsidian. It transforms your vault into a powerhouse for long-form fiction writing, offering seamless chapter merging, atomic version control, dynamic outlining, intelligent worldbuilding, and no-code data analytics—all without breaking standard Markdown.
🎮 Try the Demo Vault (Interactive Tutorial)
Before installing NovelSmith on your precious manuscript, I highly recommend downloading the NovelSmith Demo Vault. This is not just a showcase—it serves as an interactive, hands-on tutorial. You can safely play around with Scrivenings Mode, drag and drop scene cards, and test the atomic backup features using the dummy text provided. It's the fastest way to understand how the plugin works!
🏗️ Core Architecture: Chapters vs. Scenes (Crucial for Scrivener Users)
If you are transitioning from traditional novel-writing software, you might be accustomed to the "1 File = 1 Scene" structure, where Chapters are simply folders. NovelSmith takes a different, Obsidian-optimized approach:
- 1 Markdown File = 1 Chapter: To prevent your Obsidian vault from becoming cluttered with hundreds of tiny files (and to keep your Graph View clean), NovelSmith treats each physical
.mdfile as a complete Chapter. - Scenes live inside the Chapter: Within that Chapter file, you divide the text into smaller, modular Scenes using
###### 🎬 Scene Nameheaders and Callout blocks for metadata. - The Structure View Magic: NovelSmith's custom right-sidebar reads these
######headers and transforms them into draggable, color-coded "Scene Cards". - Why this matters: This design allows you to scroll and read a whole chapter naturally in Obsidian without needing to compile, while the plugin still gives you the granular power to drag, drop, split, merge, and back up individual scenes within that chapter.
✨ Core Features
📚 Scrivenings Mode (Seamless Draft Editing)
Tired of jumping between dozens of chapter files?
- Merge & Edit: Combine multiple chapter files into one continuous, temporary draft for seamless reading and editing.
- Smart Sync (ID-Protected): Click "Sync", and NovelSmith will intelligently distribute your edits back to their original chapter files using invisible, conflict-free tracking IDs.
- Safe Archiving & Discarding: Option to archive your merged drafts with timestamps instead of deleting them. Realize your edits went wrong? Just click "Discard Draft" to safely trash the temporary file without touching your original chapters.
🗂️ Interactive Structure View & Global Plot Management
A custom right-sidebar control panel designed for novelists. (Fully optimized for Mobile and Touch devices!)
- Cross-Chapter Migration (Drag & Drop): When in Scrivenings Mode (merged draft), you can drag and drop scenes across different chapters! Seamlessly migrate a scene from Chapter 1 to Chapter 3 without manual copy-pasting. Changes sync instantly to your manuscript with zero-trace replacement (preserving your
Ctrl+ZUndo history!). - Color-Coded Scene Cards: Insert, split, or merge scenes with a single click. Assign colors (Red for Conflict, Blue for POV, etc.) to your Scene Cards to visually map out your plot in the sidebar.
- Precision Merging: Use the "Merge Scene" command to flawlessly absorb text from one scene into another based on their unique IDs.
🌍 Auto Wiki & Dynamic Worldbuilding (New)
Your World Bible is now fully integrated and always just one click away.
- Smart Attribute Scanning: Click "Auto Wiki", and NovelSmith will safely scan your scene callouts (e.g.,
> - Characters:: Alice, Bob). It intelligently splits names and automatically generates beautifully linked lore notes inside your Wiki folder using your custom templates. - Dynamic Info Tab: The sidebar's "Info Tab" acts as a context-aware World Bible. As you write, it automatically lists the characters, locations, or magic items present in your current scene as clickable interactive chips.
- Lazy-Load Reading & Instant Editing: Click a character chip to instantly read their lore note in the side panel without lagging your device. Need to update a character's backstory? Click the ✏️ icon to open their note in an adjacent pane—your side panel will live-update the rendered text as you type!
🗺️ Worldboard (Visual Relational Canvas) [NEW]
Transform your raw markdown notes into a stunning, interactive world Bible without filling out static forms.
- Data-Driven & Zero Friction: NovelSmith reads your existing Obsidian YAML properties (e.g.,
Wife: [[Alice]]). It automatically generates interconnected nodes and relationship arrows. No proprietary databases, no lock-in. - Physics & Hierarchy Layouts: Choose "Network" mode for complex character relationships (bouncing physics engine), or "Hierarchy" mode for strict, top-down trees (perfect for geographical maps, magic systems, or organization charts).
- Orbiting Satellite Nodes: Mention an artifact (e.g.,
[[Holy Sword]]) in a character's note? It appears as a smaller "satellite" node orbiting the character, allowing you to visualize cross-category relationships effortlessly. - Dimension Jump Navigation: Click a satellite node to instantly teleport to its native category canvas (e.g., jumping from the Characters board to the Items board). A convenient "Return" button snaps you right back to your previous focus.
- Drag & Pin (Clean Data): Drag any node to position it exactly where you want. The physics engine turns off, and its coordinates are saved silently in the plugin's background—keeping your manuscript's markdown files completely clean and untouched.
- Interactive Preview Panel: Click any node to slide out a beautifully rendered, read-only preview of the note and its properties. Need to make a change? Click the ✏️ icon to open the file and watch your canvas update instantly.
📊 Dashboard Builder (No-Code Analytics) (New)
Transform your writing progress into a data control center, no coding required! Powered by Dataview and Mermaid JS.
- Visual BI Generator: Click "Insert Dashboard" to open a visual, user-friendly UI. Select the attributes you want to analyze (e.g., POV, Status, Rhythm) and the plugin will dynamically generate the complex queries for you.
- Multiple Render Modes: * 🥧 Pie Charts: Perfect for visualizing POV distribution or draft completion percentages.
- 📊 Bar Charts: See which characters have the highest appearance rates.
- 🗂️ DQL Tables: Generate powerful "Writing Progress Lists" (grouped by chapter) or "Character Trackers" (e.g., "Show me the last 3 scenes this character appeared in to check continuity").
- Smart Flattening: The engine automatically handles arrays (e.g., splitting
[[Alice]], [[Bob]]into individual metrics) seamlessly behind the scenes.
💾 Atomic Version Control
Stop duplicating entire files just to save a backup of a single scene.
- Scene-Level Backups: Save versions of individual scenes.
- History Browser: View the backup history of any scene you click on in the Structure View.
- Preview & Restore: Preview past versions in a side pane and restore them with one click without affecting the rest of the chapter.
🛠️ Intelligent Writing Aids
- Redundant Word Highlighter: Define a list of your overused words or cliches. NovelSmith will highlight them in real-time. It's fully optimized to sleep when deactivated, saving battery on laptops and iPads.
- Dialogue Focus Mode: Dims all descriptive text, allowing you to read and refine only the spoken dialogue.
- CorrectName (Auto-Fixer): A built-in proofreader. Define common misspellings of your character names, and fix them all across your current chapter with one click.
- Clean Draft: Instantly strips out highlights, strikethroughs, and internal links (converting
[[Location]]toLocation) when you're ready to finalize a chapter.
📤 Manuscript Compiler
Ready to publish? The Compiler merges your chapters into a clean, final manuscript.
- Strips out all system IDs, metadata, and scene cards.
- Handles Windows/Mac line endings flawlessly.
- Outputs a clean, standard Markdown file ready for conversion to PDF, EPUB, or Word.
🚨 Best Practices & Important Warnings
To ensure the absolute safety of your manuscript, please keep these rules in mind:
- Do NOT Copy-Paste Scene Cards: Every scene has a unique invisible ID. If you copy and paste a whole scene card, you will duplicate the ID. Always use the "Insert Scene Card" or "Split Scene" command.
- Lockdown during Scrivenings Mode: When you are editing a merged draft, do not rename, move, or edit the original chapter files in your file explorer. Finish your edits in the draft, click "Sync", and then manage your other files.
- DO NOT DELETE OR MODIFY structural markers in the temporary draft:
- Chapter Headings (e.g.,
# 📄 Chapter 1) - File ID Markers (e.g.,
<span class="ns-file-id">++ FILE_ID: ... ++</span>) NovelSmith relies strictly on these IDs as anchors. Modifying them will cause the sync process to fail!
- Chapter Headings (e.g.,
- Use "Smart Save" (Ctrl+S / Cmd+S): It automatically assigns IDs to newly written scenes and updates your shadow database in the background.
- Respect the
_BackstageFolder: Do not manually edit the files insideHistoryor the_Scene_Database.md. Let the system manage them! - Keep Novel Text outside of Callouts: Ensure your actual novel text is written below the
> [!NSmith]block, not inside it, or it will be stripped out during compilation!
🚀 Installation
Manual Installation:
- Download the latest
main.js,manifest.json, andstyles.cssfrom the Releases page. - Create a folder named
novelsmithinside your vault's.obsidian/plugins/directory. - Place the downloaded files into the
novelsmithfolder. - Reload Obsidian and enable NovelSmith in the Community Plugins settings.
⚙️ Getting Started & Settings
To get the most out of NovelSmith, configure your workspace:
- Designate a Book Folder: NovelSmith's features will only activate within this specific folder to protect your other Obsidian notes.
- Initialize: Click the "Initialize Now" button in the settings to automatically generate your
_Backstagefolder and a customizableNovelSmith_Template.mdscene card. - Configure Auto Wiki: Set your Wiki storage folder and define your dynamic Worldbuilding categories (e.g., POV, Location, Magic) in the settings.
🤝 Contributing & Support
Contributions, issues, and feature requests are highly welcome! If this plugin helped you forge your novel and you'd like to support its continued development, consider buying me a coffee:
This project is licensed under the MIT License.
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.