Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aetheryx/remindme
A Discord bot that allows you to create and manage reminders
https://github.com/aetheryx/remindme
hacktoberfest
Last synced: 7 days ago
JSON representation
A Discord bot that allows you to create and manage reminders
- Host: GitHub
- URL: https://github.com/aetheryx/remindme
- Owner: aetheryx
- License: mit
- Created: 2017-04-02T16:25:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:22:45.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T19:55:47.097Z (7 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage: https://remindmebot.xyz
- Size: 718 KB
- Stars: 38
- Watchers: 4
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# RemindMeBot
[](https://travis-ci.org/aetheryx/remindme)
[](https://www.codacy.com/app/aetheryx/remindme?utm_source=github.com&utm_medium=referral&utm_content=aetheryx/remindme&utm_campaign=Badge_Grade)
[](https://github.com/aetheryx/remindme/releases)
[](https://github.com/aetheryx/remindme/blob/master/LICENSE)
[](https://discord.gg/Yphr6WG)
[](https://github.com/aetheryx/remindme/issues)
[](https://github.com/aetheryx/remindme/pulls)
# Notice
This project has been discontinued alongside the RemindMe Discord bot. You may use this repo to run your own version of the discord bot (at your own risk and without help).
Please contact me [here](https://discord.com/channels/299979631715549184/300952410334167043) to purchase RemindMeBot. Current going rate is `USD$5.00`.
## Getting started
Make sure you have `git` and `node` (latest is preferred) installed on your machine. Side note - if your version of Node is below 7.6, you need to run with a `--harmony` flag.
Clone the repo, go into it, npm install:
```
git clone https://github.com/aetheryx/remindme.git folderName
cd folderName
npm install
```
Fill in your config file (`src/config-example.json`) with all of the keys and settings:
```js
{
"defaultPrefix": "", // Default prefix for the bot
"embedColor": 16777215, // The embed color for all of the embeds that the bot returns, in base10
"ownerID": "", // ID of the owner of the bot. Gives you access to eval / bash commands
"tick": 3000, // The tick of the interval at which the bot checks for reminders that are due. Don't put this too low or it'll start sending double reminders
"webserver": {
"enabled": true, // Whether the webserver should run or not
"port": 8080 // The port at which the webserverw would run
},
"keys": {
"token": "", // Your bot token
"dbl": "", // discord.bots.org token, leave empty if you don't have one
"botspw": "", // bots.discord.pw token, leave empty if you don't have one
"novo": "" // novo token, leave empty if you don't have one
},
"disabledEvents": [ // Disabled websocket events. Removing items from this list is probably harmless, but adding some can fuck up things. Be careful.
"CHANNEL_PINS_UPDATE",
"USER_NOTE_UPDATE",
"VOICE_STATE_UPDATE",
"TYPING_START",
"VOICE_SERVER_UPDATE",
"RELATIONSHIP_ADD",
"RELATIONSHIP_REMOVE",
"GUILD_BAN_ADD",
"GUILD_BAN_REMOVE",
"MESSAGE_UPDATE",
"MESSAGE_DELETE_BULK",
"MESSAGE_REACTION_ADD",
"MESSAGE_REACTION_REMOVE",
"MESSAGE_REACTION_REMOVE_ALL"
]
}
```
At this point, all you have to do is start the bot with `sudo npm start` (or `sudo pm2 start remindmebot.js`).
## License
This project is licensed under the MIT License - see the [LICENSE file](https://github.com/Aetheryx/remindme/blob/master/LICENSE) for more info. Basically, you can do whatever the fuck you like as long as you mention/credit me. Oh, and you can't sue me if it blows up.