[][src]Crate buttplug

Buttplug (Rust Implementation)

Patreon donate button Github donate button Discourse Forum Discord Twitter

Crates.io Version Crates.io Downloads Crates.io License

API Documentation | Protocol Spec | Developer Guide | Releases

Rust implementation of the Buttplug Intimate Hardware Protocol, including implementations of the client and, at some point, server.

Read Me First!

If you are new to Buttplug, you most likely want to start with the Buttplug Website or the Buttplug Core Repo.

For a demo of what this framework can do, check out this demo video.

Buttplug-rs is a full fledged implementation of Buttplug, on par with our C# and Javascript/Typescript implementations.

Buttplug-rs is currently capable of controlling toys via:

  • Bluetooth LE
  • Serial Ports
  • USB HID
  • Lovense Devices via the Lovense Dongle (All Versions)
  • XInput gamepads (Windows only)

Note that only some protocols/hardware is currently supported. See IOSTIndex for more info.

Introduction

Buttplug is a framework for hooking up hardware to interfaces, where hardware usually means sex toys, but could honestly be just about anything. It's basically a userland HID manager for things that may not specifically be HID.

In more concrete terms, think of Buttplug as something like osculator or VRPN, but for sex toys. Instead of wiimotes and control surfaces, we interface with vibrators, electrostim equipment, fucking machines, and other hardware that can communicate with computers.

The core of buttplug works as a router. It is a Rust based application that connects to libraries that registers and communicates with different hardware. Clients can then connect over websockets or network ports, to claim and interact with the hardware.

Usage

To use Buttplug in your rust application or library, check out the buttplug package on crates.io.

The following crate features are available

FeatureOther Features UsedDescription
clientNoneButtplug client implementation (in-process connection only)
serverNoneButtplug server implementation (in-process connection only)
serialize-jsonNoneSerde JSON serializer for Buttplug messages, needed for remote connectors
websocketsasync-std-runtimeWebsocket connectors, used to connect remote clients/servers, with or without SSL
btleplug-managerserverBluetooth hardware support on Windows 10, macOS, Linux, iOS
lovense-dongle-managerserverLovense USB Dongle support on Windows 7/10, macOS, Linux
serial-managerserverSerial Port hardware support on Windows 7/10, macOS, Linux
xinput-managerserverXInput Gamepad support on Windows 7/10
async-std-runtimeNoneUses async-std/smol executor for futures
dummy-runtimeNoneRuntime that panics on any spawn. Only used for tests.
thread-pool-runtimeNoneUses default thread pool executor for futures

(Tokio coming soon)

Default features are enough to build a full desktop system:

  • thread-pool-runtime
  • client
  • server
  • serialize-json
  • websocket
  • btleplug-manager
  • serial-manager
  • lovense-dongle-manager
  • xinput-manager (feature is only relevant on windows, but builds as a noop on all other platforms).

Contributing

Right now, we mostly need code/API style reviews and feedback. We don't really have any good bite-sized chunks to mentor the implementation yet, but one we do, those will be marked "Help Wanted" in our github issues.

As we need money to keep up with supporting the latest and greatest hardware, we also have multiple ways to donate!

License

Buttplug is BSD licensed.

Copyright (c) 2016-2019, Nonpolynomial Labs, LLC
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of buttplug nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Modules

client

Communications API for accessing Buttplug Servers

connector

Methods for establishing connections between Buttplug Clients and Servers

core

Protocol message and error definitions.

device
server

Handles client sessions, as well as discovery and communication with hardware.

test
util

Utility module, for storing types and functions used across other modules in the library.