Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhances to the readme #258

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
110 changes: 91 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,97 @@
# SnapMod
Xposed module for Snapchat.
<h1 align="center">
<br>
SnapMod
<br>
</h1>

## Setup
To set SnapMod up, download and install the latest apk from [here](https://github.com/rodit/SnapMod/releases). When you open it, it will ask to install some bindings. Press 'Download' and be sure to kill and restart Snapchat afterwards. The latest and only fully supported version of Snapchat is **11.96.0.31** (as of SnapMod 1.8.5). Mappings **will not** be downloaded for previous versions of Snapchat automatically, only for the latest supported version. If you are using an older version, you must manually place the mappings in `/data/data/xyz.rodit.snapmod/files/[build].json` or `/Android/data/xyz.rodit.snapmod/files/[build].json` on your internal storage where `[build]` is the version code of Snapchat the mappings correspond to. Note, there is no guarentee the newest version of Snapmod will work with old mappings (it usually will not for a couple of features).
<h4 align="center">Simple to use Xposed module for Snapchat 👻</h4>

## Features
For a full list of features and their status, please visit the wiki [here](https://github.com/rodit/SnapMod/wiki/Features).
<p align="center">
<a href="https://github.com/rodit/snapmod/releases">
<img src="https://img.shields.io/github/v/release/rodit/snapmod?style=for-the-badge"></a>
<a href="https://github.com/rodit/snapmod/releases"><img src="https://img.shields.io/github/downloads/rodit/snapmod/total?style=for-the-badge"></a>
<a href="https://github.com/rodit/snapmod/stargazers">
<img src="https://img.shields.io/github/stars/rodit/snapmod?style=for-the-badge"></a>
<a href="#donate">
<img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&amp;style=for-the-badge">
</a>
</p>

## Feature Suggestions
If you would like to suggest a new feature, please do so in **Discussions**. Please do not create an Issue for feature suggetsions (they will be moved to Discussions).
<p align="center">
<a href="#how-to-use">How To Use</a> •
<a href="#key-features">Key Features</a> •
<a href="#issues">Issue reporting</a> •
<a href="#feature-request">Feature Requests</a>
</p>

## Issues
If you have an issue please post a log from LSPosed (I have no interest in supporting other Xposed implementations, although SnapMod should work fine with them) and a description of the issue. It is **extremely** unhelpful to just say "something doesn't work" or "I can't download stories."

# How To Use

To use this Xposed module, you'll need a rooted or a non-rooted phone (😱).

## For both
* Please install a supported Snapchat version ([APKMirror](https://apkmirror.com/apk/snap-inc/snapchat/) for example), currently the supported one is **11.96.0.31** for SnapMod 1.8.5. We do not offer official (You might get in GitHub issues) support for versions that are behind either one.
* > **Note** If you are an android developer or something similar, you can create mappings yourself that might work for higher/lower Snapchat versions. You can follow the steps in `.github/workflows`
* > **Note** If you have obtained custom mappings, move them in `/(Android|data)/data/xyz.rodit.snapmod/files/[build].json`. Build numbers you can obtain from APKMirror, if they are not provided. With a good file explorer (Like MiXplorer or File Manager Plus) non-rooted users can do this as well.

* > **Warning** We might not offer support for non-rooted users


## Installation for non-rooted users
1. Download and install [LSPatch](https://github.com/LSPosed/LSPatch) and [Shizuku](https://github.com/RikkaApps/Shizuku)
2. Download and install [app-release.apk](https://github.com/rodit/SnapMod/releases/download/v1.8.5/app-release.apk) from latest release
3. Turn on Shizuku and open LSPatch and go to the second tab from the left
4. Press the plus sign and search Snapchat and select it
5. Choose the the Patch Mode to be Portable
6. Click on Embed modules and select SnapMod and tap Start Patch
7. Open SnapMod and verify that it says "Supported version". If it doesn't, try again. Make sure you have the correct mappings!

## Installation for root users
1. Download and install [LSPosed Framework](https://github.com/LSPosed/LSPosed). We do not offer support for other Xposed implementatios although SnapMod would work fine with them.
2. Download and install [app-release.apk](https://github.com/rodit/SnapMod/releases/download/v1.8.5/app-release.apk) from latest release.
3. Enable SnapMod in LSPosed manager and close Snapchat completely.
5. Open SnapMod and verify that it says "Supported version". If it doesn't, please see <a href="#issues">Issues</a>



## Key Features
> **Note** Full feature list and their status is available [here](https://github.com/rodit/SnapMod/wiki/Features)! More than 30 features available!
* Download Snaps and stories!
- Save them automatically too!
- Customizable behaviour
* Privacy
- Disable notifications for certain activities for other people and Snapchat's metrics and logging
* Tweaks
- Change how parts of Snapchat work, like removing ads or disabling the Spotlight tab
* Camera
- Change image settings
- Change video settings
* Snaps
- Change the behaviour of incoming snaps
* Notifications
- Incoming notification changing
* Miscellanous
- Additional user info
- Module update checking

# Issues
> **Warning** Please do not create duplicate issues. Refrain from creating feature requests or common questions in GitHub Issues, use **Discussions** for these.

## Troubleshooting
If anything doesn't work, the first thing you should try is killing and relaunching Snapchat (through the system settings app, not recent app list) **TWICE** and then trying again. This will ensure any cached mappings are updated. This is especially important after updating SnapMod and its mappings.

## Donations
Although this is a personal project I do entirely for fun (and it will most likely stay that way), if you would like to support the development of SnapMod, you can do so by donating:
- PayPal: https://paypal.me/roditmod
- Cashapp: https://cash.app/rodit9
- BTC: bc1qr06chdv85jf9v7ldf7l24lrgp6ad7av8y7jwyc
- ETH: 0x90659C0556b37107359FA32b40AA74c593590E04
- XRP: rDgNCbi4eCeczpzGHGs3XHsR5C3SyUCr5r
If nothing works, the first thing to do is: kill the Snapchat app process through system settings and after that relaunch it and do this twice. This will make sure any cached mappings are updated.

## GitHub Issues
If you have encountered an issue: First check Github Issues if others have experienced it if not, please get logs from LSPosed and upload them while creating a new issue. Please describe the bug, give us steps to reproduce, screenshots, expected behaviour and any additional context you might have.

# Feature request
If you have an idea for a new feature, please check **Discussions** tab first if it has been requested already. If it has not, create one!

# Donate
If you would like to support the deveploment of SnapMod, you can do it by donating
* [PayPal](https://paypal.me/roditmod)
* [Cashapp](https://cash.app/rodit9)

## Crypto
- BTC: bc1qr06chdv85jf9v7ldf7l24lrgp6ad7av8y7jwyc
- ETH: 0x90659C0556b37107359FA32b40AA74c593590E04
- XRP: rDgNCbi4eCeczpzGHGs3XHsR5C3SyUCr5r