docs: 完善项目文档和README,修复字符显示问题

- 修复README.md中的emoji字符显示问题
- 移除文档质量评级系统
- 添加贡献者致谢部分,创建详细的CONTRIBUTORS.md
- 创建核心系统文件EventNames.gd和ProjectPaths.gd
- 更新项目配置文件project.godot,添加输入映射
- 完善各模块文档,修正路径引用问题
- 创建文档更新日志CHANGELOG.md
- 优化文档结构和导航系统
This commit is contained in:
2025-12-31 18:58:38 +08:00
parent a85a7b4d0e
commit 0edd1c740b
18 changed files with 939 additions and 404 deletions

View File

@@ -22,29 +22,29 @@
### 标准目录结构
```
scenes/
├── main_scene.tscn # 场景
├── auth_scene.tscn # 认证场景
── game_scene.tscn # 游戏场景
├── settings_scene.tscn # 设置场景
└── prefabs/ # 预制体组件
├── ui/ # UI组件
│ ├── button.tscn
── dialog.tscn
── menu.tscn
├── characters/ # 角色组件
── player.tscn
── npc.tscn
├── effects/ # 特效组件
── particle_effect.tscn
│ └── animation_effect.tscn
└── items/ # 物品组件
── collectible.tscn
└── interactive.tscn
├── Maps/ # 地图场景
│ ├── main_scene.tscn # 场景
│ └── game_scene.tscn # 游戏场景
├── Components/ # 组件预制体
│ ├── ui/ # UI组件
│ │ ├── button.tscn
│ ├── dialog.tscn
── menu.tscn
── characters/ # 角色组件
│ │ ├── player.tscn
── npc.tscn
── effects/ # 特效组件
│ │ ├── particle_effect.tscn
── animation_effect.tscn
│ └── items/ # 物品组件
├── collectible.tscn
── interactive.tscn
└── auth_scene.tscn # 认证场景
```
### 场景命名规范
- **主场景**: `scene_name.tscn` (snake_case)
- **预制体**: `component_name.tscn` (snake_case)
- **主场景**: `SceneName.tscn` (PascalCase)
- **组件预制体**: `ComponentName.tscn` (PascalCase)
- **脚本文件**: `SceneName.gd` (PascalCase)
- **节点名称**: `NodeName` (PascalCase) 或 `nodeName` (camelCase)
@@ -149,7 +149,7 @@ func initialize_scene():
func load_scene_data():
"""加载场景数据"""
# 从配置文件或网络加载场景数据
var data_path = "res://data/scenes/%s.json" % SCENE_NAME.to_lower()
var data_path = ProjectPaths.get_scene_data_path(SCENE_NAME)
if FileAccess.file_exists(data_path):
var file = FileAccess.open(data_path, FileAccess.READ)
if file: