GoonCord/README.md

43 lines
2.6 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)\
2024-02-23 23:34:19 +08:00
> I might be a bit inactive to maintain Bunny until March '24.
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-23 23:34:19 +08:00
A mod for Discord's mobile apps, a 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-23 23:34:19 +08:00
Bunny is a fork from someone from the Vendetta team 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-23 23:34:19 +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-23 23:34:19 +08:00
I have created [Pyoncord's server](https://discord.gg/XjYgWXHb9Q) for support and announcements, but getting support through GitHub issues is much preferable.
> [!NOTE]
> It's worth noting that I'm not so much of an active Discord user myself. With me being a loner, even managing a dead Discord server would be tough.
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-23 23:34:19 +08:00
There's currently no proper way to install Bunny, *yet*. I am currently working on an Xposed module for Android and will think about iOS later, when most of what I planned for Bunny is finished.
2023-02-01 18:40:11 +00:00
2024-02-23 23:34:19 +08:00
### HOWEVER
2023-02-01 18:40:11 +00:00
2024-02-23 23:34:19 +08:00
For now, you can opt-in Bunny directly from Vendetta's loader (like VendettaXposed or VendettaTweak)! If you wish to opt-in, simply:
1. Go to Settings > Developer (under the Vendetta section) > Enable 'Load from custom url'
2. Insert [Pyoncord's bundle URL](https://raw.githubusercontent.com/pyoncord/detta-builds/main/bunny.js) > Restart.
2024-02-10 01:37:21 +08:00
2024-02-23 23:34:19 +08:00
It's worth noting that this method may not last long and eventually cease in the future, but that's the least thing to worry about!... probably.
2024-02-10 01:37:21 +08:00
2024-02-23 23:34:19 +08:00
## Contributing <!-- do better tbh -->
Setting up Bunny is quite simple if you're already familiar with developing with Node.js. Simply `git clone`, `pnpm install`, `pnpm dev` and locally host the `<project-dir>/dist/bunny.js` bundle generated by the script. Once you've got the local URL (something like `http://192.168.1.236:4040/bunny.js`), insert the URL under Settings > Developer (enabled in General beforehand) > Load custom URL and restart