Skip to content

atasfun/remindme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

RemindMe

Reminder bot (@remindme@mstdn.social) for Fediverse, e.g., Mastodon, Lemmy, etc.

Features

  • Allows timed reminders to be set by Fediverse users by tagging the bot in a message, e.g., @remindme@mstdn.social 1 day
  • The bot will post an acknowledgement message when registering the reminder, and posts another message after the desired duration
  • The bot supports durations in minutes, hours, days, weeks, months, and years
  • Currently, the bot posts messages publicly (the acknowledgment and reminder messages). If a private message is desired, dm should be added to the message, e.g., @remindme@mstdn.social 1 day dm
  • Uses mastodon-api-client as the Mastodon API to read/write to the Fediverse

Usage

  • Set a reminder: @remindme@mstdn.social [duration], e.g., 1 day, 1 month etc
  • Set a reminder privately: @remindme@mstdn.social [duration] dm, e.g., 1 day dm, 1 month dm etc

Development

  • The bot is written in PHP, though the author is not well-versed in PHP, so the code has lots of room for improvement. The bot was written as a fun project to contribute to the Fediverse.
  • add_reminders.php and send_reminders.php are run on a cron job every minute to add and send reminders respectively.

Bugs, issues, feature requests, etc

Please open a GitHub issue, contact @atasfun@mastodon.gamedev.place, or send an email

Improving the bot

If you would like to improve the bot's features, please feel free to submit a GitHub pull request

Author

Allison Liemhetcharat (@allisonliem@mastodon.online)

Releases

No releases published

Packages

No packages published

Languages