Coder Social home page Coder Social logo

chgv99 / scheduler Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 6.62 MB

A Discord bot that allows you to create reminders and alarms inside your own server.

JavaScript 100.00%
discord discord-bot discord-js js javascript moment-timezone reminder reminder-bot

scheduler's Introduction


Scheduler

A Discord bot that allows you to create reminders and alarms inside your own server.

FeaturesHelpCommands

Add to server

⚠️ The bot is currently WIP. This means that the database is subject to change at any moment, so any stored reminder, alarm or server configuration has a high probability of being erased. The link won't be available in this stage of the development.

Features

You and your friends will be able to set useful reminders and alarms inside your Discord server for everyone to see.

The current version offers:
  1. Creating a reminder on the specified date and time with a title (and a description).
  2. Setting up a broadcast channel
  3. Specify the output channel for a specific reminder
  4. Modify the default prefix so it doesn't get in conflict with your other bots
  5. See a list of the current reminders
Future features:
  1. Alarms (recurrent reminders)
  2. Delete reminders and alarms
  3. More settings for reminders (e.g. to specify the amount of time left rather than the date and time, to allow more date formats like YYYY-MM-DD)
  4. Server configuration for server roles with permissions (now available for server creator only)
  5. Multiple broadcast channels
  6. Command for setting own timezone (for users with a different timezone from the server)

Help

🛠️ Set up

To set up Scheduler, first you need to set a time zone for the server using >>chtimezone YourTimeZone. It is set to UTC+0 by default. For the moment, you only can set a time zone by using its full name (e.g. Atlantic/Canary, Europe/Madrid, etc...).

Check out this list of time zones if you don't know yours. You can always see the current time zone of the server using >>timezone and the time using >>time.

⚠️ Be careful, as having the expected time on your server does not mean that you got the correct time zone. Not all time zones accomplish DST, so having an incorrect time zone might cause an unexpected time offset on winter and summer.

Command prefix

The default command prefix is >>.

You can change it by using >>chprefix

📢 Broadcast channel

Every time a reminder is sent, it'll be through the broadcast channel. By default, the broadcast channel is set to 'general'. This can be modified using

>>chchannel newchannel

📆 Reminders

A reminder is used when you need to remember something once on a concrete date and time. In the current version, you can create a reminder by specifying time, date, and a title.

>>reminder dd-mm-yyyy hh-mm "title"

Also, you can add a description, so you or your friends have some context on what you wanted to remind.

>>reminder dd-mm-yyyy hh-mm "title" "description"

These reminders will be sent by default through general. You can change it to whichever you want. If you want to send a reminder through a different channel from the default you can specify it too. Just like this:

>>reminder dd-mm-yyyy hh-mm "title" "description" channel

⚠️ Time must be specified using ISO 8601 format (24h).

⚠️ The title and description of a reminder have to be enclosed in double quotes.

Commands

Commands are used by typing the bot prefix (>> by default).

  • Parameters must be separated by a space.
  • Parameters that need to be surrounded by double quotes are indicated in the table.
  • Parameters surrounded by square brackets are optional.
  • Commands with a ⚠️ sign will be changed in the near future.
Command Parameters
chchannel:warning: newBroadcastChannel
chprefix:warning: newPrefix
chtimezone:warning: "timeZone"
reminder:warning: date time "title" ["description"]
time
timeZone:warning:

scheduler's People

Contributors

chgv99 avatar

Stargazers

 avatar

Watchers

 avatar

scheduler's Issues

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.