Skip to content

Latest commit

 

History

History
88 lines (68 loc) · 3.61 KB

README.md

File metadata and controls

88 lines (68 loc) · 3.61 KB
Raw

pls read:

UPDATE 5/8/22: FINISHED MIGRATING HAVE FUN WITH THE BOT :D
I'm amazed at how many people have been using this bot. It's so crazy that this bot has gotten so big. I wrote this code about a year ago and it wasn't built to scale to what it is now. I've exceeded the limitations of my database design. I'll have to redo my database and transfer data. It'll take a while because I'm currently on vacation. When I come back, it'll be better than ever :D If you'd like to contribute, the bot is open source so feel free to put some changes in :)

🔥 Calcifer 🔥

Inspired by my Code With Friends submission, Calcifer is a Discord Study Bot that allows users to start Pomodoro Timers. Click this link to add it to your server

BUGS

Check out the Issues page for recurring bugs. If you are not getting notified of the end of your pomodoro session:

  1. I pushed a new version of the bot
  2. The Heroku Hosting service I use restarted the server which ends all processes
  3. There is a memory issue

Case 3 is rare. You can check for case 1 and 2 by running the command c: productivity. If you were attributed points, then the error happens due to case 1 and 2

Latest Feature:

Start a group pomodoro!

c: group [time]

Get Started With Group Pomodoros:

  1. Create a separate text channel whose channel name contains the word 'group'
  2. Create a separate voice channel whose channel name contains the word 'group'
  3. Connect to the voice channel
  4. Type c: group [time] in the text channel

Rules for starting a Group Pomodoro

  1. Must have a separate text channel that contains the word 'group'
  2. Must have a voice channel that contains the word 'group'
  3. Must be connected to the voice channel that contains the word 'group'
  4. A Group Pomodoro must not already be in progress

All Commands:

c: pomodoro
c: pomodoro [time]
c: pom
c: pom pom
c: pom [time] break [time]
c: group [time]
c: cancel
c: productivity
c: help
c: cook

Current Features

🍅 Pomodoro

Start a Pomodoro Timer
c: pomodoro start a 25 minute timer (default timer)
c: pomodoro [time] start a [time] minute timer || time must be within 10 - 120
c: pom start a 25 minute timerbr /> c: pom [time] start an x minute timer
c: pom pom
start a 50 minutes timer c: pom [time] break [time]
start an x minute timer and y minute break c: group [time]
start a group timer with friends! c: cancel cancel your work timer or break timer

📊 Productivity

View your Stats! The database is finally here. Start some pomodoros and you'll accumulate working hours. To see how much you've been working run the productivity command.

c: productivity will return total amount of time studied

ℹ️ Help

Need some help? I've added a list of commands to get you started. I've also updated the bot's status. It now displays the help command

c: help will return a list of helpful commands.

Future

In the future, I will be implementing a function to check how much time is left on the timer. If you have any requests, feel free to add them in Issues

I'm currently testing the bot to see how much it would cost to make it available to the general public. I'm only in college, and I don't make money LOL. If you would like to sponsor server fees, Let me Know! :D