Skip to content

Commit 26842ce

Browse files
committed
update docs
1 parent 1c418eb commit 26842ce

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,22 @@ Also, this tool does not particularly obfuscate your code; it just transpiles it
4444

4545
### General usage:
4646
```
47-
Usage: native-obfuscator [-ahV] [-b=<blackListFile>] [-l=<librariesDirectory>]
48-
[-p=<platform>] [--plain-lib-name=<libraryName>]
49-
[-w=<whiteListFile>] <jarFile> <outputDirectory>
47+
Usage: native-obfuscator [-ahV] [--debug] [-b=<blackListFile>]
48+
[--custom-lib-dir=<customLibraryDirectory>]
49+
[-l=<librariesDirectory>] [-p=<platform>]
50+
[--plain-lib-name=<libraryName>] [-w=<whiteListFile>]
51+
<jarFile> <outputDirectory>
5052
Transpiles .jar file into .cpp files and generates output .jar file
5153
<jarFile> Jar file to transpile
5254
<outputDirectory> Output directory
5355
-a, --annotations Use annotations to ignore/include native obfuscation
5456
-b, --black-list=<blackListFile>
5557
File with a list of blacklist classes/methods for
5658
transpilation
57-
-h, --help Show this help message and exit
59+
--custom-lib-dir=<customLibraryDirectory>
60+
Custom library directory for LoaderUnpack
61+
--debug Enable generation of debug .jar file (non-executable)
62+
-h, --help Show this help message and exit.
5863
-l, --libraries=<librariesDirectory>
5964
Directory for dependent libraries
6065
-p, --platform=<platform>
@@ -63,7 +68,7 @@ Transpiles .jar file into .cpp files and generates output .jar file
6368
Android)
6469
--plain-lib-name=<libraryName>
6570
Plain library name for LoaderPlain
66-
-V, --version Print version information and exit
71+
-V, --version Print version information and exit.
6772
-w, --white-list=<whiteListFile>
6873
File with a list of whitelist classes/methods for
6974
transpilation
@@ -121,7 +126,9 @@ mypackage/myotherpackage/Class*
121126
`**` matches all entries in class/package name
122127

123128

124-
`--plain-lib-name` - if you ship your .jar separately from the result native libraries or you use it for Android, you can specify the name of the native library that it will try to search while using.
129+
`--plain-lib-name` - if you ship your .jar separately from the result native libraries, or you use it for Android, you can specify the name of the native library that it will try to search while using.
130+
131+
`--custom-lib-dir` - if you want to set custom directory for storing libraries inside the jar
125132

126133
If you want to ship your .jar with native libraries in it, you should omit that argument, and after building native files, add them in the form of
127134
```
@@ -132,7 +139,7 @@ x64-macos.dylib
132139
arm64-linux.so
133140
arm64-windows.dll
134141
```
135-
to the directory of the .jar file that this tool will print in `stdout` (by default `native0/`)
142+
to the directory of the .jar file that this tool will print in `stdout` (by default `native0/` or custom if `--custom-lib-dir` is present)
136143

137144
#### Basic usage:
138145
1. Transpile your code using `java -jar native-obfuscator.jar <input jar> <output directory>`

0 commit comments

Comments
 (0)