Skip to content
Buttplug Developer Guide
Branch: master
Clone or download
Latest commit ae08053 Jan 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
developer-guide Fix spacing on feedback link Jan 17, 2019
examples
extras Move or remove extra/old chapters Jan 16, 2019
.gitignore
.travis.yml Add project docs, remove S3 directives from CI Jun 19, 2018
CODE_OF_CONDUCT.md Add project docs, remove S3 directives from CI Jun 19, 2018
CONTRIBUTING.md Add project docs, remove S3 directives from CI Jun 19, 2018
LICENSE.md Add project docs, remove S3 directives from CI Jun 19, 2018
README.md
package.json Convert to vuepress Jan 14, 2019
yarn.lock Convert to vuepress Jan 14, 2019

README.md

Buttplug Developer guide

Patreon donate button Discourse Forum Discord Twitter

A guide to developing with the Buttplug Intimate Hardware Control Library. Discusses common strategies and best practies for using the library to build new applications.

Rendered version at https://buttplug-developer-guide.docs.buttplug.io/

Building

To build the document 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 also 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.
You can’t perform that action at this time.