GoonCord/README.md

88 lines
3.9 KiB
Markdown
Raw Normal View History

2024-02-08 14:52:05 +08:00
> [!NOTE]
2024-02-12 11:31:22 +08:00
> This fork has been slowly progressing, check out [Bunny's roadmap](https://github.com/pyoncord/Bunny/issues/1)\
> Bunny is based on the codebase where I do my prototypes, so it could be unstable and might have some issues. Sticking to Vendetta is a better option for now, unless you want to try some other forks.
2024-02-08 14:52:05 +08:00
2024-02-10 01:37:21 +08:00
2024-02-09 10:37:36 +08:00
# Bunny
2024-02-12 11:31:22 +08:00
A mod for Discord's mobile apps, fork of Vendetta
2024-02-10 01:37:21 +08:00
2024-02-09 10:37:36 +08:00
## FAQs
2024-02-10 01:37:21 +08:00
### What's Bunny?
2024-02-12 11:31:22 +08:00
Bunny is a fork from a contributor of Vendetta who is still interested in modding Discord. Since Vendetta has reached EOL, Bunny was created to publish what I have been working on behind the scenes.
2024-02-10 01:37:21 +08:00
### Bunny vs. Pyoncord
2024-02-12 11:31:22 +08:00
Pyoncord and Bunny are completely different mods. [Pyoncord](https://github.com/pyoncord/pyoncord) is my very own WIP mod while Bunny is... simply a Vendetta fork. Bunny is put under Pyoncord branding following my initial plan which was to eventually merge these codebases into one (sounds insane I know).
2024-02-09 10:37:36 +08:00
### Discord server?
2024-02-12 11:31:22 +08:00
I'm not so much of an active Discord user myself. Since I'm ~~*a loner*~~ alone at the moment, managing a Discord server would be tough. With that noted, I still have created [Pyoncord's server](https://discord.gg/XjYgWXHb9Q), but using GitHub issues for support is much preferable.
2024-02-10 01:37:21 +08:00
2024-02-09 08:49:26 +08:00
2024-02-12 11:31:22 +08:00
### Progress?
Bunny is a side project that I work on for fun. I don’t have any intention to compete with other forks/client mods *(cough Revenge cough)* especially since I receive lack of support or encouragement from others. Bunny will go at its own pace and you may not get the same level of support as other mods.
2023-02-01 18:40:11 +00:00
## Installing
2024-02-12 11:31:22 +08:00
Bunny's codebase is *currently* platform-agnostic, but you need a platform-specific loader.
2024-02-08 19:52:53 +08:00
> [!NOTE]
2024-02-12 11:31:22 +08:00
> - As of now, Pyoncord/Bunny does not have a proper independent loader yet.
2024-02-10 01:37:21 +08:00
> - However, you may use Vendetta's loader (VendettaXposed, VendettaTweak) and override the loader url to [Bunny](https://raw.githubusercontent.com/pyoncord/detta-builds/main/bunny.js) (read [#Contributing > 7](#contributing))
> - Once our own independent loader is ready, support for the Vendetta loader will cease.
2023-02-01 18:40:11 +00:00
### Android
2023-06-05 07:27:03 +01:00
* Root - [VendettaXposed](https://github.com/vendetta-mod/VendettaXposed/releases/latest)
* Non-root - [VendettaManager](https://github.com/vendetta-mod/VendettaManager/releases/latest)
2023-03-28 20:35:55 +01:00
- Manager not working? No problem! Pre-built APKs are provided [here](https://discord.k6.tf/).
2023-06-05 07:27:03 +01:00
- The minimum Android version required is 9. It will not work any lower.
2023-02-01 18:40:11 +00:00
2024-02-10 01:37:21 +08:00
2023-02-01 18:40:11 +00:00
### iOS
2023-06-05 07:19:24 +01:00
* Jailbroken - [VendettaTweak](https://github.com/vendetta-mod/VendettaTweak)
2023-06-05 07:27:03 +01:00
- You can get prebuilt `.deb` files from GitHub Actions - we support rootful and rootless jailbreaks!
* Jailed - You can get IPAs from [the thread](https://discord.com/channels/1015931589865246730/1087295482667208766) in our [Discord server](https://discord.gg/n9QQ4XhhJP) or from our [host](https://discord.k6.tf/ios/).
- These IPAs do *not* work with AltStore! You should use [Sideloadly](https://sideloadly.io).
2023-02-01 18:40:11 +00:00
2024-02-10 01:37:21 +08:00
2023-02-01 18:40:11 +00:00
## Contributing
2024-02-12 11:31:22 +08: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-10 01:37:21 +08:00
2023-02-15 16:12:58 +00:00
2. Go to Settings > General and enable Developer Settings.
2024-02-10 01:37:21 +08:00
2023-02-15 16:12:58 +00:00
3. Clone the repo:
2023-02-01 18:40:11 +00:00
```
2024-02-09 10:37:36 +08:00
git clone https://github.com/pyoncord/bunny
2023-02-01 18:40:11 +00:00
```
2024-02-10 01:37:21 +08:00
2023-02-15 16:12:58 +00:00
4. Install dependencies:
2023-02-01 18:40:11 +00:00
```
pnpm i
```
<sup>`npm` or `yarn` should also work.</sup>
2024-02-10 01:37:21 +08:00
2024-02-09 10:37:36 +08:00
5. Build Bunny's code:
2023-02-01 18:40:11 +00:00
```
pnpm build
```
<sup>`npm` or `yarn` should also work.</sup>
2024-02-10 01:37:21 +08:00
2023-02-15 16:12:58 +00:00
6. In the newly created `dist` directory, run a HTTP server. I recommend [http-server](https://www.npmjs.com/package/http-server).
2024-02-10 01:37:21 +08:00
7. Go to Settings > Developer enabled earlier). Enable `Load from custom url` and input the IP address and port of the server (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-09 10:37:36 +08:00
8. Restart Discord. Upon reload, you should notice that your device will download Bunny's bundled code from your server, rather than GitHub.
2023-02-01 18:40:11 +00:00
2024-02-10 01:37:21 +08:00
2023-03-28 20:35:55 +01:00
9. Make your changes, rebuild, reload, go wild!
2024-02-10 01:37:21 +08:00