Skip to content

Repository files navigation

✍️ WebNovel Assistant

English | 中文

GitHub release License Obsidian Downloads

An all-in-one writing studio for novel and story writers in Obsidian.
Accurate word count & goal tracking · Story timeline · Foreshadowing manager · Chapter corkboard · Lore graphs & focus timers.


📖 User Guide 🎥 OBS CSS Guide 📋 Changelog



homepage

✨ Feature Highlights

🏠 Creative Homepage

Full-width Dashboard · Dynamic Welcome · Novel Overview · Stats Panel · One-Click New Novel & Import Novel

homepage

🗂️ Writing Workbench

All Chapters Panel · Timeline Board · Foreshadowing Board · Lore Board · Task Board · Notes Management

workbench

🌑 Immersive Writing Mode

Full-screen Focus · Typewriter Scroll & Line Dimming · Dynamic Dashboard · Slot-based Layout

immersive-mode

📊 Word Count & Goals

3 Counting Modes · Multi-direction Goal Tracking · Strict Chapter Mode · Smart Chapter Sorting · Real-time Word Reminder · Folder Word Count Display

word-count-gutter

⏱️ Focus Time Tracking

Auto focus vs. slack detection · Web Worker · 365 Heatmap · Bar+line trend · Efficiency card

history-chart

📝 Creative Assistants

Foreshadowing Manager
Mark → Multi-stage tracking → Final resolution

foreshadowing
Timeline System
Events, multi-chapter links, custom types

timeline
Chapter Corkboard
Card overview, status & synopsis editing

corkboard
Lore Quick Lookup
Auto-highlight, preset types & relations, relation graph

lore-lookup
Sticky Notes
Auto-save, Markdown render

sticky-note
Task Tracker
Create periodic tasks, self-driven deadlines & voluntary abandon

task
Advanced Search
Search by book, global or custom scope

search
Merge Chapters
Merge all chapters in a folder by sort order

merge
Auto-Create Next Chapter
Auto-create numbered documents, template support

auto-create-next

🎥 OBS Streaming Overlay & 📱 Mobile

🎥 OBS Overlay 📱 Mobile
Real-time writing stats in OBS Floating word count & focus timer widget
Custom style, opacity & content Edge docking & auto-collapse handle
Zero latency, zero disk I/O Copy Document — one-click with title prepended

📥 Installation

Method Steps
Community Plugins (Recommended) Settings → Community Plugins → Browse → Search "WebNovel Assistant" → Install → Enable
BRAT Install BRAT → Add repo HatanoChihiro/obsidian-webnovel-assistant → Enable
Manual Download → Extract to .obsidian/plugins/web-novel-assistant/ → Restart & Enable

🚀 Quick Start

  1. Install → open any Markdown file
  2. Status bar shows live word count → click to set a goal
  3. Command Palette Ctrl/Cmd+P → search "WebNovel"
  4. Settings → customize each feature
🎯 Key Commands
Command Description
Toggle Immersive Writing Mode Full-screen distraction-free writing
Toggle Writing Status Panel Detailed stats & history charts
Toggle Foreshadowing Panel Manage foreshadowing & recovery
Toggle Timeline Panel Manage story timeline
Toggle Timed Task Panel Timed writing task tracking
Toggle Chapter Corkboard Card-style chapter overview
Start/Pause Slack Time Tracking Toggle focus/slack tracking
Mark as Foreshadowing Mark selected text as foreshadowing
Create Blank Sticky Note New floating sticky note
Advanced Search Search by book/global/custom scope
Auto-Create Next Chapter Smart chapter numbering
Reset Streaming Stats Clear current session data

All commands can get custom shortcuts in Settings → Hotkeys

⚙️ Key Settings
Setting Default Description
Language Auto UI language — auto-detects Obsidian locale
Default Chapter Goal 3000 Chapter word goal for new files
Daily Goal 5000 Daily writing target
File Explorer Word Count Off Folder word counts in sidebar
Smart Chapter Sorting Off Auto-sort by chapter numbers
Eye Care Mode Off Warm background color
Immersive Note Size 280px Sticky note card size in immersive mode
Foreshadowing Filename Foreshadowing Customizable per workspace
Timeline Filename Timeline Customizable per workspace
Timed Task Filename Timed Task Customizable per workspace
Lore Folder Name Lore Supports dictionary outline mode
Word Count Mode Webnovel Webnovel / Standard / Native algorithm
🎨 OBS Overlay Setup
  1. Plugin settings → Enable OBS Overlay
  2. OBS → Add Browser Source → URL http://127.0.0.1:24816/
  3. Recommended: 300×500px

See OBS Overlay CSS Guide for full customization.


📄 License & 💖 Support

MIT License

⭐ Star · 🐛 Issues · 💡 Discussions


If this plugin helps with your writing, consider buying the author a coffee ☕. Your support is the greatest motivation for continuous updates!


ko-fi


Happy writing! ✍️


✍️ WebNovel Assistant

English | 中文

GitHub release License Obsidian Downloads

为网络小说与故事创作者打造的 Obsidian 一站式写作套件。
精准字数统计与目标追踪 · 故事时间线看板 · 伏笔回收管理 · 章节概览看板 · 设定图谱与专注打字模式。


📖 使用指南 🎥 OBS CSS 指南 📋 更新日志



homepage

✨ 功能一览

🏠 创作主页

全宽仪表盘 · 动态欢迎语 · 作品总览 · 数据面板 · 一键新建与导入作品

homepage

🗂️ 写作工作台

全章节面板 · 时间轴看板 · 伏笔看板 · 设定看板 · 任务看板 · 便签管理

workbench

🌑 沉浸写作模式

全屏专注 · 打字机居中滚动与行淡化 · 动态仪表盘 · 插槽化布局

immersive-mode

📊 字数统计与目标追踪

3种字数统计模式 · 多向目标追踪 · 严格章节模式 · 智能章节排序 · 实时字数提醒 · 文件夹字数显示

word-count-gutter

⏱️ 专注时间追踪

自动区分专注与摸鱼 · Worker线程 · 365热力图 · 柱状+趋势 · 效率卡片

history-chart

📝 创作辅助工具

伏笔管理
标注 → 阶段推进 → 彻底回收

foreshadowing
时间线系统
事件记录、多章节关联、类型分类

timeline
章节一览
卡片式展示、状态标记、摘要编辑

corkboard
设定速查与图谱
自动标注、预设类型与关系可视化、关联图谱

lore-lookup
悬浮便签
自动保存、Markdown渲染

sticky-note
任务追踪
创建周期任务、支持自主放弃

task
高级搜索
支持当前书籍、全局、自定义,快速跳转

search
合并章节
按照排序合并目录内所有章节

merge
自动创建下一章
自动创建带标号文档,支持模板

auto-create-next

🎥 OBS直播叠加层 & 📱 移动端

🎥 OBS叠加层 📱 移动端
实时显示写作数据 浮动字数统计与专注计时小窗
自定义样式、透明度、内容 贴边吸附与自动收起手柄模式
零延迟、零磁盘消耗 复制本文档纯净文本 — 一键带标题提取纯净正文

📥 安装

方式 步骤
社区插件市场 (推荐) 设置 → 第三方插件 → 浏览 → 搜索 "WebNovel Assistant" → 安装 → 启用
BRAT 安装 BRAT → 添加仓库 HatanoChihiro/obsidian-webnovel-assistant → 启用
手动安装 下载 → 解压到 .obsidian/plugins/web-novel-assistant/ → 重启启用

🚀 快速开始

  1. 安装插件 → 打开任意 Markdown 文件
  2. 状态栏显示实时字数 → 点击设置目标
  3. 命令面板 Ctrl/Cmd+P → 搜索 "WebNovel"
  4. 设置 → 自定义各项功能
🎯 主要命令
命令 说明
进入/退出 沉浸写作模式 切换全屏沉浸创作环境
打开/关闭写作实时状态面板 详细统计和历史图表
打开/关闭伏笔面板 管理伏笔标注和回收
打开/关闭时间线面板 管理故事时间线
打开/关闭限时任务面板 管理限时任务追踪
打开/关闭章节一览面板 卡片式展示章节纲要
开始/暂停 摸鱼时间统计 切换时间追踪
标注为伏笔 将选中文字标注为伏笔
新建空白悬浮便签 创建浮动便签
高级搜索 搜索书籍/全局/自定义范围
自动创建下一章 智能递增章节编号
重置直播统计数据 清空当前会话数据

所有命令可在 设置 → 快捷键 中自定义

⚙️ 主要设置
设置 默认值 说明
语言 跟随系统 界面语言,首次安装自动检测
默认目标字数 3000 新文件的默认章节目标
今日目标字数 5000 今日写作目标
文件浏览器字数统计 关闭 大型项目建议关闭
智能章节排序 关闭 自动按章节编号排序
护眼模式 关闭 编辑器背景护眼色
沉浸便签尺寸 280px 沉浸模式下便签卡片边长
伏笔文件名 伏笔 可按工作区自定义
时间线文件名 时间线 可按工作区自定义
限时任务文件名 限时任务 可按工作区自定义
设定文件夹名称 设定 支持字典大纲模式
字数统计模式 网文模式 网文/标准/原生 统计算法
🎨 OBS叠加层设置
  1. 插件设置 → 启用 OBS叠加层
  2. OBS → 添加 浏览器源 → URL http://127.0.0.1:24816/
  3. 建议 300×500px

详见 OBS叠加层CSS指南


📄 许可证 & 💖 支持项目

MIT License

⭐ Star · 🐛 提交问题 · 💡 功能建议


反馈和交流群:964265407


如果这个插件对你的码字事业有所帮助,欢迎请作者喝杯咖啡 ☕,你的支持是我持续更新的最大动力!

赞赏码

祝你写作愉快! ✍️

About

为小说故事创作设计的 Obsidian 插件 | Obsidian plugin for novel and story writing

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages