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

buttplug.io / buttplug
Buttplug sex toy control library
buttplug / README.md
at buttplug-6.2.0 58 lines 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[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
 6[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)
 7
 8[![Crates.io Version](https://img.shields.io/crates/v/buttplug)](https://crates.io/crates/buttplug)
 9[![Crates.io Downloads](https://img.shields.io/crates/d/buttplug)](https://crates.io/crates/buttplug)
10[![Crates.io License](https://img.shields.io/crates/l/buttplug)](https://crates.io/crates/buttplug)
11
12<div align="center">
13  <h3>
14    <a href="https://docs.rs/buttplug">
15      API Documentation
16    </a>
17    <span> | </span>
18    <a href="https://buttplug-spec.docs.buttplug.io">
19      Protocol Spec
20    </a>
21    <span> | </span>
22    <a href="https://buttplug-developer-guide.docs.buttplug.io">
23      Developer Guide
24    </a>
25    <span> | </span>
26    <a href="https://github.com/buttplugio/buttplug-rs/releases">
27      Releases
28    </a>
29  </h3>
30</div>
31
32<p align="center">
33  <img src="https://raw.githubusercontent.com/buttplugio/buttplug-rs/dev/buttplug/docs/buttplug_rust_docs.png">
34</p>
35
36Main repo for the Buttplug project, including the protocol spec, device config, and a full Rust implementation of the Buttplug Intimate Hardware Control Protocol.
37
38This repo is a monorepo with multiple projects, including:
39
40- [Buttplug Protocol Specification](spec/) - Protocol spec and docs
41- [buttplug-schema](buttplug/buttplug-schema) - JSON schema for the Buttplug protocol spec
42- [buttplug-device-config](buttplug/buttplug-device-config) - Device configuration file for buttplug (where we store all of the device identifiers)
43- [buttplug](buttplug/) - Rust implementation of the Buttplug protocol spec
44- [buttplug_device](buttplug_derive/) - Procedural macros used by the buttplug rust library.
45
46
47For information about compiling and using these libraries, please check the
48README files in their directories.
49
50For a list of applications using Buttplug, see the [awesome-buttplug repo](https://github.com/buttplugio/awesome-buttplug).
51
52## Other Language Implementations
53
54See the [awesome-buttplug repo](https://github.com/buttplugio/awesome-buttplug) for a full list of implementations.
55
56- [Buttplug C#](https://github.com/buttplugio/buttplug-rs-ffi/tree/master/csharp)
57- [Buttplug JS/Typescript/WASM](https://github.com/buttplugio/buttplug-rs-ffi/tree/master/js)
58- [Buttplug Python](https://github.com/buttplugio/buttplug-py)