@yangrunchi/a_6 1.0.0

package/A5_/346/270/270/346/210/217/345/256/242/346/210/267/347/253/257/346/250/241/345/235/227/345/274/200/345/217/221/350/247/204/350/214/203.md

@@ -0,0 +1,275 @@
+
+# -- 作者: 杨润池
+# -- 日期: 2026年05月21日
+# -- 版本: 1.3
+# -- 描述: 游戏客户端模块开发规范(v1.0)
+
+## 📌 目录 （ctrl+单击————可跳转）
+- [1. UI 资源规范](#1-ui-资源规范)
+- [2. UI 模版规范](#2-ui-模版规范)
+- [3. 配置来源（策划）](#3-配置来源策划)
+- [4. 数据来源（后端）](#4-数据来源后端)
+- [5. 数据交互](#5-数据交互)
+- [6. 红点](#6-红点)
+- [7. 启动游戏](#7-启动游戏)
+- [8. 开发效率工具](#8-开发效率工具)
+
+## 1. UI 资源规范
+
+    目标：按工程和模块划分目录，避免资源命名冲突。
+
+    目录结构：
+		dev/res/
+			├── ui/
+			│   ├── {工程名}_{模块名}/   -- 例如：ssrgame_bag/
+			│   └── ...
+			├── fonts/
+			│   ├── {工程名}_{字体名}/   -- 例如：ssrgame_fangzheng/
+			│   └── ...
+    命名规则：
+		格式：{工程名}_{模块名}、{工程名}_{字体名}
+		要求：全小写，单词间用下划线 _ 分隔
+-------------------------------------------------------------------------------------------	
+
+
+## 2. UI 模版规范
+
+    目标：区分 UI 与脚本对象，强制文件后缀，支持自动生成布局文件。
+	目录结构
+        dev/GUIExport/
+                └── {模块文件夹}/
+                    ├── Panel/               -- 存放多个 UI.lua 文件（可选）
+                    ├── Items/               -- 存放 Item 文件，命名以 Item.lua 结尾（可选）
+                    └── {XXX}UI.lua          -- UI 文件必须以 UI.lua 结尾
+   命名示例
+		类型	                    命名格式	                         示例
+		普通面板	            UI{XXX}.lua                      	 UIBagPanel.lua
+		主面板              	UIMain{XXX}.lua	                     UIMainBag.lua
+		子面板              	UISub{XXX}.lua	                     UISubBag.lua
+		Item	                {XXX}Item.lua	                     无
+
+    自动生成映射    
+		源文件                                          	自动生成文件
+		dev/GUIExport/bag/UIBag.lua                      	dev/GUILayout/bag/UIBagPanel.lua
+		dev/GUIExport/bag/UIMainBag.lua                     dev/GUILayout/bag/UIMainBagPanel.lua
+		dev/GUIExport/bag/UISubBag.lua	                    dev/GUILayout/bag/UISubBagPanel.lua
+
+	    若以UI{XXX}.lua后缀结尾 -->  则首次自动生成GUILayout 目录下的 lua 文件。
+
+   模版类型 —— 区分单独面板和子面板，减少重复代码
+        
+		类型一：单独面板（不依赖一级背景框）
+			适用：UI{XXX}.lua、UIMain{XXX}.lua
+			模版：A4_template_1.txt
+```lua 
+				ssrObjCfg.Wing = {
+						ID          = 41600,
+
+						OBJ_PATH    = "GUILayout/R/UIWingPanel",
+						UI_PATH     = "R/WingUI",
+						UI_Name     = "翅膀"				
+					}
+
+				-- 打开方式
+				ssrUIManager:OPEN(ssrObjCfg.Wing)
+ ```
+#### 类型二：子面板（依赖通用一级背景框 ComOneBgOBJ）
+- **适用**：UISub{XXX}.lua
+- **模版**：A4_template_2.txt
+- **目的**：
+		依赖通用一级背景框的模版  ,就是把子界面拼接组装到 ComOneBgOBJ 里面，更灵活些。
+- **注意事项**：	
+			1、通用一级框 ComOneBgOBJ , 包含 遮罩 背景 关闭 问号 页签(有无都支持) 红点 等，能用一级背景框，尽量使用。
+				
+			2、子界面 【垂直水平居中】 推荐使用节点
+					第一种：基础容器 + 节点      —— 【N多元素 放2级节点里面】
+						1级 基础容器  描点(0.5,0.5)  坐标(50%,50% ) 尺寸(100%,100%) 
+						2级 节点      描点(0,0)      坐标(50%,50% ) 尺寸(0,0) 
+					
+					第二种：基础容器 + 基础容器  —— 【N多元素 放2级基础容器里面】
+						1级 基础容器  描点(0.5,0.5)  坐标(50%,50% ) 尺寸(100%,100%) 
+						2级 基础容器  描点(0.5,0.5)  坐标(50%,50% ) 尺寸(1136,640) 
+
+			无分页模式： 
+			-----------------------------------------------------------
+```lua 
+				--邮件 
+				ssrObjCfg.Mail = {
+					ID       = 96000,
+					OBJ_PATH = "GUILayout/social/mail/UISubMailPanel",
+					UI_PATH  = "social/mail/UISubMail",
+					UI_Name  = "邮件"
+				}
+				
+                --无页签 例如{XXX}NoPage
+				ssrObjCfg.MailNoPage = {
+					ID        = 90205,
+					OBJ_ORDER = { ssrObjCfg.Mail },
+					--OBJ_DESCRIBE = { "41400" }, 没有页签注释
+					OBJ_TITLE = { "96000" },  
+					OBJ_PATH  = "GUILayout/R/Com/ComOneBgOBJ",
+					UI_PATH   = "R/Com/ComOneBgUI",
+				}
+	            -- 打开方式
+				ssrUIManager:OPEN(ssrObjCfg.Mail)
+```
+			------------------------------------------------------------
+
+			**有分页模式**：	
+				2.2.1 注册子界面
+```lua 
+				--强化子界面
+				ssrObjCfg.EquipQH = {
+					ID          = 1049,
+					OBJ_PATH    = "GUILayout/R/Equip/UISubEquipQHPanel",
+					UI_PATH     = "R/Equip/UISubEquipQH",
+					UI_Name     = "强化"
+				}
+
+				--升星子界面
+				ssrObjCfg.EquipSX = {
+					ID          = 1050,
+					OBJ_PATH    = "GUILayout/R/Equip/UISubEquipSXPanel",
+					UI_PATH     = "R/Equip/UISubEquipSX",
+					UI_Name     = "升星"
+				}
+
+				--洗练子界面
+				ssrObjCfg.EquipXL = {
+					ID       = 1051,
+					OBJ_PATH = "GUILayout/R/Equip/UISubEquipXLPanel",
+					UI_PATH  = "R/Equip/UISubEquipXL",
+					UI_Name  = "洗练"
+				}
+
+				--镶嵌子界面
+				ssrObjCfg.EquipXQ = {
+					ID          = 1052,
+					OBJ_PATH    = "GUILayout/R/Equip/UISubEquipXQPanel",
+					UI_PATH     = "R/Equip/UISubEquipXQ",
+					UI_Name     = "镶嵌"
+				}
+
+				------------------------  子界面  end ------------------------
+
+			    2.2.2 注册主界面
+
+                --有页签 例如 {XXX}Page
+				--例如：装备 强化、升星、洗练、镶嵌
+				ssrObjCfg.EquipPage = {
+					ID           = 90107,
+
+					OBJ_ORDER    = { ssrObjCfg.EquipQH, ssrObjCfg.EquipSX, ssrObjCfg.EquipXQ, ssrObjCfg.EquipXL },
+					OBJ_DESCRIBE = { "强化", "升星", "镶嵌", "洗炼" },   -- OBJ_DESCRIBE 数字 按钮名字是图片 ，否则按钮名字是中文
+					OBJ_TITLE    = { "1049", "1049", "1049", "1049" },
+
+					OBJ_PATH     = "GUILayout/R/Com/ComOneBgOBJ",
+					UI_PATH      = "R/Com/ComOneBgUI",
+				}
+             
+                -- 打开方式（自动选中对应页签）
+				--打开强化界面 且会选择第一个页签  ssrUIManager:OPEN(ssrObjCfg.EquipQH)
+				--打开升星界面 且会选择第二个页签  ssrUIManager:OPEN(ssrObjCfg.EquipSX)
+				--打开镶嵌界面 且会选择第三个页签  ssrUIManager:OPEN(ssrObjCfg.EquipXQ)
+				--打开洗炼界面 且会选择第四个页签  ssrUIManager:OPEN(ssrObjCfg.EquipXL)
+
+			---------------------------------------------------------------------------------
+```
+	本地生成方式1：手动执行命令可自动生成（已集成VSCode任务【Run AutoCode】，可自定义快捷键）
+	本地生成方式2：http://localhost:8080/  进入地址执行 (步骤: H:\NiePanChuanQi\Tools\Tool_other\bat_manager\sm.md)
+
+## 3. 配置来源（策划）
+
+    源文件：  Project\MirServer\功能模块表
+	
+	后端生成文件：Project\MirServer\Mir200\Envir\QuestDiary\cfgcsv                         —— 自动生成自动提交SVN
+    前端生成文件：Project\996M2_Client\dev\GUILayout\ssrgame\csvcfg                        —— 自动生成自动提交SVN
+	
+    本地生成方式：策划提交配置后。手动执行命令可自动生成（已集成VSCode任务【Run Table Client】，可自定义快捷键）
+	远程生成方式：http://10.13.0.26:8080/  进入地址执行
+
+## 4. 数据来源（后端）
+
+	源文件1：Project\NetMsg
+	源文件2：Project\MirServer\Mir200\Envir\QuestDiary\net\NetMsgCfg.lua
+	
+	前端生成文件：Project\996M2_Client\dev\GUILayout\ssrgame\net\NetMsgCfg.lua            
+	前端生成目录下所有文件：Project\996M2_Client\dev\GUILayout\ssrgame\funcData      
+	前端生成文件：Project\996M2_Client\dev\GUILayout\ssrgame\mgr\FuncDataMgr.lua      
+	
+    本地生成方式：后端提交协议(源文件)后，手动执行命令可自动生成（已集成VSCode任务【Run NetMsg Sync】，可自定义快捷键）
+	远程生成方式：http://10.13.0.26:8080/  进入地址执行
+  
+## 5. 数据交互
+
+ dev/GUILayout/ssrgame/funcData              存放协议数据类  【Run NetMsg Sync】      —— 自动生成自动提交SVN
+ dev/GUILayout/ssrgame/mgr/FuncDataMgr.lua   注册协议类名    【Run NetMsg Sync】      —— 自动生成自动提交SVN
+     **例如：**
+```lua 
+		-- 第一种：以第一列作为 Key
+			local curCfg = ssrTableMgr.cfg_item_add[道具ID]
+			local curCfg = ssrTableMgr.cfg_item[道具ID]
+			local curCfg = ssrTableMgr.cfg_equip[装备ID]
+
+		-- 第二种 table的任意列 作为key 如下可获取
+			表 第一列和第二列数据一样
+			local curCfg = ssrTableMgr:GetCfg(table, 字段名, 字段名的值)
+
+		-- 第三种 table的任意列 作为key 如下可获取 字段组的配置且可排序
+
+			local groupCfgs = ssrTableMgr:GetCfgs(table, 字段名,字段名的值,排序)
+
+			-- 分组配置：当 fieldValue == 大于 0 时，获取单个table配置 。且 可选择 排序 
+			local groupCfgs = ssrTableMgr:GetCfgs(ssrTableMgr.cfg_new_gongming, "type", 1)
+
+			-- 所有配置：当 fieldValue == -1 时，获取所有配置(单个table) 。通过Id分组 ，且 可选择 排序 
+			local groupCfgs = ssrTableMgr:GetCfgs(ssrTableMgr.cfg_new_chenghao, "id", -1, {"-id"})
+			-- 筛选配置：当 fieldValue == -2 时，筛选所有有值的配置(嵌套table)。 通过Id分组 ，且 可选择 排序
+			local groupCfgs = ssrTableMgr:GetCfgs(ssrTableMgr.cfg_new_chenghao, "id", -2, {"+id"})
+			--  分组配置：当 fieldValue == -3 时。获取所有非空值配置(嵌套table)，通过Id分组 把数据拆分成 多个table, 且 可选择 排序
+			local groupCfgs = ssrTableMgr:GetCfgs(ssrTableMgr.cfg_new_chenghao, "id", -3,  {"+id"})
+ ```
+
+ dev/GUILayout/ssrgame/mgr/TableMgr.lua      注册配置表名    【Run Table Client】     —— 自动生成自动提交SVN
+
+
+## 6. 红点
+### 红点注册方式
+```lua 
+	-- 主界面红点注册
+	ssrRedMgr:Register(主界面红点对象, ssrObjCfg.NiepanZB.ID, "mianBtnRed")
+
+	-- 通用页签红点注册
+	ssrRedMgr:Register(页签红点对象, ssrObjCfg.NiepanZB.ID)
+
+	-- 设置主界面红点和页签红点（模块ID，状态）
+	ssrRedMgr:SetRed(ssrObjCfg.NiepanZB.ID, isRed)
+
+	-- 界面内红点注册（按钮、列表等）
+	ssrRedMgr:Register(红点对象1, 模块ID, 参数1)
+	ssrRedMgr:Register(红点对象2, 模块ID, 参数2)
+
+	-- 设置界面内红点（模块ID，状态，参数）
+	ssrRedMgr:SetRed(ssrObjCfg.NiepanZB.ID, isRed, 参数1)
+	ssrRedMgr:SetRed(ssrObjCfg.NiepanZB.ID, isRed, 参数2)
+
+	-- 注意：参数格式为 NiepanData、XiLianData、ChenghaoData 等 Vo 对象
+
+ ```
+
+## 7. 启动游戏
+
+ 已集成VSCode任务【Run 996M2 Client】，可自定义快捷键 默认使用启动【Ctrl+F6】
+
+## 8. 开发效率工具
+
+### 方式一：VSCode 任务集成 + 快捷键安装脚本
+
+   **配置文件：**  `dev/.vscode/project-keys.json`
+   **启用快捷键：终端执行**	 `node a_tools/a_node/Tools/install-keys.js`
+   **禁用快捷键：终端执行**	 `node a_tools/a_node/Tools/uninstall-keys.js`
+   `修改 project-keys.json 后，必须重新执行【启用快捷键】`
+
+### 方式二：远程执行脚本（适合非 VSCode 用户）无需安装 VSCode，打开浏览器即可使用
+
+### 远程地址：http://10.13.0.26:8080/