MCP Novel Game Server

MCP Novel Game Server

如何制作视觉小说游戏 MCP 服务

English

概述

此仓库是一个支持英语和日语多分支剧情故事（视觉小说）的小说游戏服务。

此仓库旨在帮助你更好地理解 MCP（Model Context Protocol）资源。

你可以轻松运行、编辑和添加新剧情。服务支持使用 YAML 编写的剧情文件，也可以扩展为你自己的故事。

注意： 在 Cline 中，所有功能都可以开箱即用。在 Claude Desktop 和 Cursor 等其他环境中，请使用 server_tool.py 来正确启动和管理服务。

使用方法

1. 安装依赖

uv sync

2. 运行服务

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## Replace with your project root
                "run",
                "src/server.py"
            ]
        }
}

3. 游玩或测试剧情

• 将剧情文件放在 src/stories/<your_story>/ 中
• 你可以通过服务界面选择剧情，也可以在客户端中指定剧情 ID。

4. 添加新剧情

• 在 src/stories/ 下创建新目录（例如 villainess_rose 或 villainess_rose_ja）
• 添加剧情 YAML 文件（请参阅现有示例）
• 添加用于描述剧情的 meta.yaml

5. 文件结构

project-root/
├── src/
│   ├── server.py
│   └── stories/
│       ├── villainess_rose/
│       ├── villainess_rose_ja/
│       └── ...
├── mcp_example.json
├── pyproject.toml
└── README.md

备注

• 使用 uv 作为包管理器和运行工具。
• 剧情可以用英语或日语编写。
• 有关剧情树和详细信息，请参阅 src/stories/README.md。

---

日本語

概述

此仓库是一个分支式小说游戏（视觉小说）服务，支持英语和日语。

此仓库旨在帮助理解 MCP（Model Context Protocol）资源。

可以使用 YAML 格式添加和编辑剧情。

注意： 在 Cline 环境中可以直接运行；在其他环境（例如 Claude Desktop 或 Cursor）中，请使用 server_tool.py 启动和管理服务。

使用方法

1. 安装依赖包

uv sync

2. 启动服务

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## ご自身のプロジェクトルートに変更してください
                "run",
                "src/server.py"
            ]
        }
}

3. 游玩或测试剧情

• 将剧情文件放在 src/stories/<your_story>/ 中
• 可以通过服务 UI 或在客户端中指定剧情 ID 来选择剧情

4. 添加新剧情

• 在 src/stories/ 下创建新目录（例如 villainess_rose 或 villainess_rose_ja）
• 使用 YAML 文件创建剧情
• 同时添加用于描述剧情的 meta.yaml

5. 文件结构示例

project-root/
├── src/
│   ├── server.py
│   └── stories/
│       ├── villainess_rose/
│       ├── villainess_rose_ja/
│       └── ...
├── mcp_example.json
├── pyproject.toml
└── README.md

注意事项

• 请使用 uv 进行包管理和运行。
• 剧情可以用英语或日语编写。
• 有关剧情详情和剧情树，请参阅 src/stories/README.md。