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

chore(README): update with more info

Browse source
This commit is contained in:
PalmDevs 2024-02-09 01:58:41 +07:00
parent aa4bd693bd
commit e5d834fdbc
No known key found for this signature in database
GPG key ID: ADC432EE981495A3
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,41 +1,48 @@
# Revenge # Revenge
A modification for the Discord Android app. Get it? Vendetta is like, revenging..., yeah. A modification for the Discord Android app. Continuation of [Vendetta](https://github.com/vendetta-mod). Get it? Vendetta is like, revenging..., yeah.
## ⬇️ Installing ## ⬇️ Installing
> [!IMPORTANT] > [!NOTE]
> While Vendetta used to be platform-agnostic, Revenge will only focus on Android as alternatives exist for iOS. > 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.
Installing is not currently possible yet, as we're on the process of moving and renaming things. Installing is not currently possible yet, as we're on the process of moving and renaming things.
## 💖 Contributing ## 💖 Contributing
> [!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.
This section will be worked on once the [**⬇️ Installing**](#%EF%B8%8F-installing) section is finished. This section will be worked on once the [**⬇️ Installing**](#%EF%B8%8F-installing) section is finished.
<!-- 1. Install a Vendetta loader with loader config support (any mentioned in the [Installing](#installing) section). <!-- 1. Install a Vendetta loader with loader config support (any mentioned in the [Installing](#installing) section).
2. Go to Settings > General and enable Developer Settings. 1. Go to Settings > General and enable Developer Settings.
3. Clone the repo: 2. Clone the repo:
``` ```
git clone https://github.com/vendetta-mod/Vendetta git clone https://github.com/vendetta-mod/Vendetta
``` ```
4. Install dependencies: 3. Install dependencies:
``` ```
bun i bun i
``` ```
5. Build Vendetta's code: 4. Build Vendetta's code:
``` ```
bun run build bun run build
``` ```
6. In the newly created `dist` directory, run a HTTP server. We recommend [http-server](https://www.npmjs.com/package/http-server). 5. In the newly created `dist` directory, run a HTTP server. We recommend [http-server](https://www.npmjs.com/package/http-server).
7. 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`. 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`.
8. Restart Discord. Upon reload, you should notice that your device will download Vendetta's bundled code from your server, rather than GitHub. 7. 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! --> 8. Make your changes, rebuild, reload, go wild! -->