https://github.com/buttplugio/buttplug-py

Python implementation of core message system and client for the Buttplug Sex Toy Protocol Standard
https://github.com/buttplugio/buttplug-py

Last synced: about 2 months ago
JSON representation

Python implementation of core message system and client for the Buttplug Sex Toy Protocol Standard

• Host: GitHub
• URL: https://github.com/buttplugio/buttplug-py
• Owner: buttplugio
• License: other
• Created: 2018-11-05T01:07:28.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-02T01:41:53.000Z (about 2 years ago)
• Last Synced: 2024-10-03T18:46:41.791Z (3 months ago)
• Language: Python
• Homepage: https://buttplug-py.docs.buttplug.io
• Size: 74.2 KB
• Stars: 68
• Watchers: 8
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-buttplug - Buttplug Python

README

        
# buttplug-py (DEPRECATED)

[![PyPi version](https://img.shields.io/pypi/v/buttplug)](http://pypi.org/project/buttplug)

[![Python version](https://img.shields.io/pypi/pyversions/buttplug)](http://pypi.org/project/buttplug)

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)

[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)

[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

### THIS VERSION OF BUTTPLUG-PY IS DEPRECATED IN FAVOR OF [COMMUNITY MAINTAINED LIBRARIES](https://github.com/buttplugio/awesome-buttplug#python). 

The community maintained library brings in support for Buttplug Spec v3, as well as many nice to have features. It is recommended to use that instead of this library.

## Old Intro

Buttplug-py is a python implementation of the Core and Client portions of the Buttplug Sex Toy

Control Protocol. It allows users to write applications that can connect to Buttplug Servers, such

as the [Intiface Desktop Application](https://github.com/intiface/intiface-desktop) or [Intiface Rust CLI](https://github.com/intiface/intiface-cli-rs).

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

[https://buttplug.io](https://buttplug.io).

## Table Of Contents

- [Support The Project](#support-the-project)

- [Documentation](#documentation)

- [Examples](#examples)

- [License](#license)

## Support The Project

If you find this project helpful, you can [support us via Patreon](http://patreon.com/qdot) or

[Github Sponsors](http://github.com/sponsors/qdot)! Every donation helps us afford more hardware to

reverse, document, and write code for!

## Documentation

Library and API Documentation for buttplug-py is available at

https://buttplug-py.docs.buttplug.io

Other recommended reading includes

- [The Buttplug Protocol Spec](https://buttplug-spec.docs.buttplug.io)

- [The Buttplug Developer Guide](https://buttplug-developer-guide.docs.buttplug.io)

## Examples

Example code is available in the examples/ directory. Examples are heavily commented to hopefully

make usage of the library clearer.

## License

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