README.md at buttplug-9.0.2 · buttplug.io/buttplug

buttplug.io / buttplug
Buttplug sex toy control library
buttplug / README.md
at buttplug-9.0.2 2.7 kB view raw view rendered
 1# Buttplug
 2
 3[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
 4[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
 5[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io)
 6[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
 7[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)
 8
 9[![Crates.io Version](https://img.shields.io/crates/v/buttplug)](https://crates.io/crates/buttplug)
10[![Crates.io Downloads](https://img.shields.io/crates/d/buttplug)](https://crates.io/crates/buttplug)
11[![Crates.io License](https://img.shields.io/crates/l/buttplug)](https://crates.io/crates/buttplug)
12
13<div align="center">
14  <h3>
15    <a href="https://docs.rs/buttplug">
16      API Documentation
17    </a>
18    <span> | </span>
19    <a href="https://docs.buttplug.io/docs/spec">
20      Protocol Spec
21    </a>
22    <span> | </span>
23    <a href="https://docs.buttplug.io/docs">
24      Developer Guide
25    </a>
26    <span> | </span>
27    <a href="https://awesome.buttplug.io">
28      Apps and Games List
29    </a>
30  </h3>
31</div>
32
33<p align="center">
34  <picture>
35    <source media="(prefers-color-scheme: light)" srcset="images/buttplug_rust_docs.png">
36    <source media="(prefers-color-scheme: dark)" srcset="images/buttplug_rust_docs_light.png">
37    <img src="https://raw.githubusercontent.com/buttplugio/buttplug/master/images/buttplug_rust_docs.png">
38  </picture>
39</p>
40
41A Rust implementation of the Buttplug Intimate Hardware Control Protocol, including a client and server. This is the core implementation of Buttplug.
42
43This repo is a monorepo with multiple projects, including:
44
45- [buttplug](buttplug/) - Rust implementation of the Buttplug protocol spec
46- [buttplug-schema](buttplug/buttplug-schema) - JSON schema for the Buttplug protocol spec
47- [buttplug-device-config](buttplug/buttplug-device-config) - Device configuration file for buttplug
48  (where we store all of the device identifiers)
49- [buttplug_derive](buttplug_derive/) - Procedural macros used by the buttplug rust library.
50
51For information about compiling and using these libraries, please check the
52README files in their directories.
53
54For a list of applications using Buttplug, see the [awesome-buttplug repo](https://github.com/buttplugio/awesome-buttplug).
55
56## Other Language Implementations
57
58See the [awesome-buttplug repo](https://github.com/buttplugio/awesome-buttplug#development-and-libraries) for a full list of implementations.