You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ This is a open-source TeamSpeak3 bot, playing music and much more.
4
4
5
5
-**Got questions?** Check out our [Wiki](https://github.com/Splamy/TS3AudioBot/wiki), [FAQ](https://github.com/Splamy/TS3AudioBot/wiki/FAQ), or ask on our [](https://gitter.im/TS3AudioBot/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
6
6
-**Something's broken or it's complicated?**[Open an issue](https://github.com/Splamy/TS3AudioBot/issues/new/choose)
7
-
- Please use and fill out one of the templates we provide unless they are not applicable or you have a good reason not to.
8
-
This helps us getting through the technical stuff faster
9
-
- Please keep issues in english, this makes it easier for everyone to participate and keeps issues relevant to link to.
7
+
- Please use and fill out one of the templates we provide unless they are not applicable, or you have a good reason not to.
8
+
This helps us to get through the technical stuff faster
9
+
- Please keep issues in English, this makes it easier for everyone to participate and keeps issues relevant to link to.
10
10
-**Want to support this Project?**
11
-
- You can discuss and suggest features. However the [backlog](https://github.com/Splamy/TS3AudioBot/projects/2) is large and feature requests will probably take time
11
+
- You can discuss and suggest features. However, the [backlog](https://github.com/Splamy/TS3AudioBot/projects/2) is large and feature requests will probably take time
12
12
- You can contribute code. This is always appreciated, please open an issue or contact a maintainer to discuss *before* you start.
13
13
14
14
## Features
15
-
* Play Youtube and Soundcloud songs as well as stream Twitch (extensible with plugins)
15
+
* Play YouTube and Soundcloud songs as well as stream Twitch (extensible with plugins)
16
16
* Song history
17
17
* Various voice subscription modes; including to clients, channels and whisper groups
18
18
* Playlist management for all users
@@ -36,14 +36,14 @@ For an in-depth command tutorial see [here in the wiki](https://github.com/Splam
36
36
### Download
37
37
Pick and download the build for your platform and liking:
38
38
39
-
|| Stable | Experimental |
40
-
| -- | -- | -- |
41
-
|| Versions are mostly considered stable but won't get bigger features as fast. | Will always have the latest and greatest but might not be fully stable or have broken features. |
| Docker |[](https://github.com/getdrunkonmovies-com/TS3AudioBot_docker) (NOTE: This build is community-maintained. It comes with all dependencies as well as youtube-dl preconfigured) | - |
|| Versions are mostly considered stable but won't get bigger features as fast. | Will always have the latest and greatest but might not be fully stable or have broken features.|
| Docker |[](https://github.com/getdrunkonmovies-com/TS3AudioBot_docker) (NOTE: This build is community-maintained. It comes with all dependencies as well as youtube-dl preconfigured) | -|
45
45
46
-
(We have more builds like linux arm/arm64 and .NET framework dependent builds available on our [nightly server](https://splamy.de/Nightly#ts3ab))
46
+
(We have more builds like linux arm/arm64 and .NET Framework dependent builds available on our [nightly server](https://splamy.de/Nightly#ts3ab))
47
47
48
48
#### Linux
49
49
Install the required dependencies for your distro:
@@ -60,57 +60,57 @@ Run
60
60
```
61
61
* or **manually**:
62
62
1. Make sure you have a C compiler installed
63
-
1. Make the Opus script runnable with `chmod u+x InstallOpus.sh` and run it with `./InstallOpus.sh`
64
-
1. Get the ffmpeg [32bit](https://johnvansickle.com/ffmpeg/builds/ffmpeg-git-i686-static.tar.xz) or [64bit](https://johnvansickle.com/ffmpeg/builds/ffmpeg-git-amd64-static.tar.xz) binary.
65
-
1. Extract the ffmpeg archive with `tar -vxf ffmpeg-git-*XXbit*-static.tar.xz`
66
-
1. Get the ffmpeg binary from `ffmpeg-git-*DATE*-amd64-static/ffmpeg` and copy it into your TS3AudioBot folder.
63
+
2. Make the Opus script runnable with `chmod u+x InstallOpus.sh` and run it with `./InstallOpus.sh`
64
+
3. Get the ffmpeg [32bit](https://johnvansickle.com/ffmpeg/builds/ffmpeg-git-i686-static.tar.xz) or [64bit](https://johnvansickle.com/ffmpeg/builds/ffmpeg-git-amd64-static.tar.xz) binary.
65
+
4. Extract the ffmpeg archive with `tar -vxf ffmpeg-git-*XXbit*-static.tar.xz`
66
+
5. Get the ffmpeg binary from `ffmpeg-git-*DATE*-amd64-static/ffmpeg` and copy it into your TS3AudioBot folder.
67
67
68
68
#### Windows
69
69
1. Get the ffmpeg [32bit](https://ffmpeg.zeranoe.com/builds/win32/static/ffmpeg-latest-win32-static.zip) or [64bit](https://ffmpeg.zeranoe.com/builds/win64/static/ffmpeg-latest-win64-static.zip) binary.
70
-
1. Open the archive and copy the ffmpeg binary from `ffmpeg-latest-winXX-static/bin/ffmpeg.exe` into your TS3AudioBot folder.
70
+
2. Open the archive and copy the ffmpeg binary from `ffmpeg-latest-winXX-static/bin/ffmpeg.exe` into your TS3AudioBot folder.
71
71
72
72
### Optional Dependencies
73
73
If the bot can't play some youtube videos it might be due to some embedding restrictions which are blocking this.
74
74
You can install the [youtube-dl](https://github.com/rg3/youtube-dl/) binary or source folder (and specify the path in the config) to try to bypass this.
75
75
76
76
### First time setup
77
77
1. Run the bot with `./TS3AudioBot` (Linux) or `TS3AudioBot.exe` (Windows) and follow the setup instructions.
78
-
1. (Optional) Close the bot and configure your `rights.toml` to your desires.
79
-
You can use the template rules as suggested in the automatically generated file,
80
-
or dive into the rights syntax [here](https://github.com/Splamy/TS3AudioBot/wiki/Rights).
81
-
Then start the bot again.
82
-
1. (Optional, but highly recommended for everything to work properly).
78
+
2. (Optional) Close the bot and configure your `rights.toml` to your desires.
79
+
You can use the template rules as suggested in the automatically generated file,
80
+
or dive into the rights syntax [here](https://github.com/Splamy/TS3AudioBot/wiki/Rights).
81
+
Then start the bot again.
82
+
3. (Optional, but highly recommended for everything to work properly).
83
83
- Create a privilege key for the ServerAdmin group (or a group which has equivalent rights).
84
84
- Send the bot in a private message `!bot setup <privilege key>`.
85
-
1. Congratz, you're done! Enjoy listening to your favourite music, experimenting with the crazy command system or do whatever you wish to do ;).
85
+
4. Congratz, you're done! Enjoy listening to your favourite music, experimenting with the crazy command system or do whatever you wish to do ;).
86
86
For further reading check out the [CommandSystem](https://github.com/Splamy/TS3AudioBot/wiki/CommandSystem).
Download the git repository with `git clone --recurse-submodules https://github.com/Splamy/TS3AudioBot.git`.
96
96
97
97
#### Linux
98
-
1. Get the `.NET 5.0` sdk by following [this tutorial](https://docs.microsoft.com/dotnet/core/install/linux-package-managers) and choose your platform
99
-
1. Go into the directory of the repository with `cd TS3AudioBot`
100
-
1. Execute `dotnet build --framework net5.0 --configuration Release TS3AudioBot` to build the AudioBot
101
-
1. The binary will be in `./TS3AudioBot/bin/Release/net5.0` and can be run with `dotnet TS3AudioBot.dll`
98
+
1. Get the `.NET 10.0` sdk by following [this tutorial](https://docs.microsoft.com/dotnet/core/install/linux-package-managers) and choose your platform
99
+
2. Go into the directory of the repository with `cd TS3AudioBot`
100
+
3. Execute `dotnet build --framework net10.0 --configuration Release TS3AudioBot` to build the AudioBot
101
+
4. The binary will be in `./TS3AudioBot/bin/Release/net10.0` and can be run with `dotnet TS3AudioBot.dll`
102
102
103
103
#### Windows
104
-
1. Make sure you have `Visual Studio` with the `.NET 5.0` development toolchain installed
105
-
1. Build the AudioBot with Visual Studio.
104
+
1. Make sure you have `Visual Studio` with the `.NET 10.0` development toolchain installed
105
+
2. Build the AudioBot with Visual Studio.
106
106
107
107
### Building the WebInterface
108
108
1. Go with the console of your choice into the `./WebInterface` folder
109
-
1. Run `yarn install` to restore or update all dependencies for this project
110
-
1. Run `yarn run build` to build the project.
109
+
2. Run `yarn install` to restore or update all dependencies for this project
110
+
3. Run `yarn run build` to build the project.
111
111
The built project will be in `./WebInterface/dist`.
112
112
Make sure to the set the webinterface path in the ts3audiobot.toml to this folder.
113
-
1. You can alternatively use `yarn run start` for development.
113
+
4. You can alternatively use `yarn run start` for development.
114
114
This will use the webpack dev server with live reload instead of the ts3ab server.
0 commit comments