PulseMonitor

This is the chatbot component of Halflife. It is currently running on the Halflife bot account.

To run PulseMonitor, you need to have the packages enumerated in requirements.txt installed on your computer.

Once that is done, copy the privileged user file to a directory in your home directory named .pulsemonitor.

mkdir ~/.pulsemonitor
cp room_*_privileged_users ~/.pulsemonitor/

You might want to add yourself as a privileged user. Load the file with pickle, change one of the user ID:s to your own, and save back and overwrite the pickle file.

To enable Redunda, paste your redunda key in a file called redunda_key.txt at ~/.pulsemonitor/.

Then run the startup.py file.

python3 ./Source/startup.py

It will ask you for the account email and password for running the bot. To avoid manual interaction, you can define these in the environment variables PulseEmail and PulsePass, respectively. The account (obviously) needs to have the necessary privileges to participate in the chat room.

The bot has commands to add, review, and remove notifications by regex. Here's a quick example.

you> @halflife notifications
Halflife> | User    | Regex     |
Halflife> |---------+-----------|
Halflife> | you     | [23]/3    |
Halflife> | someone | (9|10)/10 |
you> @halflife notify .*
Halflife> @you Added notification for you for `.*`
you> @halflife notifications
Halflife> | User    | Regex     |
Halflife> |---------+-----------|
Halflife> | you     | [23]/3    |
Halflife> | someone | (9|10)/10 |
Halflife> | you     | .*        |
you> @halflife my notifications
Halflife> | you       |
Halflife> | Regex     |
Halflife> |-----------|
Halflife> | [23]/3    |
Halflife> | .*        |    
you> @halflife unnotify .
Halflife> @you Removed notifications `.*`

you> @halflife addtag threshold [23]/3
Halflife> @you added [tag:threshold] for regex [23]/3
you> @halflife removetag nonesvch
Halflife> @you No tag found with regex nonesvch
you> @halflife listtags
Halflife> | Name        | Regex      | Added by    |
Halflife> |-------------+------------+-------------|
Halflife> | threshold   | [23]/3     | you         |
Halflife> | threshold   | (9|10)/10  | someone     |

Notice that the argument to unnotify and removetag is a regex which can match more than one active pattern. You can only add and remove your own notifications.

Because the Stack Exchange chat interface will do odd things to some special characters, you can optionally embed the regex for notify and addtag in `backticks`.

The notification mechanism simply pings @you when a matching line is printed to the chat transcript. Tagging adds a tag to the transcript which can be searched for with an expression like tagged/tagname