mumtrix/mumtrix
1
0
Fork 0
mirror of https://github.com/mumtrix/mumtrix.git synced 2025-05-12 10:21:42 +02:00
Code Issues Projects Releases Wiki Activity
Posts the current count of online users – on Mumble – to a Matrix room.
15 commits 2 branches 2 tags 72 KiB
Find a file
Exact
Vri f40ed39199 Update gitignore 
Added TODO.md to gitignore.
2022-08-23 11:14:48 +02:00
.github/ISSUE_TEMPLATE Use default issue templates 2022-08-16 14:59:42 +02:00
.gitignore Update gitignore 2022-08-23 11:14:48 +02:00
DEPENDENCIES add dependencies 2022-08-17 14:57:03 +02:00
LICENSE add date/name 2022-08-17 15:13:51 +02:00
mumtrix.py bump version 2022-08-22 19:35:11 +02:00
README.md Revert "renamed README" 2022-08-18 12:28:55 +02:00

README.md

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

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

  1. Install dependencies
    pip install -r DEPENDENCIES

  2. Generate config
    python mumtrix.py

  3. 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

  1. (optional) Edit the config mumtrix.ini

  2. 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