Technical Documentation – Reading .RIV Files in the Control Panel
🧪 Current panel version: BETA
📌 Objective
This documentation explains what our platform's control panel can interpret and control from .riv files produced in the Rive App.
✅ Currently Supported Features
Our panel already supports various essential features for dynamic and interactive animation control. Reading is based on data bindings defined in the Rive App.
📥 Supported Bindings (State Machine Inputs)
Type
Support
Description
✅ Trigger
✅ Boolean
✅ Number
✅ Color
✅ String
✅ Enum
Total
Total
Total
Total
Total
Total
Triggers actions or transitions
Toggles states
Controls properties such as position
Allows real-time color changes
Displays dynamic text
Switches between fixed states
These input types are displayed in appropriate interactive controls (buttons, text fields, selectors, etc.), allowing full integration into your livestreams or external systems.
❌ Features that are not yet supported
(in development)
We are constantly expanding our panel's support. Below are the items that are not yet compatible, but are on our implementation roadmap:
🔒 Data bindings not yet read:
Type
Status
Notes
⛔ Image
⛔ List
⛔ List Attributes
Not supported
Not supported
Not supported
Image changes via panel not supported yet
No support for value or element lists
Reading attributes inside lists is not available yet
❌ Structural features that we have not yet read:
Item
Status
Notes
⛔ Multiple State Machines
⛔ Events
⛔ MOUSE Interactions
⛔ Listeners
⛔ Timeline control outside the State Machine
⛔ Conditional or logical bindings
⛔ Real-time external data integration
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Only the first state machine is currently read
Custom events defined in Rive are not triggered
Interactions like click or drag are not recognized yet
Only the main artboard is recognized by the panel
No direct timeline control unless linked to a state machine
Internal logic is not yet interpreted
In the future, integration with data like scoreboards, chats, APIs, etc. will be possible
📁 .RIV File Requirements
To ensure compatibility and proper functioning of your .RIV file, follow these guidelines:
- Use only one state machine per file (for now).
- Name the inputs clearly and objectively (e.g.
showScore,bgColor,teamName). - Avoid lists and images with bindings, until support is implemented.
- Optimize the .riv file size, to avoid real-time loading overload.
💡 Best Practices and Recommendations
Follow these best practices to ensure the best possible experience when working with .RIV files:
- Test your
.rivfile directly in the Rive App before uploading to the platform. - Use only the currently supported binding types to ensure full functionality.
- In case of errors, send the file to our technical team for review.
- Stay updated – new features are constantly being released.