Documentation of protocols and server architecture for the Buttplug Sex Toy Control System
This repo houses specifications documents for the Buttplug Intimate Hardware Control Server Protocol (referred to hereafter as Buttplug).
Buttplug aims to simplify accessing and controlling different kinds of intimate hardware such as vibrators, strokers, and machines, as well as other devices like kegelcizers, electrostimulation systems, and whatever else seems like it could be intimate. The goal is to abstract line level (usb/bluetooth/serial/etc) protocol knowledge away from the developer, so they can concentrate on creating new and interesting interfaces, applications, games, and other software.
HTML rendered version of the Protocol Spec is at https://buttplug-spec.docs.buttplug.io/.
More information on the Buttplug project can be found at at https://buttplug.io.
If you're interested in Buttplug Development, check out our discord server!
There's also a message board for development and support at metafetish.club.
To build this document into HTML pages or pdfs, you'll need to use vuepress. We have a node package file available to install the version we use for development and build the book. Use the following commands to set it up.
npm install npm run build
To see a local version of the protocol docs:
npm run dev
If you find this project helpful, you can support us via Patreon! Every donation helps us afford more hardware to reverse, document, and write code for!
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.