|
@@ -11,28 +11,54 @@
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## 1. 配置设计总方案
|
|
|
|
|
-
|
|
|
|
|
-### [config-design-proposal.md](D:/dev/cmr-mini/doc/config-design-proposal.md)
|
|
|
|
|
-
|
|
|
|
|
-作用:
|
|
|
|
|
-
|
|
|
|
|
-- 说明为什么配置要按 `app / map / playfield / game / resources / debug` 分层
|
|
|
|
|
-- 说明 `KML` 和配置的职责边界
|
|
|
|
|
-- 说明为什么上位概念用 `playfield`
|
|
|
|
|
-- 适合做总体架构参考
|
|
|
|
|
-
|
|
|
|
|
-适合阅读时机:
|
|
|
|
|
-
|
|
|
|
|
-- 设计配置结构
|
|
|
|
|
-- 设计客户端读取链
|
|
|
|
|
-- 和后端讨论顶层模型时
|
|
|
|
|
|
|
+## 1. 配置核心结构
|
|
|
|
|
+
|
|
|
|
|
+当前项目的配置主入口已经稳定在:
|
|
|
|
|
+
|
|
|
|
|
+```json
|
|
|
|
|
+{
|
|
|
|
|
+ "schemaVersion": "1",
|
|
|
|
|
+ "version": "2026.03.30",
|
|
|
|
|
+ "app": {},
|
|
|
|
|
+ "map": {},
|
|
|
|
|
+ "playfield": {},
|
|
|
|
|
+ "game": {},
|
|
|
|
|
+ "resources": {},
|
|
|
|
|
+ "debug": {}
|
|
|
|
|
+}
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+顶层职责建议固定为:
|
|
|
|
|
+
|
|
|
|
|
+- `app`
|
|
|
|
|
+ 活动级基础信息
|
|
|
|
|
+- `map`
|
|
|
|
|
+ 地图底图与空间底座
|
|
|
|
|
+- `playfield`
|
|
|
|
|
+ 当前玩法使用的空间对象定义
|
|
|
|
|
+- `game`
|
|
|
|
|
+ 当前玩法规则配置
|
|
|
|
|
+- `resources`
|
|
|
|
|
+ 资源包与 profile
|
|
|
|
|
+- `debug`
|
|
|
|
|
+ 调试与开发开关
|
|
|
|
|
+
|
|
|
|
|
+当前推荐的核心原则:
|
|
|
|
|
+
|
|
|
|
|
+- 配置只描述,不执行逻辑
|
|
|
|
|
+- `KML` 描述空间事实,配置描述玩法解释
|
|
|
|
|
+- `playfield` 是上位概念,`course` 只是其中一种 `kind`
|
|
|
|
|
+- 当前阶段继续以单文件配置为主,后续再逐步升级成 manifest 组合
|
|
|
|
|
+
|
|
|
|
|
+如果你需要看旧版长文讨论稿,已经移到归档:
|
|
|
|
|
+
|
|
|
|
|
+- [config-design-proposal.md](/D:/dev/cmr-mini/doc/archive/config/配置设计方案.md)
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
## 2. 配置选项字典
|
|
## 2. 配置选项字典
|
|
|
|
|
|
|
|
-### [config-option-dictionary.md](D:/dev/cmr-mini/doc/config-option-dictionary.md)
|
|
|
|
|
|
|
+### [config-option-dictionary.md](D:/dev/cmr-mini/doc/config/配置选项字典.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -46,7 +72,7 @@
|
|
|
- 想知道字段应该怎么写
|
|
- 想知道字段应该怎么写
|
|
|
- 想确认默认行为时
|
|
- 想确认默认行为时
|
|
|
|
|
|
|
|
-### [track-visualization-proposal.md](D:/dev/cmr-mini/doc/track-visualization-proposal.md)
|
|
|
|
|
|
|
+### [track-visualization-proposal.md](D:/dev/cmr-mini/doc/rendering/轨迹可视化方案.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -54,7 +80,7 @@
|
|
|
- 说明拖尾轨迹的默认策略与推荐参数
|
|
- 说明拖尾轨迹的默认策略与推荐参数
|
|
|
- 说明当前轨迹样式的配置结构
|
|
- 说明当前轨迹样式的配置结构
|
|
|
|
|
|
|
|
-### [gps-marker-style-system-proposal.md](D:/dev/cmr-mini/doc/gps-marker-style-system-proposal.md)
|
|
|
|
|
|
|
+### [gps-marker-style-system-proposal.md](D:/dev/cmr-mini/doc/rendering/GPS点样式系统方案.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -62,7 +88,7 @@
|
|
|
- 说明默认样式、朝向小三角和品牌 logo 扩展思路
|
|
- 说明默认样式、朝向小三角和品牌 logo 扩展思路
|
|
|
- 说明第一阶段最小实现字段和长期演进方向
|
|
- 说明第一阶段最小实现字段和长期演进方向
|
|
|
|
|
|
|
|
-### [gps-marker-animation-system-proposal.md](D:/dev/cmr-mini/doc/gps-marker-animation-system-proposal.md)
|
|
|
|
|
|
|
+### [gps-marker-animation-system-proposal.md](D:/dev/cmr-mini/doc/rendering/GPS点动画系统方案.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -72,23 +98,9 @@
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## 3. 默认配置模板
|
|
|
|
|
|
|
+## 3. 当前推荐模板
|
|
|
|
|
|
|
|
-### [config-default-template.md](D:/dev/cmr-mini/doc/config-default-template.md)
|
|
|
|
|
-
|
|
|
|
|
-作用:
|
|
|
|
|
-
|
|
|
|
|
-- 提供当前推荐的默认配置模板
|
|
|
|
|
-- 包含顺序赛和积分赛的基础默认示例
|
|
|
|
|
-- 用于服务端、后台、联调时直接起步
|
|
|
|
|
-
|
|
|
|
|
-适合阅读时机:
|
|
|
|
|
-
|
|
|
|
|
-- 新建一份活动配置
|
|
|
|
|
-- 想直接照着填配置
|
|
|
|
|
-- 想知道最小可运行模板长什么样
|
|
|
|
|
-
|
|
|
|
|
-### [config-template-minimal-game.md](D:/dev/cmr-mini/doc/config-template-minimal-game.md)
|
|
|
|
|
|
|
+### [config-template-minimal-game.md](D:/dev/cmr-mini/doc/config/最小游戏配置模板.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -96,21 +108,21 @@
|
|
|
- 去掉绝大部分选配项
|
|
- 去掉绝大部分选配项
|
|
|
- 适合快速起步、联调和排查配置链
|
|
- 适合快速起步、联调和排查配置链
|
|
|
|
|
|
|
|
-### [config-template-minimal-classic-sequential.md](D:/dev/cmr-mini/doc/config-template-minimal-classic-sequential.md)
|
|
|
|
|
|
|
+### [config-template-minimal-classic-sequential.md](D:/dev/cmr-mini/doc/config/顺序赛最小配置模板.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
|
- 提供顺序赛最小可跑模板
|
|
- 提供顺序赛最小可跑模板
|
|
|
- 适合快速起顺序赛活动
|
|
- 适合快速起顺序赛活动
|
|
|
|
|
|
|
|
-### [config-template-minimal-score-o.md](D:/dev/cmr-mini/doc/config-template-minimal-score-o.md)
|
|
|
|
|
|
|
+### [config-template-minimal-score-o.md](D:/dev/cmr-mini/doc/config/积分赛最小配置模板.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
|
- 提供积分赛最小可跑模板
|
|
- 提供积分赛最小可跑模板
|
|
|
- 适合快速起积分赛活动
|
|
- 适合快速起积分赛活动
|
|
|
|
|
|
|
|
-### [config-template-full-current.md](D:/dev/cmr-mini/doc/config-template-full-current.md)
|
|
|
|
|
|
|
+### [config-template-full-current.md](D:/dev/cmr-mini/doc/config/当前最全配置模板.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -120,27 +132,7 @@
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## 4. 按玩法拆分的配置模板文档
|
|
|
|
|
-
|
|
|
|
|
-### [config-template-classic-sequential.md](D:/dev/cmr-mini/doc/config-template-classic-sequential.md)
|
|
|
|
|
-
|
|
|
|
|
-作用:
|
|
|
|
|
-
|
|
|
|
|
-- 解释顺序赛配置结构
|
|
|
|
|
-- 说明顺序赛的必填字段和默认值
|
|
|
|
|
-- 适合给后端和后台做顺序赛专项参考
|
|
|
|
|
-
|
|
|
|
|
-### [config-template-score-o.md](D:/dev/cmr-mini/doc/config-template-score-o.md)
|
|
|
|
|
-
|
|
|
|
|
-作用:
|
|
|
|
|
-
|
|
|
|
|
-- 解释积分赛配置结构
|
|
|
|
|
-- 说明积分赛的必填字段和默认值
|
|
|
|
|
-- 适合给后端和后台做积分赛专项参考
|
|
|
|
|
-
|
|
|
|
|
----
|
|
|
|
|
-
|
|
|
|
|
-## 5. 运行中的样例配置
|
|
|
|
|
|
|
+## 4. 运行中的样例配置
|
|
|
|
|
|
|
|
### [event/classic-sequential.json](D:/dev/cmr-mini/event/classic-sequential.json)
|
|
### [event/classic-sequential.json](D:/dev/cmr-mini/event/classic-sequential.json)
|
|
|
|
|
|
|
@@ -160,16 +152,9 @@
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## 6. 后台与服务端配置管理方案
|
|
|
|
|
|
|
+## 5. 后台与服务端配置管理方案
|
|
|
|
|
|
|
|
-### [backend-config-management-proposal.md](D:/dev/cmr-mini/doc/backend-config-management-proposal.md)
|
|
|
|
|
-
|
|
|
|
|
-作用:
|
|
|
|
|
-
|
|
|
|
|
-- 第一版后台配置管理建议
|
|
|
|
|
-- 适合了解 `Map / Playfield / GameMode / ResourcePack / Event` 这套核心对象
|
|
|
|
|
-
|
|
|
|
|
-### [backend-config-management-v2.md](D:/dev/cmr-mini/doc/backend-config-management-v2.md)
|
|
|
|
|
|
|
+### [backend-config-management-v2.md](D:/dev/cmr-mini/doc/config/后台配置管理方案V2.md)
|
|
|
|
|
|
|
|
作用:
|
|
作用:
|
|
|
|
|
|
|
@@ -185,33 +170,33 @@
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## 7. 推荐阅读顺序
|
|
|
|
|
|
|
+## 6. 推荐阅读顺序
|
|
|
|
|
|
|
|
如果你是第一次接触这套配置体系,建议按这个顺序看:
|
|
如果你是第一次接触这套配置体系,建议按这个顺序看:
|
|
|
|
|
|
|
|
-1. [config-design-proposal.md](D:/dev/cmr-mini/doc/config-design-proposal.md)
|
|
|
|
|
-2. [config-option-dictionary.md](D:/dev/cmr-mini/doc/config-option-dictionary.md)
|
|
|
|
|
-3. [config-template-minimal-game.md](D:/dev/cmr-mini/doc/config-template-minimal-game.md)
|
|
|
|
|
-4. [config-template-minimal-classic-sequential.md](D:/dev/cmr-mini/doc/config-template-minimal-classic-sequential.md)
|
|
|
|
|
-5. [config-template-minimal-score-o.md](D:/dev/cmr-mini/doc/config-template-minimal-score-o.md)
|
|
|
|
|
-6. [config-template-full-current.md](D:/dev/cmr-mini/doc/config-template-full-current.md)
|
|
|
|
|
|
|
+1. 本页“配置核心结构”一节
|
|
|
|
|
+2. [config-option-dictionary.md](D:/dev/cmr-mini/doc/config/配置选项字典.md)
|
|
|
|
|
+3. [config-template-minimal-game.md](D:/dev/cmr-mini/doc/config/最小游戏配置模板.md)
|
|
|
|
|
+4. [config-template-minimal-classic-sequential.md](D:/dev/cmr-mini/doc/config/顺序赛最小配置模板.md)
|
|
|
|
|
+5. [config-template-minimal-score-o.md](D:/dev/cmr-mini/doc/config/积分赛最小配置模板.md)
|
|
|
|
|
+6. [config-template-full-current.md](D:/dev/cmr-mini/doc/config/当前最全配置模板.md)
|
|
|
7. [event/classic-sequential.json](D:/dev/cmr-mini/event/classic-sequential.json)
|
|
7. [event/classic-sequential.json](D:/dev/cmr-mini/event/classic-sequential.json)
|
|
|
8. [event/score-o.json](D:/dev/cmr-mini/event/score-o.json)
|
|
8. [event/score-o.json](D:/dev/cmr-mini/event/score-o.json)
|
|
|
-9. [backend-config-management-v2.md](D:/dev/cmr-mini/doc/backend-config-management-v2.md)
|
|
|
|
|
|
|
+9. [backend-config-management-v2.md](D:/dev/cmr-mini/doc/config/后台配置管理方案V2.md)
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## 8. 维护约定
|
|
|
|
|
|
|
+## 7. 维护约定
|
|
|
|
|
|
|
|
后续每次新增配置能力时,建议至少同步更新这几处:
|
|
后续每次新增配置能力时,建议至少同步更新这几处:
|
|
|
|
|
|
|
|
-1. [config-option-dictionary.md](D:/dev/cmr-mini/doc/config-option-dictionary.md)
|
|
|
|
|
-2. [config-template-minimal-game.md](D:/dev/cmr-mini/doc/config-template-minimal-game.md)
|
|
|
|
|
-3. [config-template-minimal-classic-sequential.md](D:/dev/cmr-mini/doc/config-template-minimal-classic-sequential.md)
|
|
|
|
|
-4. [config-template-minimal-score-o.md](D:/dev/cmr-mini/doc/config-template-minimal-score-o.md)
|
|
|
|
|
-5. [config-template-full-current.md](D:/dev/cmr-mini/doc/config-template-full-current.md)
|
|
|
|
|
|
|
+1. [config-option-dictionary.md](D:/dev/cmr-mini/doc/config/配置选项字典.md)
|
|
|
|
|
+2. [config-template-minimal-game.md](D:/dev/cmr-mini/doc/config/最小游戏配置模板.md)
|
|
|
|
|
+3. [config-template-minimal-classic-sequential.md](D:/dev/cmr-mini/doc/config/顺序赛最小配置模板.md)
|
|
|
|
|
+4. [config-template-minimal-score-o.md](D:/dev/cmr-mini/doc/config/积分赛最小配置模板.md)
|
|
|
|
|
+5. [config-template-full-current.md](D:/dev/cmr-mini/doc/config/当前最全配置模板.md)
|
|
|
6. 对应玩法的 `event/*.json` 样例
|
|
6. 对应玩法的 `event/*.json` 样例
|
|
|
-7. 如果涉及顶层结构变化,再更新 [config-design-proposal.md](D:/dev/cmr-mini/doc/config-design-proposal.md)
|
|
|
|
|
|
|
+7. 如果涉及顶层结构变化,先更新本页“配置核心结构”一节,再视情况补充归档讨论稿
|
|
|
|
|
|
|
|
这样可以保证:
|
|
这样可以保证:
|
|
|
|
|
|
|
@@ -221,3 +206,15 @@
|
|
|
- 后台录入
|
|
- 后台录入
|
|
|
|
|
|
|
|
保持一致。
|
|
保持一致。
|
|
|
|
|
+
|
|
|
|
|
+---
|
|
|
|
|
+
|
|
|
|
|
+## 8. 已归档文档
|
|
|
|
|
+
|
|
|
|
|
+下列文档仍保留在归档目录,但不再作为当前主入口:
|
|
|
|
|
+
|
|
|
|
|
+- [config-default-template.md](/D:/dev/cmr-mini/doc/archive/config/默认配置模板.md)
|
|
|
|
|
+- [config-design-proposal.md](/D:/dev/cmr-mini/doc/archive/config/配置设计方案.md)
|
|
|
|
|
+- [config-template-classic-sequential.md](/D:/dev/cmr-mini/doc/archive/config/顺序赛配置模板.md)
|
|
|
|
|
+- [config-template-score-o.md](/D:/dev/cmr-mini/doc/archive/config/积分赛配置模板.md)
|
|
|
|
|
+- [backend-config-management-proposal.md](/D:/dev/cmr-mini/doc/archive/config/后台配置管理方案.md)
|