Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EpicPlayerA10 committed Jan 16, 2025
1 parent a87781c commit a7dad4d
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,25 @@ A deobfuscator for java
## ✅ How to run deobfuscator
If you want to use this deobfuscator, you need to start it from your IDE manually.

1. Place your obfuscated jar inside the root project directory. For example in `work/obf-test.jar`
2. Navigate to class [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java)
3. In this class edit the deobfuscator configuration
1. (Windows) Run `git config --system core.longpaths true` to enable long paths support
2. Place your obfuscated jar inside the root project directory. For example in `work/obf-test.jar`
3. Navigate to class [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java)
4. In this class edit the deobfuscator configuration
- `inputJar` - Your obfuscated jar file that you placed in step 1
- `transformers` - Pick transformers that you want to run. You can find them in [`deobfuscator-transformers`](./deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other) module.
4. Run this class manually from your IDE. You can use our pre-configured IntelliJ task named `Bootstrap`.
5. Run this class manually from your IDE. You can use our pre-configured IntelliJ task named `Bootstrap`.

![tak](./assets/run-deobfuscator.gif)

## 🔧 Contributing
Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for a project introduction and some basics about java bytecode.

---
## Troubleshooting

<p align="center">
<a href="https://discord.gg/tRU27KtPAZ"><img src="https://discordapp.com/api/guilds/900083350314811432/widget.png?style=banner2"/></a>
</p>
### Git shows `Filename too long`
You need to run `git config --system core.longpaths true`. This error is only shown for windows users.

---
## Links

<a href="https://discord.gg/tRU27KtPAZ"><img src="https://discordapp.com/api/guilds/900083350314811432/widget.png?style=banner2"/></a>

0 comments on commit a7dad4d

Please sign in to comment.