Revenge/README.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

2024-02-08 16:26:03 +00:00
# Revenge
2024-02-08 18:58:41 +00:00
A modification for the Discord Android app. Continuation of [Vendetta](https://github.com/vendetta-mod). Get it? Vendetta is like, revenging..., yeah.
2024-02-06 23:45:41 +00:00
2024-02-08 16:26:03 +00:00
## ⬇️ Installing
2024-02-08 18:58:41 +00:00
> [!NOTE]
> While [Vendetta](https://github.com/vendetta-mod) used to be platform-agnostic, Revenge will only focus on Android as alternatives exist for iOS.
> Focusig on just Android gives us more benefit, as we can add Android-only features more easily.
2023-02-01 18:40:11 +00:00
2024-02-08 16:26:03 +00:00
Installing is not currently possible yet, as we're on the process of moving and renaming things.
2023-02-01 18:40:11 +00:00
2024-02-08 16:26:03 +00:00
## 💖 Contributing
2023-02-01 18:40:11 +00:00
2024-02-08 18:58:41 +00:00
> [!IMPORTANT]
> 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.
2024-02-08 16:26:03 +00:00
This section will be worked on once the [**⬇️ Installing**](#%EF%B8%8F-installing) section is finished.
2023-02-01 18:40:11 +00:00
2024-02-08 16:26:03 +00:00
<!-- 1. Install a Vendetta loader with loader config support (any mentioned in the [Installing](#installing) section).
2023-02-01 18:40:11 +00:00
2024-02-08 18:58:41 +00:00
1. Go to Settings > General and enable Developer Settings.
2023-02-15 16:12:58 +00:00
2024-02-08 18:58:41 +00:00
2. Clone the repo:
2023-02-01 18:40:11 +00:00
```
git clone https://github.com/vendetta-mod/Vendetta
```
2024-02-08 18:58:41 +00:00
3. Install dependencies:
2023-02-01 18:40:11 +00:00
```
2024-02-08 16:26:03 +00:00
bun i
2023-02-01 18:40:11 +00:00
```
2024-02-08 18:58:41 +00:00
4. Build Vendetta's code:
2023-02-01 18:40:11 +00:00
```
2024-02-08 16:26:03 +00:00
bun run build
2023-02-01 18:40:11 +00:00
```
2024-02-08 18:58:41 +00:00
5. In the newly created `dist` directory, run a HTTP server. We recommend [http-server](https://www.npmjs.com/package/http-server).
2023-02-15 16:12:58 +00:00
2024-02-08 18:58:41 +00:00
6. Go to Settings > Developer enabled earlier). Enable `Load from custom url` and input the IP address and port of the server (e.g. e.g. `http://192.168.1.236:4040`) in the new input box labelled `VENDETTA URL`.
2023-02-01 18:40:11 +00:00
2024-02-08 18:58:41 +00:00
7. Restart Discord. Upon reload, you should notice that your device will download Vendetta's bundled code from your server, rather than GitHub.
2023-02-01 18:40:11 +00:00
2024-02-08 18:58:41 +00:00
8. Make your changes, rebuild, reload, go wild! -->