Skip to content

Commit 0e64a80

Browse files
authored
Update README (#598)
Rename LSPosed to Vector and apply a modern style.
1 parent a7d97a6 commit 0e64a80

1 file changed

Lines changed: 81 additions & 44 deletions

File tree

README.md

Lines changed: 81 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,106 @@
1-
# LSPosed Framework
1+
<div align="center">
22

3-
[![Build](https://img.shields.io/github/actions/workflow/status/JingMatrix/LSPosed/core.yml?branch=master&event=push&logo=github&label=Build)](https://github.com/JingMatrix/LSPosed/actions/workflows/core.yml?query=event%3Apush+branch%3Amaster+is%3Acompleted) [![Crowdin](https://img.shields.io/badge/Localization-Crowdin-blueviolet?logo=Crowdin)](https://crowdin.com/project/lsposed_jingmatrix) [![Download](https://img.shields.io/github/v/release/JingMatrix/LSPosed?color=orange&logoColor=orange&label=Download&logo=DocuSign)](https://github.com/JingMatrix/LSPosed/releases/latest) [![Total](https://shields.io/github/downloads/JingMatrix/LSPosed/total?logo=Bookmeter&label=Counts&logoColor=yellow&color=yellow)](https://github.com/JingMatrix/LSPosed/releases)
3+
# Vector Framework
44

5-
## Introduction
5+
**A high-performance ART hooking framework for modern Android**
66

7-
A Zygisk module trying to provide an ART hooking framework which delivers consistent APIs with the OG Xposed, leveraging LSPlant hooking framework.
7+
[![Build](https://img.shields.io/github/actions/workflow/status/JingMatrix/LSPosed/core.yml?branch=master&event=push&logo=github&label=Build)](https://github.com/JingMatrix/LSPosed/actions/workflows/core.yml?query=event%3Apush+branch%3Amaster+is%3Acompleted)
8+
[![Crowdin](https://img.shields.io/badge/Localization-Crowdin-blueviolet?logo=Crowdin)](https://crowdin.com/project/lsposed_jingmatrix)
9+
[![Download](https://img.shields.io/github/v/release/JingMatrix/LSPosed?color=orange&logoColor=orange&label=Download&logo=DocuSign)](https://github.com/JingMatrix/LSPosed/releases/latest)
10+
[![Total](https://shields.io/github/downloads/JingMatrix/LSPosed/total?logo=Bookmeter&label=Counts&logoColor=yellow&color=yellow)](https://github.com/JingMatrix/LSPosed/releases)
811

9-
> Xposed is a framework for modules that can change the behavior of the system and apps without touching any APKs. That's great because it means that modules can work for different versions and even ROMs without any changes (as long as the original code was not changed too much). It's also easy to undo. As all changes are done in the memory, you just need to deactivate the module and reboot to get your original system back. There are many other advantages, but here is just one more: multiple modules can do changes to the same part of the system or app. With modified APKs, you have to choose one. No way to combine them, unless the author builds multiple APKs with different combinations.
12+
</div>
1013

11-
## Supported Versions
14+
---
1215

13-
Android 8.1 ~ 16
16+
### Introduction
1417

15-
## Install
18+
Vector is a Zygisk module providing an ART hooking framework that maintains API consistency with the original Xposed. It is engineered on top of [LSPlant](https://github.com/JingMatrix/LSPlant) to deliver a stable, native-level instrumentation environment.
1619

17-
1. Install Magisk v26+
18-
2. [Download](#download) and install LSPosed in Magisk app
19-
3. Reboot
20-
4. Open LSPosed manager from notification
21-
5. Have fun :)
20+
The framework allows modules to modify system and application behavior in-memory. Because no APK files are modified, changes are non-destructive, easily reversible via reboot, and compatible across various ROMs and Android versions.
2221

23-
## Download
22+
---
2423

25-
- For stable releases, please go to [Github Releases page](https://github.com/JingMatrix/LSPosed/releases)
26-
- For canary build, please check [Github Actions](https://github.com/JingMatrix/LSPosed/actions/workflows/core.yml?query=branch%3Amaster)
24+
### Compatibility
2725

28-
Note: debug builds are only available in Github Actions.
26+
Vector supports devices running **Android 8.1 through Android 17 Beta**.
2927

30-
## Get Help
31-
**Only bug reports from **THE LATEST DEBUG BUILD** will be accepted.**
32-
- GitHub issues: [Issues](https://github.com/JingMatrix/LSPosed/issues/)
33-
- (For Chinese speakers) 本项目只接受英语**标题**的issue。如果您不懂英语,请使用[翻译工具](https://www.deepl.com/zh/translator)
28+
> [!TIP]
29+
> This framework requires a recent installation of Magisk or KernelSU with Zygisk enabled.
3430
35-
## For Developers
31+
---
3632

37-
Developers are welcome to write Xposed modules with hooks based on LSPosed Framework. A module based on LSPosed framework is fully compatible with the original Xposed Framework, and vice versa, a Xposed Framework-based module will work well with LSPosed framework too.
33+
### Installation
3834

39-
- [Xposed Framework API](https://api.xposed.info/)
35+
1. Download the latest release as a system module.
36+
2. Install the module via your root manager (Magisk/KernelSU).
37+
3. Ensure a Zygisk environment (e.g., [NeoZygisk](https://github.com/JingMatrix/NeoZygisk)).
38+
4. Reboot the device.
39+
5. Access management settings via the system notification.
4040

41-
We use our own module repository. We welcome developers to submit modules to our repository, and then modules can be downloaded in LSPosed.
41+
---
4242

43-
- [LSPosed Module Repository](https://github.com/Xposed-Modules-Repo)
43+
### Downloads
4444

45-
## Community Discussion
45+
| Channel | Source |
46+
| :--- | :--- |
47+
| Stable Releases | [GitHub Releases](https://github.com/JingMatrix/LSPosed/releases) |
48+
| Canary Builds | [GitHub Actions](https://github.com/JingMatrix/LSPosed/actions/workflows/core.yml?query=branch%3Amaster) |
4649

47-
[Troubleshooting guide](https://github.com/JingMatrix/LSPosed/issues/123) and [Disscusions](https://github.com/JingMatrix/LSPosed/discussions).
50+
> [!NOTE]
51+
> Debug builds are recommended for users experiencing technical difficulties.
4852
49-
## Translation Contributing
53+
---
5054

51-
You can contribute translation [here](https://crowdin.com/project/lsposed_jingmatrix).
55+
### Support and Contribution
5256

53-
## Credits
57+
If you encounter issues or wish to help improve the project, please refer to the resources below.
5458

55-
- [Magisk](https://github.com/topjohnwu/Magisk/): makes all these possible
56-
- [XposedBridge](https://github.com/rovo89/XposedBridge): the OG Xposed framework APIs
57-
- [LSPlant](https://github.com/JingMatrix/LSPlant): the core ART hooking framework
58-
- [Dobby](https://github.com/JingMatrix/Dobby): inline hooker for `LSPlant` and `native_api` implement
59-
- [EdXposed](https://github.com/ElderDrivers/EdXposed): fork source
60-
- [xz-embedded](https://github.com/tukaani-project/xz-embedded): decompress `.gnu_debugdata` header section of stripped `libart.so`
61-
- ~~[Riru](https://github.com/RikkaApps/Riru): provides a way to inject code into zygote process~~
62-
- ~[SandHook](https://github.com/ganyao114/SandHook/): ART hooking framework for SandHook variant~
63-
- ~[YAHFA](https://github.com/rk700/YAHFA): previous ART hooking framework~
64-
- ~[dexmaker](https://github.com/linkedin/dexmaker) and [dalvikdx](https://github.com/JakeWharton/dalvik-dx): to dynamically generate YAHFA hooker classes~
65-
- ~[DexBuilder](https://github.com/LSPosed/DexBuilder): to dynamically generate YAHFA hooker classes~
59+
* **Troubleshooting:** Consult the [guide](https://github.com/JingMatrix/LSPosed/issues/123) before reporting bugs.
60+
* **Discussions:** Join our community on [GitHub Discussions](https://github.com/JingMatrix/LSPosed/discussions).
61+
* **Localization:** Help translate the project via [Crowdin](https://crowdin.com/project/lsposed_jingmatrix).
6662

67-
## License
63+
> [!IMPORTANT]
64+
> Bug reports are only accepted if they are based on the **latest debug build**.
65+
>
66+
> For Chinese speakers: 本项目只接受英语标题的 Issue。
67+
> 请使用[翻译工具](https://www.deepl.com/zh/translator)提交。
6868
69-
LSPosed is licensed under the **GNU General Public License v3 (GPL-3)** (http://www.gnu.org/copyleft/gpl.html).
69+
---
70+
71+
### Developer Resources
72+
73+
Vector supports both legacy and modern hooking standards to ensure broad module compatibility.
74+
75+
* [Legacy Xposed API](https://api.xposed.info/)
76+
* [Modern libxposed API](https://libxposed.github.io/api/)
77+
* [Xposed Module Repository](https://github.com/Xposed-Modules-Repo)
78+
79+
---
80+
81+
### Credits
82+
83+
This project is made possible by the following open-source contributions:
84+
85+
* [Magisk](https://github.com/topjohnwu/Magisk/): The foundation of Android customization.
86+
* [LSPlant](https://github.com/JingMatrix/LSPlant): The core ART hooking engine.
87+
* [XposedBridge](https://github.com/rovo89/XposedBridge): The standard Xposed APIs.
88+
* [Dobby](https://github.com/JingMatrix/Dobby): Inline hooking implementation.
89+
* [LSPosed](https://github.com/LSPosed/LSPosed): Upstream source.
90+
* [xz-embedded](https://github.com/tukaani-project/xz-embedded): Library decompression utilities.
91+
92+
<details>
93+
<summary>Legacy and Historical Dependencies</summary>
94+
95+
- ~~[Riru](https://github.com/RikkaApps/Riru)~~
96+
- ~~[SandHook](https://github.com/ganyao114/SandHook/)~~
97+
- ~~[YAHFA](https://github.com/rk700/YAHFA)~~
98+
- ~~[dexmaker](https://github.com/linkedin/dexmaker)~~
99+
- ~~[DexBuilder](https://github.com/LSPosed/DexBuilder)~~
100+
</details>
101+
102+
---
103+
104+
### License
105+
106+
Vector is licensed under the [GNU General Public License v3](http://www.gnu.org/copyleft/gpl.html).

0 commit comments

Comments
 (0)