Browser based tutorial for Buttplug setup
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.
assets
buttplug-twine
src
sugarcube-2
util
.eslintrc
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
Makefile
README.md
deploy_rsa.enc

README.md

Buttplug Tutorial

Patreon donate button Discourse Forum Discord Twitter

This repo contains a web-based tutorial for using the Buttplug Sex Toy Control Protocol. It is built with the Twine Interactive Fiction Engine and Buttplug Twine Addon Macros.

To run the tutorial, visit https://tutorial.buttplug.world.

Table Of Contents

Buttplug

For more information on the Buttplug Sex Toy Control Protocol, visit the main repo at

https://github.com/buttplugio/buttplug

There, you can find more information on the protocol, as well as library implementations and other applications using the protocol.

Building

Building the tutorial requires tweego, which in turn will require the go language environment installed on your machine.

To install tweego using our Makefile, you can run

make install

This will install the tweego package for you, or upgrade it if it's already installed.

Once you have tweego installed, you can just run "make" and it will build the tutorial into the "build" directory.

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

buttplug-js is BSD 3-Clause licensed.

Copyright (c) 2017-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 the project 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.