Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.12 KB

README.md

File metadata and controls

54 lines (35 loc) · 2.12 KB

buttplug-py

PyPi version Python version Discord

Buttplug-py is a python implementation of the Client of the Buttplug Sex Toy Control Protocol. It allows users to write applications that can connect to Buttplug Servers, such as Intiface Central or Intiface Engine.

For more information on the Buttplug project, check out the project website at buttplug.io.

Officiality

Buttplug-py is not officially supported by the developers of Buttplug, it is a community maintained project. There is an outdated official Python client that can be found in buttplugio/buttplug-py.

Table Of Contents

Support The Project

If you find this project helpful you can support me via Ko-Fi. Every donation helps to maintain this library up to date and adding new features.

ko-fi

Buttplug developer's Patreon can be used if you wish to support the Buttplug project.

Documentation

Currently, the documentation of the library is limited to class and methods documentations. The main entrypoint is the Client class which will guide the reader forward.

Examples

Example code is available in the examples/ directory. Examples are heavily commented to hopefully make usage of the library clearer.

License

Buttplug-py is BSD 3-Clause licensed. More information is available in the LICENSE file.

Changelog

The full changelog can be found here.