A discord bot made primarily with Node.js and Eris, with plans to constantly add commands and grow to new platforms.
Getting Started
These instructions will get you started using the bot and making sure it is set up well on your server. If you are having issues with the bot, be sure to check over these steps again or join the support server.
Prerequisites
To add the bot to your server, you need to meet at least one of the following requirements:
- Be the owner of the server
- Have "Manage Server" permission on the server
For the bot to work properly, it will need all of the permissions seen in the below image.
You can click here for an invite that has these permissions pre-selected for you.
Using the bot
The prefix to use the bot is pls
Example: pls ping. No, not !
, ?
, or -
like most bots. Prefixes don't have to be a common symbol!
To get the full command list, you can do pls help
.
All commands use the same prefix, and are updated constantly!
If you need any more help with anything, join this server!
Dependencies
Dank Memer requires the following dependencies (in no order):
- Node and NPM
- RethinkDB
- Gyp build tool (gyp)
- Libtool
- Freetype & it's headers (libfreetype6-dev)
- Cairo & it's headers (libcairo2-dev)
Installing dependencies
As root:
apt-get install \
libfreetype6-dev \
libcairo2-dev \
libsodium-dev \
libtool
Building
After installing the dependencies...
npm install
Example config
Must be placed in the "src
" directory.
Refer to example-config.json
.
Running
Make sure that RethinkDB is listening on it's default port 28015
.
Change directory to "src
" then:
node memer.js
Built With
- JavaScript - The language
- Node - The runtime
- Eris - The Library
- Eris-Sharder - The custom sharder
- RethinkDB - The database
Contributing
Please read CONTRIBUTING.md for details on our code style, and how not to trigger us.
Authors
- Melmsie - Initial work and owner - GitHub Profile
- Aetheryx - I like trains - GitHub Profile
- CyberRonin - Melmsie is my lover Github Profile
- DaJuukes - Haha yes - GitHub Profile
- Kromatic - Mayonnaise is an instrument Github Profile
See also the list of contributors who participated in this project.
License
This project is licensed under the GNU AGPLv3 License - see the LICENSE.md file for exact details, but basically if you take my work, give me credit. You also need to have your application that uses my code under the same license.
Acknowledgments
- Stupid Cat - Original author of trigger.js - GitHub Profile
- Samoxive - Help with debugging stupid node errors and learning js - GitHub Profile
- Kodehawa - Emotional support when dealing with stupid issues and users - GitHub Profile
- Sporks - Went through 800 meme templates to give everyone a better experience <3