diff --git a/README.md b/README.md index c1a8c6d..9aee19a 100644 --- a/README.md +++ b/README.md @@ -7,40 +7,40 @@ Vendetta's codebase is platform-agnostic, but you need a platform-specific loade ### Android * Root - [VendettaXposed](https://github.com/vendetta-mod/VendettaXposed) * 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 -* [VendettaTweak](https://github.com/vendetta-mod/VendettaTweak) must be built from source for now™️ +* [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 -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 ``` -2. Install dependencies: +4. Install dependencies: ``` pnpm i ``` `npm` or `yarn` should also work. -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 - ``` - You can replace the second `4040` with any port of your choosing, as long as the first port is **always** `4040`. - 5. Build Vendetta's code: ``` pnpm build ``` `npm` or `yarn` should also work. -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! \ No newline at end of file +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! \ No newline at end of file