Skip to content

Updated to use rive runtime databinding api#250

Merged
JCash merged 335 commits intomainfrom
editor-plugin-update
Apr 1, 2026
Merged

Updated to use rive runtime databinding api#250
JCash merged 335 commits intomainfrom
editor-plugin-update

Conversation

@JCash
Copy link
Copy Markdown
Contributor

@JCash JCash commented Mar 10, 2026

⚠️ Breaking Change!!! ⚠️

⚠️ This is a complete overhaul of the Lua bindings. See the rive.script_api file, or use the editor code completions to read more.

The editor rendering of the Rive scenes is now also updated.

  • Docs are generated (as there are no official docs to read from)
  • rive.* functions work on the Defold components, to get or set e.g. the default file, artboard, statemachine, and viewmodel
  • rive.cmd.* functions are a 1:1 mapping to the rive api in command_queue.hpp.
  • It's possible to register global listener callbacks for the different handle types, and also properties
  • The api is asynchronous, and as such there are no true "getters". Use the listeners
    • If you set a property, it's cached, and you can get it synchronously
  • Linux backend now uses Vulkan (as the Rive OpenGL backend is broken on Linux).
  • Required Defold 1.12.3+

⚠️ Removed or disabled functionalities, related to the support of Rive's official command queue api.
In terms of function parity, we model our extension after the functionality of the Rive Unreal plugin.

  • There is no way to attach a game object to a Rive bone in e.g. a character
  • Playing individual animations is not supported anymore.
    • No events are received from animation finished or animation looping
  • Each rive file needs to have at least one state machine

Fixes #198

JCash and others added 28 commits March 25, 2026 15:38
@JCash JCash merged commit 356dbf4 into main Apr 1, 2026
3 checks passed
@JCash JCash deleted the editor-plugin-update branch April 1, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Data Bindings: add support for Lists, Images, and Artboards

4 participants