From 388e9a56054d75cdb396cfd95ddd7d6b635ab88f Mon Sep 17 00:00:00 2001 From: zhiqui Date: Sun, 15 Nov 2026 16:15:38 +0800 Subject: [PATCH] =?UTF-8?q?MIT=20=E5=BC=80=E6=BA=90:=20LICENSE=20+=20READM?= =?UTF-8?q?E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 54 +++++++++++++++--------------------------------------- 1 file changed, 15 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index da6dda6c..b2839d64 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,26 @@ -# Open Maopaoya 🦆 +# 🦆 Open Maopaoya -冒泡鸭开源复刻:AI 角色扮演平台 + 动态小说引擎(AI 编剧自主扩列建角色)。 +冒泡鸭(阶跃星辰角色扮演 App,2025-11 停运)的开源复刻。 -## 快速启动 +单角色扮演 · 动态小说引擎(AI 自主扩列建档生成立绘)· 群聊 · 角色朋友圈 · 语音通话 · +消息 Swipe 多版本 · 角色广场与分享码 · 多模型渠道 · 多用户权限 · AES 数据加密 · +uni-app 前端(H5/小程序/App 一套代码)· 商业化 v1 API 预留。 +## 快速开始 ```bash -uv sync -uv run uvicorn app.main:app --port 8820 -# 打开 http://localhost:8820 -# 默认管理员: admin / maopaoya-admin(首次登录后请改) +uv sync # 依赖(可选 --extra mysql / --extra postgres 切商用库) +uvicorn app.main:app --port 46711 ``` - -## 功能 -- 单角色扮演:角色卡 / 记忆(完全透明可篡改)/ 世界书 / TTS -- 动态小说:AI 自主引入新角色 → 自动建档 → 生成立绘 → 注册世界书 → 新角色可单独对话 -- 多渠道:OpenAI 兼容 API,内置 Step Plan 预设(叙事/抽取 step-3.5-flash,TTS stepaudio-2.5-tts,生图槽位留空可接任意兼容接口) -- 多用户:注册/注销开关、BYOK 开关、渠道分配、用户数据硬隔离 -- 管理后台:用户管理、权限开关、「数据可见」开关 - - 数据可见 OFF → 用户数据 AES-GCM 加密落库(密钥由用户密码派生,服务器不存明文),管理员只读密文 - - OFF→ON → 存量密文在用户下次登录时自动解密转明文,静默不告知用户 - - 修改密码时自动重加密;注销删除全部数据不可恢复 - -## 配置(.env,均带 OMO_ 前缀) +首个管理员凭环境变量注入: ``` -OMO_DATABASE_URL=sqlite+aiosqlite:///./data.db # 商用切: mysql+aiomysql://... / postgresql+asyncpg://... -OMO_JWT_SECRET=change-me OMO_FIRST_ADMIN_USER=admin OMO_FIRST_ADMIN_PASS=maopaoya-admin ``` -## 商用扩展 -- 数据库切换只需改 DATABASE_URL(可选依赖: `uv sync --extra mysql` 或 `--extra postgres`) -- 数据访问统一走 `app/db/repos.py` 仓储层 -- Alembic 迁移: `uv run alembic init migrations` 后接入 `app.db.session.Base.metadata` +## 结构 +- `app/` FastAPI 后端(路由 / 仓储层 / 加密 / LLM 服务) +- `web-legacy/` 旧版单页前端 +- `frontend-uni/` uni-app Vue3 前端(`npm run build:h5`) -## 商业化 API(v1 稳定契约) -- 前缀 `/v1`,独立于 `/api` 演进;契约只加字段不改语义 -- 认证:`X-API-Key` 头(sha256 落库,明文仅创建时返回一次) -- scope:`chat`(仅对话)/ `full`(含角色读取);每 key 独立限流(req/min) -- 端点:`GET /v1/ping`、`POST /v1/keys`、`GET /v1/keys`、`DELETE /v1/keys/{id}`、 - `GET /v1/usage`(用量账本,计费底座)、`GET /v1/characters`、`POST /v1/chat` -- 多实例部署时限流换 Redis(现为进程内滑动窗口) - -## 性能 -- 全局 httpx 连接池复用(不再每请求握手) -- 站点设置进程内缓存(写时失效) -- 复合索引覆盖热查询路径(消息/记忆/朋友圈/会话),旧表启动时自动补建 -- GZip 响应压缩(>1KB) -- 部署建议:`uvicorn app.main:app --workers 2` 或 nginx 反代 + 多 worker;量大切 PG +## 协议 +MIT