Code Monkey home page Code Monkey logo

discord-reminder-bot-1's Introduction

discord-reminder-bot

build Docker pulls

This is a simple Discord bot for managing reminders.

If you react to a message with ⏰ (:alarm_clock:) or ⏲ (:timer:), a message will be sent to you through direct message informing you that you will be reminded about the message you reacted to in 8 hours.

You may also use the following syntax:

!RemindMe <DURATION> [NOTE]

Where:

  • <DURATION> must be use one of the following formats: 30m, 6h30m, 48h
  • [NOTE] is an optional note to attach to the reminder with less than 240 characters

Note that !RemindMe can be replaced by directly pinging the bot (e.g. @reminder-bot 2h30m meeting about cookies)

Once a reminder is created using one of the aforementioned methods, a direct message is sent to the user with several options to manage the newly created reminder. This is internally referred to as the notification message:

new reminder

Once a reminder is due, a direct message is sent to the user with a link to the message that triggered the creation of the reminder.

Here is an example of a message with and without a note:

reminder

Furthermore, once a reminder has been deleted or has been processed, its notification message is automatically crossed to make the differentiation between active and inactive reminders:

deleted reminder

Usage

Environment variable Description Required Default
DISCORD_BOT_TOKEN Discord bot token yes ""
COMMAND_PREFIX Character prepending all bot commands no !

Getting started

Discord

  1. Create an application
  2. Add a bot in your application
  3. Save the bot's token and set it as the DISCORD_BOT_TOKEN environment variable
  4. Go to https://discordapp.com/oauth2/authorize?client_id=<YOUR_BOT_CLIENT_ID>&scope=bot&permissions=2112
  5. Add the bot to a server of your choice

Docker

Pulling from Docker Hub

docker pull twinproduction/discord-reminder-bot

Building image locally

Building the Docker image is done as following:

docker build . -t twinproduction/discord-reminder-bot

You can then run the container with the following command:

docker run -e DISCORD_BOT_TOKEN=secret --name discord-reminder-bot twinproduction/discord-reminder-bot

discord-reminder-bot-1's People

Contributors

twin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.