BetterDiscordApp-v2/README.md

82 lines
3.2 KiB
Markdown
Raw Normal View History

2015-08-25 06:08:22 +02:00
# BetterDiscordApp
Better Discord App enhances Discord desktop app with new features.
2015-08-26 09:58:47 +02:00
2015-08-30 11:09:43 +02:00
![ss](http://puu.sh/jTEBB.png)
2015-09-02 11:39:35 +02:00
2015-09-02 11:40:07 +02:00
## If Discord has updated and the installer hasn't, try replacing the installer index.js with the latest one here: [index.js](https://github.com/Jiiks/BetterDiscordApp/blob/master/NodeInstaller/index.js)
2015-09-02 11:39:35 +02:00
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
* Hopefully it works.
* Installer requires [node](https://nodejs.org/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
2015-08-30 11:09:43 +02:00
## Features
**Emotes:**
BetterDiscord adds all [Twitch.tv](http://twitch.tv), some [FrankerFaceZ](http://frankerfacez.com)(~240 suggested emotes) and [BetterTTV](http://betterttv.net) emotes to Discord.
2015-08-30 11:09:43 +02:00
**Quick Emote Menu:**
Quick Emote Menu adds a menu for quickly adding twitch 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
2015-08-30 11:09:43 +02:00
**Public Servers:**
A menu for displaying public servers.(soon) [Serverlist](https://github.com/Jiiks/BetterDiscordApp/blob/master/serverlist.json)
**Save Logs Locally:**
Save chatlogs locally.(soon)
## Adding you server to public servers
Edit the [Serverlist](https://github.com/Jiiks/BetterDiscordApp/blob/master/serverlist.json) and submit a pull request.
## 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-08-30 11:09:43 +02:00
## License
The MIT License (MIT)
Copyright (c) <year> <copyright holders>
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.