Difference between revisions of "Mumo"

From Mumble Wiki
Jump to: navigation, search
(Add readme as initial page)
 
(Nicen it up a little)
Line 9: Line 9:
 
by mumo. Developers can focus on their specific functionality instead.
 
by mumo. Developers can focus on their specific functionality instead.
  
Currently mumo comes with the following modules:
+
==Currently mumo comes with the following modules==
  
  * bf2: Battlefield 2 game management plugin that can dynamically
+
===bf2===
        move players into appropriate channels and groups to fit
+
   
        the in-game command structure. This is achieved by using
+
Battlefield 2 game management plugin that can dynamically
        data gathered from Mumble's positional audio system and does
+
move players into appropriate channels and groups to fit
        not require cooperation by the game server.  
+
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
+
===idlemove===
        a configurable amount of time into a idle channel. Optionally
+
Plugin for moving players that have been idle for
        the players can be muted/deafened on move.
+
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
+
===onjoin===
        of which channel they were in when they left last time.
+
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
+
===seen===
        the last time a specific nick was seen on the server.
+
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
+
===source===
        players into on-the-fly created channel structures representing
+
Source game management plugin that can dynamically move
        in-game team setup. This is achieved by using data gathered from
+
players into on-the-fly created channel structures representing
        Mumble's positional uadio system and does not require cooperation
+
in-game team setup. This is achieved by using data gathered from
        by the game server. Currently the following source engine based
+
Mumble's positional uadio system and does not require cooperation
        games are supported: Team Fortress 2, Day of Defeat: Source,
+
by the game server. Currently the following source engine based
        CounterStrike: Source, Half Life 2: Death Match.
+
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
+
===test===
        outputs every call with parameters into the debug log.
+
A debugging plugin that registers for all possible events and
 +
outputs every call with parameters into the debug log.
  
 +
==Contributions==
 
If you have a module that you would like to see shipped with mumo or
 
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
 
have any improvements or suggestions please contact us. Whether you
Line 43: Line 51:
 
starting a thread in our forums at http://sourceforge.net/apps/phpbb/mumble/ is up to you.
 
starting a thread in our forums at http://sourceforge.net/apps/phpbb/mumble/ is up to you.
  
 +
==Configuration==
 
To configure and run mumo take a look at the mumo.ini and the module
 
To configure and run mumo take a look at the mumo.ini and the module
 
specific configurations in modules-available folder. Enabling modules
 
specific configurations in modules-available folder. Enabling modules
Line 48: Line 57:
 
modules-enabled folder.
 
modules-enabled folder.
  
 +
==Requirements==
 
mumo requires:
 
mumo requires:
 
  - python 2.7*
 
  - python 2.7*

Revision as of 16:51, 31 May 2013

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.

Contributions

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.

Configuration

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.

Requirements

mumo requires:

- python 2.7*
- python-zeroc-ice
- murmur >=1.2.3*
  • Not tested with lower versions yet