OCNovel 是一个基于大语言模型的智能小说生成工具，能够根据参考小说和用户设定的主题、风格等参数，自动生成完整的长篇小说。
- 🤖 支持多种 AI 模型（Gemini、OpenAI）
- 📚 智能知识库系统，支持参考小说导入和分析
- 📝 自动生成小说大纲和章节内容
- 💡 支持手动更新和优化小说大纲
- 🔄 支持手动更新已生成章节的摘要信息
- 👥 智能角色管理系统 (待实现)
- 🎯 支持章节重新生成和内容优化 (通过
content --target-chapter) - ✨ 章节内容自动定稿与优化 (集成在
content和auto流程中) - 📂 基于小说标题的专属输出目录管理和配置快照
- ⚙️ 自动工作目录初始化
- 📄 首次运行时可交互生成基础配置文件
- 📊 完整的日志记录系统
- 🎨 支持生成营销内容（标题、封面提示词等）
- Python 3.9+
- 足够的磁盘空间用于存储知识库和生成内容
- API 密钥（Gemini 和/或 OpenAI）
- 克隆项目到本地：
git clone https://github.com/yourusername/OCNovel.git
cd OCNovel- 创建并激活虚拟环境：
python -m venv .venv
source .venv/bin/activate # Linux/Mac
# 或
.venv\Scripts\activate # Windows- 安装依赖：
pip install -r requirements.txt- 配置环境变量：
创建
.env文件并添加以下内容：
# Gemini API配置
GEMINI_API_KEY=你的Gemini API密钥
# OpenAI API配置
OPENAI_API_KEY=你的OpenAI API密钥
OPENAI_API_BASE=你的OpenAI API基础URL（可选）
- 准备配置文件 (
config.json)：- 你可以手动复制
config.json.example并重命名为config.json，然后根据需要修改。 - 首次运行
main.py时，如果config.json不存在，程序会提示你输入小说主题，并自动调用src/tools/generate_config.py生成一个基础的config.json文件。
- 你可以手动复制
python main.py [--config <配置文件路径>] [command] [options]--config：可选，指定配置文件的路径，默认为config.json。
支持以下子命令：
python main.py auto [--extra-prompt "额外提示词"]- 功能：自动执行完整的小说生成流程。从
summary.json(位于输出目录) 读取进度，检查并生成缺失的大纲，然后从上次进度开始生成章节内容并自动定稿，直至达到config.json中设定的target_chapters。 - 参数：
--extra-prompt：可选，用于指导生成的额外提示词，会传递给大纲和内容生成阶段。
python main.py outline \
--start <起始章节> \
--end <结束章节> \
[--novel-type <小说类型>] \
[--theme <主题>] \
[--style <写作风格>] \
[--extra-prompt "额外提示词"]- 功能：生成或更新指定章节范围的小说大纲 (
outline.json)。 - 参数：
--start：必需，起始章节号（从 1 开始）。--end：必需，结束章节号（包含）。--novel-type：可选，小说类型（如未提供，使用配置文件中的设置）。--theme：可选，主题（如未提供，使用配置文件中的设置）。--style：可选，写作风格（如未提供，使用配置文件中的设置）。--extra-prompt：可选，用于指导大纲生成的额外提示词。
python main.py content \
[--start-chapter <起始章节>] \
[--target-chapter <指定章节>] \
[--extra-prompt "额外提示词"]- 功能：生成或重新生成章节内容。默认从上次中断的章节（记录在
progress.json）开始生成，直至大纲结束。生成过程中会自动调用定稿逻辑。 - 参数：
--start-chapter：可选，指定从哪一章开始生成。如果指定，将覆盖progress.json中的记录。--target-chapter：可选，指定仅重新生成某一个章节。优先级高于--start-chapter。--extra-prompt：可选，用于指导内容生成的额外提示词。
python main.py finalize --chapter <章节号>- 功能：对指定章节进行手动的定稿处理（通常已集成到
content和auto流程中，此命令主要用于特殊情况或调试）。 - 参数：
--chapter：必需，需要定稿的章节号（从 1 开始）。
python src/tools/generate_marketing.py --keywords "关键词1" "关键词2" --characters "角色1" "角色2"(此工具的功能和用法请参考其内部实现或相关文档)
python src/tools/process_novel.py <输入目录> <输出目录> -e <结束章节号> [-s <起始章节号>] [--split-sentences](此工具的功能和用法请参考其内部实现或相关文档)
OCNovel/
├── data/ # 数据目录 (自动创建)
│ ├── cache/ # 知识库、模型缓存等
│ ├── logs/ # 日志文件
│ ├── output/ # 生成输出根目录
│ │ ├── <novel_title>/ # 基于小说标题的专属输出目录
│ │ │ └── config_snapshot.json # 本次运行的配置快照
│ │ ├── content_kb/ # 章节知识库
│ │ ├── outline.json # 生成的小说大纲
│ │ ├── summary.json # 各章节摘要信息
│ │ └── sync_info.json # 同步信息
│ └── reference/ # 参考小说存放处
├── src/ # 源代码
│ ├── config/ # 配置管理
│ │ ├── ai_config.py # AI Config类，加载和管理LLM配置
│ │ └── config.py # Config类，加载和管理配置
│ ├── generators/ # 生成器模块
│ │ ├── common/ # 通用工具 (如 utils.py)
│ │ ├── content/ # 章节内容生成
│ │ │ └── content_generator.py
│ │ ├── finalizer/ # 章节定稿处理
│ │ │ └── finalizer.py
│ │ └── outline/ # 大纲生成
│ │ └── outline_generator.py
│ ├── knowledge_base/ # 知识库管理
│ │ └── knowledge_base.py
│ ├── models/ # AI模型接口
│ │ ├── base_model.py # 基础模型类
│ │ ├── gemini_model.py
│ │ └── openai_model.py
│ └── tools/ # 辅助工具脚本
│ ├── generate_config.py # 自动生成配置文件脚本
│ ├── generate_marketing.py # 营销内容生成
│ └── process_novel.py # 章节内容整理
├── tests/ # 测试文件
├── .env # 环境变量 (API Keys等)
├── config.json # 主配置文件
├── config.json.example # 配置文件示例
├── main.py # 主程序入口
├── requirements.txt # Python依赖列表
└── README.md # 项目说明
配置文件是指导小说生成的核心。如果 config.json 不存在，首次运行 main.py 时会尝试自动调用 src/tools/generate_config.py 生成一个基础文件。
主要配置项分为以下部分：
在项目根目录创建 .env 文件，配置 AI 模型相关参数：
# Gemini API配置
GEMINI_API_KEY=你的Gemini API密钥
# OpenAI API配置
OPENAI_API_KEY=你的OpenAI API密钥
OPENAI_API_BASE=你的OpenAI API基础URL（可选）
将config.json.example的文件名改为config.json，编辑 config.json 文件，设置项目相关参数。详细配置说明如下：
用于管理和处理参考小说的配置项。
{
"reference_files": ["data/reference/my_novel.txt"], // 参考小说文件路径列表，支持多个文件
"chunk_size": 1000, // 文本分块大小，用于将长文本分割成小块进行处理
"chunk_overlap": 200, // 分块重叠大小，确保上下文连贯性
"cache_dir": "data/cache" // 知识库缓存目录，用于存储处理后的文本块
}用于记录系统运行状态的配置项。
{
"max_retries": 3, // 单个任务（如生成章节）失败时的最大重试次数
"retry_delay": 10, // 重试之间的延迟时间（秒）
"force_rebuild_kb": false, // 是否强制重新构建知识库，即使缓存存在
"validation": { // 内容验证选项 (部分可能未完全实现)
"check_logic": true,
"check_consistency": true,
"check_duplicates": true
}
}控制生成结果的保存方式。
{
"format": "txt", // 输出文件格式 (目前主要影响 process_novel.py)
"encoding": "utf-8", // 输出文件编码
"save_outline": true, // 是否保存生成的小说大纲 (outline.json)
"save_character_states": false, // 是否保存角色状态信息 (待移除)
"output_dir": "data/output" // 生成文件的根目录，实际输出会在 data/output/<novel_title>/ 下
}