All-in-one VS Code extension for novel writing: Character/vocabulary management, dual outlines, heatmaps, time statistics, WebDAV/AutoGit sync, and more.
Novel Helper now offers two versions to meet different user needs. Whether you're a professional writer or an occasional creator, you'll find the version that suits you.
Novel Helper Code
Professional
💻
Powerful extension based on VS Code, providing professional-grade novel creation environment
Transform VS Code into a professional novel writing IDE. Center your world-building, characters, sensitive words, and professional vocabulary around "Setting Collection / Resource Collection," connecting them with chapter files to provide an integrated toolchain from resource management to editing assistance, export/publishing, and cloud synchronization.
Resource Organization: Unified management of novel projects (character libraries, vocabulary libraries, sensitive word lists, regex configurations, chapters and images) in the "Package Manager," supporting sub-package structures and quick creation of common files via right-click.
Setting Collections & References: Character/vocabulary/sensitive word libraries support aliases and color identification, providing intelligent highlighting, hover tooltips, and "Go to Definition," plus building "character reference heatmaps and bubble charts."
Editing Assistance: Smart enter/jump out/auto-complete and full-text quick formatting, typo detection (macro rules and LLM modes), visual annotation sidebar and comment management.
Outlines & Statistics: Dual outlines (directory/files), writing resource explorer (word count and chapter sorting), time statistics status bar (CPM/CPH, sessions and milestones), dashboard visualization.
Visual Editors: Built-in custom editors for managing .ojson5 (character objects), .rjson5 (relationship graphs), .tjson5 (timelines), supporting drag-and-drop and hierarchical timelines.
Template Export: Typst-based template system, supporting built-in/external and single-file templates, export to PDF/PNG/SVG; default template sample, selectable and refreshable in settings.
Cloud Sync & Version Control: WebDAV bidirectional sync (ignore directory/file rules and sidecar metadata), AutoGit auto-commit/pull/push (WIP), unified status bar notifications.
Compatible Formats & Languages: Focus on Markdown/Plaintext/JSON5; extended formats .ojson5/.rjson5/.tjson5, with snippets and completion.
Setting File Formats: Support writing settings and resources in Markdown or JSON5, balancing readability and structure.
First activation prompts whether to activate in the current workspace; can be switched anytime through "Quick Settings" and the command palette. For portable installation packages, please join the QQ group.
Note: WebDAV and AutoGit features are in continuous iteration (WIP). Please backup before use and configure ignore rules and sync strategies carefully to avoid data conflicts.
Core Features
Package Manager: Unified management of settings/chapters/resources, quick creation of common files
Character/Vocabulary/Sensitive Word Libraries: Definition and management (JSON5/Markdown), reference tracking and heatmap visualization
Random Character Generator: Faker-js based intelligent name generation, supporting multiple languages and cultural backgrounds
Portable installation packages are available in the QQ group
For bug reports and suggestions, prioritize GitHub Issues; for instant communication, QQ group is usually fastest.
QQ group also provides video tutorials and resources.
Open Source & Contributing
Novel Helper is released under MPL-2.0. We welcome all forms of contributions: code, documentation, testing, feedback, community maintenance, and promotion.
Submit contributions: Welcome to improve through Pull Requests and Issues.
Participate in discussions: Exchange ideas and plans on GitHub Discussions and QQ group.
Support the project: Star the repository and share with more creators and developers.
We look forward to improving the novel writing IDE experience with the community. Thank you for joining and supporting.
