Skip to content

RachelForster/Shinsekai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

645 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

中文版 | English Version

新世界(Shinsekai)

面向 Galgame / 乙女 / 剧情向 RPG 的桌面助手:用大语言模型驱动角色对白,立绘与情绪联动,并可接入 语音合成语音识别视觉、工具 等扩展——一切在本地 Settings 里配置,聊天窗口专注演出。


为什么用它

  • 角色演出一条龙:聊天模板、会话历史、立绘切图与情绪、TTS/ASR 与输入管线在同一套工作流里衔接,减少到处换工具。
  • 双窗分工React 设置中心webui_react.py / start.bat / start-react.*)集中管 API、角色、背景、模板、小工具、插件与 MCP;聊天主窗专责对白与演出,思路清晰。
  • 多模型、可换引擎:在 API 设定 对接常见 LLM 与 OpenAI 兼容端点;TTS 含 GPT-SoVITS、Genie TTS 等,无独显也可选轻量方案;文生图可接 ComfyUI 等工作流(同页配置)。
  • 听懂与说出口:麦克风 ASR(如 Vosk;更多后端可装插件)与台词 TTS 可选开关,适配「只打字」「只朗读立绘音频」等多种玩法。
  • 模型不仅会聊天:内置/插件 LLM 工具(如角色与世界书相关能力)+ MCP 接入外部服务,把检索、自动化等能力收进同一次对话。
  • 可扩展、可换肤插件 SDK 扩展适配器与设置页、聊天栏控件;主题与聊天窗样式可通过配置与插件微调(如 chat_ui_theme)。
  • 数据在本地、可备份:配置与资源默认落在项目 data/ 下(api.yamlsystem_config.yaml、角色与历史等),便于打包备份与二次开发。
  • 开源可玩:源码与 发行版整合包 任选;社区插件索引见 Shinsekai-Plugin-Registry

效果预览

演出示例

教程: 配置 API 与导入角色包


核心能力一览

模块 说明
角色与模板 创建 / 导入导出角色包(.char);AI 辅助生成设定与背景;聊天模板一键套用多角色与世界书;会话 历史 读写、回溯与存档。
立绘与演出 多张三宣图 / 立绘管理;0–3 倍缩放;为每张图打 情绪标签,对白中的情绪指令与立绘切换联动;可选 CG / 特效字段(视模板与管线)。
语音 TTS:GPT-SoVITS、Genie TTS、CosyVoice 等(API 设定中选引擎并填服务路径/URL);选「不使用」时可仅播放 立绘绑定的台词音频ASR:麦克风识别默认可走 Vosk;Whisper 类等可通过 插件 注册。
LLM 与工具 API 设定中配置供应商、模型 ID、Key、Base URL;支持 流式输出与 工具调用;工具来源包括内置/插件 @toolMCPdata/config/mcp.yaml)。
文生图(T2I) API 设定中配置 ComfyUI 等服务端地址、工作流与节点 ID;可按需接入其他 T2I 适配器(插件注册)。
设置与系统集成 React 设置中心通过本地 Python bridge 管理 APIdata/config/api.yaml)与 系统data/config/system_config.yaml):界面语言、语音识别后端、主题色、字体等;配置读写仍留在 Python 层。
插件与小工具 data/config/plugins.yaml 清单加载;插件页发现/安装、启用禁用;小工具页对齐 PySide 设置窗的立绘提示词、批量生成、裁剪和抠图流程;插件可扩展 LLM/TTS/ASR/T2I、工具与 Settings / 工具箱 / 聊天窗 入口。
MCP 插件 → MCP 子页或 YAML 连接远端/本机 MCP Server(SSE / stdio),工具并入当前进程的 LLM 工具列表。
视觉与其它扩展 视觉理解、主题编辑等能力可通过 官方或社区插件 启用(如仓库内 plugins/ 示例);具体能力以各插件说明为准。

快速开始(约 5 分钟)

1. 获取程序

源码:

git clone https://github.com/RachelForster/Shinsekai
cd Shinsekai

整合包:Releases 下载解压。

平台 安装 启动
Windows 双击 install.bat 双击 start-react.bat
macOS 双击 install.command 双击 start-react.command
Linux ./scripts/install-linux.sh ./start-react.sh

macOS 首次运行:如果双击提示「无法验证开发者」,请右键(或 Ctrl+点击)文件 → 打开,在弹出的对话框中再次点 打开 即可。或者前往 系统设置 → 隐私与安全性 中允许。

2. 安装依赖

整合包用户:双击对应平台的安装脚本即可。

开发者 使用项目标准 conda 环境 shinsekai

conda env create -f environment.yml
conda activate shinsekai

也可以手动创建同名环境:

conda create -n shinsekai python=3.10
conda activate shinsekai
pip install -r requirements.txt

Linux 源码用户也可以运行 ./scripts/install-linux.sh。如果已激活 Python 3.10 的非 base conda 环境,脚本会直接在当前环境安装依赖;否则会优先用 uv 创建 .venv,没有 uv 时需要系统提供 python3.10

3. 启动 React 设置中心

安装完成后,优先使用 React 启动脚本:

平台 启动方式
Windows 双击 start-react.bat
macOS 双击 start-react.command
Linux 运行 ./start-react.sh

start-react.* 会启动本地 Python HTTP bridge,托管 React 设置中心,并自动打开浏览器。React 设置中心用于管理 API、角色、背景、聊天模板、小工具、插件和 MCP。

源码用户如果没有运行安装脚本,需要先安装前端依赖并构建 React 前端:

cd frontend
pnpm install
pnpm build
cd ..

源码仓库不再提交 frontend/diststart-react.* 发现构建产物不存在时会提示手动运行 cd frontend && pnpm install && pnpm build;需要自动构建时可显式传入 --build-if-missing--build-if-stale。正式桌面安装包会在 release 构建流程中生成并内置前端资源。旧 PySide 设置页仍作为兼容入口保留:python webui_qt.py

Tauri 桌面端开发

需要调试正式桌面壳、窗口控制或官方 updater 时,在 frontend/ 下启动 Tauri dev:

cd frontend
pnpm install
pnpm tauri:dev

pnpm tauri:dev 会先执行 pnpm buildpnpm prepare:tauri-resources,再运行 tauri dev。如果手动拆开执行,请使用完整顺序:

cd frontend
pnpm build
pnpm prepare:tauri-resources
pnpm tauri dev

桌面 dev 模式会被识别为 Tauri 桌面环境:更新按钮走官方 Tauri updater;源码更新入口只保留给非 Tauri 的浏览器/源码模式。

构建本地桌面安装包或做 release dry run 时:

cd frontend
pnpm install
pnpm build
pnpm prepare:tauri-resources
pnpm tauri build

正式 release 构建需要设置 updater 签名私钥环境变量 TAURI_SIGNING_PRIVATE_KEY;如果私钥设置了密码,还需要 TAURI_SIGNING_PRIVATE_KEY_PASSWORD。本地只想验证打包流程且不生成 updater artifacts 时,可使用 Tauri CLI 的 --config 覆盖关闭 bundle.createUpdaterArtifacts

4. 第一次对话

  1. API 设定 中填写 LLM(例如 DeepSeek / OpenAI 兼容端点),保存。
  2. 角色管理 导入角色包(示例:nanami.char;更多角色包见 社区资源)。
  3. 打开 聊天模板,勾选角色并生成模板。
  4. 启动聊天,即可在主窗口发消息、看立绘与回复。

可选:让角色开口说话

需要台词语音合成时,可部署 GPT-SoVITS;机器较弱或无独显时,可在 API 设定中改用 Genie TTS 等方案。


配置 LLM(简要)

  1. 顶部进入 API 设定
  2. 选择供应商,填写 模型 IDAPI KeyBase URL(部分供应商会自动填默认地址)。
  3. 保存后回到聊天流程即可使用。

插件系统

data/config/plugins.yaml 登记插件;源码放在 plugins/<包名>/。宿主会合并 LLM / TTS / ASR / T2I 适配器、工具Settings / 工具箱 / 聊天窗 等贡献。

  • 图形界面:Settings → 插件:启用/禁用、从索引发现与下载、pip install 依赖(与当前解释器一致)。
  • 索引仓库Shinsekai-Plugin-Registry
  • 脚手架python -m sdk.cli create --package your_plugin_name
  • 设计说明(英文):docs/PLUGIN_DEVELOPER_GUIDE.md

修改清单后请 重启应用 以加载插件。


MCP(模型上下文协议)

MCP 服务接入 本进程 LLM 工具列表:支持 SSEstdio 等传输方式。

  1. 安装:pip install mcp
  2. 配置:data/config/mcp.yaml,或在 Settings → 插件MCP 子页可视化编辑。
  3. 保存并应用 会重连服务并把远端工具注册到当前会话(可用前缀避免工具名冲突)。

与插件系统独立:不写插件也能通过 YAML 接外部能力。


文档与链接

内容 链接
项目主页(GitHub Pages) rachelforster.github.io/Shinsekai
图形界面使用指南(新手) docs/GUI_USER_GUIDE_zh-CN.md
英文说明 docs/README_EN.md
插件开发者指南 docs/PLUGIN_DEVELOPER_GUIDE.md
本仓库 github.com/RachelForster/Shinsekai

欢迎 Issue / PR;若二次分发角色与语音资源,请遵守对应作者许可。

About

AI RPG maker

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors