Roleplay Hub

一款纯前端运行的本地角色扮演（Roleplay）对话和角色卡生成工具。

【免责与授权声明】
本项目基于 CC BY-NC 4.0（知识共享-署名-非商业性使用 4.0 国际许可协议） 开源。明确禁止任何形式的商业化使用（包括但不限于：作为收费服务提供、打包在付费产品中售卖、在产品内植入广告盈利等）。 任何使用者必须遵守该协议，尊重原作者的署名权。对于违反协议的商业行为，保留追究法律责任的权利。

---

核心特性 (Features)

Roleplay Hub 致力于提供流畅、私密且功能强大的本地化AI Roleplay体验。

快速开始 (Quick Start)

本项目无需复杂的 Node.js 环境或依赖安装，即开即用！

1. 下载与运行

1. 点击项目主页绿色的 Code 按钮，选择 Download ZIP。
2. 将下载的 ZIP 压缩包解压到您的本地任意文件夹中。
3. 双击打开 index.html 文件，即可在浏览器（推荐 Chrome / Edge / Firefox）中启动 Roleplay Hub。

(注：如果您遇到跨域或本地文件读取权限问题，可以尝试使用 VS Code 的 Live Server 插件，或简单的本地服务器工具来运行该目录。但在绝大多数现代浏览器中，双击 index.html 即可正常使用所有核心功能。)

2. 初始化设置

1. 打开应用后，点击侧边栏（或顶部菜单）的设置 (Settings) 选项。
2. 选择自定义配置，填入您自己的或第三方提供的 API 节点 (API URL)。
3. 填入对应的 API Key，并输入或选择您想使用的 模型名称 (Model)。
4. 在角色管理界面，导入您的角色卡文件（或点击新建角色并手动填写设定）。
5. 回到对话界面，开始属于您的 Roleplay 旅程

---

目录结构 (Directory Structure)

Roleplay-Hub/
├── index.html            # 主程序
├── character/            # 辅助页面
│   └── index.html
├── assets/
│   ├── css/
│   │   └── styles.css    # 核心样式文件
│   └── js/
│       ├── app.js        # 核心业务逻辑
│       ├── card-utils.js # 角色卡导入导出相关工具
│       ├── ui-select.js  # 自定义选择器组件
│       └── utils.js      # 工具函数库
└── README.md             # 本说明文件

---

协议与许可 (License)

本项目严格遵守以下开源协议：

Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)

• 您可以：自由地共享（在任何媒介以任何形式复制、发行本作品）与演绎（修改、转换或以本作品为基础进行创作）。
• 您必须：
  • 署名 (Attribution)：给出适当的署名，提供指向本许可协议的链接，同时标明是否对原始作品作了修改。
  • 非商业性使用 (NonCommercial)：您不得将本作品或演绎作品用于任何商业目的。 禁止任何形式的售卖、付费订阅集成或利用本项目进行广告牟利。
• 若要获取本项目的商业授权，请直接联系项目原作者。

详细许可条款请参见根目录下的 LICENSE 文件。