Mumble-Ruby-Pluginbot¶
Mumble-Ruby-Pluginbot is an extensible bot which can play audio, be fed by different sources, and much, really much more :)
You can find the source code on GitHub.
This is the documentation of the current stable version 0.10.3 of the Mumble-Ruby-Pluginbot.
Contents¶
- Features
- Compatibility
- Usage
- Plugins
- How to run the bot
- Installation HowTo
- How much time will you need?
- How will it look like?
- On Arch Linux only: Install and set up system package dependencies
- On CentOS 7 only: Install and setup package dependencies
- On Debian/Ubuntu based Distributions only: Install and set up system package dependencies
- Create a user which should contain all the relevant bot structures
- Create all needed directories and subdirectories for MPD and the bot(s)
- Install and set up ruby and all needed libraries
- Download and set up celt-ruby and libcelt
- Download and set up opus-ruby
- Download and set up mumble-ruby-pluginbot
- Set up MPD (Music Player Daemon)
- Install a custom version of youtube-dl
- Only on Arch Linux: Install dependencies for youtube-dl
- Only on CentOS 7: Install dependencies for youtube-dl
- Only on Debian/Ubuntu based distributions: Install the dependencies (if ffmpeg is available for your distribution)
- Only on Debian/Ubuntu based distributions (OPTIONAL): Install the dependencies (if ffmpeg IS NOT available for your distribution)
- Login as botmaster
- Install the youtube-dl script
- Almost done, start your bot(s) for the first time
- Set up bot to start automatically on system startup
- Controlling the bot(s) from your shell
- Configuration settings of your bot
- Known problems
- Explain the configs
- Configuration files
- Default configuration and override configuration
- Syntax within this help
- Notes for editing the configuration
- Default config/config.yml
- Main settings
- config:version
- debug
- language
- main:tempdir
- main:logfile
- main:ducking
- main:automute_if_alone
- main:stop_on_unregistered
- main:channel_notify
- main:controllable
- main:whitelist_enabled
- main:control:string
- main:control:message:private_only
- main:control:message:registered_only
- main:control:historysize
- main:display:comment:set
- main:user:whitelisted
- main:user:superuser
- main:user:banned
- main:user:bound
- main:certfolder
- main:fifo
- main:logo
- main:timer:ticks
- main:blacklisted_commands
- mumble:use_vbr
- mumble:bitrate
- mumble:host
- mumble:port
- mumble:name
- mumble:password
- mumble:channel
- Bandcamp plugin settings
- Ektoplazm plugin settings
- Idle plugin settings
- Mixcloud plugin settings
- MPD plugin settings
- Soundcloud plugin settings
- Youtube plugin settings
- Known problems
- Status of the project
- FAQ – Frequently Asked Questions
About this documentation¶
This documentation is written in ReStructuredText.
- ReStructuredText (on Wikipedia)
- http://www.sphinx-doc.org/en/1.5.1/rest.html
- http://www.sphinx-doc.org/en/1.5.1/markup/inline.html
- http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
Contribute to this documentation¶
You can contribute to this documentation on Github, see https://github.com/MusicGenerator/mumble-ruby-pluginbot-docs.