Skip to content

Commit

Permalink
docs: improve installation guide [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Palm authored Feb 14, 2024
1 parent 35d227b commit 9225773
Showing 1 changed file with 32 additions and 13 deletions.
45 changes: 32 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,50 @@
# Revenge

A modification for the Discord Android app. Continuation of [Vendetta](https://github.com/vendetta-mod). Get it? Vendetta is like, revenging..., yeah.
A modification for Discord mobile apps. Continuation of [Vendetta](https://github.com/vendetta-mod). Get it? Vendetta is like, revenging..., yeah.

> [!WARNING]
> Revenge is still WIP! Please understand that you might encounter some issues.
> Revenge is still being worked on! Please understand that you may encounter some issues.
## ⬇️ Installing

> [!NOTE]
> While Revenge is platform-agnostic, there is no guarantee it will always work on iOS. I do not have a device to test the changes I've made, so feel free to report iOS-specific issues if you encounter one.
### Android

1. Install [Vendetta Manager](https://github.com/vendetta-mod/VendettaManager/releases/latest/download/Manager.apk)
2. Download (don't install!) the latest [Xposed module](https://github.com/revenge-mod/RevengeXposed/releases/latest/download/app-release.apk)
3. Go to Vendetta manager's **Settings > About** and press version number **10 times**
4. Set the custom Xposed module location to:
```
/storage/emulated/0/Download/app-release.apk
```
2. Download *(don't install!)* the latest [Xposed module](https://github.com/revenge-mod/RevengeXposed/releases/latest/download/app-release.apk)
3. Go to Vendetta Manager's **Settings > About** and press version number **10 times**
4. Set **Custom Xposed module location** to:
```
/storage/emulated/0/Download/app-release.apk
```
> [!NOTE]
> This is default location of module if you use *default downloads folder* and *you don't have any `app-release.apk` saved*. If you move module or it has different name - change the path respectively.
> This is default location of downloaded module if you use the default `Downloads` folder **and** you don't have any file with the same name saved. If these two conditions don't match, you will have to change the path respectively.
5. Head back to main screen and install!

### Alternative method / Other platforms

> [!IMPORTANT]
> While Revenge is platform-agnostic, there is no guarantee it will always work on other platforms. we do not have a device to test the changes I've made, so feel free to report issues if you encounter them.
1. Install [Vendetta](https://github.com/vendetta-mod/Vendetta)
2. Head to **Settings > General** under the **Vendetta** section
3. Toggle on the **Developer Settings** switch
4. Restart the app
5. Head to **Settings > Developer** under the **Vendetta** section
6. Toggle on the **Load Vendetta from custom URL** option
7. Input the following in the text field that appears
```
https://cdn.jsdelivr.net/gh/revenge-mod/builds@main/revenge.js
```
8. Restart the app again, and that should be it!

## 💖 Contributing

> [!NOTE]
> This project now uses [Bun](https://bun.sh) instead of Node.js.
> It is **recommended** to use Bun over Node.js because Bun is faster and far better for development.
>
> If you're on Windows, we recommend checking out [WSL](https://github.com/MicrosoftDocs/WSL).
> If you're on Windows, we recommend checking out [Windows Subsystem for Linux](https://github.com/MicrosoftDocs/WSL).
1. Follow the first two steps listed in [**⬇️ Installing**](#%EF%B8%8F-installing) section

Expand All @@ -36,7 +55,7 @@ A modification for the Discord Android app. Continuation of [Vendetta](https://g

3. Install dependencies
```
bun i
bun install
```

4. Build Revenge
Expand Down

0 comments on commit 9225773

Please sign in to comment.