Add readme

Add nice readme with useful info for Xposed Module and about it
This commit is contained in:
kmmiio99o 2025-12-07 23:33:41 +01:00 • committed by GitHub
parent e3e6f484ea
commit 224ca9997a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# ShiggyXposed
ShiggyXposed is a root Xposed module that injects the ShiggyCord Discord mobile client modifications into the official Discord application.
## Info
* Injects ShiggyCord client into the Discord mobile app.
* Built in Kotlin.
* Material 3 like Shake menu with some discord popup accents
## Prerequisites
To use this module, your device must meet the following requirements:
* **Root Access**: Provided by Magisk, KernelSU, KernelSUNext, or Sukisu Ultra.
* **Xposed Framework**: Use JingMatrix Fork of [LSPosed](https://github.com/JingMatrix/LSPosed).
* **Target Application**: An official Discord application (stable, beta, or alpha version).
## Installation
1. Download the latest version of the module from the [Releases](https://github.com/kmmiio99o/ShiggyXposed/releases) page.
2. Install the downloaded APK file on your device.
3. Open the LSPosed manager application.
4. Go to the **Modules** section and enable **ShiggyXposed**.
5. In the module's settings, set the scope to include the **Discord** application.
6. Reboot your device for the changes to take effect.
The project is built with Kotlin and inherits its foundational structure from KettuXposed.
# Troubleshooting
- Module not working: Ensure the module is enabled in LSPosed and that Discord is correctly selected in its scope. if still nothing, head to our [discord support server](https://discord.gg/nQykFF9Ud6)
- Any other issues: Same server as above, listing them all is not worth it.
# Thanks & Credits
This project was made possible thanks to the work of:
· The LSPosed Team for the framework.
· JingMatrix for their LSPosed fork.
· [cocobo1](https://codeberg.org/cocobo1) for adjusting the Xposed module for Kettu client mod
· [Revenge Team](https://github.com/revenge-mod) for making a really good Xposed Module to base of