Skip to content

Commit

Permalink
docs: Add source module readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kissaki committed Mar 12, 2024
1 parent a4fa29a commit bb59c02
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions modules/source/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Source Engine Module

The Source game management plugin for Mumo 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 and does not require cooperation by the game server.

The following source engine based games are supported:

* Team Fortress 2
* Day of Defeat: Source
* Counter-Strike: Source
* Half-Life 2: Deathmatch

## Enabling the `source` module

1. Link or copy the ''source.ini'' file from the `modules-available` folder into the `modules-enabled` folder\
`cd modules-enabled`\
`ln -s ../modules-available/source.ini`
2. Check whether the defaults in `source.ini` are ok for your setup. They should be sane for basic setups.
3. Restart mumo

0 comments on commit bb59c02

Please sign in to comment.