simploxide-client 0.10.0

SimpleX-Chat API client
Documentation

simploxide-client

SimpleX-Chat bot API client

🤖Try out SimplOxide bots right now!

  1. Install Rust if you haven't already.
  2. Get SimpleX chat CLI
  3. Ensure that SimpleX Chat CLI is available globally: simplex-chat --version
  4. Run the squaring bot: 
    cargo run --example squaring_bot
    You can run any bot from examples/ directory by changing the --example argument.

    1. Interact with the bot:

      Interactions Screenshot

Some examples require you to follow specific setup instructions, make sure you read the top-level comments of an example to setup everything correctly.

Explore bot sources or read crate docs to learn how to write your own bots.

LICENSE

DISCLAIMER

SIMPLEX CLI HAS AN OPEN WEBSOCKET API, AND IT CAN BE ACCESSED FROM ANY LIBRARY OR APPLICATION, WHETHER OPEN-SOURCE OR NOT. THE SIMPLOXIDE LIBRARIES PROVIDE A WEBSOCKET CLIENT AND API CODECS FOR SIMPLEX CLI THAT DON'T DEPEND ON ANY CODE FROM THE SIMPLEX PROJECT AND THEREFORE ARE DUAL LICENSED UNDER APACHE-2.0/MIT AS STATED BELOW. APACHE-2.0/MIT TERMS AND CONDITIONS ARE APPLICABLE TO YOUR PROJECTS AS LONG AS THEY DON'T:

  • SHIP SIMPLEX-CLI OR ANY OTHER SIMPLEX COMPONENTS AS PART OF AN APPLICATION
  • USE FFI BINDINGS
  • DEPEND ON OR INCLUDE ANYTHING ELSE LICENSED UNDER AGPL

OTHERWISE, YOUR PROJECTS MUST ADHERE TO SIMPLEX AGPL-3.0.

ENABLING THE ffi FEATURE IN THIS CRATE(INCLUDING VIA THE fullffi META-FEATURE) DIRECTLY ACTIVATES FFI BINDINGS AND TRIGGERS THE CONDITION ABOVE. YOUR PROJECT BECOMES SUBJECT TO AGPL-3.0.

SIMPLOXIDE LIBRARIES AUTHORS DISCLAIM ALL RESPONSIBILITY AND LIABILITY FOR ANY FAILURE BY SIMPLOXIDE USERS TO COMPLY WITH THE AGPL-3.0.

Licensed under either of Apache License, Version 2.0 or MIT license at your option, unless the ffi feature is enabled, in which case AGPL-3.0 applies.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.