Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theholywaffle/teamspeak-3-java-api
A Java wrapper of TeamSpeak's 3 server query API.
https://github.com/theholywaffle/teamspeak-3-java-api
java maven teamspeak teamspeak3
Last synced: about 3 hours ago
JSON representation
A Java wrapper of TeamSpeak's 3 server query API.
- Host: GitHub
- URL: https://github.com/theholywaffle/teamspeak-3-java-api
- Owner: TheHolyWaffle
- License: mit
- Created: 2013-11-27T16:19:16.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-07T21:10:42.000Z (6 months ago)
- Last Synced: 2024-09-24T19:23:42.091Z (about 3 hours ago)
- Topics: java, maven, teamspeak, teamspeak3
- Language: Java
- Homepage:
- Size: 83.7 MB
- Stars: 307
- Watchers: 24
- Forks: 107
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TeamSpeak 3 Java API
====================
[](https://github.com/TheHolyWaffle/TeamSpeak-3-Java-API/actions/workflows/maven.yml) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.github.theholywaffle%22%20a%3A%22teamspeak3-api%22) [](http://www.javadoc.io/doc/com.github.theholywaffle/teamspeak3-api) [](https://gitter.im/TheHolyWaffle/TeamSpeak-3-Java-API?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
A Java wrapper of the [TeamSpeak 3](http://media.teamspeak.com/ts3_literature/TeamSpeak%203%20Server%20Query%20Manual.pdf) Server Query API
## Features
- Contains almost all server query functionality! (see [TeamSpeak 3 Server Query Manual](https://www.teamspeak-info.de/downloads/ts3_serverquery_manual.pdf))
- Built-in keep alive method
- Threaded event-based system
- Both [synchronous](src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java) and [asynchronous](src/main/java/com/github/theholywaffle/teamspeak3/TS3ApiAsync.java) implementations available
- Can be set up to reconnect and automatically resume execution after a connection problem
- Utilizes [SLF4J](https://www.slf4j.org/) for logging abstraction and integrates with your logging configuration
## Getting Started
### Download
- **Option 1 (Standalone Jar)**:
Download the [latest release](https://search.maven.org/remote_content?g=com.github.theholywaffle&a=teamspeak3-api&v=LATEST&c=with-dependencies) and add this jar to the buildpath of your project.
- **Option 2 (Maven)**:
Add the following to your pom.xml:
```xml
com.github.theholywaffle
teamspeak3-api
...
```
This API utilizes [SLF4J](https://www.slf4j.org/) for logging purposes and doesn't come shipped with a default logging implementation, if you use Maven instead of the standalone jar.
You will manually have to add one via Maven to get any logging going, if you don't have one already.
The easiest way to do so is to just add SimpleLogger to your project, which also supports configuration via
config file (needs to be shipped as a resource with your jar), if you want to log ```DEBUG``` messages for instance (e.g. raw client-server communication).
See this [configuration example](https://github.com/TheHolyWaffle/TeamSpeak-3-Java-API/blob/master/src/main/resources/simplelogger.properties) for SimpleLogger.
Add the following to your pom.xml to get started:
```xml
org.slf4j
slf4j-simple
1.7.25
```
You can however choose whichever logging framework suits your needs best. Just add your logging framework and the
corresponding [binding](https://mvnrepository.com/artifact/org.slf4j) to your pom.xml.
### Usage
All functionality is contained in the [TS3Api](src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java) object.
1. Create a [TS3Config](src/main/java/com/github/theholywaffle/teamspeak3/TS3Config.java) object and customize it.
2. Create a [TS3Query](src/main/java/com/github/theholywaffle/teamspeak3/TS3Query.java) object with your TS3Config as argument.
3. Call `TS3Query#connect()` to connect to the server.
4. Call `TS3Query#getApi()` to get an [TS3Api](src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java) object.
5. Do whatever you want with this api :)
### Example
```java
final TS3Config config = new TS3Config();
config.setHost("77.77.77.77");
final TS3Query query = new TS3Query(config);
query.connect();
final TS3Api api = query.getApi();
api.login("serveradmin", "serveradminpassword");
api.selectVirtualServerById(1);
api.setNickname("PutPutBot");
api.sendChannelMessage("PutPutBot is online!");
...
```
### More examples
[here](example)
## Extra notes
### FloodRate
Only use `FloodRate.UNLIMITED` if you are sure that your query account is whitelisted (query_ip_whitelist.txt in Teamspeak server folder). If not, use `FloodRate.DEFAULT`. The server will temporarily ban your account if you send too many commands in a short period of time. For more info on this, check the [TeamSpeak 3 Server Query Manual, page 6](http://media.teamspeak.com/ts3_literature/TeamSpeak%203%20Server%20Query%20Manual.pdf#page=6).
### TS3Config Settings
| Option | Description | Method signature | Default value | Required |
| --- | --- | --- | :---: | :---: |
|Host/IP | IP/Host of TeamSpeak 3 server.| ``setHost(String)`` | | yes |
|QueryPort | Query port of TeamSpeak 3 server. | ``setQueryPort(int)`` | 10011 | no |
|FloodRate | Prevents possible spam to the server. | ``setFloodRate(FloodRate)`` | `FloodRate.DEFAULT` | no |
|Communications logging | Log client-server communication. | ``setEnableCommunicationsLogging(boolean)`` | false | no |
|Command timeout | Time until a command waiting for a response fails | ``setCommandTimeout(int)`` | 4000 (ms) | no |
## Questions or bugs?
Please let us know [here](../../issues). We'll try to help you as soon as we can.
If you just have a simple question or want to talk to us about something else, please join the [repository chat](https://gitter.im/TheHolyWaffle/TeamSpeak-3-Java-API) on Gitter.