From 9fcaa1fbc21fc74ee595d8d8a29372f0a6dace74 Mon Sep 17 00:00:00 2001 From: Carl Kittelberger Date: Fri, 16 Oct 2015 11:19:28 +0200 Subject: [PATCH 1/2] Fix the service run files so they're executable. --- etc/service/dbus-daemon/run | 0 etc/service/ts3bot/run | 0 2 files changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 etc/service/dbus-daemon/run mode change 100644 => 100755 etc/service/ts3bot/run diff --git a/etc/service/dbus-daemon/run b/etc/service/dbus-daemon/run old mode 100644 new mode 100755 diff --git a/etc/service/ts3bot/run b/etc/service/ts3bot/run old mode 100644 new mode 100755 From 182a607bf41656e03f35ec1bfdd0733ebcb48c7d Mon Sep 17 00:00:00 2001 From: icedream Date: Fri, 16 Oct 2015 12:56:26 +0200 Subject: [PATCH 2/2] Added a readme. --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b91f1f --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# TS3Bot for Docker + +This is the Docker image that contains everything necessary to run Icedream's TS3Bot. You only need to provide a configuration with an identity and off it goes! + +## Supported features + +- Thanks to VLC support for YouTube and direct livestreams +- Takes commands from both channel and private messages +- Can change nickname on the fly + +## Supported commands + +- `play ` - Plays a URL +- `stop` - Stops playback +- `changenick ` - Changes the bot's nickname + +## How to run this? + +1. You can pull the latest image via `docker pull icedream/ts3bot`. +2. Create a folder, it will contain your configuration and your identity file that the bot uses to log in. +3. Create a `config.json` in the configuration folder. A working example would be here: + ```json + { + "identity-path": "/config/identity.ini", + "ts3-server": "ts3server://?port=&password=&channel=" + } + ``` +4. Generate an identity in your TeamSpeak3 client (Settings > Identities > Add), set the nickname to the nickname you want the bot to have and optionally increase the security level to the level needed for your bot to join the server. +5. Export the identity you just generated via the "Export" button. Save it as `identity.ini` and put it into your configuration folder from earlier. You can now delete the identity from your TS3 client. +6. Now set up a container with your configuration folder mounted at `/config`. The command for this would be: `docker run -d -v ":/config:ro" --cap-add SYS_NICE icedream/ts3bot` + +Alternatively instead of running a `docker` command you can use [Docker Compose](https://docs.docker.com/compose/). A typical `docker-compose.yml` for this would be: + +```yaml +bot: + image: icedream/ts3bot + volume: + - ":/config:ro" + cap_add: + - SYS_NICE +``` + +## Source code + +The main repository for the source code of the bot is available at [https://github.com/icedream/ts3bot-control](https://github.com/icedream/ts3bot-control). + +## Planned features + +- Improve support for video platforms (see issue [#1](https://github.com/icedream/ts3bot-docker/issues/1) and ts3bot-control issue [#4](https://github.com/icedream/ts3bot-control/issues/4)) +- Timestamping/skip intros (issue [#3](https://github.com/icedream/ts3bot-control/issues/3)) +- Volume adjustment (issue [#5](https://github.com/icedream/ts3bot-control/issues/5)) +- Playlisting (issue [#2](https://github.com/icedream/ts3bot-control/issues/2)) +- Permission system (issue [#1](https://github.com/icedream/ts3bot-control/issues/1)) +- Command aliases to quickly reuse media +- Recording features \ No newline at end of file