项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 3402
使用教程
环境要求
- Node.js ^20.19.0 || ^22.12.0 || >=24.0.0
- pnpm(项目使用 pnpm workspace 管理前后端)
- 可访问 Electron 分发源的网络环境(仅启动桌面端时需要)
- 可选:Qdrant Cloud 账号(需要启用 RAG 检索时)
安装与启动步骤
-
1拉取项目代码
把仓库克隆到本地并进入项目目录,后续所有命令都在项目根目录执行。
git clone https://github.com/ExplosiveCoderflome/AI-Novel-Writing-Assistant.git cd AI-Novel-Writing-Assistant -
2安装项目依赖
默认只准备 Web / Server 开发所需依赖,不会在首次安装时强制下载 Electron 桌面运行时。
pnpm install -
3排查安装卡死
若在 Windows 上卡在 prisma preinstall,先查 Node 版本与 script-shell 配置,删除后再重装。
node -v pnpm config get script-shell npm config get script-shell -
4配置环境变量
服务端读 server/.env,前端读 client/.env 或 client/.env.local;根目录 .env.example 只作总览参考。
-
5启动开发环境
一条命令同时起前后端;首次启动服务端会自动执行 Prisma generate 和 db push。
pnpm dev -
6配置模型与路由
打开设置页至少填一组可用的模型供应商 API Key,再到模型路由页确认各任务实际使用的模型。
-
7可选接入 Qdrant
在 Qdrant Cloud 建集群并复制 Cluster URL 与 API Key 写入 server/.env,再验证连通性。
curl -X GET "https://your-cluster.region.cloud.qdrant.io:6333" \ --header "api-key: your_database_api_key"
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
RAG_ENABLED | 否 | 是否启用 RAG 检索;只想先体验主流程可设为 false | false |
QDRANT_URL | 否 | Qdrant Cloud 集群地址,建议直接填带 :6333 的 REST 地址 | https://your-cluster.region.cloud.qdrant.io:6333 |
QDRANT_API_KEY | 否 | Qdrant 集群的 Database API Key,创建后通常只展示一次 | your_database_api_key |
如何确认成功
浏览器打开 http://localhost:5173 能看到界面,后端 http://localhost:3000/api 可访问,即表示启动成功。
常见问题
Q:pnpm install 卡在 prisma preinstall 怎么办?
A:先确认 Node 版本符合要求;再检查 script-shell 是否被设成带 /k 的 cmd.exe,执行 npm config delete script-shell 和 pnpm config delete script-shell 后重开终端再安装。
Q:首次启动前需要手动跑 prisma generate 或 db push 吗?
A:不需要。首次启动服务端时会自动执行 Prisma generate 和 db push,只有自己改了 Prisma schema 或要走正式迁移流程时才手动使用相关命令。
Q:不装 Qdrant 能用吗?
A:可以。在 server/.env 里设 RAG_ENABLED=false 就能跑通主链,需要 RAG 检索时再接入 Qdrant。
Q:只想直接使用、不想配环境怎么办?
A:去 GitHub Releases 下载 Windows 桌面版,优先选 Setup.exe 安装版;不想安装或想放 U 盘运行可选 portable 版本。
注意事项
- 环境变量按子包读取:服务端读 server/.env,前端读 client/.env 或 client/.env.local,根目录 .env.example 只是总览参考。
- RAG 并发数、限速等运行时参数已从 .env 迁到设置面板,改完即生效无需重启。
- 桌面端运行时首次下载需能访问 Electron 分发源,网络受限时先配置代理或镜像。
- 启动后建议先访问 /settings、/settings/model-routes,启用知识库时再进 /knowledge?tab=settings 保存 Embedding 与集合设置。
核心亮点
- Agent 驱动的工作流能自动推进章节生成,减少手动干预
- 内置世界观构建模块,支持复杂设定管理,保持长篇一致性
- RAG 技术增强上下文理解,避免剧情遗忘和设定冲突
不足之处
- 项目仍处于成长阶段,稳定性和文档完善度待观察
- 对于非技术用户,安装和配置门槛可能较高
适用场景
- 新手作者快速生成小说初稿
- 长篇连载写作时的设定和剧情管理
- 创意写作教学中的 AI 辅助工具
替代项目
NovelAI、Sudowrite、AI Dungeon
上一篇:humanizer-skill
下一篇:cotabby
同类项目推荐
GenerativeAI-Prompt-Sample-Japan···
开源
拿日语提示词,直接套用,让AI更懂你
Copilotなど各種生成AI用の「日本語]の Prompt のサンプル
MaliangAINovalWriter
开源
中文网文专用,大纲知识库全配齐
马良写作 AINoval — AI novel writer for Chinese webnovels(网文)| 多智能体AI小说创作···
webnovel-writer-opencode
开源
让 AI 记住 200 万字设定,连载不断片
本项目是基于webnovel-writer 改编的 OpenCode 版本,目标是让用户在OpenCode 使用长篇网文···
ai-writing-assistant-enhancer
开源
给通用 AI 写作工具装上场景模板,邮件纪要小说一键出稿
Ai Writing Assistant Enhancer
salt-story
开源
一键生成知乎盐选风反转故事,告别AI味
盐选故事写作 Skill — 生成有反转、有吸引力、无 AI 味的知乎盐选付费故事。支持 Claude ···
Mathematician-Humanizer
开源
让数学文字去掉AI味,读着像人写的
An evidence-based AI writing skill for clearer, more human mathematical prose, built···
vela
开源
稿子不出门,本地AI陪你写小说
AI-powered IDE for novel writing — local LLM + RAG, privacy-first, BYOK. For web fi···
Once-Upon-AI-Time
开源
输入主题,自动生成带插图的短故事
GPT-3 and Stable Diffusion powered short story generator
story-skills
开源
给 AI 代理装上写小说的完整工序,设定不跑偏
Agent Skills for end-to-end story writing in markdown, packaged as Codex and Claude ···
