A bot that updates a matrix room's topic
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
src
.gitignore
.travis.yml
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

matrix-topic-bot

TravisCI badge

A simple bot that keeps your Matrix room's dynamic topic up to date.

Questions? Ask away in #topicbot:t2bot.io

Usage

  1. Invite @topic:t2bot.io to a room
  2. Give the bot permission to edit your topic (usually requires moderator privileges)
  3. Set your topic template and variables: !topic template member_count
  4. Set your desired room topic: !topic set My first room with $RESULT people!
  5. The bot will keep your topic up to date!

For information on the available templates, type !topic templates or !topic help for more information.

Building your own

Note: You'll need to have access to an account that the bot can use to get the access token.

  1. Clone this repository
  2. npm install
  3. Copy config/default.yaml to config/production.yaml
  4. Edit the values of config/production.yaml and config/database.json to match your needs
  5. Run the bot with NODE_ENV=production node index.js