Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nunof07/discourse-mumble

Mumble Viewer plugin for Discourse
https://github.com/nunof07/discourse-mumble

discourse-plugin mumble

Last synced: 14 days ago
JSON representation

Mumble Viewer plugin for Discourse

Awesome Lists containing this project

README

        

# Mumble plugin for Discourse
A Mumble Viewer plugin for Discourse that displays channel and user information.
- [Discourse] is an open source discussion platform.
- [Mumble] is an open source voice chat software.

The Mumble server needs to support the [Channel Viewer Protocol][cvp]. Most Mumble servers support this. If you manage your own server you can install a [3rd party application][cvpapp] to do this.

## Features
The plugin adds a button to the header.
- The button displays the number of users connected to the Mumble server.
- Clicking the button opens a menu with the list of channels and users.
- Idle users have a toned down icon.
- Information is refreshed periodically (configurable).

Screenshot of the plugin in action:

![Discourse Mumble Plugin Screenshot](https://cdn.rawgit.com/nunof07/discourse-mumble/9a3d7866096885567201e2d1bf44a3b8e6cf78cc/discourse-mumble-screenshot.png)

[discourse]: http://www.discourse.org/
[mumble]: http://wiki.mumble.info/wiki/Main_Page
[cvp]: http://wiki.mumble.info/wiki/Channel_Viewer_Protocol
[cvpapp]: http://wiki.mumble.info/wiki/3rd_Party_Applications#Channel_Viewers

## How to install
Follow the guide on how to [Install a Plugin][plugin] for Discourse but add this repository URL instead.

Then go to Admin > Plugins and choose Mumble settings:
- *mumble_interval*: the interval between information refreshes
- *mumble_cvp*: the URL to the [Channel Viewer Protocol][cvp] service
- *mumble_xml*: whether the URL to the CVP service is for XML, otherwise will use JSON

[plugin]: https://meta.discourse.org/t/install-a-plugin/19157

## Contributors

- [nunof07](https://github.com/nunof07)
- [muhlisbc](https://github.com/muhlisbc)
- [Adorfer](https://github.com/Adorfer)
- [ArwedSchmidt](https://github.com/ArwedSchmidt)