Repository navigation
Project.Refactoring.zh
English | 简体中文
✅ 重构已于 2026 年 10 月完成。 计划中的重构范围已经完成,并随 Ultimate Scaler 0.4.0 发布。项目现在使用现代 Fabric 工具链和 mojmap、V4 配置系统与重写的配置界面,并建立了自动化 CI/CD、新的文档与协作流程。自动化冒烟测试和 旧配置界面的移除仍作为后续工作。完整变更列表见 0.4.0 更新日志,新配置系统的详细说明见 配置全解。
本文档记录了 Ultimate Scaler 项目自 2025 年 11 月 至 2026 年 10 月 的全面重构过程。此举旨在将项目从一个个人项目,升级为一个 符合现代软件开发标准、可持续、可协作的开放生态。
为何重构?
- 技术债累积:旧代码库难以维护与扩展,阻碍了新功能的引入。
- 协作门槛高:缺乏规范的流程,使外部贡献者难以参与。
- 发布流程繁琐:手动操作易出错,且无法提供持续集成体验。
重构目标:
- 规范化:建立代码提交、版本管理与分支策略的明确规范。
- 自动化:改进构建、测试、发布的CI/CD流水线,解放生产力。
- 文档化:完善代码注释、API文档与贡献者指南。
- 社区化:降低协作门槛,建立健康的贡献者生态。
| 模块 | 状态 | 详细说明/子任务 |
|---|---|---|
| 1. 版本控制与协作流程 | 已完成 | - [x] 确立语义化提交和语义化版本号规范 - [x] 采用主干开发分支策略 - [x] 建立 Issue 模板并说明 Pull Request 流程 |
| 2. 持续集成与交付 | 已完成 | - [x] 搭建基础 CI (AppVeyor) - [x] 实现正式版自动发布 - [x] 实现每日构建 (Nightly Build) - [ ] 集成自动化测试(暂时搁置) |
| 3. 项目文档与社区 | 已完成 | - [x] 重构 README.md - [x] 建立 Wiki 主页与本页面 - [x] 编写 CONTRIBUTING.md - [x] 建立贡献者名单 |
| 4. 代码质量与架构 | 已完成 | - [x] 为核心代码添加文档注释 - [x] 更换混淆映射表 - [x] 统一依赖管理 (Gradle) - [x] 重组配置界面 |
由于我(INF32768,本Mod的作者)缺乏软件工程实践经验,此项目自启动以来,一直基于我的“想当然”的想法来提交更改、发布版本。这导致我踩了 大爆炸提交一类的坑,使得项目代码库难以维护与扩展。
大约三个半月前,在发布一个稳定版后,我按下了暂停键。原因很简单:我需要休息,也需要应对开学后的学业。
正是这段“间隔期”,让我有机会反思。在交流与学习中,我接触到了 原子提交、 主干开发 等现代软件工程实践。我意识到,旧的工作流虽“能用”,但在代码溯源、协作规范和长期维护上存在巨大隐患。 与其等问题爆发,不如主动升级。
在项目的稳定期进行重构,成本最低,收益最大。这就像为一艘正在航行的船更换更强大的引擎,只为它能开往更远的未来。
因此,我决定启动 Ultimate Scaler 项目的重构计划,并将其作为此项目恢复更新的宣告。愿 Ultimate Scaler 项目能在重构后,成为一个更加规范、可持续、可协作的开源项目。
关于重构正式启动的公告,请见 Ultimate Scaler:重构工作流,开启新篇章
Licensed under CC BY-NC-SA 3.0 license otherwise stated
🧭 用户指南 | User Guide
- 配置全解 | Configuration Reference
- 世界重定位功能详解 | Worldgen Reposition
- 命令/locate pos | /locate pos
- 常见问题 | FAQ
📈 项目治理 | Project Management
📚 参考资料 | References