https://github.com/hivecom/pokebot
TeamSpeak 3 Music Bot
https://github.com/hivecom/pokebot
hacktoberfest music-bot teamspeak3
Last synced: 4 months ago
JSON representation
TeamSpeak 3 Music Bot
- Host: GitHub
- URL: https://github.com/hivecom/pokebot
- Owner: hivecom
- License: gpl-3.0
- Created: 2020-01-05T23:06:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-15T23:31:55.000Z (5 months ago)
- Last Synced: 2025-05-19T02:11:30.756Z (5 months ago)
- Topics: hacktoberfest, music-bot, teamspeak3
- Language: Rust
- Homepage:
- Size: 509 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pokebot
```
pokebot 0.2.0
Jokler
USAGE:
pokebot [FLAGS] [OPTIONS] [config_path]
FLAGS:
-h, --help Prints help information
-l, --local Run locally in text mode
-V, --version Prints version information
-v, --verbose Print the content of all packets
OPTIONS:
-a, --address
The address of the server to connect to
-g, --generate-identities Generate 'count' identities
-d, --master_channel The channel the master bot should connect to
-w, --increase-security-level Increases the security level of all identities in the config file
ARGS:
Configuration file [default: config.toml]
```
## Usage
1. Poke the main bot.
2. Once the secondary bot joins your channel, type !help for a list of commands.
**Chat commands:**
```
add Adds url to playlist
clear Clears the playback queue
help Prints this message or the help of the given subcommand(s)
leave Leaves the channel
next Switches to the next playlist entry
pause Pauses audio playback
play Starts audio playback
search Adds the first video found on YouTube
seek Seeks by a specified amount
stop Stops audio playback
volume Changes the volume to the specified value
```
## Compiling
1. Make sure the following are installed
* cargo + rustc 1.42 or later
* `gstreamer` development libraries which should be `libgstreamer-dev` and `libgstreamer-plugins-base-dev`
2. Clone the source with `git`:
```sh
$ git clone https://github.com/Mavulp/pokebot.git
$ cd pokebot
```
3. Building the binary
```sh
$ cargo build --release
```
This creates the binary under `target/release/`.