ZofBot

Commands

Quick Skip

• set
• show
• del

• set

  This command instructs the bot to set an alarm. Takes two aruguments, the time to elapse until the alarm will ring and the message to display when alarm rings. The first argument can be postfixed with letters 'm' or 'h' to indicate that the number is the number of 'minutes' or 'hours' respectively.

  Example

  [06:52:54] <Zoffix> _ZofBot4, alarm set 4 test1
  [06:52:55] <_ZofBot4> Zoffix, Started alarm, it will ring in 4 second(s)
  [06:52:58] <_ZofBot4> Zoffix, Alarm rang: test1
  [06:53:04] <Zoffix> _ZofBot4, alarm set 1m test2
  [06:53:05] <_ZofBot4> Zoffix, Started alarm, it will ring in 1 minute(s)
  [06:54:05] <_ZofBot4> Zoffix, Alarm rang: test2
  [06:55:07] <Zoffix> _ZofBot4, alarm set 1h go back to bed
  [06:55:08] <_ZofBot4> Zoffix, Started alarm, it will ring in 1 hour(s)

  Back to top

• show

  Command Aliases

  • list

  This command will list all of the active alarms you have currently set. The output will contain alarm number (which you could use for remove command) as well as the time remaining until alarm will go off and the alarm message (supplied with the set command). Note that the output of the command is returned via /notice mode to prevent spamming.

  Example

  <Zoffix> _ZofBot4, alarm set 5m test2
  <_ZofBot4> Zoffix, Started alarm, it will ring in 5 minute(s)
  <Zoffix> _ZofBot4, alarm set 50 test4
  <_ZofBot4> Zoffix, Started alarm, it will ring in 50 second(s)
  <Zoffix> _ZofBot4, alarm list
  -_ZofBot4- [ #0 - 45 seconds until alarm 'test4'] 
             [ #1 - 4 minutes and 49 seconds until alarm 'test2']
             [ #2 - 4 minutes and 32 seconds until alarm 'foo']

  Back to top

• del

  Command Aliases

  • rem
  • delete
  • remove

  Takes an alarm number as an argument and cancels that alarm. Alarm number is gotten from the output of the show command.

  Example

  <Zoffix> _ZofBot4, alarm set 10m test
  <_ZofBot4> Zoffix, Started alarm, it will ring in 10 minute(s)
  <Zoffix> _ZofBot4, alarm show
  -_ZofBot4- [ #0 - 9 minutes and 55 seconds until 
             alarm 'test']
  <Zoffix> _ZofBot4, alarm del 0
  -_ZofBot4- Removed alarm 'test' (9 minutes
             and 50 seconds was remaining)

  Back to top

TODO

This is what is planned to be implemented, feel free to help out.

• Support for setting time in form of "5h 35m" which would set an alarm for 5 hours and 35 minutes. Currently you'd have to calculate what 5 hours is in minutes and add 35 to that number.
• Support for alarms without "alarm message" (see set command). Sometimes you don't feel like typing it and support for that is simple to do, I am just being lazy.

Back to top