The remindme bot responds to you after a period of time to remind you about something (e.g. if someone in a post says theyre going to do something after a week and you want to be there for that)
Theres a version of this bot being hosted currently in programming.dev. You can still self host your own if you want to do things like customize it a bit more for your community but its not required. All remindme bots can work simultaneously since its triggered off of mentions as opposed to a command.
To use the bot you need to mention it and put a length of time somewhere in the message.
Example: @RemindMe@programming.dev 5 years
Example: @RemindMe@programming.dev remind me about this in 2 minutes
In order to function in your community you need to request that it be added to the whitelist in the issues tab in this repository (only mods + admins of the community can request)
You need node.js downloaded to run this
- Clone the repository (
git clone https://github.com/PangoraWeb/remindme-bot.gitin a terminal) - Create an account in the instance you want the bot to have as its home (just make a regular user)
- Create a file called .env in the bot folder and give it values in this format with the data in the quotes (dont add the slashes or the part after the slashes)
LEMMY_INSTANCE="" // The instance the bot account is in
LEMMY_USERNAME="" // The bot username
LEMMY_PASSWORD="" // The bot password
- Change the data in config.yaml based on what you want set
- Open a terminal in the bot folder and run
npm installto install dependendies and thennode main.jsto run the bot (whenever you want to start the bot again you can just do ctrl+c to interrupt the process and node main.js to start the bot)
I recommend installing something like forever.js for running it in the background on your server
If you run into issues feel free to dm me on Matrix here
If you want to contribute to add some sort of feature feel free to make a pull request with it added
This repository has some info on how to do development in a repository and make a pull request
Icon base by Delapouite under CC BY 3.0 with modifications to add a gradient