UNPKG

4.81 kBMarkdownView Raw
1![banner](../gh-pages/img/banner.png)
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="#backers" alt="Backers on Open Collective"><img src="https://opencollective.com/miscord/backers/badge.svg?style=for-the-badge" /></a>
9 <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/miscord/sponsors/badge.svg?style=for-the-badge" /></a>
10 <br />
11 <a href="https://discord.gg/DkmTvVz"><img src="https://discordapp.com/api/guilds/431471556540104724/embed.png" alt="Discord"></a>
12</p>
13
14> Built on [libfb](https://github.com/ChatPlug/libfb-js) and [discord.js](https://discord.js.org)
15
16**[Website](https://miscord.net/)** &nbsp;
17**[Donate](https://paypal.me/Bjornskjald)** &nbsp;
18**[FAQ](../../wiki/faq)** &nbsp;
19**[Config Generator](https://miscord.net/config-generator.html)** &nbsp;
20
21# :memo: Wiki
22
23**Miscord has its own wiki [here](../../wiki), any information is most likely to be there**
24
25# :wrench: Setup
26
27## Installation
28- [NPM install (Linux)](../../wiki/install#npm)
29- [Homebrew install (macOS)](../../wiki/install#homebrew)
30- [Binary packages (Windows)](../../releases/latest)
31- [Docker install (headless servers)](../../wiki/install#docker)
32
33## Configuration
34
35**Follow a guide [here](../../wiki/Creating-a-Discord-bot) to get the Discord token**
36
37**[Config Generator](https://miscord.net/config-generator.html)**
38**[Example config](config.example.json)**
39**[All config properties (explained)](../../wiki/configuration)**
40**Next step: [connections setup](../../wiki/Connections.yml)**
41
42# :heart: Contributors
43
44This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
45<a href="https://github.com/miscord/miscord/graphs/contributors"><img src="https://opencollective.com/miscord/contributors.svg?width=890&button=false" /></a>
46
47
48# :dollar: Backers
49
50Thank you to all our backers! šŸ™ [[Become a backer](https://opencollective.com/miscord#backer)]
51
52<a href="https://opencollective.com/miscord#backers" target="_blank"><img src="https://opencollective.com/miscord/backers.svg?width=890"></a>
53
54
55# :moneybag: Sponsors
56
57Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/miscord#sponsor)]
58
59<a href="https://opencollective.com/miscord/sponsor/0/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/0/avatar.svg"></a>
60<a href="https://opencollective.com/miscord/sponsor/1/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/1/avatar.svg"></a>
61<a href="https://opencollective.com/miscord/sponsor/2/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/2/avatar.svg"></a>
62<a href="https://opencollective.com/miscord/sponsor/3/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/3/avatar.svg"></a>
63<a href="https://opencollective.com/miscord/sponsor/4/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/4/avatar.svg"></a>
64<a href="https://opencollective.com/miscord/sponsor/5/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/5/avatar.svg"></a>
65<a href="https://opencollective.com/miscord/sponsor/6/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/6/avatar.svg"></a>
66<a href="https://opencollective.com/miscord/sponsor/7/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/7/avatar.svg"></a>
67<a href="https://opencollective.com/miscord/sponsor/8/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/8/avatar.svg"></a>
68<a href="https://opencollective.com/miscord/sponsor/9/website" target="_blank"><img src="https://opencollective.com/miscord/sponsor/9/avatar.svg"></a>
69
70# :scroll: License
71This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
72
73
74# :warning: Disclaimer
75
76We 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.
77All 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.
78Facebook and the Facebook logo are trademarks or registered trademarks of Facebook, Inc., used under license agreement.