hgw/mercury
1
Fork 0
Code Issues Pull Requests Packages Wiki Activity
cd33d16f4d
mercury/README.md
hgw cd33d16f4d add alias functionality
2023-10-02 02:11:25 +00:00

1.6 KiB
Raw Blame History

Mercury

Simple & Customisable RSS Client for IRC.

This bot is not completed, expect bugs/crashes/errors. Use in production is disadvised at this stage.

m!feed Example

Commands

  • m!feed [USER/FEED/ALIAS] [ENTRIES] - Return the last x amount of entries from any RSS feed or your own saved feeds (if you have saved feeds)
  • m!twitter [USER] [ENTRIES] - Return the last x amount of tweets from a particular user.
  • m!opt [CATEGORY] [OPTION] [VALUE] - Control bot options, see wiki for info on usage.

Deployment

  1. Install Docker (required) and Docker Compose (optional, but strongly recommended, this guide assumes you have it)
  2. Rename config/example.default.json to config/default.json and modify it accordingly. A list of variables and their descriptions can be found in this repos wiki. You do not need to do anything with example.usersettings.json unless you wish to predefine settings prior to the bots first start, the usersettings file will be made when any options are set at runtime.
  3. Run docker compose up to begin. Append -d to start in the background and --build if you make any changes to any files.

Support

If you need assistance with installation or usage, join #5000 on irc.supernets.org

License

This software is licensed under the ISC License, its full text can be found here.

Some required packages may be using licenses other than the ISC License. A full list of packages can be found in package-lock.json and their licenses can be found on their respective homepages/repositories.