SimpleX-Chat bot SDK for Rust.
- 🤖Try out example bots
- 💡See crate docs for guidance on how to make one.
Right now you're supposed to use the
simploxide-client crate it
provides a native Rust support for everything described in SimpleX API
docs as well as
high-level idiomatic wrappers. Once the SDK matures and stabilizes this crate
could be split into 2: simploxide - providing the highest level API;
simploxide-client - providing the mid-level API for uncommon tasks.
The other crates are:
-
simploxide-ws-core: SimpleX-Chat raw websocket client. You can use this crate directly if you want to work with raw SimpleX commands and deal with parsing JSON responses on your own.
-
simploxide-ffi-core: A raw client interface implemented on top of SimpleX-Chat FFI bindings(
simploxide-sxcrt-sys). Can be used instead ofsimploxide-ws-coreto run everything within a single process. -
simploxide-core: A common code shared by all simploxide crates. Not very useful on its own.
-
simploxide-sxcrt-sys: Raw bindings to SimpleX-Chat with minimal safe wrappers. Can be used directly to implement runtimes alternative to
simploxide-ffi-core. Linking this crate makes you subject to theAGPL-3.0. -
simploxide-api-types: Autogenerated from SimpleX API docs Rust types and traits with serialization, command syntax interpretation, and even some syntax sugar support. You may want to use this crate explicitly if you're implementing your own SimpleX clients in Rust(e.g. non-tokio/sync runtimes).
-
simploxide-bindgen: A crate that produces
simploxide-api-typesfiles and automatically keeps them up to date by parsing the upstream documentation and generating the code from it. You can use this crate as a library to generate SimpleX API bindings for other languages. -
simploxide: An empty crate reserved for the future use.
This table, similar to some crates in this repository, is updated automatically by autoupdater.sh during scheduled CI runs
| SimplOxide Version | Simplex Chat Min Version | Simplex Chat Max Version |
|---|---|---|
| 0.14.0 | 7.0.0.0 | 7.0.0.0 |
| 0.13.0 | 6.5.5.0 | 6.5.6.0 |
| 0.12.0 | 6.5.4.0 | 6.5.4.1 |
| 0.11.0 | 6.5.3.0 | 6.5.3.0 |
| 0.10.0 | 6.5.2.0 | 6.5.2.0 |
| 0.9.0 | 6.4.5.1 | 6.4.10.0 |
- Teleghosts: Telegram <-> SimpleX-Chat direct messages bridge
simploxide-client: APACHE-2.0 or MIT when "ffi" feature is not used, AGPL-3.0 otherwisesimploxide-ws-core:APACHE-2.0 or MITsimploxide-ffi-core:AGPL-3.0simploxide-core:APACHE-2.0 or MITsimploxide-sxcrt-sys:AGPL-3.0simploxide-bindgen:APACHE-2.0 or MITsimploxide-api-types:APACHE-2.0 or MIT