BetterDiscordApp-rauenzi/README.md

138 lines
5.3 KiB
Markdown

# BandagedBD [![Patreon][patreon-badge]][patreon-link] [![Paypal][paypal-badge]][paypal-link]
[patreon-badge]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2FZerebos&style=flat-square
[patreon-link]: https://patreon.com/Zerebos
[paypal-badge]: https://img.shields.io/badge/Paypal-Donate!-%2300457C.svg?logo=paypal&style=flat-square
[paypal-link]: https://paypal.me/ZackRauen
BandagedBD (Bandaged BetterDiscord) is a fork of the original [BetterDiscord](https://github.com/Jiiks/BetterDiscordApp) by Jiiks. This has a number of improvements over the original which is currently undergoing a full rewrite. In the interim, the current version has been unmaintained hence this fork existing. I will continue to maintain this fork until BDv2 comes out. I am helping to develop BDv2 as well so as release gets closer this fork will become less and less active.
# Installation
### Windows
Grab the `exe` file from the latest release on the [releases page](https://github.com/rauenzi/BetterDiscordApp/releases).
### macOS/OS X
Grab the `zip` file from the latest release on the [releases page](https://github.com/rauenzi/BetterDiscordApp/releases).
### Linux
See this link: https://gist.github.com/ObserverOfTime/d7e60eb9aa7fe837545c8cb77cf31172
# FAQ
### What is this?
This is a client modification for Discord. You can read more about it in the [original repo](https://github.com/Jiiks/BetterDiscordApp).
### Where can I get plugins and themes?
In our suport servers we have channels with lists of official plugins and themes. Please note we do not have an official listing on a website and are **not affiliated with any of those websites**.
### Support Servers?
Yup we have two of them [this one](https://discord.gg/0Tmfo5ZbORCRqbAd) and [this one](https://discord.gg/2HScm8j)
<!-- # What's Different
## New Settings
![Settings](https://i.zackrauen.com/nkb9Qi.png)
## UI
- Redesigned plugin and theme cards with additional classes for themes to use
- Additional tab in settings with additional settings.
- CustomCSS editor from CodeMirror has been removed due to being bloated and having high cpu usage. Replaced with another lightweight editor
## Plugins/Themes Related
- Prevent broken plugins from halting BD from loading
- Speed up the loading process
- Show startup errors in a modal
![Startup](https://i.zackrauen.com/PwlQcp.gif)
- Add `try...catch` blocks to help prevent errors from crashing BD and Discord
- Fix internal functions that some functions rely on such as `onSwitch` and `onMessage`
- Add `source` and `website` as options for plugin and theme METAs
- Allow themes to use spaces and apostrophes in their names
- Prettier errors in console, useful for debugging
- Auto-reload of themes/plugins
- Stabalize and enhance the `BdApi`
## Emote Module
- Emotes load asynchronously in the background (does not prevent the mod from loading anymore)
- Several bug fixes including tooltips, modifiers and emote menu
- Consolidate emotes to a single file
- Revamp how emotes are injected—speedup
- Use react and injection techniques
## Misc
- Fix Minimal Mode
- Fix React errors when opening settings
- Fix selected class disappearing when clicking an open tab
- Create new alert modal for `BdApi`
- Add toasts as notification option and in `BdApi`
- Remove most jQuery dependency for speedup
- Attach to settings when entering from right click
- Patch PublicServers
## And so much more... -->
# Supporters
These people have all subscribed to the `True Supporter` tier on Patreon to support BandagedBD.
<table>
<tr>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/196098063092154368/78a810438015b20ea8d530fafc7fe463.png?size=128" width="100px;" alt="Kraken"/><br />
<strong>Kraken</strong><br />
</td>
</tr>
</table>
# Bandagers
These people have all subscribed to the `Bandager` tier on Patreon to support BandagedBD.
<table>
<tr>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/332199319169925120/4709f8f0c9cb7ababd85459bf71848b9.png?size=128" width="50px;" alt="Kraken"/><br />
<a href="https://github.com/williamjcm" target="_blank" rel="noreferrer noopener"><strong>William JCM</strong></a>
</td>
</tr>
</table>
# Donors
These people have either donated or subscribed to the most basic patron tier to support BandagedBD.
<table>
<tr>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/284122164582416385/4f12bf80cac47656ad7fc6a82fbd5f3b.png?size=128" width="25px;" /><br />
<strong>aetheryx</strong>
</td>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/216782345779281921/d4b651b606f108cd2f96a19af68f942f.png?size=128" width="25px;" /><br />
<strong>JBeauDee</strong>
</td>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/261673576216789004/31d590fb92329e270a6225a13d500c1d.png?size=128" width="25px;" /><br />
<strong>vantiss</strong>
</td>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/122204411962327043/bd773f79607316e6be10e12682a6c10f.png?size=128" width="25px;" /><br />
<strong>xstefen</strong>
</td>
<td align="center">
<img src="https://cdn.discordapp.com/avatars/219400174869413888/a_58438b5a8e939e997902dc1e4b81e09e.png?size=128" width="25px;" /><br />
<strong>『Sorey』</strong>
</td>
</tr>
</table>