Notifications

The bot has a feature that allows people to be notified when something happens. It supports a bunch of different types of events, and can send notifications through different medias too.

Notification Types

All the currently supported notification types are listed below. The "Name" is what you use in the addnotification command to specify which notification type it is you want to add.

1. New order added* - Name: orders
2. New aid request/offer added - Name: aid
3. New NAP (non aggression pact) added - Name: nap
4. New note added* - Name: note
5. New build added* - Name: build
6. New event added* - Name: event added
7. Wave date set - Name: wave added
8. New target added* - Name: target
9. Army returns - Name: army
10. A user checks in - Name: checkin
11. Someone you waited for has logged in - Name: wait
12. An alarm you set went off - Name: alarm
13. A scheduled event is now happening* - Name: event
14. A scheduled wave is now happening - Name: wave
15. News were pasted that contained a hit on your province - Name: incoming attack
16. Dragon begun ravaging your kingdom - Name: dragon arrived
17. Dragon sent to enemy kingdom - Name: dragon sent
18. Dragon affecting your kingdom is slain - Name: dragon slain
19. War declared - Name: war declared
20. War ended - Name: war ended
21. Self Spell Expiring - Name: selfspell expired
22. Resources needed - Name: resources needed

*: These notification types are controlled by bindings, meaning if, for example, an order is bound to Human Sages only, and you're not a Human Sage, you won't get a notification when that order is added, since it doesn't apply to you.

Notification Delivery Methods

All the different ways the bot can deliver notifications are listed below. Note that you can have all of them active at the same time if you want. The "Name" is what you use in the addnotification command to specify which notification method it is you want to use for the notification type you're adding.

1. Send a pm on IRC - Name: pm
2. Send an email - Name: email
3. Send an sms - Name: sms

If you're going to be using anything other than pm, make sure you've actually set the necessary information first and that the bot administrator has set up the necessary facilities in the bot (see below for how to set things up correctly). You set information by using the contacts command.

Example

I want the bot to notice me via email and pm when my army comes back home and when it's time for a wave. What I do is: * !contacts add email my-email-address@gmail.com

• !addnotification army pm

• !addnotification army email

• !addnotification wave pm

• !addnotification wave email

Assuming the bot administrator has setup the email account for the bot, I'll be notified of those 2 event types.

SMS Example

I want the bot to text me on my phone when my army returns and when war is declared. My phone number is 206-555-1234 and my phone provider is ATT. I lookup their email to sms gateway info HERE and do the following:

Steps:

• !contacts add sms 2065551234@txt.att.net

• !confirmsms true

• !addnotification army sms

• !addnotification war declared sms

Now when any of these events are detected by the bot, it will SMS me. This assumes that the below is done by the Bot Owner/Administrator

Required Setup

Email/SMS

These 2 both use email, so what needs to be setup is an smtp server that the bot can use. The easiest way to get this working is to create a gmail account for the bot to use and just use the defaults in the lucidbot.properties file (uncomment them first, meaning remove the #) and just insert whatever email address and password you set up. Make sure to uncomment ALL of the email related properties before restarting the bot.