-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Pedro.js <pedroolimpioguerra@gmail.com>
- Loading branch information
Showing
1 changed file
with
49 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,79 @@ | ||
| # ReZygisk | ||
|
|
||
| ReZygisk is a fork of Zygisk Next, which is a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk (besides built-in) and futurely APatch. | ||
| ReZygisk is a fork of Zygisk Next, a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk (besides built-in), and APatch (Work In Progress). | ||
|
|
||
| It aims at the modernization and re-write of the codebase to C (from C++ and Rust), allowing a more efficient and faster implementation of the Zygisk API with a more permissive license. | ||
| It aims to modernize and re-write the codebase to C (from C++ and Rust), allowing a more efficient and faster implementation of the Zygisk API with a more permissive license. | ||
|
|
||
| > [!NOTE] | ||
| > This module/fork is WIP, only use .zip from the releases. | ||
| > This module/fork is WIP (Work In Progress); only use .zip from the Releases. | ||
| > | ||
| > Although you may install the .zip from the [Actions](https://github.com/PerformanC/ReZygisk/actions) page, it is only at your discretion to install it since your device might enter bootloop. | ||
| ## Why? | ||
|
|
||
| The latest releases of Zygisk Next are not open-source, reserving entirely the code for its developers. Not only that limits our ability to contribute to the project, but also impossibilitates the audit of the code, which is a major concern for security, as Zygisk Next is a module that runs with superuser (root) privileges, having access to the entire system. | ||
| The latest releases of Zygisk Next are not open-source, reserving entirely the code for its developers. Not only does that limit our ability to contribute to the project, but also impossibilities the audit of the code, which is a major security concern, as Zygisk Next is a module that runs with superuser (root) privileges, having access to the entire system. | ||
|
|
||
| The Zygisk Next developers are famous and trusted in the Android community, however this doesn't mean that the code is not malicious or vulnerable. We (PerformanC) understand they have their reasons to keep the code closed-source, but we believe that contrary. | ||
| The Zygisk Next developers are famous and trusted in the Android community, however, this doesn't mean that the code is not malicious or vulnerable. We (PerformanC) understand they have their reasons to keep the code closed-source, but we believe the contrary. | ||
|
|
||
| ## Features | ||
| ## Advantages | ||
|
|
||
| - FOSS (forever) | ||
| - Better hiding standalone | ||
| - FOSS (Forever) | ||
| - Better Standalone Hiding | ||
|
|
||
| ## Dependencies | ||
|
|
||
| - rustc | ||
| - Android NDK | ||
| | Tool | Description | | ||
| |-----------------|----------------------------------------| | ||
| | `rustc` | The Rust compiler | | ||
| | `Android NDK` | Native Development Kit for Android | | ||
|
|
||
| ### Rust Dependencies | ||
|
|
||
| | Dependency | Description | | ||
| |------------------|---------------------------------------------------------------| | ||
| | `android_logger` | Logger for Android platform | | ||
| | `anyhow` | Error handling library | | ||
| | `bitflags` | Macro to generate structures for bitwise operations | | ||
| | `const_format` | Compile-time string formatting | | ||
| | `futures` | Abstractions for asynchronous programming | | ||
| | `konst` | Compile-time constant evaluation | | ||
| | `lazy_static` | Macro for declaring lazily evaluated static variables | | ||
| | `libc` | FFI bindings to native C libraries | | ||
| | `log` | Logging facade | | ||
| | `memfd` | Memory file descriptor utilities | | ||
| | `num_enum` | Derive macros to convert between numbers and enums | | ||
| | `passfd` | Passing file descriptors over Unix sockets | | ||
| | `proc-maps` | Parse and analyze process memory maps | | ||
|
|
||
| ### C++ Dependencies | ||
|
|
||
| | Dependency | Description | | ||
| |------------|-------------------------------| | ||
| | `lsplt` | Simple PLT Hook for Android | | ||
|
|
||
| ### Rust side: | ||
|
|
||
| - android_logger | ||
| - anyhow | ||
| - bitflags | ||
| - const_format | ||
| - futures | ||
| - konst | ||
| - lazy_static | ||
| - libc | ||
| - log | ||
| - memfd | ||
| - num_enum | ||
| - passfd | ||
| - proc-maps | ||
|
|
||
| ### C++ side: | ||
| ## Usage | ||
|
|
||
| - lsplt | ||
| We're currently in the process of cooking. (Coming Soon) | ||
|
|
||
| ## Installation | ||
|
|
||
| WIP, do not install yet. | ||
| There are currently no available stable releases. (Coming Soon) | ||
|
|
||
| ## Usage | ||
| ## Translation | ||
|
|
||
| WIP | ||
| As of now, we don't have integration with another platform for translations but you may contribute to the [add/webui](https://github.com/PerformanC/ReZygisk/tree/add/webui) branch. Please don't forget to include your GitHub profile in [TRANSLATOR.md](https://github.com/PerformanC/ReZygisk/blob/add/webui/TRANSLATOR.md) so that people can see your contribution. | ||
|
|
||
| ## Support | ||
| For any question related to ReZygisk or other PerformanC projects, feel free to join any of the following channels below: | ||
|
|
||
| Any question related to ReZygisk or other PerformanC projects can be made in [PerformanC's Discord server](https://discord.gg/uPveNfTuCJ). You can also find support in [ReZygisk Telegram chat](https://t.me/rezygiskchat) or in [The PerformanC Organization telegram channel](https://t.me/performancorg) or [the chat](https://t.me/performancorg_channel). | ||
| - Discord Channel: [PerformanC](https://discord.gg/uPveNfTuCJ) | ||
| - ReZygisk Telegram Channel: [@rezygiskchat](https://t.me/rezygiskchat) | ||
| - PerformanC Telegram Channel: [@performancorg](https://t.me/performancorg) | ||
|
|
||
| ## Contribution | ||
|
|
||
| It is mandatory to follow the PerformanC's [contribution guidelines](https://github.com/PerformanC/contributing) to contribute to ReZygisk. Following its Security Policy, Code of Conduct and syntax standard. | ||
| It is mandatory to follow PerformanC's [Contribution Guidelines](https://github.com/PerformanC/contributing) to contribute to ReZygisk. Following its Security Policy, Code of Conduct, and syntax standard. | ||
|
|
||
| ## License | ||
|
|
||
| ReZygisk is licensed majoritaly under GPL, by Dr-TSNG, but also AGPL 3.0, by The PerformanC Organization, for re-written code. You can read more about it on [Open Source Initiative](https://opensource.org/licenses/AGPL-3.0). | ||
| ReZygisk is licensed majoritaly under GPL, by Dr-TSNG, but also AGPL 3.0, by The PerformanC Organization, for re-written code. You can read more about it on [Open Source Initiative](https://opensource.org/licenses/AGPL-3.0). |