Skip to content

Commit 6ec0f3c

Browse files
authored
create readme English version
1 parent 2d49f38 commit 6ec0f3c

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

README_en.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# What is Xpatch
2+
3+
Xpatch is a jar tool which is used to repackage the apk file. Then, the new apk can load any Xposed modules installed in the android system.
4+
5+
This is a way to use Xposed modules without root your device.
6+
7+
It is easy way to modify one app using xposed module. And any apps changed by Xpatch can load every modules downloaded in the [Xposed Module Repository](https://repo.xposed.info/).
8+
# Benefits
9+
1. Use xposed modules without your device;
10+
2. Modify any apps without root your device.
11+
12+
# How to use
13+
1. Download the latest jar file from the [release page](https://github.com/WindySha/Xpatch/releases);
14+
2. Run this command in the Windows/Mac console:
15+
```
16+
$ java -jar ../../xpatch.jar ../../source.apk
17+
```
18+
Then, a new apk named `source-xposed-signed.apk` in the same folder as `source.apk`.
19+
20+
# More commands
21+
1. You can specify the output apk path by add `-o` parameter, eg:
22+
```
23+
$ java -jar ../../xpatch.jar ../../source.apk -o ../../dst.apk
24+
```
25+
2. Show all the building new apk logs, just add `-l`, eg:
26+
```
27+
$ java -jar ../../xpatch.jar ../../source.apk -l
28+
```
29+
3. Not delete the build files, just add `-k`, eg:
30+
```
31+
$ java -jar ../../xpatch.jar ../../source.apk -k
32+
```
33+
4. After the version 1.2, craching app signature verifying is added, if you won't need the function, just add '-c', eg:
34+
```
35+
$ java -jar ../../xpatch.jar ../../source.apk -c
36+
```
37+
5. More command details can be found when no parameter is added, eg:
38+
```
39+
$ java -jar ../../xpatch.jar
40+
```
41+
42+
43+
# Todo list
44+
1. Support packaging the xposed modules into the source apk;
45+
2. Support loading so library in the xposed modules;
46+
3. Crach apk protections.
47+
48+
# Issues
49+
1. If the apk dex files are protected, dex2jar can not effect on the dexs, then this tool will not work;
50+
2. The hook framework is using [whale](https://github.com/asLody/whale); this framework is not very stable, some hooks may fail;
51+
3. Do not support Davlik VM;
52+
4. Do not support resource hook;
53+
54+
55+
# Thanks
56+
- [Xposed][10]
57+
- [whale][11]
58+
- [dex2jar][12]
59+
- [AXMLPrinter2][13]
60+
61+
[10]: https://github.com/rovo89/Xposed
62+
[11]: https://github.com/asLody/whale
63+
[12]: https://github.com/pxb1988/dex2jar
64+
[13]: https://code.google.com/archive/p/android4me/downloads

0 commit comments

Comments
 (0)