Skip to content

Commit

Permalink
docs(readme): Fix and improve README text (minor changes)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kissaki committed Mar 11, 2024
1 parent 3f01ad5 commit 3fa586f
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# 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
# 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
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.

## Documentation
The documentation can be found in our wiki, see https://wiki.mumble.info/wiki/Mumo.

## Docker image
An official docker image is available at https://hub.docker.com/r/mumblevoip/mumo.
ALl the documentation is inside the wiki.
All the documentation is inside the wiki.

## Modules for Mumble moderator
### Included modules
Currently mumo comes with the following 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 by the game server.
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 a idle channel. Optionally the players can be muted/deafened on move.
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***

Expand All @@ -34,7 +34,7 @@ Currently mumo comes with the following modules:

* ***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 uadio system and does not require cooperation by 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.
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***

Expand All @@ -50,15 +50,13 @@ prefer a pull request, visiting us in IRC in #mumble on Freenode or
creating an issue with a diff-patch is up to you.

## 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
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.
`modules-enabled` folder.

## Requirements
mumo requires:
* python >=3.2
* python3-zeroc-ice
* mumble-server >=1.2.3*

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

0 comments on commit 3fa586f

Please sign in to comment.