From eb0542ed0fc08fd63c08f5a61bcfb8a563976089 Mon Sep 17 00:00:00 2001 From: walon Date: Sat, 17 May 2025 14:47:50 +0800 Subject: [PATCH] update README.MD . --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++-- REAME-EN.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 133 insertions(+), 2 deletions(-) create mode 100644 REAME-EN.md diff --git a/README.md b/README.md index a225568..6c2b56b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,67 @@ -# Obfuz +# Obfuz - Unity 代码混淆工具 -Obfuz is a powerful code obfuscation tool designed specifically for Unity projects. +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Unity Version](https://img.shields.io/badge/Unity-2019%2B-blue)](https://unity.com/) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/your-repo/obfuz/pulls) + +Obfuz 是一款开源的 Unity 代码混淆工具，致力于为 Unity 开发者提供强大、安全且易用的代码保护解决方案。Obfuz 基于 MIT 协议，功能媲美商业混淆工具，与 Unity 工作流深度集成，并完美支持 HybridCLR、xLua、Puerts 等热更新方案。 + +[English](./README-EN.md) | [中文](./README.md) + +--- + +## 功能特性 + +- **符号混淆**：支持丰富的配置规则和增量混淆，灵活高效地保护代码。 +- **常量混淆**：混淆 `int`、`long`、`float`、`double`、`string` 等常量，防止逆向工程。 +- **变量内存加密**：加密内存中的变量，提升运行时安全。 +- **函数调用混淆**：打乱函数调用结构，增加破解难度。 +- **随机加密虚拟机**：生成随机化虚拟机，有效抵御反编译和破解工具。 +- **静态与动态解密**：结合静态和动态解密，防止离线静态分析。 +- **深度 Unity 集成**：与 Unity 工作流无缝衔接，配置简单即可使用。 +- **热更新支持**：全面兼容 HybridCLR、xLua、Puerts 等热更新框架，确保动态代码更新顺畅。 + +## 未来计划 + +Obfuz 正在持续开发中，即将推出的功能包括： + +- **表达式混淆**：混淆复杂表达式，进一步增强保护。 +- **控制流混淆**：打乱代码执行流程，增加逆向难度。 +- **代码水印**：嵌入可追踪的水印。 +- **反内存转储与反调试**：防止内存转储和调试行为。 +- **DLL 文件结构加密**：保护 DLL 文件结构免受篡改。 +- **代码虚拟化**：将代码转化为虚拟化指令，提供最高级别安全。 + +## 为什么选择 Obfuz？ + +- **开源免费**：基于 MIT 协议，免费使用和修改。 +- **企业级保护**：提供媲美商业工具的强大混淆功能。 +- **专为 Unity 设计**：深度集成 Unity 生态，简化开发流程。 +- **热更新优化**：为现代 Unity 项目中的热更新方案提供优异支持。 + +## 文档 + +[即将推出] 完整文档将位于 docs/ 文件夹或我们的 Wiki 中。 + +## 贡献 + +我们欢迎社区贡献！开始贡献的步骤： + +- Fork 本仓库。 +- 创建功能分支（git checkout -b feature/your-feature）。 +- 提交更改（git commit -m 'Add your feature'）。 +- 推送分支（git push origin feature/your-feature）。 +- 提交 Pull Request。 +- 请阅读我们的贡献指南以获取更多信息。 + +## 许可证 + +Obfuz 采用 MIT 许可证发布，欢迎自由使用、修改和分发。 + +## 联系我们 + +如有问题、建议或错误报告，请在用以下方式联系我们： + +- GitHub 上提交 Issue +- 邮件联系维护者：[obfuz@code-philosophy.com] +- 加入 **Luban&Obfuz交流群**，QQ群号： 692890842 diff --git a/REAME-EN.md b/REAME-EN.md new file mode 100644 index 0000000..117155f --- /dev/null +++ b/REAME-EN.md @@ -0,0 +1,67 @@ +# Obfuz - Unity Code Obfuscation Tool + +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Unity Version](https://img.shields.io/badge/Unity-2019%2B-blue)](https://unity.com/) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/your-repo/obfuz/pulls) + +**Obfuz** is an open-source Unity code obfuscation tool designed to provide Unity developers with a powerful, secure, and user-friendly code protection solution. Licensed under MIT, Obfuz delivers commercial-grade obfuscation capabilities that seamlessly integrate with Unity workflows while offering exceptional support for hot-reload solutions like HybridCLR, xLua, and Puerts. + +[English](./README-EN.md) | [中文](./README.md) + +--- + +## Features + +- **Symbol Obfuscation**: Supports comprehensive configuration rules and incremental obfuscation for flexible and efficient code protection. +- **Constant Obfuscation**: Obfuscates constants such as `int`, `long`, `float`, `double`, and `string` to prevent reverse engineering. +- **Variable Memory Encryption**: Encrypts variables in memory to enhance runtime security. +- **Function Call Obfuscation**: Scrambles function call structures to increase cracking difficulty. +- **Randomized Encryption VM**: Generates randomized virtual machines to thwart decompilation and cracking tools. +- **Static and Dynamic Decryption**: Combines static and dynamic decryption to resist offline static analysis. +- **Seamless Unity Integration**: Deeply integrated with Unity workflows, requiring minimal configuration to get started. +- **Hot Update Compatibility**: Fully supports hot update frameworks like HybridCLR, xLua, and Puerts, ensuring compatibility with dynamic code updates. + +## Planned Features + +Obfuz is actively evolving. Upcoming features include: + +- **Expression Obfuscation**: Obfuscate complex expressions for enhanced protection. +- **Control Flow Obfuscation**: Disrupt code flow to deter reverse engineering. +- **Code Watermarking**: Embed traceable watermarks in your code. +- **Anti-Memory Dumping and Anti-Debugging**: Prevent memory dumps and debugging attempts. +- **DLL Structure Encryption**: Secure DLL file structures against tampering. +- **Code Virtualization**: Transform code into virtualized instructions for maximum security. + +## Why Choose Obfuz? + +- **Open Source & Free**: Licensed under MIT, Obfuz is free to use and modify. +- **Enterprise-Grade Protection**: Offers robust obfuscation features comparable to commercial tools. +- **Unity-Centric Design**: Seamlessly integrates with Unity’s ecosystem, streamlining your workflow. +- **Hot Update Ready**: Optimized for modern Unity projects using hot update frameworks. + +## Documentation + +[Coming soon] Full documentation will be available in the docs/ folder or on our Wiki. + +## Contributing + +We welcome contributions from the community! To get started: + +- Fork the repository. +- Create a feature branch (git checkout -b feature/your-feature). +- Commit your changes (git commit -m 'Add your feature'). +- Push to the branch (git push origin feature/your-feature). +- Open a Pull Request. +- Please read our Contributing Guidelines for more details. + +## License + +Obfuz is released under the MIT License. Feel free to use, modify, and distribute it as needed. + +## Contact + +For questions, suggestions, or bug reports, please reach us through: + +- Submit an Issue on GitHub +- Email the maintainer: [obfuz@code-philosophy.com] +- Join the ​​Luban & Obfuz Discussion Group​​ on QQ: 692890842