https://github.com/Siege-Wizard/buttplug-py

Python client implementation of the Buttplug Intimate Hardware Control Protocol.
https://github.com/Siege-Wizard/buttplug-py

Last synced: 4 months ago
JSON representation

Python client implementation of the Buttplug Intimate Hardware Control Protocol.

• Host: GitHub
• URL: https://github.com/Siege-Wizard/buttplug-py
• Owner: Siege-Wizard
• License: other
• Created: 2022-11-26T11:40:35.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-25T07:15:06.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T02:53:18.357Z (5 months ago)
• Language: Python
• Size: 79.1 KB
• Stars: 29
• Watchers: 7
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-buttplug - buttplug-py

README

        
# buttplug-py

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

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

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

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](https://github.com/intiface/intiface-central) or

[Intiface Engine](https://github.com/intiface/intiface-engine).

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

[buttplug.io](https://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](https://github.com/buttplugio/buttplug-py).

## Table Of Contents

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

- [Documentation](#documentation)

- [Examples](#examples)

- [License](#license)

- [Changelog](#changelog)

## Support The Project

If you find this project helpful you can [support me via Ko-Fi](https://ko-fi.com/siegewizard).

Every donation helps to maintain this library up to date and adding new features.

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/siegewizard)

[Buttplug developer's Patreon](http://patreon.com/qdot) 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](LICENSE).

## Changelog

The full changelog can be found [here](CHANGELOG.md).