diff --git a/README.md b/README.md index 27624bfd..c04f318a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@
- [![Build](https://img.shields.io/github/actions/workflow/status/rhunk/SnapEnhance/debug.yml?branch=dev&logo=github&label=Build)](https://github.com/rhunk/SnapEnhance/actions/workflows/android.yml?query=branch%3Amain+event%3Apush+is%3Acompleted) [![Total](https://shields.io/github/downloads/rhunk/SnapEnhance/total?logo=Bookmeter&label=Downloads&logoColor=Green&color=Green)](https://github.com/rhunk/snapenhance/releases) [![Translation status](https://hosted.weblate.org/widget/snapenhance/app/svg-badge.svg)](https://hosted.weblate.org/engage/snapenhance/) - +[![Build](https://img.shields.io/github/actions/workflow/status/rhunk/SnapEnhance/debug.yml?branch=dev&logo=github&label=Build)](https://github.com/rhunk/SnapEnhance/actions/workflows/android.yml?query=branch%3Amain+event%3Apush+is%3Acompleted) [![Total](https://shields.io/github/downloads/rhunk/SnapEnhance/total?logo=Bookmeter&label=Downloads&logoColor=Green&color=Green)](https://github.com/rhunk/snapenhance/releases) [![Translation status](https://hosted.weblate.org/widget/snapenhance/app/svg-badge.svg)](https://hosted.weblate.org/engage/snapenhance/) + # SnapEnhance SnapEnhance is an Xposed mod that enhances your Snapchat experience.

-Please note that this project is currently in development, so bugs and crashes may occur. If you encounter any issues, we encourage you to report them. To do this simply visit our [issues](https://github.com/rhunk/SnapEnhance/issues) page and create an issue, make sure to follow the guidelines. +Please note that this project is currently in development, so bugs and crashes may occur. If you encounter any issues, we encourage you to report them [here](https://github.com/rhunk/SnapEnhance/issues).
## Quick Start @@ -18,13 +18,18 @@ Although using this in an unrooted enviroment using something like `LSPatch` sho 1. Install the module APK from either this [Github repo](https://github.com/rhunk/SnapEnhance/releases) or the [LSPosed repo](https://modules.lsposed.org/module/me.rhunk.snapenhance) 2. Turn on the module in `LSPosed` and make sure Snapchat is in scope 3. Force Stop Snapchat -4. Open the menu by clicking the [Settings Gear Icon](https://i.imgur.com/2grm8li.png) +4. Open the menu by clicking the [Settings Gear Icon](https://i.imgur.com/2grm8li.png) or the [Top Title](https://imgur.com/xWFKha7) (v2.1.0 and higher) -## Download -To Download the latest stable release, please visit the [Releases](https://github.com/rhunk/SnapEnhance/releases) page.
+A full installation guide can be found [here](https://github.com/rhunk/SnapEnhance/wiki/Installation-Guide). + +## Download +To download the latest stable release, please visit the [Releases](https://github.com/rhunk/SnapEnhance/releases) page.
You can also download the latest debug build from the [Actions](https://github.com/rhunk/SnapEnhance/actions) section.
We no longer offer official `LSPatch` binaries for obvious reasons. However, you're welcome to patch them yourself, as they should theoretically work without any issues. +> [!Caution] +> Snapchat has locked many user accounts that used SnapEnhance or its related forks due to new detections. It's recommended to use Snapchat [v12.81.0.44](https://www.apkmirror.com/apk/snap-inc/snapchat/snapchat-12-81-0-44-release/) or earlier. Only use signed builds or builds you've modified yourself to avoid compromising the security of your account. + ## Main Features
Media Downloader @@ -155,9 +160,24 @@ We no longer offer official `LSPatch` binaries for obvious reasons. However, you
## FAQ +
+ How to report a bug? + + - Check that the bug has not already been reported in [Issues](https://github.com/rhunk/SnapEnhance/issues?q=). + - Make sure the bug is not occurring when you use Snapchat without SnapEnhance. + - Make sure you have logs before reporting (go to the SnapEnhance application -> click on the debug icon at the top right and then on the 3 vertical dots -> export logs). +
+ +
+ My Snapchat keeps crashing/doesn't want to open after installing + + - In some cases, because of Android's signature verification, you **must install Snapchat before SnapEnhance**, so that the two can communicate with each other. + - You may use [LSPatch](https://github.com/LSPosed/LSPatch/forks) or [LSPosed](https://github.com/LSPosed/LSPosed/forks) forks to ensure compatibility with new Android versions, as original projects are no longer updated. +
+
AI wallpapers and the Snapchat+ badge aren't working! - + - Yeah, they're server-sided and will probably never work.
@@ -167,42 +187,18 @@ We no longer offer official `LSPatch` binaries for obvious reasons. However, you - Open an issue on our Github repo. -
- When will this feature become available or finish? - - - At some point. -
- -
- Can I get banned with this? - - - Obviously, however, the risk is low. SnapEnhance takes no responsibility for any consequences, including but not limited to account bans or suspensions. -
-
Can I PM the developers? - No.
-
- This doesn't work! - - - Open an issue. -
-
My phone isn't rooted; how do I use this? - You can use `LSPatch` in combination with `SnapEnhance` to run this on an unrooted device, however this is unrecommended and not considered safe.
-
- Where can I download the latest stable build? - - - https://github.com/rhunk/snapenhance/releases -
-
Can I use HideMyApplist with this?