简介
欢迎来到 Phira-Firefly 文档。
本仓库由 phira-docs 改编而来,保留了原版 Phira 的全部文档内容,并在此基础上加入了 Phira-Firefly 的新增功能说明:
这是什么
Phira-Firefly 是 Phira 的分支,一款受 Phigros 启发的跨平台音乐节奏游戏,使用 Rust 开发。
- 包含原版 Phira 的全部功能
- 新增跳过曲目、动态背景、歌词显示、新手教程、崩溃界面、文言本地化、手柄支持、XC-SIM 谱面分区、本地谱面联机等特性
- 当前版本:
0.9.4-CBT1
文档结构
| 章节 | 说明 |
|---|---|
| 新增功能 | Phira-Firefly 相对原版的新增特性(按玩法、画面、界面、本地化等分类) |
| 资源包 | 资源包规范 |
| 谱面标准 | 谱面信息、音乐文件格式、扩展特性(含新增的歌词)等 |
| 谱面管理 | 谱面上传、审核与协作者功能 |
| 谱面文件格式 | RPE / PE / Official 谱面格式 |
| 活动指南 | 活动相关说明 |
| UML 文档 | 谱面动画脚本 UML 语法 |
| Phira 构建指南 | 各平台从源码构建的方法(含 Phira-Firefly 构建说明) |
| 糗事集锦 | 开发过程中的趣事记录 |
贡献
如果你发现了问题,欢迎前往 GitHub Issues 提出;如果你想补充或修正文档,欢迎提交 Pull Request。文档内容位于本仓库的 docs/ 目录,基于 VitePress 构建。
翻译
Phira-Firefly 游戏本体支持包括英语、简体中文、繁体中文、文言(zh-LZH)、日语、韩语、俄语、法语等在内的多种语言。文档站点的多语言版本(如 /en/)属于后续计划,欢迎参与翻译工作。