# MyGameRemake

**Repository Path**: SlayerNux_admin/MyGameRemake

## Basic Information

- **Project Name**: MyGameRemake
- **Description**: 囧囧西游之大闹天宫重置版
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-17
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MyGameRemake

囧囧西游之大闹天宫 - C++/SDL2 复刻版

## 📖 项目概述

这是一个将经典J2ME游戏《囧囧西游之大闹天宫》移植到现代平台的项目。使用C++和SDL2从零开始重新实现游戏逻辑，目标是**严格复刻**原版游戏体验，同时为未来的功能扩展和编辑器开发打下基础。

**项目阶段**：
- ✅ 阶段1：严格复刻（进行中，~60%完成）
- ⏳ 阶段2：架构重构（部分已开始）
- 📅 阶段3：QoL改进（计划中）
- 📅 阶段4：编辑器开发（计划中）

## ✨ 项目特点

- **严格复刻原版逻辑**：所有游戏机制与原版J2ME游戏保持一致
- **跨平台支持**：基于SDL2，支持Windows/Linux/macOS
- **数据驱动**：游戏内容（对话、脚本、关卡）外部化为JSON/脚本文件
- **可测试性**：脚本模式支持自动化测试和验证
- **可追溯性**：完整的代码溯源标注系统，每个函数都可追溯到原版Java代码
- **模组友好**：架构设计支持未来的第三方扩展

## 🚀 快速开始

### 编译

```bash
# 克隆项目（包括vcpkg子模块）
git clone --recursive https://github.com/yourname/MyGameRemake.git
cd MyGameRemake

# 配置CMake（首次运行会通过vcpkg自动安装依赖）
cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=third_party/vcpkg/scripts/buildsystems/vcpkg.cmake

# 编译
cmake --build build

# 运行游戏
./bin/x64-linux/game
```

### 依赖项

- **C++17** 编译器（GCC 7+、Clang 5+、MSVC 2017+）
- **CMake 3.12+**
- **SDL2、SDL2_image、SDL2_mixer**（通过vcpkg自动安装）
- **nlohmann-json**（通过vcpkg自动安装）

## 📚 文档导航

### 新手入门
- **[CLAUDE.md](CLAUDE.md)** - AI助手工作指南（包含项目架构和开发命令）
- **快速开始指南** - 编译和运行说明（见上方）

### 开发规范（⭐ 重要）
- **[docs/rules/PROJECT_CHARTER.md](docs/rules/PROJECT_CHARTER.md)** - 项目章程（核心原则、阶段定义、决策树）
- **[docs/rules/DEVELOPMENT_RULES.md](docs/rules/DEVELOPMENT_RULES.md)** - 开发规则（代码组织、命名、质量标准）
- **[docs/rules/CODE_ANNOTATION_GUIDE.md](docs/rules/CODE_ANNOTATION_GUIDE.md)** - 代码溯源标注规范
- **[docs/rules/REFACTORING_CHECKLIST.md](docs/rules/REFACTORING_CHECKLIST.md)** - 重构检查清单
- **[docs/rules/COMMIT_GUIDELINES.md](docs/rules/COMMIT_GUIDELINES.md)** - 提交规范
- **[docs/rules/TESTING_GUIDE.md](docs/rules/TESTING_GUIDE.md)** - 测试指南
- **[docs/rules/BUG_SEVERITY.md](docs/rules/BUG_SEVERITY.md)** - Bug严重程度分级

### 原版行为参考
- **[docs/original_behaviors/](docs/original_behaviors/)** - 原版游戏行为数据库
  - [battle_system.md](docs/original_behaviors/battle_system.md) - 战斗系统逻辑
  - [special_items.md](docs/original_behaviors/special_items.md) - 特殊物品效果
  - [monster_stats.json](docs/original_behaviors/monster_stats.json) - 怪物属性数据
  - [equipment_stats.json](docs/original_behaviors/equipment_stats.json) - 装备属性数据

### 项目追踪
- **[docs/reports/COMPLETION_TRACKER.md](docs/reports/COMPLETION_TRACKER.md)** - 游戏完成度追踪
- **[docs/reports/DIFFERENCES_FROM_ORIGINAL.md](docs/reports/DIFFERENCES_FROM_ORIGINAL.md)** - 与原版差异追踪

### 架构文档
- **[docs/architecture/](docs/architecture/)** - 架构设计文档
- **[docs/architecture_upgrade/](docs/architecture_upgrade/)** - 架构升级计划

### 系统文档
- **[docs/systems/](docs/systems/)** - 各子系统详细文档
  - [battle/](docs/systems/battle/) - 战斗系统
  - [item/](docs/systems/item/) - 物品系统
  - [rendering/](docs/systems/rendering/) - 渲染系统
  - [level/](docs/systems/level/) - 关卡系统

## 🛠️ 开发指南

### 功能测试

优先使用**DebugConsole命令**配合`--command`参数进行自动化测试：

```bash
# 自动执行多个调试命令
./bin/x64-linux/game --debug --command "setlv 10" --command "gold 9999"

# 运行测试脚本
./bin/x64-linux/game --script data/scripts/tests/test_battle.js
```

### 代码贡献流程

1. **遵循项目章程**：查看[PROJECT_CHARTER.md](docs/rules/PROJECT_CHARTER.md)了解当前阶段允许的操作
2. **添加代码溯源标注**：所有新函数必须添加`@origin`标签（参考[CODE_ANNOTATION_GUIDE.md](docs/rules/CODE_ANNOTATION_GUIDE.md)）
3. **遵守开发规范**：代码风格、命名、质量要求见[DEVELOPMENT_RULES.md](docs/rules/DEVELOPMENT_RULES.md)
4. **编写测试**：核心功能改动必须有测试脚本（参考[TESTING_GUIDE.md](docs/rules/TESTING_GUIDE.md)）
5. **提交代码**：遵循[COMMIT_GUIDELINES.md](docs/rules/COMMIT_GUIDELINES.md)的提交格式

### 常见开发任务

#### 添加新游戏逻辑
```cpp
// 1. 添加代码溯源标注
/**
 * @brief 新功能描述
 * @origin a.java:行号 函数名
 * @logic 核心逻辑说明
 * @key_values 关键数值
 * @differences 与原版的差异（如果有）
 */
void newFunction() {
    // 实现...
}

// 2. 更新COMPLETION_TRACKER.md中的完成度
// 3. 如有差异，记录到DIFFERENCES_FROM_ORIGINAL.md
```

#### 修复Bug
```bash
# 1. 确认bug严重程度（参考BUG_SEVERITY.md）
# 2. 编写复现测试脚本
# 3. 修复并验证测试通过
# 4. 提交时关联bug issue编号
```

## 🤝 参与贡献

欢迎贡献！在提交PR之前，请：

1. 阅读[PROJECT_CHARTER.md](docs/rules/PROJECT_CHARTER.md)了解项目原则
2. 确保代码符合[DEVELOPMENT_RULES.md](docs/rules/DEVELOPMENT_RULES.md)规范
3. 添加必要的测试
4. 更新相关文档
5. 遵循[COMMIT_GUIDELINES.md](docs/rules/COMMIT_GUIDELINES.md)提交格式

## 📜 许可证

待定

## 🙏 致谢

- 原版游戏开发者
- SDL2开发团队
- vcpkg项目
- 所有贡献者

---

**维护者**: [您的名字]
**最后更新**: 2026-02-12