SnapEnhance/README.md
2023-12-26 19:00:32 +01:00

190 lines
7.4 KiB
Markdown

<div align="center">
<img src="https://raw.githubusercontent.com/rhunk/SnapEnhance/main/app/src/main/res/mipmap-xxxhdpi/launcher_icon_foreground.png" height="250" />
[![Build](https://img.shields.io/github/actions/workflow/status/rhunk/SnapEnhance/beta.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.<br/><br/>
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.
</div>
## Quick Start
Requirements:
- Rooted using Magisk or KernelSU
- LSPosed installed and fully functional
Although using this in an unrooted enviroment using something like LSPatch should be working fine, it is not recommended to do so, use at your own risk!
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)
## Download
To Download the latest stable release, please visit the [Releases](https://github.com/rhunk/SnapEnhance/releases) page.<br/>
You can also download the latest debug build from the [Actions](https://github.com/rhunk/SnapEnhance/actions) section.<br/>
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.
## Features
<details open>
<summary>Spying & Privacy</summary>
- Message logger
- Prevent sending Read Receipts
- Hide Bitmoji Presence
- Better Notifications
- Disable Metrics
- Block Ads
- Unlimited Snap View Time
- Prevent Screenshot Notification
- Prevent Status Notifications
- Anonymous Story View
- Prevent Typing Notification
</details>
<details open>
<summary>Media Manager</summary>
- Download any message in a chat (Snaps, External Media, Voice Notes, etc.)
- Download any story (Private, Public, or Professional)
- Anti Auto-download (Prevents automatic Downloading on specific conversations)
- Gallery Media Send Override
- Auto Save Messages
- Force Source Quality
</details>
<details open>
<summary>UI & Tweaks</summary>
- Disable Camera
- Immersive Camera Preview (Fix Snapchats camera bug)
- Hide certain UI Elements
- Show Streak Expiration Info
- Disable Snap Splitting
- Disable Video Length Restriction
- Snapchat Plus
- New Map UI
- Location Spoofer
- Disable Spotlight
- Enable Official App Appearance Settings (Darkmode)
- Pin Conversations
- Multi Snap Limit bypass
- Override Startup Page
</details>
<details open>
<summary>Experimental</summary>
- App Passcode
- Infinite Story Boost
- My Eyes Only Bypass
- AMOLED Dark Mode
- Chat Export (HTML, JSON and TXT)
</details>
## FAQ
<details>
<summary>AI wallpapers and the Snapchat+ badge aren't working!</summary>
- Yeah, they're server-sided and will probably never work.
</details>
<details>
<summary>Can you add this feature, please?</summary>
- Open an issue on our Github repo.
</details>
<details>
<summary>When will this feature become available or finish?</summary>
- At some point.
</details>
<details>
<summary>Can I get banned with this?</summary>
- Obviously, however, the risk is very low, and we have no reported cases of anyone ever getting banned while using the mod.
</details>
<details>
<summary>Can I PM the developers?</summary>
- No.
</details>
<details>
<summary>This doesn't work!</summary>
- Open an issue.
</details>
<details>
<summary>My phone isn't rooted; how do I use this?</summary>
- You can use LSPatch in combination with SnapEnhance to run this on an unrooted device, however this is unrecommended and not considered safe.
</details>
<details>
<summary>Where can I download the latest stable build?</summary>
- https://github.com/rhunk/snapenhance/releases
</details>
<details>
<summary>Can I use HideMyApplist with this?</summary>
- No, this will cause some severe issues, and the mod will not be able to inject.
</details>
<details>
<summary>How can I translate SnapEnhance into my language?</summary>
- We have a [Weblate](https://hosted.weblate.org/projects/snapenhance/app/) hosted repo, feel free to submit your translations there.
</details>
## Privacy
We do not collect any user information. However, please be aware that third-party libraries may collect data as described in their respective privacy policies.
<details>
<summary>Permissions</summary>
- [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission#INTERNET)
- [android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS](https://developer.android.com/reference/android/Manifest.permission.html#REQUEST_IGNORE_BATTERY_OPTIMIZATIONS)
- [android.permission.POST_NOTIFICATIONS](https://developer.android.com/reference/android/Manifest.permission.html#POST_NOTIFICATIONS)
- [android.permission.SYSTEM_ALERT_WINDOW](https://developer.android.com/reference/android/Manifest.permission#SYSTEM_ALERT_WINDOW)
</details>
<details>
<summary>Third-party libraries used</summary>
- [libxposed](https://github.com/libxposed/api)
- [ffmpeg-kit-full-gpl](https://github.com/arthenica/ffmpeg-kit)
- [osmdroid](https://github.com/osmdroid/osmdroid)
- [coil](https://github.com/coil-kt/coil)
- [Dobby](https://github.com/jmpews/Dobby)
- [rhino](https://github.com/mozilla/rhino)
- [libsu](https://github.com/topjohnwu/libsu)
</details>
## Contributors
Thanks to everyone involved including the [third-party libraries](https://github.com/rhunk/SnapEnhance?tab=readme-ov-file#privacy) used!
- [rathmerdominik](https://github.com/rathmerdominik)
- [Flole998](https://github.com/Flole998)
- [authorisation](https://github.com/authorisation/)
- [RevealedSoulEven](https://github.com/revealedsouleven)
- [iBasim](https://github.com/ibasim)
- [xerta555](https://github.com/xerta555)
- [TheVisual](https://github.com/TheVisual)
- [CanerKaraca23](https://github.com/CanerKaraca23)
## Donate
- LTC: LbBnT9GxgnFhwy891EdDKqGmpn7XtduBdE
- BCH: qpu57a05kqljjadvpgjc6t894apprvth9slvlj4vpj
- BTC: bc1qaqnfn6mauzhmx0e6kkenh2wh4r6js0vh5vel92
- ETH: 0x0760987491e9de53A73fd87F092Bd432a227Ee92
## License
The [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text) license is a free, open-source software license that grants users the right to modify, share, and redistribute the software.
By using this software, you agree to make the source code freely available, along with any modifications, additions, or derivatives.
When redistributing the software, it must remain under the same [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text) license, and any modifications should be clearly indicated as such.