The documentation can be found here:
TeamSpeak 3.1 updates the plugin api version from 20 to 21.
Version 0.2 and above are compatible with this version while version 0.1 is
compatible with the api version 20.
Breaking changes will happen from time to time, leading to a minor version bump.
At the moment, not all methods that are exposed by the TeamSpeak API are available for plugins. If a method that you need is missing, please file an issue or open a pull request.
Add the following to your Cargo.toml:
[lib]
name = "<pluginname>"
crate-type = ["cdylib"]
[dependencies]
ts3plugin = "0.3"This code can be used to make your library a TeamSpeak plugin:
#[macro_use]
extern crate ts3plugin;
use ts3plugin::*;
struct MyTsPlugin;
impl Plugin for MyTsPlugin {
fn name() -> String { String::from("My Ts Plugin") }
fn version() -> String { String::from("0.1.0") }
fn author() -> String { String::from("My Name") }
fn description() -> String { String::from("A wonderful tiny example plugin") }
// Optional
fn command() -> Option<String> { Some(String::from("myplugin")) }
fn autoload() -> bool { false }
fn configurable() -> ConfigureOffer { ConfigureOffer::No }
fn new(api: &mut TsApi) -> Result<Box<MyTsPlugin>, InitError> {
api.log_or_print("Inited", "MyTsPlugin", LogLevel::Info);
Ok(Box::new(MyTsPlugin))
// Or return Err(InitError::Failure) on failure
}
// Implement callbacks here
fn shutdown(&mut self, api: &mut TsApi) {
api.log_or_print("Shutdown", "MyTsPlugin", LogLevel::Info);
}
}
create_plugin!(MyTsPlugin);Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Template code that is needed to run the rust code in this file as a test:
{}
fn main(){{}}