| 1 | 
|
| 2 |
|
| 3 | <p align="center">
|
| 4 | <a href="https://npmjs.org/package/miscord"><img src="https://img.shields.io/npm/dt/miscord.svg?style=for-the-badge" alt="NPM downloads"></a>
|
| 5 | <a href="https://npmjs.org/package/miscord"><img src="https://img.shields.io/npm/v/miscord.svg?style=for-the-badge" alt="Version"></a>
|
| 6 | <a href="https://npmjs.org/package/miscord"><img src="https://img.shields.io/github/stars/miscord/miscord.svg?style=for-the-badge" alt="Stars"></a>
|
| 7 | <br />
|
| 8 | <a href="https://discord.gg/DkmTvVz"><img src="https://discordapp.com/api/guilds/431471556540104724/embed.png" alt="Discord"></a>
|
| 9 | </p>
|
| 10 |
|
| 11 | > Built on [libfb](https://github.com/ChatPlug/libfb-js) and [discord.js](https://discord.js.org)
|
| 12 |
|
| 13 | **[Website](https://miscord.net/)**
|
| 14 | **[Donate](https://paypal.me/Bjornskjald)**
|
| 15 | **[FAQ](../../wiki/faq)**
|
| 16 | **[Config Generator](https://miscord.net/config-generator.html)**
|
| 17 |
|
| 18 | # :memo: Wiki
|
| 19 |
|
| 20 | **Miscord has its own wiki [here](../../wiki), any information is most likely to be there**
|
| 21 |
|
| 22 | # :wrench: Setup
|
| 23 |
|
| 24 | ## Installation
|
| 25 | - [NPM install (Linux)](../../wiki/install#npm)
|
| 26 | - [Homebrew install (macOS)](../../wiki/install#homebrew)
|
| 27 | - [Binary packages (Windows)](../../releases/latest)
|
| 28 | - [Docker install (headless servers)](../../wiki/install#docker)
|
| 29 |
|
| 30 | ## Configuration
|
| 31 |
|
| 32 | **Follow a guide [here](../../wiki/Creating-a-Discord-bot) to get the Discord token**
|
| 33 |
|
| 34 | **[Config Generator](https://miscord.net/config-generator.html)**
|
| 35 | **[Example config](config.example.json)**
|
| 36 | **[All config properties (explained)](../../wiki/configuration)**
|
| 37 | **Next step: [connections setup](../../wiki/Connections.yml)**
|
| 38 |
|
| 39 | # :warning: Disclaimer
|
| 40 |
|
| 41 | We do not guarantee that this bridge will work correctly. We are not responsible for getting banned on any serivices integrated with Miscord. Use at your own discretion.
|
| 42 | All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
|
| 43 | Facebook and the Facebook logo are trademarks or registered trademarks of Facebook, Inc., used under license agreement.
|
| 44 |
|
| 45 | # :scroll: License
|
| 46 | This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
|