From deb9aba0221411e494caec343a6fd16828bfef77 Mon Sep 17 00:00:00 2001 From: Stefan Hacker Date: Tue, 26 Feb 2013 01:09:45 +0100 Subject: [PATCH] Add a README --- README | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..f5df00e --- /dev/null +++ b/README @@ -0,0 +1,52 @@ +mumo - The Mumble moderator +=========================== + +Mumo is meant to provide a platform on which python based Mumble server +plugins 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. + +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. + + * 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. + + * 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 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, + CounterStrike: Source, Half Life 2: Death Match. + + * test: A debugging plugin that registers for all possible events and + outputs every call with parameters into the debug log. + +If you have a module that you would like to see shipped with mumo or +have any improvements or suggestions please contact us. Whether you +prefer a pull request, visiting us in IRC in #mumble on Freenode or +starting a thread in our forums at http://sourceforge.net/apps/phpbb/mumble/ is up to you. + +mumo requires: + - python 2.7* + - python-zeroc-ice + - murmur >=1.2.3* + +* Not tested with lower versions yet +