Features

• Read/Write/Convert supported script formats.

• Export scripts as Buttplug Protocol v4 command sequences.

  • Buttplug Protocol v3 and earlier are no longer supported. For v3 and earlier support, use a10sa-script>=1.0,<2.0

Experimental features

Experimental features are not fully tested, use at your own risk.

• Control Vorze devices directly via BluetoothLE (tested with CycloneSA, untested for UFOSA, PistonSA).

• Control linear/funscript devices via Buttplug Protocol (requires Intiface Central 3.0 or later, tested with Handy).

Bluetooth functionality requires installation with ``[ble]`` dependencies.

Supported Formats

• Vorze CSV

• Afesta/LPEG VCSX (.bin)

• Funscript JSON

Requirements

• Python 3.11+

Installation

You can install A10SA Script via pip from PyPI:

$ pip install a10sa-script

Optional dependencies can also be installed to enable experimental feature support:

$ pip install a10sa-script[ble]

Usage

Convert VCSX Vorze_CycloneSA.bin to script_cyclone.csv:

>>> from a10sa_script.script import VCSXCycloneScript, VorzeRotateScript
>>> with open("Vorze_CycloneSA.bin", "rb") as f:
...     vcsx = VCSXCycloneScript.load(f)
>>> with open("script_cyclone.csv", "wb") as f:
...     VorzeRotateScript(vcsx.commands).dump(f)

Convert CSV script_piston.csv to script.funscript:

>>> from a10sa_script.script import VorzeLinearScript, FunscriptScript
>>> with open("script_piston.csv", "rb") as f:
...     csv = VorzeLinearScript.load(f)
>>> with open("script.funscript", "wb") as f:
...     FunscriptScript.from_vorze(csv).dump(f)

Convert funscript script.funscript to script_piston.csv:

>>> from a10sa_script.script import VorzeLinearScript, FunscriptScript
>>> with open("script.funscript", "rb") as f:
...     funscript = FunscriptScript.load(f)
>>> with open("script_piston.csv", "wb") as f:
...     funscript.to_vorze().dump(f)

Please see the Command-line Reference Usage for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, A10SA Script is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.