RhinoReminds

An XMPP reminder bot written in C#.

Getting Started

Downloading Prebuilt Binaries

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

Building from Source

Install the NuGet dependencies:

nuget restore

Build the solution:

msbuild

Specify the environment variables

Variable	Meaning
`XMPP_JID`	The JID to connect with
`XMPP_PASSWORD`	The password to use when connecting

Execute the program

cd RhinoReminds/bin/{Debug|Release}
# Linux:
mono [--debug] RhinoReminds.exe [--help]
# Windows:
RhinoReminds.exe [--help]

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

2.4 KiB Raw Blame History