kibble-cabal/godot-rive

An integration of Rive into Godot 4 using GDExtension

Godot Rive

An integration of Rive into Godot 4.1+ using GDExtension

Warning

This extension is in alpha. That means:

• You may encounter some bugs
• It's untested on many platforms
• Most features are implemented, but the API may change a little

This extensions adds Rive support to Godot 4.

It makes use of the following third-party libraries:

• rive-cpp
• skia (included in rive-cpp)

Table of Contents

1. Features
2. Building
3. Installation
4. Roadmap
5. Contributing
6. Screenshots

Features

• Load .riv files (artboards, animations, and state machines)
• Listen for input events
• Change state machine properties in-editor and in code
• Robust API for runtime interaction
• Optimized for Godot

Building

Important

These instructions are only tested on M1 MacOS. You may have to modify build/build.py or build/SConstruct for your system.

The following must be installed:

• Python 3
• git
• scons
• ninja

To build, run the following commands (from the root directory):

cd build
python build.py

To see the available options, run:

python build.py --help

Installation

Important

If you are not on M1 MacOS, you will need to build the extension yourself. Binaries are only provided for MacOS universal (debug and release). Eventually, binaries will be provided for other platforms.

1. Copy demo/bin/, demo/icons/, and demo/rive.gdextension to your project folder
2. Update the paths in rive.gdextension to match your project folder structure

Roadmap

• Load .riv files
• Run and play Rive animations
• Raster image support
• Input events (hover, pressed, etc.)
• Alignment & size exported properties
• Multiple scenes/artboards
• Dynamic exported properties based on state machine
• API for interaction during runtime
• Add error handling
• Add signals for event listeners (hover, pressed, etc)
• Disable/enable event listeners (hover, pressed, etc) in API and editor
• Optimization
• Static editor preview
• Animated editor preview
• Add reset button
• .riv ResourceLoader (thumbnails)
• Other platform support
• Any missing features

Contributing

Help would be MUCH appreciated testing and/or building for the following platforms:

• Windows
• Android
• iOS
• Linux
• Web

Feel free to contribute bug fixes (see open issues), documentation, or features as well.

Screenshots

godot-rive's Issues

How can the project be used to make a working character in Godot

Hi @audse ,

Thank you for undertaking such a hugely demanded integration. Ive tried running the demo in godot 4.2 and it really displays the animations. I have experience with rive and flutter integration and ive looked really hard for an alternative to spline and was about to give up and go with skeleton2d godot native animation system when i stumbled upon your project and suddenly remembered Rive.

Did you have success implementing a basic usable character with it in Godot ? If yes can you give me pointers ?

Best regards.

Add `RiveViewer2D` class

The rive viewer extends Control – which means it can't easily be used as a child of Node2D.

• Move RiveViewer logic into a separate class (e.g. RiveViewerBase)
• Modify RiveViewer class to inherit Control and RiveViewerBase
• Add RiveViewer2D class, inherit Node2D and RiveViewerBase

Multiple inheritance may not be possible, so composition is fine as an alternative.

`RiveViewer` cannot be extended in GDScript

When a script is attached, nothing renders.

The current workaround is to only use RiveViewer as a child node.

This seems to be related to the _process method.

Add trigger inputs

I'm not sure how to handle Rive's "trigger" input type.

I'm thinking:

1. For runtime, add a function to RiveInput called trigger or fire or something
2. For the editor, I think there are two options. Either:
   a. Add a boolean to the editor input list that does not save it's state, or
   b. Add a button to the editor input list (may require an editor plugin?)

State machine inputs reset when scene is closed

Crash when `RiveViewer` node is scene root

Steps to reproduce (haven't tested, may be inaccurate)

1. Create scene with RiveViewer root node
2. Change file path

Rive render opensource

Now that Rive Render is open-source, do you have plans to integrate with it? I would really like to work on a project using Rive and Godot. Currently, they don't have official support, but your library does a great job. It would be great if you could port it to their Render, which reportedly has excellent performance according to them. Rive Renderer

`RiveViewer2D` should only listen for local input

Currently, this node responds to any input event, including ones that occur outside the Rive canvas. This should be changed to local events only, using local mouse position.

Replace `paused` prop with built-in `process_mode`

Add `*.riv` resource loader

The goals for this issue are:

• Show *.riv files in the file system
• Show a thumbnail for *.riv files
• Move loading logic out of RiveFile class

Getting this error when compiling on MacBook Pro M1

jjolton@PRO-F335Y build % python build.py
File "build.py", line 26
def Dim(text: str) -> str:
^
SyntaxError: invalid syntax

Am I missing something?

`RiveViewer` property list should use input's initial value

If you load a rive file with an input, the in-editor value for that input is either 0 (number) or false (bool), regardless of the initial value in the .riv file.

Add `RiveViewer3D` class

Windows 11 Compilation error

Input args:

PS C:\Users\sande\Downloads\godot-rive-main\build> python build.py -p=windows -t=debug

Debug Log Output:

Running Rive's build script...
Platform: windows
Target: debug
---
fatal: not a git repository (or any of the parent directories): .git
Traceback (most recent call last):
  File "C:\Users\sande\Downloads\godot-rive-main\build\build.py", line 236, in <module>
    build_rive(platform, target)
  File "C:\Users\sande\Downloads\godot-rive-main\build\build.py", line 75, in build_rive
    handle_fail(subprocess.call(args, cwd="../thirdparty/rive-cpp"))
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.9_3.9.3568.0_x64__qbz5n2kfra8p0\lib\subprocess.py", line 349, in call
    with Popen(*popenargs, **kwargs) as p:
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.9_3.9.3568.0_x64__qbz5n2kfra8p0\lib\subprocess.py", line 951, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.9_3.9.3568.0_x64__qbz5n2kfra8p0\lib\subprocess.py", line 1420, in _execute_child
    hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
FileNotFoundError: [WinError 2] The system cannot find the file specified

same logs when -t=release is used too

Editor crashes when changing file path

Doesn't happen every time, possibly affected by the values of scene and artboard props. Probably a nullptr error in src/rive_extension.cpp or src/rive_controller.cpp.

Has anyone successfully built on Windows?

I got an error after trying to build
`
Traceback (most recent call last):
File "D:\Godot\Godot_v4.2.2-stable_mono_win64\godot-rive\build\build.py", line 236, in
build_rive(platform, target)
File "D:\Godot\Godot_v4.2.2-stable_mono_win64\godot-rive\build\build.py", line 75, in build_rive
handle_fail(subprocess.call(args, cwd="../thirdparty/rive-cpp"))
File "C:\Users\a1247\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 349, in call
with Popen(*popenargs, **kwargs) as p:
File "C:\Users\a1247\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 951, in init
self._execute_child(args, executable, preexec_fn, close_fds,
File "C:\Users\a1247\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 1421, in _execute_child
hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
FileNotFoundError: [WinError 2]
Process finished with exit code 1

`

When no state machine is selected and the window is resized, nothing gets drawn

`RiveViewer` sometimes doesn't render when resized

In demo/main.tscn, a couple rive viewers (res://examples/joystick.riv, res://examples/rating-animation.riv) don't re-render when the container/window is resized. They just disappear. I am guessing it's related to their interactivity; those are the only two nodes in the scene that listen for hover/click events.