https://github.com/mumble-voip/mumo

Mumble Moderator framework simplifying development of plugins that connect to Mumble servers via Ice. (handles basic ICE connectivity, contains basic module loading and message multiplexing)
https://github.com/mumble-voip/mumo

hacktoberfest ice mumble python zeroc-ice

Last synced: 3 days ago
JSON representation

Mumble Moderator framework simplifying development of plugins that connect to Mumble servers via Ice. (handles basic ICE connectivity, contains basic module loading and message multiplexing)

• Host: GitHub
• URL: https://github.com/mumble-voip/mumo
• Owner: mumble-voip
• Created: 2014-07-15T11:06:23.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-07-28T09:26:39.000Z (5 months ago)
• Last Synced: 2024-12-17T00:12:53.099Z (10 days ago)
• Topics: hacktoberfest, ice, mumble, python, zeroc-ice
• Language: Python
• Homepage:
• Size: 186 KB
• Stars: 55
• Watchers: 16
• Forks: 28
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mumo - The Mumble Moderator

Mumo is meant to provide a platform on which Python-based Mumble server ICE extension modules can be built upon. The goal is to reduce the boilerplate needed

to interact with the Mumble server to a minimum.

To achieve this goal, tasks like Ice interface setup, basic error

handling, configuration management, logging, and more are provided

by mumo. Developers can focus on their specific functionality instead.

## Requirements

mumo requires:

* python >=3.2

* python3-zeroc-ice

* zeroc-ice-slice

* mumble-server >=1.2.3 (not tested with lower versions)

## Setting up

To configure and run mumo take a look at the `mumo.ini` and the module

specific configurations in `modules-available` folder. Enabling modules

is done by linking the configuration in modules-available to the

`modules-enabled` folder.

## Docker image

An official docker image is available at https://hub.docker.com/r/mumblevoip/mumo.

More information in [docker.md](docker.md).

## Modules for Mumble moderator

### Included modules

Currently, mumo comes with the following modules:

#### bf2

Battlefield 2 game management plugin that can dynamically move players into appropriate channels and groups to fit the in-game command structure. This is achieved by using data gathered from Mumble's positional audio system and does not require cooperation from the game server.

#### idlemove

Plugin for moving players that have been idle for a configurable amount of time into an idle channel. Optionally the players can be muted/deafened on move.

#### onjoin

Moves players into a specific channel on connect regardless of which channel they were in when they left last time.

#### seen

Makes the server listen for a configurable keyword to ask for the last time a specific nick was seen on the server.

#### source

Source game management plugin that can dynamically move players into on-the-fly-created channel structures representing in-game team setup.

This is achieved by using data gathered from Mumble's positional audio system and does not require cooperation from the game server.

 

Currently, the following source-engine-based games are supported: Team Fortress 2, Day of Defeat: Source, Counter-Strike: Source, Half-Life 2: Deathmatch.

#### test

A debugging plugin that registers for all possible events and outputs every call with parameters into the debug log.

### 3rd party modules

See [docs/third-party-modules.md](docs/third-party-modules.md)

## Contributing

We appreciate contributions. For example as issue or suggestion reports and comments, change pull requests, additional modules, or extending documentation.

You can talk to us in tickets or in chat in [#mumble-dev:matrix.org](https://matrix.to/#/#mumble-dev:matrix.org).