Skip to content

Commit b79fc40

Browse files
committed
improvements readme.md
1 parent 6a7b6e7 commit b79fc40

1 file changed

Lines changed: 3 additions & 50 deletions

File tree

README.md

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Java obfuscator with Minecraft plugins supports.
44
Based on [ColonialObfuscator](https://github.com/ColonialBuilders/ColonialObfuscator)
55

6+
📖 **[How to Run](https://github.com/katze225/JavaObfuscator/wiki/Usage)**
7+
68
## Features
79

810
- **String Encryption** - Encrypts string constants with XOR-based encryption
@@ -12,52 +14,7 @@ Based on [ColonialObfuscator](https://github.com/ColonialBuilders/ColonialObfusc
1214
- **Dispatcher** - Converts methods to use dispatcher pattern
1315
- **Shuffle** - Randomizes order of fields and methods
1416

15-
## Building
16-
17-
```bash
18-
./gradlew build
19-
```
20-
21-
The output JAR will be in `build/libs`
22-
23-
## Usage
24-
25-
```bash
26-
java -jar JavaObfuscator.jar <input.jar> <output.jar> [options]
27-
```
28-
29-
### Options
30-
31-
- `--names-length <n>` - Name length for generated identifiers (default: 40)
32-
- `--numbers` - Enable number obfuscation
33-
- `--strings` - Enable string encryption
34-
- `--booleans` - Enable boolean obfuscation
35-
- `--flow` - Enable flow obfuscation
36-
- `--dispatcher` - Enable dispatcher transformation
37-
- `--shuffle` - Enable shuffle transformation
38-
- `--zip-comment` - Add ZIP comment to output JAR
39-
- `--zip-comment-text <text>` - Custom ZIP comment text
40-
41-
If no transformer options are specified, all transformers are enabled by default.
42-
43-
### Examples
44-
45-
Enable all transformers (default):
46-
```bash
47-
java -jar JavaObfuscator.jar input.jar output.jar
48-
```
49-
50-
Enable specific transformers:
51-
```bash
52-
java -jar JavaObfuscator.jar input.jar output.jar --strings --numbers --flow
53-
```
54-
55-
Custom name length:
56-
```bash
57-
java -jar JavaObfuscator.jar input.jar output.jar --names-length 60
58-
```
59-
60-
## Obfuscatio
17+
## Obfuscation
6118
Before:
6219
```
6320
public boolean returnTrue() {
@@ -123,10 +80,6 @@ public class Test {
12380
}
12481
```
12582

126-
## Requirements
127-
128-
- Java 21 or higher
129-
13083
## Author
13184

13285
by @core2k21 (tg)

0 commit comments

Comments
 (0)