gamesense/lib.rs
1//! SteelSeries GameSense™ client written in Rust
2//!
3//!
4//! To use this crate, simply add it as a dependency:
5//! ```toml
6//! [dependency]
7//! gamesense = "0.1.2"
8//! ```
9//!
10//!
11//! To get started, simply instantiate your client using the [`gamesense::client::GameSenseClient`][client::GameSenseClient] struct.
12//! ```
13//! let mut client = GameSenseClient::new("GAME_ID", "Game Display Name", "Author", None)?;
14//! ```
15//!
16//! In this example, a client is created to the local API and it automatically creates a game with the provided values. Each value
17//! deemed optional by the official documentation can receive `None` as a value to default it to the server's default.
18//! If you wish to have a raw client for the API, you can! Simply use the [`gamesense::raw_client::RawGameSenseClient`][raw_client::RawGameSenseClient]
19//!
20//! For more (in-depth) examples refer to the [examples](https://github.com/ptrstr/gamesense/tree/master/examples)
21//!
22//! For information regarding the API see the [original API documentation](https://github.com/SteelSeries/gamesense-sdk)
23
24extern crate anyhow;
25extern crate reqwest;
26extern crate serde;
27extern crate serde_json;
28extern crate serde_repr;
29
30
31mod timer;
32pub mod handler;
33pub mod raw_client;
34pub mod client;