rive-app / rive-app/rive-unity

Header File / Exported Functions Documentation

Open
#122 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

triage
Dominant language
C#
Stars
205
Forks
22
PR merge metrics
No merged PRs in 30d

Description

Are there any plans to make documentation or at the very least release a .h file with the native DLL functions that are exported to Unity?

It is strange considering the runtime is open source but these compiled DLL builds do not seem to have any guidance on that front. This makes it difficult to upkeep between Unity versions or invest time into the runtime if it happens to lose support. For example I don't expect the Rive team to adapt to Unity's new render graph but would like to implement such things myself.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the native DLL functions exported to Unity and any existing runtime guidance, then determine whether a .h file or documentation is the appropriate deliverable; done means Unity users can understand and maintain the exported interface.

Written by the indexing model from the issue text.

Assessment

Tech stack
unity
Domain
documentation, game-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.