sbrl/RhinoReminds
sbrl/RhinoReminds
1
0
Fork 0
Code Issues 1 Pull requests Releases 1 Wiki Activity
An XMPP reminder bot written in C#. https://starbeamrainbowlabs.com/blog/article.php?article=posts/328-RhinoReminds.html
93 commits 1 branch 1 tag 150 KiB
C# 87.7%
Shell 12.3%
Find a file
Starbeamrainbowlabs 3b072f3e97
Bugfix: Don't say we're late if we aren't
2019-05-08 15:44:46 +01:00
lantern-build-engine@411df752dd Update lantern build engine 2019-03-28 19:30:05 +00:00
RhinoReminds Bugfix: Don't say we're late if we aren't 2019-05-08 15:44:46 +01:00
.gitignore Embed git commit hash in binary & output version number 2019-03-28 20:03:10 +00:00
.gitmodules Drop in lantern build engine ready for CI 2018-12-02 12:41:25 +00:00
build Remove debug call in CI script 2019-03-29 00:08:09 +00:00
LICENSE Initial commit 2018-11-10 18:47:03 +00:00
logrotate Add logrotate script 2019-03-14 22:31:02 +00:00
README.md Add link to associated blog post to README.md 2019-02-17 15:58:18 +00:00
rhinoreminds-rsyslog.conf Update systemd config to optionally use rsyslog 2019-02-04 13:54:21 +00:00
rhinoreminds.service Add --auto-exit CLI param 2019-03-28 23:04:52 +00:00
RhinoReminds.sln Just in case this turns into something :P 2018-11-09 22:45:59 +00:00
start_service.sh Add --auto-exit CLI param 2019-03-28 23:04:52 +00:00

README.md

RhinoReminds

An XMPP reminder bot written in C#.

I've blogged about this project here: RhinoReminds: An XMPP reminder bot for my convenience

Getting Started

Downloading Prebuilt Binaries

Prebuilt binaries for the latest release are available on the releases page.

Building from Source

  1. Install the NuGet dependencies:
nuget restore
  1. Build the solution:
msbuild
  1. Specify the environment variables
Variable Meaning
XMPP_JID The JID to connect with
XMPP_PASSWORD The password to use when connecting
  1. Execute the program
cd RhinoReminds/bin/{Debug|Release}
# Linux:
mono [--debug] RhinoReminds.exe [--help]
# Windows:
RhinoReminds.exe [--help]

Setting up RhinoReminds as a system service

Some helpful template files are located in this repository to aid in setting RhinoReminds up as a system service.

  • start_service.sh Contains a script that reads in CLI variables from a file, sets up a PID file directory with the appropriate permissions, and then executes RhinoReminds as an unprivileged user.
  • rhinoreminds.service Contains a systemd service file compatible with start_service.sh
  • rhinoreminds-rsyslog.conf Contains an Rsyslog definition file compatible with the systemd service file defined above. When put in /etc/rsyslog.d (don't forget to restart the rsyslog service!), it will write and auto-rotate log files of the standard output and standard error of the main RhinoReminds process to a subfolder fo /var/log automatically.

Usage

The bot operates on natural language instructions. It picks what to do from the first word in the sentence, but the rest is parsed via AI.

Setting a reminder

Remind me to feed the cat at 6pm
Remind me about CrossCode's release on 20th September 2018
Remind me to water the greenhouse tomorrow at 4:03pm
Remind me in 1 hour to check the oven

Listing reminders

List all reminders
Show all
List all

Deleting Reminders

Delete reminder 43
Delete #22, #23, and #45
Delete number eight
Delete reminders 2, 3, 4, and 7

Contributing

Contributions are welcome! Bug reports can be opened against this repository if you have an account. Otherwise, send them to bugs at starbeamrainbowlabs dot com.

Pull requests and patches are welcome too. Here's a great tutorial on creating patches. If there's any interest, I'll move this repository to my account on gitlab.com if that makes things easier.

License

RhinoReminds is licensed under the Mozilla Public License 2.0 (MPL-2.0 for short) - the full text of which can be found in the LICENSE file in this repository. tl;drLegal have a great summary if you don't want to spend all day read dry legalese :P

Useful Links