Skip to content

Commit 6b6fe5d

Browse files
Update README.md
1 parent 41aaa92 commit 6b6fe5d

File tree

1 file changed

+8
-22
lines changed

1 file changed

+8
-22
lines changed

README.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,20 @@
11
# Diobfuscator
22
A deobfuscator for java
33

4-
> [!IMPORTANT]
5-
> **This is dev(v2) version of diobfuscator version and it's not completed yet, if you are willing to help there is a list of things that needs to be completed. The old diobfuscator was moved to [v1 branch](https://github.com/narumii/Deobfuscator/tree/v1).**<br>
6-
>
7-
> - Porting old transformers to new code base
8-
> - Testing `Match` API
9-
> - Implementing/Improving transformers
10-
> - Writing tests
11-
> - Feedback on how the new api presents itself (mainly `Match` API)
12-
> <br>
13-
>
14-
> 1. *You can also provide samples of obfuscation to help with development of the transformers.*
15-
> 2. **No... there is no gui planned**
16-
> 3. _Also from now on Diobfuscator uses [Java Google Codestyle](https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml)_
17-
> - `mvn fmt:format`
18-
> - `mvn fmt:check`
19-
20-
> Built on: [Java 17 (Temurin)](https://adoptium.net/temurin/releases/?version=17)
4+
> If you are looking for v1 version of Diobfuscator, you can find it [here](https://github.com/narumii/Deobfuscator/tree/v1)
215
226
## ✅ How to run deobfuscator
237
If you want to use this deobfuscator, you need to start it from your IDE manually.
248

25-
1. (Windows) Open cmd as administrator and run `git config --system core.longpaths true` to enable long paths support
26-
2. Place your obfuscated jar inside the root project directory. For example in `work/obf-test.jar`
27-
3. Navigate to class [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java)
28-
4. In this class edit the deobfuscator configuration
9+
1. Clone this repository and open it in IntelliJ
10+
2. (Windows) Open cmd as administrator and run `git config --system core.longpaths true` to enable long paths support
11+
3. Make sure that you have selected [Java 17 (Temurin)](https://adoptium.net/temurin/releases/?version=17) in `Project Structure` -> `SDK`
12+
4. Place your obfuscated jar inside the root project directory. For example in `work/obf-test.jar`
13+
5. Navigate to class [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java)
14+
6. In this class edit the deobfuscator configuration
2915
- `inputJar` - Your obfuscated jar file that you placed in step 1
3016
- `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.
31-
5. Run this class manually from your IDE. You can use our pre-configured IntelliJ task named `Bootstrap`.
17+
7. Run this class manually from your IDE. You can use our pre-configured IntelliJ task named `Bootstrap`.
3218

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

0 commit comments

Comments
 (0)