obfuz/REAME-EN.md

74 lines
3.6 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 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.
## Supported Unity Versions & Platforms
- Unity 2019 and later versions
- Tuanjie 1.0.0 and later versions
- All platforms supported by Unity and Tuanjie
## 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 Unitys 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