Mumtrix

TOC: About – Getting Started – Usage – License – Contribute – Contact – Acknowledgments

About

Posts the current count of online users – on Mumble – to a Matrix room.

Getting started

Requirements

• Python 3
• Matrix Webhook

Installation

1. Configure Matrix Webhook ❗️

2. Clone the repo
   git clone --depth=1 https://github.com/mumtrix/mumtrix.git

3. Create venv
   python -m venv /path/to/new/virtual/environment

4. Activate venv

Shell	Command
bash/zsh	source <venv>/bin/activate
Windows CMD	C:\> <venv>\Scripts\activate.bat

ℹ️ For other shells consult the venv documentation

5. Install dependencies
   pip install -r DEPENDENCIES

6. Generate config
   python mumtrix.py

7. Tailor the config mumtrix.ini to your needs

Usage

1. Activate venv

Shell	Command
bash/zsh	source <venv>/bin/activate
Windows CMD	C:\> <venv>\Scripts\activate.bat

ℹ️ For other shells consult the venv documentation

2. (optional) Edit the config mumtrix.ini

3. Run Mumtrix
   python mumtrix.py

Contribute

See github.com/firstcontributions.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Matrix: #mumtrix:cozy.town

Github: github.com/mumtrix
Gitea (Mirror): code.cozy.town/mumtrix

Acknowledgments

• Ranomier
• azlux/pymumble
• nim65s/matrix-webhook
• othneildrew/Best-README-Template