Rust implementation of the Buttplug Intimate Hardware Protocol, including implementations of the client and, at some point, server.
For a demo of what this framework can do, check out this demo video.
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.
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.
On Windows and macOS, running
cargo build should suffice for building the
project. All dependencies are vendored in.
On Linux, the following packages will be needed to build with default features:
libudev-dev(Required for serial port/HID support)
libusb-1.0-0-dev(Required for serial port/HID support)
The package names are listed as their debian requirements, and may be different
for other distributions. Removing the
serial-manager features should stop these from being requires.
To use Buttplug in your rust application or library, check out the buttplug package on crates.io.
The following crate features are available
|Feature||Other Features Used||Description|
|None||Buttplug client implementation (in-process connection only)|
|None||Buttplug server implementation (in-process connection only)|
|None||Serde JSON serializer for Buttplug messages, needed for remote connectors|
|Websocket connectors, used to connect remote clients/servers, with or without SSL|
|Bluetooth hardware support on Windows 10, macOS, Linux, iOS|
|Lovense USB Dongle support on Windows 7/10, macOS, Linux|
|Serial Port hardware support on Windows 7/10, macOS, Linux|
|XInput Gamepad support on Windows 7/10|
|None||Uses async-std/smol executor for futures|
|None||Runtime that panics on any spawn. Only used for tests.|
|None||Uses default thread pool executor for futures|
(Tokio coming soon)
Default features are enough to build a full desktop system:
xinput-manager(feature is only relevant on windows, but builds as a noop on all other platforms).
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!
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.
Communications API for accessing Buttplug Servers
Methods for establishing connections between Buttplug Clients and Servers
Protocol message and error definitions.
Handles client sessions, as well as discovery and communication with hardware.
Utility module, for storing types and functions used across other modules in the library.