BetterDiscordApp-v1/README.md

108 lines
4.3 KiB
Markdown

# BetterDiscordApp
If you have issues then join the BD Discord server: [Here](https://discord.gg/0Tmfo5ZbORCRqbAd)
If your Discord breaks then uninstall BD and try again
# Do not contact Discord support about BD issues.
## Coming in 0.2.8 all plugins must be named `*.plugin.js` and all themes must be named `*.theme.css`
Better Discord App enhances Discord desktop app with new features.
![ss](http://i.imgur.com/P0XEyp6.jpg)
## Windows Universal Installer
* Download the latest installer from [releases](https://github.com/Jiiks/BetterDiscordApp/releases)
* Follow the instructions
* .NET 4.0 required https://www.microsoft.com/en-us/download/details.aspx?id=30653
* Windows Installer users asar.net https://github.com/Jiiks/asar.net
## Auto Installation
* Download the latest package from [releases](https://github.com/Jiiks/BetterDiscordApp/releases)
* Run the installer
* Installer requires [node](https://nodejs.org/en/download/) download the binaries and place in the same folder as the installer if you don't have node installed.
* Installer uses [asar](https://github.com/atom/asar) which is bundled with the installer.
* Installer uses [wrench](https://github.com/ryanmcgrath/wrench-js) which is bundled with the installer.
## Manual Installation
* Extract app.asar
* Add BetterDiscord as a dependency
* Add init to Discord load event
* Move BetterDiscord to node_modules
## Features
**Emotes:**
BetterDiscord adds all [Twitch.tv](http://twitch.tv), most [FrankerFaceZ](http://frankerfacez.com) and [BetterTTV](http://betterttv.net) emotes to Discord. Supported emotes: https://betterdiscord.net/emotes
**Quick Emote Menu:**
Quick Emote Menu adds a menu for quickly adding twitch emotes and your favorite emotes.
**Emote Autocapitalize:**
Automatically capitalize [Twitch.tv](http://twitch.tv) global emotes.
**Emote Autocomplete:**
Automatically completes/suggests emotes.(soon)
**Minimal Mode:**
Minimal mode makes elements smaller and hides certain elements.
**Voice Chat Mode:**
Only display voice channels
**Public Servers:**
A modal window for public servers [DiscordServers.com](https://www.discordservers.com/)
![ss](http://puu.sh/o9oNl.png)
**Custom CSS**
BetterDiscord supports custom CSS for styling Discord to your liking.
**Custom Themes**
BetterDiscord comes with a theme loader for loading your own or downloading themes made by others.
**Plugins**
BetterDiscord comes with a JavaScript plugin loader for loading your own or downloading plugins made by others.
**Spoilers**
Add spoilers to your chat, simply add [!s] to your message.
**Save Logs Locally:**
Save chatlogs locally.(soon)
## Adding your server to public servers
As of JS1.60 the public server list is supplied by [DiscordServers.com](https://www.discordservers.com/)
Add your server there and it will appear in the list!
## BetterDiscord Uses the following API's
* https://twitchemotes.com/apidocs for Twitch emotes
* https://api.betterttv.net/emotes for [BetterTTV](https://nightdev.com/betterttv/) emotes
## Credits
* MacOS Installer by [Candunc](https://github.com/Candunc)
* Emote titles by [pendo324](https://github.com/pendo324)
* Majority of FFZ emote work by [Pohky] (https://github.com/pohky)
* Majority of BTTV emote work by [EhsanKia] (https://github.com/EhsanKia)
## License
The MIT License (MIT)
Copyright (c) 2015-2016 Jiiks | [Jiiks.net] (https://jiiks.net)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.