Initial taiko.su easter-egg site

README.md

@@ -0,0 +1,68 @@
+# taiko.su
+
+`taiko.su` 是 [taiko.asia](https://taiko.asia) 的彩蛋站点代码仓库。
+
+当前站点提供一个精简的单曲活动入口：页面完成开屏加载和 setup 后，自动进入管理员指定的歌曲；游玩结束后生成并保存彩蛋码，用户领取后返回加载完成页面。
+
+## 功能
+
+- 开屏加载与 setup 完成页
+- 管理员指定单首歌曲和固定难度
+- 单人游玩与结算
+- 彩蛋码生成、持久化及领取
+- Token + 彩蛋码双认证 API
+- 管理员活动设置与彩蛋码记录
+
+站点版本标识为 `vSU? ??.??.??`。
+
+## 运行
+
+项目需要 MongoDB。Redis 为可选依赖，未连接时使用本地文件会话。
+
+```bash
+python -m pip install -r requirements.txt
+python app.py 34801 -b 127.0.0.1
+```
+
+生产环境可使用：
+
+```bash
+sudo bash setup.sh
+```
+
+首次部署时，脚本会引导创建管理员。管理员入口为 `/1128admin1128`，后台可以选择数据库中已启用的歌曲、固定游玩难度，并设置彩蛋码验证 Token。
+
+## 彩蛋码验证 API
+
+```http
+POST /api/easter-eggs/verify
+Authorization: Bearer <管理员设置的 Token>
+Content-Type: application/json
+
+{"code":"AI4-XXXX-XXXX"}
+```
+
+也可以通过 `X-Verification-Token` 请求头传递 Token。
+
+- Token 与彩蛋码均正确：返回 HTTP 200 和 `{"success":true}`
+- Token 缺失或错误：返回 HTTP 401
+- Token 正确但彩蛋码无效：返回 HTTP 200 和 `{"success":false}`
+
+## 数据集合
+
+- 歌曲：`songs`
+- 活动设置：`experience_settings`
+- 彩蛋码：`easter_egg_codes`
+- 管理员：`users` 集合中 `user_level >= 50` 的账号
+
+## 项目范围
+
+本仓库只维护 `taiko.su` 彩蛋站点所需的加载、单曲游玩、彩蛋码和管理员配置功能，不包含歌曲上传、用户中心、排行榜、社交、多人、AI 对战或谱面编辑器。
+
+## 仓库
+
+项目现已迁移至：
+
+```text
+https://code.taiko.im/Superories/taiko.su.git
+```