revenge-mod/Revenge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Meta] Update README

Browse source
This commit is contained in:
Beef 2023-02-15 16:12:58 +00:00
parent 307cf453f5
commit 180d60041e
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -7,40 +7,40 @@ Vendetta's codebase is platform-agnostic, but you need a platform-specific loade
### Android ### Android
* Root - [VendettaXposed](https://github.com/vendetta-mod/VendettaXposed) * Root - [VendettaXposed](https://github.com/vendetta-mod/VendettaXposed)
* Non-root - [frendetta](https://github.com/vendetta-mod/frendetta) * Non-root - [frendetta](https://github.com/vendetta-mod/frendetta)
- Unable to use frendetta? No problem! Pre-built APKs are provided [here](https://discord.k6.tf/).
- Note that this solution is not permanent - a dedicated patcher app for Android is on it's way.
### iOS ### iOS
* [VendettaTweak](https://github.com/vendetta-mod/VendettaTweak) <sub>must be built from source for now™️</sub> * [VendettaTweak](https://github.com/vendetta-mod/VendettaTweak)
- You can get prebuilt `.deb` files from GitHub Actions.
- Both an IPA and an APT repo will be provided in future.
## Contributing ## Contributing
I ([Beef](https://github.com/Beefers)) develop Vendetta entirely on my rooted Pixel 7, so these instructions only cover Android with LSPosed. If you have development instructions for iOS or unrooted Android, PRs are welcome! 1. Install a Vendetta loader with loader config support (any mentioned in the [Installing](#installing) section).
1. Clone the repo: 2. Go to Settings > General and enable Developer Settings.
3. Clone the repo:
``` ```
git clone https://github.com/vendetta-mod/Vendetta git clone https://github.com/vendetta-mod/Vendetta
``` ```
2. Install dependencies: 4. Install dependencies:
``` ```
pnpm i pnpm i
``` ```
<sup>`npm` or `yarn` should also work.</sup> <sup>`npm` or `yarn` should also work.</sup>
3. Install the [debug build of the Xposed module](https://nightly.link/vendetta-mod/VendettaXposed/workflows/build/master/app-debug.zip), and enable it. It should target Discord by default.
4. Connect your test device via ADB, and run:
```
adb reverse tcp:4040 tcp:4040
```
<sup>You can replace the second `4040` with any port of your choosing, as long as the first port is **always** `4040`.</sup>
5. Build Vendetta's code: 5. Build Vendetta's code:
``` ```
pnpm build pnpm build
``` ```
<sup>`npm` or `yarn` should also work.</sup> <sup>`npm` or `yarn` should also work.</sup>
6. In the newly created `dist` directory, run a HTTP server on port 4040. 6. In the newly created `dist` directory, run a HTTP server. I recommend [http-server](https://www.npmjs.com/package/http-server).
7. Upon starting Discord, you should notice that your phone makes a request to your HTTP server, downloading Vendetta's bundle. 7. Go to Settings > Developer enabled earlier) and input the IP address and port of the server, e.g. `http://192.168.1.236:4040`.
8. Make your changes, rebuild, reload, go wild! 8. Restart Discord. Upon reload, you should notice that your device will download Vendetta's bundled code from your server, rather than GitHub.
9. Make your changes, rebuild, reload, go wild!