Der Mumble-Ruby-Pluginbot ist vielseitiger auf Bot, dessen Hauptaufgabe das Streamen von Audio an einen Mumble-Server ist.

Durch Plugins können jedoch auch andere Funktionalitäten realisiert werden.

Neue Plugins

Zu den mitgelieferten Plugins des Mumble-Ruby-Pluginbot sind zwei neue hinzugekommen:

• Ektoplazm – Lädt ganze Alben von Ektoplazm.com herunter, entpackt diese und fügt sie zur Sammlung hinzu.
• Bandcamp – Lädt entweder einzelne Tracks oder ganze Alben von Bandcamp.com herunter und fügt sie zur Sammlung hinzu.

Eine Liste aller mitgelieferten Plugins findet sich im Wiki.

Über mich…

Zusätzlich gibt es ein neues Kommando, mit dem man ein paar Informationen zum Bot abrufen kann:

.about

Hi, I am the Mumble-Ruby-Pluginbot.

• Get my source code
• Read my documentation
• I am licensed by the MIT license
• If you have any issues, bugs or ideas please tell us on https://github.com/dafoxia/mumble-ruby-pluginbot/issues

Audioducking

Die Lautstärke der Ducking-Funktion, die dann aktiviert wird, sobald jemand im Kanal spricht, ist nun änderbar, sowohl in der Konfigurationsdatei als auch im laufenden Betrieb.

Z. B. mit .duckvol 60

Ist das Ducking nicht aktivi, so aktiviert man es mittels .ducking

Installation und mehr…

Eine einfach Installationsanleitung gibt es im Wiki, siehe hier. Dort sind auch weitere Informationen zum Mumble-Ruby-Pluginbot enthalten, siehe hier.

Nur mal testen…

Wer einen solchen Bot nur ausprobieren möchte, kann gerne bei uns auf Mumble vorbeikommen

Mumble-Ruby-Pluginbot is a Mumble-Ruby based, extensible bot which can play audio, fed by different sources like Youtube, Bandcamp and more and is controllable through text commands within your Mumble client.

Here is a list of the changes from the last weeks.

New commands

• .ytdl-version – Shows every version of the used youtube-dl binaries used for all plugins.
• .version – Shows the git version string of the bot.
• .delplaylist id – Removes the playlist referenced by their id. Use .playlists to get a list of all playlists.
• .duckvol – Shows the current ducking volume and whether it is enabled.

New features

• A new variable has been added for an initial volume of the bot with a default value of 65 %.
• The bot is now able to register itself on a server that allows self registration (which is default). Use .register in order to do that
• Instead of adding theradio.cc stream on every startup this is done only once now.
• On every start through the start script youtube-dl gets updated.
• The start script doesn’t use fixed paths anymore. Instead all paths are relative to $HOME.
• The bot checks if it is muted or deafened before it unmutes/undeafs himself; this reduces „Bot unmuted/unmuted himself“ messages.
• A start script for systemd was added.
• If available youtube-dl downloads Opus audio from Youtube.

Bug fixes

• Seeking forward/backward works now as it should. Try .seek +30 to seek 30 seconds forward or -30 to seek backwards.
• If you installed the bot with the installation howto then a .bind, followed by a .restart the bot did not reconnect. This is fixed now.
• Fix crash when using .play with a not existing ID.

Try it

The bot is open source, you can run it headless on a Linux server, on your desktop or download a fully installed virtual appliance for VirtualBox in order to use the bot on any other operating system.

The documentation about the bot can be found here.

• A new updater script was added which doesn’t only update the mumble-ruby-pluginbot itself but also all dependencies.
  Running a complete update through the updater…
  (The script is located in mumble-ruby-pluginbot/scripts/updater.sh)
• The .seek command works now as it should for absoulte positions (.seek 10:35) and for relative ones (.seek +15/.seek -10:30).
• The automute function is now enabled by default. If the bot is alone in a channel he mutes himself and the song is paused until a user enters the channel. This saves a lot of bandwidth.
• If you command the bot to come into your channel with .ch it automatically undeafens itself, no wakeup command is needed anymore.
• When you create a playlist with .saveplaylist you get a confirmation now.
• If the variable mumbleserver_targetchannel in the configuration file is empty the bot complains to go to bed and informs you what to do.

As you can see the Mumble-Ruby-Pluginbot is being activly developed; if you have wishes, ideas or bugs please report on our GitHub project page.

VirtualBox Appliance to run the Bot

The VirtualBox appliance for the Mumble-Ruby-Pluginbot was already updated to the new version.

With this appliance you can run a fully configured and set up Mumble-Ruby-Pluginbot on your desktop within a virtual machine.

Fix for installation howto

If you used the offical installation tutorial for installing the Mumble-Ruby-Pluginbot on your own server then you must install the following two packages in order to make the Ektoplazm plugin work:

sudo apt-get install unzip unrar

Some great features have been implemented into the Mumble-Ruby-Pluginbot:

• You can change the bitrate while the bot is connected to your server via the .bitrate command
• The bot reduces its quality automatically when it connects to a server that allows a lower maximum bandwidth than what was set in the bots configuration.
• The bot mutes itself not only if all users left his channel but also when connecting into an empty channel.
• The new command .bandwidth shows current bandwidth settings of your bot:
  
• You may also try the new command .framesize with values from 10 up to 60; default is 10. The higher the framesize the lower the overall bandwidth and overhead. This feature is not meant for daily usage yet because anything not 10 ms will become „laggy“.

Manual update

If you update your Mumble-Ruby-Pluginbot you must also update your mumble-ruby in order to use the new features.

Automatic update

Both can be done with the updater.sh script if you used our installation howto or downloaded the VirtualBox appliance.

Virtual Appliance

I am going to update the VirtualBox appliance later this night.

gomumblesoundboard is an audiobot for Mumble which you can control through a local web interface:

For each sound file which the bot can find in a special directory on your disk a play botton is generated in this interface.

An easy to set up docker image for this bot can be found here.

Der Mumble-Ruby-Pluginbot ist ein vielseitiger Bot mit verschiedenen Plugins, der unter anderem Musik an einen Mumble-Server senden kann. Die Musik kann sich der Bot direkt z. B. bei Youtube oder anderen Musik-/Videoplattformen herunterladen.

Der Bot ist über Textbefehle innerhalb deines Mumble-Clients steuerbar.

Heute wurde eine großartige neue Version des Mumble-Ruby-Pluginbots mit dem Namen „Winter melon punch“ (Version 0.10.0) veröffentlicht. Es gibt viele neue Funktionen, Fehlerbehebungen, neue Befehle, neue Plugins und Übersetzungen.

Neue Funktionen und Verbesserungen

• Der Bot erstellt sein Logo über die Avatarfunktion in Mumble anstatt es in den Kommentar zu setzen.
• Es wird jetzt YAML für die Konfiguration verwendet.
• In der Warteschlange wird der gerade gespielte Titel fett geschrieben angezeigt.
• Befehle können gesperrt werden.
• Man kann mehrere Titel aus der Warteschlange löschen mit dem delete Befehl. Zum Beispiel .delete 1 5 6.
• Der Bot prüft jetzt, ob er die benötigten Berechtigungen hat, bevor er einen Download startet und meldet sich, falls er keine hat.
• Viele weitere Fehlerbehebungen…
• Die Installationsanleitung funktioniert jetzt auch auf Arch Linux (danke @Nascher für seine Arbeit).
• Das Systemd script wurde verbessert.
• Die Debugausgabe wurde vereinfacht und verbessert.
• Die Verzeichnisstruktur wurde verbessert.

Start script verbessert

Das Script start.sh wurde ersetzt durch manage.sh und dieses kann mehr als nur den Bot zu starten.

Aktuell gibt es die folgenden Möglichkeiten:

OPTIONS
 stop               Stop the bot(s)
 start              Start the bot(s)
 restart            Restart the bot(s)
 uytdl|updateytdl   Update youtube-dl
 log                Show the bots log using tail
 status             Show if bots are running or
                    not
 -h|--help          Show this help

Ohne Parameter gestartet erhält man diese Hilfe.

Weitere Informationen, wie man den Bot von der Shell aus steuern kann, gibt es hier.

Wiedergabelisten

Die Arbeit mit Wiedergabelisten wurde verbessert:

• .saveplaylist wurde ersetzt durch das neue Befehl .save2playlist, um aufzuzeigen, dass bei ersterem die Titel aus der aktuellen Wartschlange an eine existierende Wiedergabeliste angehängt werden. Existiert die angegebene Wiedergabeliste nicht, dann wird sie natürlich erstellt.
• .replaceplaylist wurde hinzugefügt und ersetzt eine bereits bestehende Wiedergabeliste mit den Titeln aus der aktuellen Warteschlange.

Verbesserte Plugins

Radiostream Plugin

Das Radiostream Plugin hat einige neue Befehle:

• .radioupdate – Der Bot aktualisiert bzw. lädt sich die Liste der verfügbaren Radiosender herunter von steamcast.com.
• .radiocategories – Zeigt eine Liste aller verfügbaren Kategorien an.
• .radiocategory – Zeigt alle Radiosender einer Kategorie an, zum Beispiel .radiocategory Electro
• Mit dem Befehl .radioselect Electro 5 fügt der Bot den entsprechenden Sender aus der mit radiocategory Electro angezeigten Liste zur aktuellen Warteschlange hinzu.

Neue Plugins

Neues Version Plugin

Dieses Plugin zeigt einige Versionsinformationen zum Bot an.

Man erhält den aktuellen Zweig des Bots, einige allgemeine Informationen und auch eine klickbare URL für den letzten Commit des bots zu GitHub.

Siehe .help version für weitere Informationen.

Neues Mixcloud Plugin

Dieses Plugin kann Musik von mixcloud.com herunterladen.

Siehe .help mixcloud für weitere Informationen.

Neues Timer Plugin

Dieses Plugin ist in der Lage, einen Mumble-Benutzer in einer bestimmten Zeit an etwas zu erinnern.

Siehe .help timer für weitere Informationen.

Dokumentation verbessert

Die (Englisch-sprachige) Dokumentation des Bots befindet sich nun nicht mehr verstreut in meinem eigenen Wiki sondern zentral bei „Read the Docs“, siehe hier.

Das hat den schönen Nebeneffekt, dass man die Dokumentation auch komplett herunterladen kann z. B. als PDF, Epub oder als Zip-Archiv mit HTML-Seiten.

Der Quelltext der Dokumentation ist auf GitHub verfügbar und man kann eigene Verbesserungen beitragen, siehe hier.

i18n – Internationalization

Der Bot spricht in der neuen Version neben Englisch jetzt auch Deutsch und sogar Bayerisch.

Für weitere Sprachen brauchen wir eure Hilfe. Wer helfen möchte möge bitte ins Verzeichnis i18n schauen :) Danke.

Wie kann ich meinen Bot 0.9.x aktualisieren? Du kannst es versuchen, aber lass es lieber …

Es wurde sehr viel am Bot geändert und letztlich ist die neue Version ein komplett neuer Bot. Das bedeutet leider auch, dass man den Bot nicht einfach aktualisieren kann.

Natürlich kann man es versuchen und mit ein bisschen Linux-Erfahrung schafft man es auch.

Wir empfehlen aber eine Neuinstallation.

Wer wirklich ein Update versuchen möchte, kann meine Update-Anleitung befolgen, aber es könnte sein, dass es nicht funktioniert und ich gebe auch keinen Support dafür.

Wie kann man neuere Versionen des Bots aktualisieren?

Seit der neuen Version ist ein Script updater.sh enthalten, mit dem man in Zukunft ganz einfach eine Aktualisierung durchführen kann.

Es gibt jetzt Superuser

Man kann sogenannte Superuser in der Konfiguration des Bots eintragen. Dazu benötigt man die Zertifikats-ID (Prüfsumme des Zertifikats).

Nur solche Benutzer sind in der Lage die Befehle „set“, „reset“ und „settings“ verwenden.

Es gibt eine Bannliste

Man kann die Zertifikats-ID von mehreren Benutzern in die dauerhaft Bannliste des Bots in der Konfiguration eintragen. Dieser ignoriert die Benutzer dann einfach.

Wenn du ein Entwickler bist…

Wenn du ein Entwickler bist, dann möchtest du vielleicht wissen, dass das Projekt auf GitHub jetzt woanders liegt und dass du deine URLs in Git umstellen kannst. Wir haben auf GitHub eine neue Organisation erstellt mit dem namen MusicGenerator, um einen zentralen Ort für die weitere Entwicklung zu haben.

Dockerized

Das ist nicht wirklich eine neue Funktion des Bots aber ich möchte erwähnen, dass ich ein Dockerfile erstellt habe, um vollautomatisch einen Mumble-Ruby-Pluginbot bauen zu lassen, siehe hier.

Nutzt man mehrere dieser Docker Container, dann kann man auch die Musik und die Wiedergablisten zentral speichern lassen.

Verbesserte VirtualBox Virtual Appliance(s)

Es gibt jetzt zwei neue Versionen der VirtualBox Virtual Appliance mit der neuen Version des Bots.

Diese können von Menschen benutzt werden, die sich die Installation auf der Kommandozeile eines Linux-Systems nicht zutrauen.

Eine der virtuellen Maschinen wird wie bisher auch nur den Bot enthalten und muss per Kommandozeile konfiguriert werden.

Die zweite virtuelle Maschine kann man über eine grafische Oberfläche konfigurieren und steuern. Hier gibt es auch einen grafischen Client, um den MPD zu steuern.

Die Anleitung für die VirtualBox Virtual Appliances gibt es hier.

Vorkonfigurierte System images

Es gibt auch wieder vorkonfigurierte Systemimages für Raspberry Pi2, Raspberry Pi3 und Banana Pie, siehe hier.

Danke an…

• Danke @Nascher, der uns einen Testserver zur Verfügung stellt, wo wir unsere Bots bauen und testen können.
• Danke @robin, der uns den Platz auf seinem Server zur Verfügung stellt, sodass man sich die VirtualBox virtual appliance herunterladen kann.
• Danke an all die vielen Tester auf unserem Mumble-Server, die Tag und Nacht versucht und es auch oft geschafft haben, unsere Bots zu schrotten :)

Lies die Dokumentation

http://mumble-ruby-pluginbot.readthedocs.io

\o/

Hab Spaß mit dem neuen Mumble-Ruby-Pluginbot „Winter melon punch“ :)

Übrigens: Wenn du so einen Bot ausprobieren möchtest, bevor du ihn selbst installierst, dann kannst du gerne auf meinem Mumble-Server vorbeikommen. Wir haben mehrere davon.

Mumble-Ruby-Pluginbot is a versatile bot with many plugins which can for example download music from Youtube or other music/video platforms and much, much more.

It can be controlled via text commands within your Mumble client.

Today a great new version of Mumble-Ruby-Pluginbot named „Winter melon punch“ (Version 0.10.0) was released with many new features, bug fixes, new commands, new plugins and translations.

New features and improvements

• The bot sets its logo as a Mumble avatar instead of embedding it into the comment.
• The improved config file now uses YAML.
• The queue shows the current playing entry in bold font.
• Commands can be blacklisted.
• You can delete several songs from the current queue with the delete command. For example .delete 1 5 6.
• The bot checks if it has write permissions before downloading music and reports if it doesn’t have.
• Many other fixes.
• The installation howto now works also with Arch Linux (thanks @Nascher for his work).
• Improved systemd service script.
• Improved debug output in the log.
• Improved directory structure.

Start script improved

The start.sh script was replaced by a manage.sh which can do more than just starting the bot(s).

Currently you have the following options:

OPTIONS
 stop               Stop the bot(s)
 start              Start the bot(s)
 restart            Restart the bot(s)
 uytdl|updateytdl   Update youtube-dl
 log                Show the bots log using tail
 status             Show if bots are running or
                    not
 -h|--help          Show this help

Start it without any parameter to get a help text.

More information about controlling the bot on the shell can be found here.

Playlists

Working with playlists has been improved:

• .saveplaylist was replaced by the new command .save2playlist to reflect that the current queue will be appended to an already existing playlist. Of course it will create a new playlists if one with the given name does not exist.
• .replaceplaylist was added to be able to overwrite a named playlist with the current queue.

Improved Plugins

Radiostream Plugin

The radiostream plugin has some new commands:

• .radioupdate – Let the bot download/update the list of available streams from steamcast.com.
• .radiocategories – Get a list of available categories.
• .radiocategory – Show all streams of a category, for example .radiocategory Electro
  With the previous command you get a list of all streams within this category.
• With the command .radioselect Electro 5 you let the bot add the fifth stream to the current queue.

New Plugins

New Version Plugin

This plugin shows some version information of the bot.

You get the current branch, a general information and also a clickable URL linked to Github for the last commit the bot uses.

See .help version for more information.

New Mixcloud Plugin

There is a new plugin that allows you to download music from mixcloud.com.

See .help mixcloud for more information.

New Timer Plugin

This plugin is able to remind you (through text messages) at a specific time.

See .help timer for more information.

Documentation improved

The documentation about the bot has been moved from my own wiki to „Read the Docs“, see here.

This also means that you have the option to download the whole bot documentation as PDF, Epub or as a zip archive with HTML pages.

The source code of the documentation is available on GitHub and you can contribute to it or create an issue, see here.

i18n – Internationalization

The bot has now the basics to „speak“ other languages than English and is already translated into German and also into Bavarian.

But we need your help to translate the strings into other languages. Take a look into the i18n directory of your bot.

How to update my bot 0.9.x? You may, but don’t…

So much code was changed that you can say this is a complete new bot. This means that you cannot simply update your bot. Of course you can try to if you know what you are doing, but we recommend to do a fresh install.

Try my upgrade tutorial but beware that it might not work.

How to update in the future?

Beginning with this release there is a new updater.sh script which you can use to update your bot in the future.

There are Superusers

You can add so called superusers into the bots configuration. You need the certificate id (hash of the certificate).

Only those superusers are able to use the commands „set“, „reset“ und „settings“.

There is a Banlist

You can insert the certificate id of Mumble users into the bots configuration so that the bot ignores them permanently.

If you are a Developer

In case you are a developer you may want to adapt the new URLs of the project because we created a new organisation named MusicGenerator on GitHub to have a central place for development.

Dockerized

This is not exactly a new feature of the bot but I would like to mention that I wrote a Dockerfile to build a Mumble-Ruby-Pluginbot image for Docker, see here.

The Dockerfile was updated and now you can have one persistant playlists volume for all of your bots.

Improved VirtualBox Virtual Appliance(s)

There are now two flavors of the VirtualBox Virtual Appliance containing the new version of the bot.

You may use them if you can’t or don’t want to install a bot yourself.

Of of the virtual machines does have a terminal only.

The other one has a lightweight Desktop environment to configure and edit the bot. You can also control the MPD.

See here for documentation about the virtual appliances.

Preconfigured System images

There are also preconfigured system images for Raspberry Pi2, Raspberry Pi3 and Banana Pie, see here.

Thanks at…

• Thanks @Nascher for providing a Testserver where we can build and use our Pluginbots.
• Thanks @robin for providing space to upload the VirtualBox virtual appliance.
• All the users on our Mumble-Server who tried and crashed our bots again and again :)

Read the documentation

http://mumble-ruby-pluginbot.readthedocs.io

\o/

Have fun with the Mumble-Ruby-Pluginbot „Winter melon punch“ :)

BTW: If you want to try the bot before installing it you are welcome to visit my Mumble-Server. We have several of them.

Documentation

We completed the documentation about configuration settings and removed the comments from the config file.

Information about the bot

The Version plugin has now one command only but shows more information about the bot, see .version:

Some git information:
Version (short): 1ef6b79
Version (long): 1ef6b793bc8fb5eb238fb2c1fb3baf1ddc625ec0
Date of last commit: 2017-01-20 12:53:27 UTC
Branch: master
Tag: 0.10.1
Commiturl: 1ef6b793bc8fb5eb238fb2c1fb3baf1ddc625ec0

This is very useful information if you want to create an issue.

Configuration

We completely removed the example user hashes from the configuration files as some users feared those could be backdoors :P

In fact there were and will be no certificate out there that would match the example entries because the format was completely wrong by purpose. We placed them there to show how the list works.

Now there are links to the documentation only, see here.

Whitelist added

We created a whitelist for the bot. If it is enabled then only whitelisted users are able to control the bot. Superusers are treated as being on the whitelist.

See here for further documentation.

Blacklisted superusers

Even if a superuser is blacklisted by another user he will still be able to control the bot.

Bugs and fixes

• .bind && .register fixed
• .bind && .reset fixed
• Blacklisting users fixed
• The comment contains now a translated verion of the „about me“ sentence.

Update your bot

You can update to the latest version of the bot using the updater, see here.

Please run the updater.sh twice :)

Virtual Appliances

The virtual appliances were updated to this latest release, see here.

Preconfigured System Images for Raspberry Pi2/3 and BananaPi

These images were not updated but you can still use them and then run the updater after installation, see here.

This is the second update of Mumble-Ruby-Pluginbot „Winter melon punch“.

Fixes

• The superpassword was already completely removed in 0.10.0 but now we also removed the related help texts in .internals.
• The logfile setting is now included in the override config file.
• We added a URL to the override config file where one can read how the configuration file works.

Improved manage script

The manage.sh script had some problems if you started more than one bot. Thats why we rewrote it.

Now it is much simpler to read and it uses tmux sessions instead of tmux windows.

And there is now a manage.conf where you can enable additional bots. That means you no longer need to touch the manage.sh at all.

Update your bot (official installation howto)

If you used the official installation howto AND modified the manage.sh script to start more than one bots then you need to login as botmaster and do:

cd ~/src/mumble-ruby-pluginbot

./scripts/manage.sh stop

git checkout scripts/manage.sh

git pull origin master

git fetch --tags

cp templates/manage.conf ~/src/manage.conf

./scripts/manage.sh start

Then edit ~/src/manage.conf and enable your additional bots.

Update your bot (if you installed it yourself)

In all other cases you can run the updater script, see here and THEN copy the config as user botmaster:

cd ~/src/mumble-ruby-pluginbot/

./scripts/manage.sh stop

cp templates/manage.conf ~src/manage.conf

./scripts/manage.sh start

Virtual Appliance

The virtual appliances were updated.