cocos-obfuscator 1.0.0

package/README//345/256/211/350/243/205/346/226/271/346/263/225/346/200/273/347/273/223.md

@@ -0,0 +1,267 @@
+# 安装方法总结
+
+## 🚀 快速选择指南
+
+根据你的使用场景，选择最适合的方法：
+
+| 场景 | 推荐方法 | 命令 |
+|------|---------|------|
+| **本地开发，单个项目** | npm link | `npm link` → `npm link cocos-obfuscator` |
+| **本地开发，多个项目** | file: 路径 | `"cocos-obfuscator": "file:../path"` |
+| **团队协作，使用 Gitee** | Git 安装 | `git+https://gitee.com/...` |
+| **团队协作，使用 GitHub** | Git 安装 | `git+https://github.com/...` |
+| **企业内网** | Verdaccio | 自建私有 npm 仓库 |
+| **使用 GitLab** | GitLab Package | GitLab Package Registry |
+
+---
+
+## 方法对比
+
+### 1. npm link（最简单，适合本地）
+
+**优点**：
+- ✅ 安装简单
+- ✅ 修改代码后自动生效
+- ✅ 适合开发调试
+
+**缺点**：
+- ❌ 需要手动在每个项目链接
+- ❌ 不适合生产环境
+
+**使用**：
+```bash
+cd cocos-obfuscator && npm link
+cd your-project && npm link cocos-obfuscator
+```
+
+---
+
+### 2. file: 路径（推荐，适合团队）
+
+**优点**：
+- ✅ 版本控制友好
+- ✅ 适合团队协作
+- ✅ 可以指定相对路径
+
+**缺点**：
+- ❌ 路径变化需要更新
+- ❌ 跨机器需要调整路径
+
+**使用**：
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "file:../cocos-obfuscator"
+  }
+}
+```
+
+---
+
+### 3. Gitee Git 安装（推荐，国内访问快）
+
+**优点**：
+- ✅ 国内访问速度快
+- ✅ 支持私有仓库
+- ✅ 版本控制完善
+
+**缺点**：
+- ❌ Gitee 不支持 npm registry
+- ❌ 安装速度较慢（需要 clone）
+
+**使用**：
+```bash
+# 公开仓库
+npm install git+https://gitee.com/username/cocos-obfuscator.git
+
+# 私有仓库（SSH）
+npm install git+ssh://git@gitee.com/username/cocos-obfuscator.git
+```
+
+**详细说明**：查看 [GITEE.md](./GITEE.md)
+
+---
+
+### 4. GitHub Git 安装
+
+**优点**：
+- ✅ 全球访问
+- ✅ 支持 GitHub Packages（npm registry）
+- ✅ 生态完善
+
+**缺点**：
+- ❌ 国内访问可能较慢
+
+**使用**：
+```bash
+npm install git+https://github.com/username/cocos-obfuscator.git
+```
+
+---
+
+### 5. 发布到 npm（公开）
+
+**优点**：
+- ✅ 安装简单
+- ✅ 版本管理完善
+- ✅ 全球可用
+
+**缺点**：
+- ❌ 包是公开的
+- ❌ 需要 npm 账号
+
+**使用**：
+```bash
+npm install cocos-obfuscator
+```
+
+---
+
+### 6. 私有 npm 仓库
+
+**方案 A：Verdaccio（自建）**
+
+```bash
+# 安装 Verdaccio
+npm install -g verdaccio
+
+# 启动服务
+verdaccio
+
+# 配置使用
+npm config set registry http://localhost:4873
+
+# 发布
+cd cocos-obfuscator && npm publish
+```
+
+**方案 B：GitLab Package Registry**
+
+```json
+{
+  "name": "@your-scope/cocos-obfuscator",
+  "publishConfig": {
+    "@your-scope:registry": "https://gitlab.com/api/v4/projects/ID/packages/npm/"
+  }
+}
+```
+
+**方案 C：华为云 CodeArts**
+
+在华为云 CodeArts 创建 npm 私有仓库，配置后发布。
+
+---
+
+## 📋 完整安装步骤示例
+
+### 示例 1：使用 Gitee（推荐国内用户）
+
+#### 步骤 1：推送到 Gitee
+
+```bash
+cd cocos-obfuscator
+git init
+git add .
+git commit -m "Initial commit"
+git remote add origin https://gitee.com/your-username/cocos-obfuscator.git
+git push -u origin master
+```
+
+#### 步骤 2：在其他项目中安装
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+https://gitee.com/your-username/cocos-obfuscator.git"
+  },
+  "scripts": {
+    "obfuscate": "cocos-obfuscate"
+  }
+}
+```
+
+```bash
+npm install
+npm run obfuscate
+```
+
+---
+
+### 示例 2：使用 npm link（本地开发）
+
+```bash
+# 在 cocos-obfuscator 目录
+npm link
+
+# 在其他项目
+npm link cocos-obfuscator
+cocos-obfuscate
+```
+
+---
+
+### 示例 3：使用 file: 路径（团队协作）
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "file:D:/projects/cocos-obfuscator"
+  }
+}
+```
+
+```bash
+npm install
+npx cocos-obfuscate
+```
+
+---
+
+## 🔍 选择建议
+
+### 个人开发者
+- **推荐**：npm link 或 file: 路径
+
+### 小团队（2-5人）
+- **推荐**：Gitee Git 安装 或 file: 路径
+
+### 大团队（5人以上）
+- **推荐**：私有 npm 仓库（Verdaccio）或 GitLab Package
+
+### 企业用户
+- **推荐**：私有 npm 仓库 或 企业级制品仓库（如华为云 CodeArts）
+
+---
+
+## 📚 相关文档
+
+- [README.md](./README.md) - 基本使用说明
+- [GITEE.md](./GITEE.md) - Gitee 详细使用指南
+- [INSTALL.md](./INSTALL.md) - 完整安装方法
+- [QUICKSTART.md](./QUICKSTART.md) - 快速开始
+- [在其他项目中使用.md](./在其他项目中使用.md) - 中文使用指南
+
+---
+
+## ❓ 常见问题
+
+### Q: Gitee 支持 npm 包托管吗？
+
+A: 目前不支持，但可以从 Git 仓库直接安装。详见 [GITEE.md](./GITEE.md)
+
+### Q: 哪种方法最快？
+
+A: npm link 最快，但只适合本地开发。
+
+### Q: 哪种方法最适合团队？
+
+A: 从 Git 仓库安装（Gitee/GitHub）或使用私有 npm 仓库。
+
+### Q: 如何更新包？
+
+A: 
+- npm link: 修改代码后自动生效
+- file: 路径: `npm install`
+- Git 安装: `npm update cocos-obfuscator`
+- npm 安装: `npm update cocos-obfuscator`
+

package/index.js

@@ -0,0 +1,361 @@
+#!/usr/bin/env node
+
+const JavaScriptObfuscator = require('javascript-obfuscator');
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+
+// 混淆配置 - 兼顾隐藏标识符/字符串与体积
+const obfuscationOptions = {
+    compact: true,                    // 压缩输出
+    controlFlowFlattening: false,     // 禁用控制流扁平化（大幅减少体积）
+    deadCodeInjection: false,         // 禁用死代码注入（减少文件大小）
+    debugProtection: false,           // 禁用调试保护（避免影响游戏运行）
+    disableConsoleOutput: false,     // 不禁用console（游戏可能需要）
+    identifierNamesGenerator: 'mangled',  // 更难读的标识符生成器
+    log: false,                       // 不输出日志
+    numbersToExpressions: false,      // 禁用数字转表达式（减少体积）
+    renameGlobals: true,              // 重命名全局变量以隐藏脚本名称
+    reservedNames: [                  // 保留必要全局，避免运行错误
+        '^cc$', '^window$', '^document$', '^wx$', '^tt$', '^setTimeout$',
+        '^setInterval$', '^clearTimeout$', '^clearInterval$'
+    ],
+    selfDefending: false,             // 关闭以减少体积并便于调试
+    simplify: true,                   // 简化代码
+    splitStrings: false,              // 禁用字符串分割（减少体积）
+    stringArray: true,                // 开启字符串数组以隐藏字符串文字（含文件名）
+    stringArrayThreshold: 0.05,       // 较低阈值，平衡体积
+    stringArrayEncoding: ['base64'],  // 编码字符串，避免直观暴露
+    stringArrayRotate: true,         // 字符串数组旋转
+    stringArrayShuffle: true,        // 字符串数组洗牌
+    stringArrayWrappersCount: 1,     // 保持较低包装层数
+    transformObjectKeys: false,      // 禁用对象键转换（避免破坏游戏）
+    unicodeEscapeSequence: false     // 禁用unicode转义序列（减少体积）
+};
+
+// 混淆单个文件
+function obfuscateFile(targetFile) {
+    // 检查文件是否存在
+    if (!fs.existsSync(targetFile)) {
+        console.warn('文件不存在，跳过:', targetFile);
+        return false;
+    }
+
+    const backupFile = targetFile + '.backup';
+    
+    console.log('\n========================================');
+    console.log('开始混淆文件:', targetFile);
+    
+    try {
+        // 读取原文件
+        const originalCode = fs.readFileSync(targetFile, 'utf8');
+        
+        // 创建备份
+        fs.writeFileSync(backupFile, originalCode, 'utf8');
+        console.log('已创建备份文件:', backupFile);
+        
+        // 执行混淆
+        const obfuscationResult = JavaScriptObfuscator.obfuscate(originalCode, obfuscationOptions);
+        const obfuscatedCode = obfuscationResult.getObfuscatedCode();
+        
+        // 写入混淆后的代码
+        fs.writeFileSync(targetFile, obfuscatedCode, 'utf8');
+        
+        console.log('混淆完成！');
+        console.log('原文件大小:', (originalCode.length / 1024).toFixed(2), 'KB');
+        console.log('混淆后大小:', (obfuscatedCode.length / 1024).toFixed(2), 'KB');
+        console.log('备份文件:', backupFile);
+        
+        return true;
+        
+    } catch (error) {
+        console.error('混淆过程中出现错误:', error);
+        console.log('正在恢复备份文件...');
+        if (fs.existsSync(backupFile)) {
+            const backupCode = fs.readFileSync(backupFile, 'utf8');
+            fs.writeFileSync(targetFile, backupCode, 'utf8');
+        }
+        return false;
+    }
+}
+
+// 交互式选择菜单
+function interactiveSelect(options, question) {
+    return new Promise((resolve) => {
+        if (!process.stdin.isTTY) {
+            // 非交互式环境，使用默认值
+            console.log(question);
+            console.log('非交互式环境，使用默认值:', options[0].label);
+            resolve(options[0].value);
+            return;
+        }
+
+        let selectedIndex = 0;
+        let isResolved = false;
+
+        // 设置原始模式以捕获特殊按键
+        const wasRawMode = process.stdin.isRaw || false;
+        process.stdin.setRawMode(true);
+        process.stdin.resume();
+        process.stdin.setEncoding('utf8');
+
+        // 隐藏光标
+        process.stdout.write('\x1B[?25l');
+
+        // 显示菜单
+        function displayMenu() {
+            // 移动光标到开头并清除屏幕
+            process.stdout.write('\x1B[2J\x1B[H');
+            process.stdout.write(question + '\n');
+            process.stdout.write('使用 ↑↓ 键选择，Enter 确认\n\n');
+            
+            options.forEach((option, index) => {
+                const prefix = index === selectedIndex ? '> ' : '  ';
+                const marker = index === selectedIndex ? '◉' : '○';
+                process.stdout.write(`${prefix}${marker} ${option.label}\n`);
+            });
+        }
+
+        displayMenu();
+
+        // 处理键盘输入
+        let buffer = '';
+        function onData(str) {
+            if (isResolved) return;
+
+            // 处理 Ctrl+C
+            if (str === '\u0003') {
+                cleanup();
+                process.exit(0);
+                return;
+            }
+
+            // 处理 Enter
+            if (str === '\r' || str === '\n') {
+                cleanup();
+                resolve(options[selectedIndex].value);
+                isResolved = true;
+                return;
+            }
+
+            // 处理箭头键
+            // 箭头键通常是转义序列：ESC [ A (上), ESC [ B (下)
+            // 在原始模式下，这些字符会逐个到达
+            buffer += str;
+
+            // 检查是否是完整的箭头键序列
+            if (buffer.length >= 3) {
+                // 上箭头: ESC [ A
+                if (buffer === '\u001b[A' || buffer.endsWith('\u001b[A')) {
+                    selectedIndex = (selectedIndex - 1 + options.length) % options.length;
+                    displayMenu();
+                    buffer = '';
+                    return;
+                }
+                // 下箭头: ESC [ B
+                if (buffer === '\u001b[B' || buffer.endsWith('\u001b[B')) {
+                    selectedIndex = (selectedIndex + 1) % options.length;
+                    displayMenu();
+                    buffer = '';
+                    return;
+                }
+                // 如果不是箭头键序列，且缓冲区太长，清空
+                if (buffer.length > 10 || (!buffer.startsWith('\u001b') && buffer.length > 1)) {
+                    buffer = '';
+                }
+            }
+        }
+
+        function cleanup() {
+            process.stdin.removeListener('data', onData);
+            process.stdin.setRawMode(wasRawMode);
+            process.stdin.pause();
+            // 显示光标
+            process.stdout.write('\x1B[?25h');
+            // 清屏
+            process.stdout.write('\x1B[2J\x1B[H');
+        }
+
+        process.stdin.on('data', onData);
+    });
+}
+
+// 解析命令行参数
+function parseArgs() {
+    const args = process.argv.slice(2);
+    const config = {
+        platform: null,  // null 表示需要交互式选择
+        includeSubpackages: null,  // null 表示需要交互式选择
+        projectDir: null  // 项目目录，默认为当前工作目录
+    };
+
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        
+        if (arg === '--platform' && i + 1 < args.length) {
+            const platform = args[i + 1].toLowerCase();
+            if (platform === 'bytedance' || platform === 'bytedance-mini-game' || platform === 'wechatgame') {
+                config.platform = platform;
+                i++; // 跳过下一个参数
+            } else {
+                console.warn(`警告: 未知的平台 "${platform}"，使用默认值 "bytedance"`);
+                config.platform = 'bytedance';
+            }
+        } else if (arg === '--include-subpackages' || arg === '--subpackages') {
+            config.includeSubpackages = true;
+        } else if (arg === '--no-subpackages') {
+            config.includeSubpackages = false;
+        } else if (arg === '--project-dir' && i + 1 < args.length) {
+            config.projectDir = args[i + 1];
+            i++;
+        } else if (arg === '--help' || arg === '-h') {
+            console.log(`
+用法: cocos-obfuscate [选项]
+
+选项:
+  --platform <平台>              指定平台: bytedance (2.x版本) 或 bytedance-mini-game (3.x版本) 或 wechatgame
+  --include-subpackages          包含分包文件进行混淆
+  --no-subpackages               不包含分包文件
+  --project-dir <目录>           指定项目目录（默认为当前目录）
+  --help, -h                     显示此帮助信息
+
+如果不提供参数，将进入交互式选择模式。
+
+示例:
+  cocos-obfuscate --platform bytedance
+  cocos-obfuscate --platform bytedance-mini-game
+  cocos-obfuscate --platform wechatgame --include-subpackages
+  cocos-obfuscate (进入交互式选择)
+            `);
+            process.exit(0);
+        }
+    }
+
+    return config;
+}
+
+// 查找主包文件（文件名会变化，如 index.xxx.js）
+function findMainIndexFile(projectDir, platform) {
+    const mainDir = path.join(projectDir, 'build', platform, 'assets', 'main');
+    if (!fs.existsSync(mainDir)) {
+        return null;
+    }
+    
+    const files = fs.readdirSync(mainDir);
+    const indexFile = files.find(file => file.startsWith('index.') && file.endsWith('.js'));
+    
+    if (indexFile) {
+        return path.join(mainDir, indexFile);
+    }
+    
+    return null;
+}
+
+// 主函数
+async function main() {
+    // 解析命令行参数
+    const config = parseArgs();
+    let platform = config.platform;
+    let includeSubpackages = config.includeSubpackages;
+    const projectDir = config.projectDir || process.cwd();
+
+    // 检查项目目录是否存在
+    if (!fs.existsSync(projectDir)) {
+        console.error('错误: 项目目录不存在:', projectDir);
+        process.exit(1);
+    }
+
+    // 如果没有通过命令行参数指定，则使用交互式选择
+    if (platform === null) {
+        const platformChoice = await interactiveSelect([
+            { label: 'bytedance (2.x 版本)', value: 'bytedance' },
+            { label: 'bytedance-mini-game (3.x 版本)', value: 'bytedance-mini-game' },
+            { label: 'wechatgame', value: 'wechatgame' }
+        ], '请选择平台:');
+        platform = platformChoice;
+    }
+
+    if (includeSubpackages === null) {
+        includeSubpackages = await interactiveSelect([
+            { label: '是', value: true },
+            { label: '否', value: false }
+        ], '是否包含分包文件?');
+    }
+
+    console.log('\n========================================');
+    console.log('混淆配置:');
+    console.log('  项目目录:', projectDir);
+    console.log('  平台:', platform);
+    console.log('  包含分包:', includeSubpackages ? '是' : '否');
+    console.log('========================================\n');
+
+    const buildDir = path.join(projectDir, 'build', platform);
+
+    // 定义要混淆的文件列表
+    const filesToObfuscate = [];
+
+    // 添加主包文件（自动查找）
+    const mainIndexFile = findMainIndexFile(projectDir, platform);
+    if (mainIndexFile) {
+        filesToObfuscate.push(mainIndexFile);
+        console.log('找到主包文件:', mainIndexFile);
+    } else {
+        console.warn('警告: 未找到主包文件 build/' + platform + '/assets/main/index.xxx.js');
+    }
+
+    // 添加分包文件（如果启用）
+    if (includeSubpackages) {
+        const subpackages = [
+            'com_new_v1/game.js',
+            'for_sm/game.js',
+            'for_wx/game.js',
+            'remote_v1/game.js'
+        ];
+
+        subpackages.forEach(subpackage => {
+            const filePath = path.join(buildDir, 'subpackages', subpackage);
+            if (fs.existsSync(filePath)) {
+                filesToObfuscate.push(filePath);
+                console.log('找到分包文件:', filePath);
+            } else {
+                console.warn('警告: 分包文件不存在，跳过:', filePath);
+            }
+        });
+    }
+
+    // 执行混淆
+    console.log('\n准备混淆', filesToObfuscate.length, '个文件...\n');
+
+    if (filesToObfuscate.length === 0) {
+        console.error('错误: 没有找到需要混淆的文件！');
+        console.log('\n提示:');
+        console.log('  1. 请检查 build/' + platform + ' 目录是否存在');
+        console.log('  2. 确认已执行构建命令');
+        console.log('  3. 使用 --help 查看使用说明');
+        process.exit(1);
+    }
+
+    let successCount = 0;
+    let failCount = 0;
+
+    filesToObfuscate.forEach((file, index) => {
+        if (obfuscateFile(file)) {
+            successCount++;
+        } else {
+            failCount++;
+        }
+    });
+
+    console.log('\n========================================');
+    console.log('混淆任务完成！');
+    console.log('成功:', successCount, '个文件');
+    console.log('失败:', failCount, '个文件');
+    console.log('\n提示: 如果游戏无法正常运行，可以使用备份文件（.backup)恢复');
+}
+
+// 运行主函数
+main().catch(error => {
+    console.error('发生错误:', error);
+    process.exit(1);
+});
+

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "cocos-obfuscator",
+  "version": "1.0.0",
+  "description": "Cocos Creator 项目代码混淆工具，支持字节跳动小游戏和微信小游戏平台",
+  "main": "index.js",
+  "bin": {
+    "cocos-obfuscate": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cocos",
+    "cocos-creator",
+    "obfuscator",
+    "javascript-obfuscator",
+    "bytedance",
+    "wechatgame",
+    "miniprogram"
+  ],
+  "author": "habehe",
+  "license": "ISC",
+  "dependencies": {
+    "javascript-obfuscator": "^4.1.1"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  }
+}
+