Sex Toys Protocols I Have Known And Loved - Documentation of Reverse Engineered Protocols for Commercial Sex Hardware
Switch branches/tags
Nothing to show
Clone or download
definite-purple and qdot Petroom documentation (#44)
Create petroom documentation to tackle issue #41.

Fixes #41
Latest commit 1f6708e Oct 12, 2018

README.md

Sex Toy Protocols I Have Known And Loved

Patreon donate button Discourse Forum Discord Twitter

STPIHKAL (pronouned stuff-eye-call): A Sex Robot Love Story

Rendered version at https://stpihkal.docs.buttplug.io/

Introduction

STPIHKAL is a compendium of sex toy protocols, ranging from hardware communications protocols, to firmware loaders, to video script formats, to whatever else we find. If it controls a protocol in some vaguely standard way, we'll document it and put it here.

The name STPIHKAL is an homage to PIHKAL: A Chemical Love Story. We're just experimenting with sticking slightly different things in our bodies.

Building

To build STPIHKAL into HTML pages or pdfs, you'll need to use gitbook. 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

This will build the HTML version of the book into the _book directory.

We keep a built version of the HTML version in our gh-pages branch, and it is updated on every commit to master.

Contributing

If we're missing anything or you'd like to see documentation or something, please file an issue and let us know!

Support The Project

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!

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

See LICENSE.md for full text.

STPIHKAL is covered under the following copyright

Copyright (c) 2017-2018, Nonpolynomial Labs LLC, All rights reserved.