5 releases
0.1.4 | Apr 6, 2023 |
---|---|
0.1.3 | Apr 6, 2023 |
0.1.2 | Feb 5, 2023 |
0.1.1 | Jan 10, 2023 |
0.1.0 | Jan 10, 2023 |
#530 in Game dev
35 downloads per month
34KB
417 lines
tts-external-api
A Rust implementation of the External Editor API for Tabletop Simulator.
This is intended to make it easier to write development tools and plugins instead of using the built-in script editor.
ExternalEditorApi
This is the client/server representing the editor. You can listen for connections from an active instance of Tabletop Simulator, and send messages to an active instance.
use tts_external_api::ExternalEditorApi;
fn main() {
let api = ExternalEditorApi::new();
api.execute(String::from("print('Hello World')")).unwrap();
}
Outgoing Messages
You can send four types of outgoing messages:
Get Lua Scripts
use tts_external_api::{messages::AnswerReload, ExternalEditorApi};
fn get_lua_scripts(api: ExternalEditorApi) {
let answer_reload: AnswerReload = api.get_scripts().unwrap();
println!("{:#?}", answer_reload.script_states);
}
Save & Play
use tts_external_api::{json, messages::AnswerReload, ExternalEditorApi};
fn save_and_play(api: ExternalEditorApi) {
// Objects not mentioned in the script_states are not updated
let answer_reload: AnswerReload = api.reload(json!([])).unwrap();
println!("{:#?}", answer_reload);
}
Custom Message
use tts_external_api::{json, ExternalEditorApi, Value};
fn custom_message(api: ExternalEditorApi) {
let message: Value = json![{"foo": "Foo", "bar": "Bar"}];
api.custom_message(message).unwrap();
}
Execute Lua Script
use tts_external_api::{messages::AnswerReturn, ExternalEditorApi};
fn execute_lua_script(api: ExternalEditorApi) {
// JSON strings will be deserialized if possible
let answer_return: AnswerReturn = api
.execute(String::from(
"return JSON.encode({foo = 'Foo', bar = 'Bar'})",
))
.unwrap();
println!("{:#?}", answer_return.return_value);
}
Incoming Messages
You can also listen to eight types of incoming messages:
Pushing New Object
use tts_external_api::{messages::AnswerNewObject, ExternalEditorApi};
fn await_new_object(api: ExternalEditorApi) {
let answer_new_object: AnswerNewObject = api.wait();
println!("{:#?}", answer_new_object);
}
Loading a New Game
use tts_external_api::{messages::AnswerReload, ExternalEditorApi};
fn await_reload(api: ExternalEditorApi) {
let answer_reload: AnswerReload = api.wait();
println!("{:#?}", answer_reload);
}
Print/Debug Messages
use tts_external_api::{messages::AnswerPrint, ExternalEditorApi};
fn await_print(api: ExternalEditorApi) {
let answer_print: AnswerPrint = api.wait();
println!("{:#?}", answer_print);
}
Error Messages
use tts_external_api::{messages::AnswerError, ExternalEditorApi};
fn await_error(api: ExternalEditorApi) {
let answer_error: AnswerError = api.wait();
println!("{:#?}", answer_error);
}
Custom messages
use tts_external_api::{messages::AnswerCustomMessage, ExternalEditorApi};
fn await_custom_message(api: ExternalEditorApi) {
let answer_custom_message: AnswerCustomMessage = api.wait();
println!("{:#?}", answer_custom_message);
}
Return messages
use tts_external_api::{messages::AnswerReturn, ExternalEditorApi};
fn await_return(api: ExternalEditorApi) {
let answer_return: AnswerReturn = api.wait();
println!("{:#?}", answer_return);
}
Game Saved
use tts_external_api::{messages::AnswerGameSaved, ExternalEditorApi};
fn await_game_saved(api: ExternalEditorApi) {
let answer_game_saved: AnswerGameSaved = api.wait();
println!("{:#?}", answer_game_saved);
}
Object Created
use tts_external_api::{messages::AnswerObjectCreated, ExternalEditorApi};
fn await_object_created(api: ExternalEditorApi) {
let answer_object_created: AnswerObjectCreated = api.wait();
println!("{:#?}", answer_object_created);
}
Unspecified Message
Or you can wait for any incoming message:
use tts_external_api::{messages::Answer, ExternalEditorApi};
fn await_message(api: ExternalEditorApi) {
let answer: Answer = api.read();
match answer {
Answer::AnswerNewObject(_) => println!("pushing new object"),
Answer::AnswerReload(_) => println!("loading new game"),
Answer::AnswerPrint(_) => println!("print/debug message"),
Answer::AnswerError(_) => println!("error message"),
Answer::AnswerCustomMessage(_) => println!("custom message"),
Answer::AnswerReturn(_) => println!("return message"),
Answer::AnswerGameSaved(_) => println!("game saved"),
Answer::AnswerObjectCreated(_) => println!("object created"),
}
}
Dependencies
~0.7–1.4MB
~32K SLoC