BetterDiscordApp-v1/README.md

110 lines
4.4 KiB
Markdown
Raw Permalink Normal View History

Note that this whole branch is deprecated. all further development is going on here: https://github.com/JsSucks/BetterDiscordApp
2017-02-11 23:37:49 +01:00
2015-08-25 06:08:22 +02:00
# BetterDiscordApp
2016-01-27 08:30:57 +01:00
2016-11-07 19:46:14 +01:00
# If you have issues then join the BD Discord server: [Here](https://discord.gg/0Tmfo5ZbORCRqbAd)
2016-01-27 08:30:57 +01:00
# Do not contact Discord support about BD issues.
2016-11-07 19:46:14 +01:00
## All plugins must be named `*.plugin.js` and all themes must be named `*.theme.css`
2016-04-09 20:32:43 +02:00
2017-01-16 20:13:18 +01:00
Better Discord App enhances the Discord desktop app with new features.
2015-08-26 09:58:47 +02:00
2017-04-30 05:24:11 +02:00
![ss](http://i.imgur.com/Gj6oD7z.png)
2015-09-02 11:39:35 +02:00
2015-12-05 02:29:32 +01:00
## Windows Universal Installer
2015-12-23 10:33:14 +01:00
* Download the latest installer from [releases](https://github.com/Jiiks/BetterDiscordApp/releases)
2015-12-05 02:29:32 +01:00
* Follow the instructions
* .NET 4.0 required https://www.microsoft.com/en-us/download/details.aspx?id=30653
2015-12-06 15:45:20 +01:00
* Windows Installer users asar.net https://github.com/Jiiks/asar.net
2015-09-02 11:33:30 +02:00
2015-08-30 16:24:45 +02:00
## 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.
2015-08-30 16:24:45 +02:00
* 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
2015-08-30 11:09:43 +02:00
## Features
**Emotes:**
2015-12-18 16:33:00 +01:00
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
2015-08-30 11:09:43 +02:00
**Quick Emote Menu:**
2015-12-18 16:32:08 +01:00
Quick Emote Menu adds a menu for quickly adding twitch emotes and your favorite emotes.
2015-08-30 11:09:43 +02:00
**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
2015-08-30 11:09:43 +02:00
**Public Servers:**
2017-04-30 05:24:11 +02:00
Public server listing provided by: [DiscordServers.com](https://www.discordservers.com/)
![ss](http://i.imgur.com/BVUZlu9.png)
2015-11-28 00:58:12 +01:00
2015-11-28 04:17:39 +01:00
**Custom CSS**
BetterDiscord supports custom CSS for styling Discord to your liking.
2015-12-18 16:32:08 +01:00
**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.
2015-12-18 16:32:08 +01:00
2015-11-28 00:58:12 +01:00
**Spoilers**
2015-11-28 01:13:40 +01:00
Add spoilers to your chat, simply add [!s] to your message.
2015-08-30 11:09:43 +02:00
**Save Logs Locally:**
Save chatlogs locally.(soon)
2016-03-04 06:35:23 +01:00
## Adding your server to public servers
2016-04-07 14:08:16 +02:00
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!
2015-08-30 11:09:43 +02:00
## 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
2015-10-27 21:18:00 +01:00
## Credits
* MacOS Installer by [Candunc](https://github.com/Candunc)
2015-11-28 15:41:43 +01:00
* Emote titles by [pendo324](https://github.com/pendo324)
2017-04-30 05:26:35 +02:00
* Majority of FFZ emote work by [Pohky](https://github.com/pohky) and [DeathStrikeV](https://github.com/DeathStrikeV)
* Majority of BTTV emote work by [EhsanKia](https://github.com/EhsanKia)
2015-12-18 16:32:08 +01:00
2015-08-30 11:09:43 +02:00
## License
The MIT License (MIT)
2017-04-30 05:27:03 +02:00
Copyright (c) 2015-present Jiiks | [Jiiks.net](https://jiiks.net)
2015-08-30 11:09:43 +02:00
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
2016-01-17 13:03:53 +01:00
THE SOFTWARE.