0verengineer / matrix-social-credits

Social Credit bot for Matrix

Matrix bot for a social credit system

Report Bug · Request Feature . Docker Hub

---

Screenshots

Table of Contents

1. About The Project
2. Setup
3. License
4. Contact

About The Project

• This is a Matrix bot for a social credit system.

Setup

• Use the example docker-compose.yml file to setup the bot.
• The bot user can be created with Element / Element Web or any other Matrix client that supports registering a new user.

Environment Variables

• INITIAL_SOCIAL_CREDIT: The initial social credit that a user has
• ADMIN_USERNAME: Username of the user that will be the admin of the social credit system, user needs to be on the MATRIX_HOMESERVER_URL
• MATRIX_USERNAME: Username of the bot user
• MATRIX_PASSWORD: Password of the bot user
• MATRIX_HOMESERVER_URL: Homeserver url of the bot user for example https://matrix.org
• REACTION_LIMIT: Limits the social credit change reactions that are possible within REACTION_TIMESPAN
• REACTION_TIMESPAN: Timespan in minutes for the REACTION_LIMIT, like a cooldown
• DB_PATH: Path to the database file

Commands

• !help: Shows the help message
• !list: Lists all users and their social credit for the current room
• !list-emoji: Lists all emojis that can be used to change the social credit for the current room
• !register-emoji: To register an emoji

Usage

• React with a registered emoji to a message to change the social credit of the user that sent the message

License

Distributed under the GNU General Public License v3 See LICENSE for more information.

Contact

Julian Hackinger - [email protected]

Project Link: https://github.com/0verEngineer/matrix-social-credit