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
34 commits 1 branch 1 tag 150 KiB
C# 87.7%
Shell 12.3%
Find a file
Starbeamrainbowlabs dd96754126
Fill out more of the README
2018-12-06 00:20:58 +00:00
lantern-build-engine@37e1d0ea74 Drop in lantern build engine ready for CI 2018-12-02 12:41:25 +00:00
RhinoReminds Update NuGet packages & fix avatar uploading, but I think we need to make it use vcard somehow to get it to display. 2018-12-05 23:18:38 +00:00
.gitignore Just in case this turns into something :P 2018-11-09 22:45:59 +00:00
.gitmodules Drop in lantern build engine ready for CI 2018-12-02 12:41:25 +00:00
build Drop in lantern build engine ready for CI 2018-12-02 12:41:25 +00:00
LICENSE Initial commit 2018-11-10 18:47:03 +00:00
README.md Fill out more of the README 2018-12-06 00:20:58 +00:00
rhinoreminds.service Finish setting up service file & script 2018-11-11 11:18:58 +00:00
RhinoReminds.sln Just in case this turns into something :P 2018-11-09 22:45:59 +00:00
start_service.sh Make start_service.sh executable 2018-11-30 23:18:07 +00:00

README.md

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

  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]

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