icedream
/
ts3bot
mirror of https://github.com/icedream/ts3bot.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix example configuration formatting. 

This formatting mistake is only visible on GitHub but not on Docker Hub.
master
Icedream 2015-10-16 13:29:58 +02:00
parent b1f857fc47
commit 8e79406f27
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -19,12 +19,14 @@ This is the Docker image that contains everything necessary to run Icedream's TS
1. You can pull the latest image via `docker pull icedream/ts3bot`. 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. 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: 3. Create a `config.json` in the configuration folder. A working example would be here:
```json ```json
{ {
"identity-path": "/config/identity.ini", "identity-path": "/config/identity.ini",
"ts3-server": "ts3server://<your.ts3.server>?port=<port>&password=<password>&channel=<channelpath>" "ts3-server": "ts3server://<your.ts3.server>?port=<port>&password=<password>&channel=<channelpath>"
} }
``` ```
Note that you can generate the URL for `ts3-server` using your TS3 client via Extras > Invite friend, select the checkbox "Channel" and select "ts3server link" as invitation type. Note that you can generate the URL for `ts3-server` using your TS3 client via Extras > Invite friend, select the checkbox "Channel" and select "ts3server link" as invitation type.
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. 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. 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.