cocos-obfuscator 1.0.0

package/README/QUICKSTART.md

@@ -0,0 +1,160 @@
+# 快速开始
+
+## 5 分钟快速上手
+
+### 场景：在另一个 Cocos Creator 项目中使用
+
+假设你有一个新项目 `/path/to/my-game`，想要使用混淆工具。
+
+---
+
+## 最简单的方法（推荐）
+
+### 步骤 1：在当前项目链接包
+
+```bash
+# 在 happyMahjongElimination 项目目录下
+cd cocos-obfuscator
+npm link
+```
+
+输出类似：
+```
+C:\Users\YourName\AppData\Roaming\npm\node_modules\cocos-obfuscator -> D:\projects\cocos\happyMahjongElimination\cocos-obfuscator
+```
+
+### 步骤 2：在新项目中使用
+
+```bash
+# 进入你的新项目
+cd /path/to/my-game
+
+# 链接包
+npm link cocos-obfuscator
+```
+
+### 步骤 3：运行混淆工具
+
+```bash
+# 交互式选择（推荐）
+cocos-obfuscate
+
+# 或直接指定参数
+cocos-obfuscate --platform bytedance
+```
+
+---
+
+## 实际使用示例
+
+### 示例 1：在项目 package.json 中配置
+
+在你的新项目的 `package.json` 中添加：
+
+```json
+{
+  "name": "my-game",
+  "version": "1.0.0",
+  "scripts": {
+    "obfuscate": "cocos-obfuscate",
+    "obfuscate:bytedance": "cocos-obfuscate --platform bytedance",
+    "obfuscate:wechat": "cocos-obfuscate --platform wechatgame --include-subpackages"
+  },
+  "devDependencies": {
+    "cocos-obfuscator": "file:../happyMahjongElimination/cocos-obfuscator"
+  }
+}
+```
+
+然后：
+
+```bash
+# 安装依赖
+npm install
+
+# 使用
+npm run obfuscate
+npm run obfuscate:bytedance
+npm run obfuscate:wechat
+```
+
+### 示例 2：构建后自动混淆
+
+```json
+{
+  "scripts": {
+    "build": "你的构建命令",
+    "obfuscate": "cocos-obfuscate",
+    "build:release": "npm run build && npm run obfuscate"
+  }
+}
+```
+
+运行：
+
+```bash
+npm run build:release
+```
+
+---
+
+## 路径说明
+
+### 使用 file: 路径时的相对路径
+
+如果你的项目结构是：
+
+```
+projects/
+  ├── happyMahjongElimination/
+  │   └── cocos-obfuscator/
+  └── my-game/
+      └── package.json
+```
+
+在 `my-game/package.json` 中：
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "file:../happyMahjongElimination/cocos-obfuscator"
+  }
+}
+```
+
+### 使用绝对路径
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "file:D:/projects/cocos/happyMahjongElimination/cocos-obfuscator"
+  }
+}
+```
+
+---
+
+## 验证安装
+
+运行以下命令验证是否安装成功：
+
+```bash
+# 检查命令是否存在
+which cocos-obfuscate  # Linux/Mac
+where cocos-obfuscate  # Windows
+
+# 查看帮助
+cocos-obfuscate --help
+
+# 或使用 npx
+npx cocos-obfuscate --help
+```
+
+---
+
+## 下一步
+
+- 查看 [README.md](./README.md) 了解完整功能
+- 查看 [INSTALL.md](./INSTALL.md) 了解其他安装方法
+- 查看 [USAGE.md](./USAGE.md) 了解高级用法
+

package/README/README.md

@@ -0,0 +1,130 @@
+# Cocos Obfuscator
+
+Cocos Creator 项目代码混淆工具，支持字节跳动小游戏和微信小游戏平台。
+
+## 功能特性
+
+- ✅ 支持 Cocos Creator 2.x 和 3.x 版本
+- ✅ 支持字节跳动小游戏（bytedance/bytedance-mini-game）
+- ✅ 支持微信小游戏（wechatgame）
+- ✅ 交互式选择界面（使用键盘上下键）
+- ✅ 自动备份原文件
+- ✅ 支持分包文件混淆
+- ✅ 优化的混淆配置，平衡安全性和文件大小
+
+## 安装
+
+### 方式一：作为项目依赖安装
+
+```bash
+npm install cocos-obfuscator --save-dev
+```
+
+### 方式二：全局安装
+
+```bash
+npm install -g cocos-obfuscator
+```
+
+### 方式三：从本地目录安装
+
+```bash
+npm install /path/to/cocos-obfuscator
+```
+
+### 方式四：从 Git 仓库安装（支持 Gitee、GitHub、GitLab）
+
+```bash
+# Gitee
+npm install git+https://gitee.com/your-username/cocos-obfuscator.git
+
+# GitHub
+npm install git+https://github.com/your-username/cocos-obfuscator.git
+
+# 私有仓库（使用 SSH）
+npm install git+ssh://git@gitee.com/your-username/cocos-obfuscator.git
+```
+
+**注意**：Gitee 目前不支持 npm 包托管，但可以从 Git 仓库直接安装。详细说明请查看 [GITEE.md](./GITEE.md)。
+
+## 使用方法
+
+### 交互式选择模式（推荐）
+
+在项目根目录运行：
+
+```bash
+# 如果作为项目依赖安装
+npx cocos-obfuscate
+
+# 如果全局安装
+cocos-obfuscate
+```
+
+运行后会进入交互式选择：
+1. 选择平台（bytedance 2.x / bytedance-mini-game 3.x / wechatgame）
+2. 选择是否包含分包文件
+
+### 命令行参数模式
+
+```bash
+# 指定平台
+cocos-obfuscate --platform bytedance
+cocos-obfuscate --platform bytedance-mini-game
+cocos-obfuscate --platform wechatgame
+
+# 包含分包文件
+cocos-obfuscate --platform wechatgame --include-subpackages
+
+# 指定项目目录
+cocos-obfuscate --platform bytedance --project-dir /path/to/project
+```
+
+### 在 package.json 中添加脚本
+
+```json
+{
+  "scripts": {
+    "obfuscate": "cocos-obfuscate"
+  }
+}
+```
+
+然后运行：
+
+```bash
+npm run obfuscate
+```
+
+## 命令行选项
+
+- `--platform <平台>` - 指定平台: `bytedance` (2.x版本) 或 `bytedance-mini-game` (3.x版本) 或 `wechatgame`
+- `--include-subpackages` - 包含分包文件进行混淆
+- `--no-subpackages` - 不包含分包文件
+- `--project-dir <目录>` - 指定项目目录（默认为当前目录）
+- `--help, -h` - 显示帮助信息
+
+## 项目结构要求
+
+工具会在以下路径查找文件：
+
+- 主包文件: `build/{platform}/assets/main/index.*.js`
+- 分包文件: `build/{platform}/subpackages/*/game.js`
+
+## 注意事项
+
+1. 混淆前会自动创建 `.backup` 备份文件
+2. 如果混淆后游戏无法正常运行，可以使用备份文件恢复
+3. 建议在构建完成后、发布前进行混淆
+4. 混淆会增加文件大小，但会提高代码安全性
+
+## 支持的平台
+
+- **bytedance** - 字节跳动小游戏（Cocos Creator 2.x）
+- **bytedance-mini-game** - 字节跳动小游戏（Cocos Creator 3.x）
+- **wechatgame** - 微信小游戏
+
+## 许可证
+
+ISC
+

package/README/USAGE.md

@@ -0,0 +1,100 @@
+# 使用指南
+
+## 发布到 npm（可选）
+
+如果你想将这个包发布到 npm 供其他人使用：
+
+1. 登录 npm：
+```bash
+npm login
+```
+
+2. 发布包：
+```bash
+cd cocos-obfuscator
+npm publish
+```
+
+## 本地使用（推荐）
+
+### 方式一：使用 npm link（开发时推荐）
+
+在当前项目目录：
+
+```bash
+cd cocos-obfuscator
+npm link
+```
+
+然后在其他项目中使用：
+
+```bash
+cd /path/to/other/project
+npm link cocos-obfuscator
+```
+
+之后就可以在任何项目中使用 `cocos-obfuscate` 命令了。
+
+### 方式二：从本地路径安装
+
+在其他项目的 `package.json` 中添加：
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "file:../cocos-obfuscator"
+  }
+}
+```
+
+然后运行：
+
+```bash
+npm install
+```
+
+### 方式三：从 Git 仓库安装
+
+如果包在 Git 仓库中，可以直接安装：
+
+```bash
+npm install git+https://your-repo-url.git#cocos-obfuscator
+```
+
+## 在其他项目中使用
+
+安装后，在项目的 `package.json` 中添加脚本：
+
+```json
+{
+  "scripts": {
+    "obfuscate": "cocos-obfuscate",
+    "obfuscate:bytedance": "cocos-obfuscate --platform bytedance",
+    "obfuscate:wechat": "cocos-obfuscate --platform wechatgame --include-subpackages"
+  }
+}
+```
+
+然后运行：
+
+```bash
+npm run obfuscate
+```
+
+## 更新包
+
+如果使用 npm link：
+
+```bash
+cd cocos-obfuscator
+# 修改代码后
+npm link
+```
+
+如果使用 file: 路径安装，需要重新安装：
+
+```bash
+cd /path/to/other/project
+npm install
+```
+

package/README//345/234/250/345/205/266/344/273/226/351/241/271/347/233/256/344/270/255/344/275/277/347/224/250.md

@@ -0,0 +1,252 @@
+# 如何在其他项目中使用
+
+## 🚀 快速开始（3 步完成）
+
+### 第一步：在当前项目链接包（已完成 ✅）
+
+```bash
+cd cocos-obfuscator
+npm link
+```
+
+**注意**：这个步骤只需要执行一次，现在已经完成了。
+
+### 第二步：在新项目中链接
+
+进入你的其他 Cocos Creator 项目目录，运行：
+
+```bash
+cd /path/to/your/other/project
+npm link cocos-obfuscator
+```
+
+### 第三步：使用
+
+```bash
+# 交互式选择（推荐）
+cocos-obfuscate
+
+# 或直接指定参数
+cocos-obfuscate --platform bytedance
+cocos-obfuscate --platform wechatgame --include-subpackages
+```
+
+---
+
+## 📝 完整示例
+
+假设你有一个新项目 `my-game`，目录结构如下：
+
+```
+D:\projects\
+  ├── cocos\
+  │   ├── happyMahjongElimination\    (当前项目)
+  │   │   └── cocos-obfuscator\
+  │   └── my-game\                     (新项目)
+  │       ├── package.json
+  │       └── build\
+```
+
+### 方法 A：使用 npm link（最简单）
+
+```bash
+# 1. 在新项目中链接（只需一次）
+cd D:\projects\cocos\my-game
+npm link cocos-obfuscator
+
+# 2. 使用
+cocos-obfuscate
+```
+
+### 方法 B：在 package.json 中配置（推荐用于团队）
+
+在 `my-game/package.json` 中添加：
+
+```json
+{
+  "name": "my-game",
+  "version": "1.0.0",
+  "scripts": {
+    "obfuscate": "cocos-obfuscate"
+  },
+  "devDependencies": {
+    "cocos-obfuscator": "file:../happyMahjongElimination/cocos-obfuscator"
+  }
+}
+```
+
+然后：
+
+```bash
+cd D:\projects\cocos\my-game
+npm install
+npm run obfuscate
+```
+
+---
+
+## 🎯 常用场景
+
+### 场景 1：单个项目使用
+
+```bash
+# 在新项目中
+npm link cocos-obfuscator
+cocos-obfuscate --platform bytedance
+```
+
+### 场景 2：多个项目使用
+
+每个项目都执行：
+
+```bash
+npm link cocos-obfuscator
+```
+
+或者使用 `file:` 路径在各自的 `package.json` 中配置。
+
+### 场景 3：集成到构建流程
+
+在 `package.json` 中：
+
+```json
+{
+  "scripts": {
+    "build": "你的构建命令",
+    "obfuscate": "cocos-obfuscate",
+    "build:release": "npm run build && npm run obfuscate"
+  }
+}
+```
+
+运行：
+
+```bash
+npm run build:release
+```
+
+---
+
+## ⚙️ 配置选项
+
+### 在 package.json 中添加多个脚本
+
+```json
+{
+  "scripts": {
+    "obfuscate": "cocos-obfuscate",
+    "obfuscate:bytedance": "cocos-obfuscate --platform bytedance",
+    "obfuscate:bytedance3": "cocos-obfuscate --platform bytedance-mini-game",
+    "obfuscate:wechat": "cocos-obfuscate --platform wechatgame",
+    "obfuscate:wechat:full": "cocos-obfuscate --platform wechatgame --include-subpackages"
+  }
+}
+```
+
+使用：
+
+```bash
+npm run obfuscate:bytedance
+npm run obfuscate:wechat:full
+```
+
+---
+
+## 🔍 验证安装
+
+检查是否安装成功：
+
+```bash
+# Windows
+where cocos-obfuscate
+
+# Linux/Mac
+which cocos-obfuscate
+
+# 查看帮助
+cocos-obfuscate --help
+```
+
+---
+
+## ❓ 常见问题
+
+### Q1: 提示找不到命令？
+
+**A:** 使用 `npx` 运行：
+
+```bash
+npx cocos-obfuscate
+```
+
+或者在 `package.json` 中配置脚本后使用：
+
+```bash
+npm run obfuscate
+```
+
+### Q2: 如何更新包？
+
+**A:** 如果使用 `npm link`：
+
+```bash
+# 在 cocos-obfuscator 目录修改代码后
+cd cocos-obfuscator
+npm link  # 重新链接
+```
+
+如果使用 `file:` 路径：
+
+```bash
+# 在新项目中
+npm install  # 重新安装
+```
+
+### Q3: 可以同时用于多个项目吗？
+
+**A:** 可以！每个项目都可以独立使用：
+
+```bash
+# 项目 A
+cd project-a
+npm link cocos-obfuscator
+
+# 项目 B
+cd project-b
+npm link cocos-obfuscator
+```
+
+### Q4: 如何卸载？
+
+**A:** 
+
+```bash
+# 在新项目中
+npm unlink cocos-obfuscator
+
+# 或从 package.json 中删除依赖后
+npm install
+```
+
+---
+
+## 📚 更多信息
+
+- [README.md](./README.md) - 完整功能说明
+- [QUICKSTART.md](./QUICKSTART.md) - 快速开始指南
+- [INSTALL.md](./INSTALL.md) - 详细安装方法
+- [USAGE.md](./USAGE.md) - 高级用法
+
+---
+
+## ✅ 检查清单
+
+使用前确认：
+
+- [ ] 已运行 `npm link`（在 cocos-obfuscator 目录）
+- [ ] 在新项目中运行了 `npm link cocos-obfuscator`
+- [ ] 项目有 `build/{platform}/assets/main/` 目录
+- [ ] 已执行过 Cocos Creator 构建
+
+现在就可以开始使用了！🎉
+