Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 81 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,106 @@
# LSPosed Framework
<div align="center">

[![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)
# Vector Framework

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

A Zygisk module trying to provide an ART hooking framework which delivers consistent APIs with the OG Xposed, leveraging LSPlant hooking framework.
[![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)

> 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.
</div>

## Supported Versions
---

Android 8.1 ~ 16
### Introduction

## Install
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.

1. Install Magisk v26+
2. [Download](#download) and install LSPosed in Magisk app
3. Reboot
4. Open LSPosed manager from notification
5. Have fun :)
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.

## Download
---

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

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

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

## For Developers
---

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.
### Installation

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

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

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

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

[Troubleshooting guide](https://github.com/JingMatrix/LSPosed/issues/123) and [Disscusions](https://github.com/JingMatrix/LSPosed/discussions).
> [!NOTE]
> Debug builds are recommended for users experiencing technical difficulties.

## Translation Contributing
---

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

## Credits
If you encounter issues or wish to help improve the project, please refer to the resources below.

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

## License
> [!IMPORTANT]
> Bug reports are only accepted if they are based on the **latest debug build**.
>
> For Chinese speakers: 本项目只接受英语标题的 Issue。
> 请使用[翻译工具](https://www.deepl.com/zh/translator)提交。

LSPosed is licensed under the **GNU General Public License v3 (GPL-3)** (http://www.gnu.org/copyleft/gpl.html).
---

### Developer Resources

Vector supports both legacy and modern hooking standards to ensure broad module compatibility.

* [Legacy Xposed API](https://api.xposed.info/)
* [Modern libxposed API](https://libxposed.github.io/api/)
* [Xposed Module Repository](https://github.com/Xposed-Modules-Repo)

---

### Credits

This project is made possible by the following open-source contributions:

* [Magisk](https://github.com/topjohnwu/Magisk/): The foundation of Android customization.
* [LSPlant](https://github.com/JingMatrix/LSPlant): The core ART hooking engine.
* [XposedBridge](https://github.com/rovo89/XposedBridge): The standard Xposed APIs.
* [Dobby](https://github.com/JingMatrix/Dobby): Inline hooking implementation.
* [LSPosed](https://github.com/LSPosed/LSPosed): Upstream source.
* [xz-embedded](https://github.com/tukaani-project/xz-embedded): Library decompression utilities.

<details>
<summary>Legacy and Historical Dependencies</summary>

- ~~[Riru](https://github.com/RikkaApps/Riru)~~
- ~~[SandHook](https://github.com/ganyao114/SandHook/)~~
- ~~[YAHFA](https://github.com/rk700/YAHFA)~~
- ~~[dexmaker](https://github.com/linkedin/dexmaker)~~
- ~~[DexBuilder](https://github.com/LSPosed/DexBuilder)~~
</details>

---

### License

Vector is licensed under the [GNU General Public License v3](http://www.gnu.org/copyleft/gpl.html).
Loading