PyTVPaint 🐍 → 🦋

PyTVPaint is a type-safe Python library that wraps the George programming language commands in order to interact with the 2D animation software TVPaint.

It communicates through WebSocket to a custom C++ plugin running in an open TVPaint instance.

You can check the documentation for more details.

Installation

Requirements

• Windows (for now, see this)
• Python v3.9+
• TVPaint v11.5+
• TVPaint RPC plugin (install instructions here)

Install the package with Pip:

pip install pytvpaint

Simple example

from pytvpaint import george
from pytvpaint.project import Project

# Get access to tvp elements
project = Project.load("scene.tvpp", silent=True)

clip = project.current_clip
# Or get the clip by name
clip = project.get_clip(by_name="my_clip")

layer = clip.add_layer("my_new_layer")

# Check out other layers
for layer in clip.layers:
    print(layer.name)

# Get access to George functions
george.tv_rect(50, 50, 100, 100)

# Render your file
clip.render("./out.#.png", start=20, end=45)

project.close()

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Disclaimer

PyTVPaint is a project created at BRUNCH Studio to facilitate our development experience with George. The API is targeted at experienced developers and is by no means a replacement for TVPaint or George but simply builds on it.

We are not affiliated with the TVPaint development team and therefore can't fix any bugs in the software or the George API.

Please direct your issues appropriately; any issues with PyTVPaint should be submitted as an issue in this repository or the C++ plugin's repository, any issues with TVPaint the software should be addressed to the tvp support team.

For any questions on the limitations of our API, please head to this page.

License

MIT

TVPaint 12

TVPaint-12 compatibility has been added in the latest release. It requires a new version of the tvpaint-rpc plugin. The api has been tested with the new version of TVPaint and mostly works, however there are a lot of breaking changes and some bugs, check the release notes for more info. We currently do not advise using pytvpaint with TVPaint-12 in production.

Made with ❤️ at BRUNCH Studio