Repository for the Buttplug Protocol JSON Message Schema
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
schema
.bookignore
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
README.md
package-lock.json
package.json

README.md

Buttplug Message Format JSON Schema

Build Status

Patreon donate button Discourse Forum Discord Twitter

This repo houses the central json schema for the Buttplug Sex Toy Control Server Protocol.

The JSON Schema for the Buttplug Message format is available in the 'schema' directory. This is the central source of truth for communicating with Buttplug clients and servers. The goal is to only update and not remove messages, but as with all protocols, this goal may be more of a dream than a reality. We'll be abiding by semantic versioning rules, with major version changes only on breaking changes to the schema.

More information on Buttplug and the hardware it supports can be found at https://buttplug.io.

Support The Project

If you find this project helpful, you can support us on Patreon! Every donation helps us afford more hardware to reverse, document, and write code for!

License

Buttplug is BSD licensed.

Copyright (c) 2016-2018, 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.