Skip to content

docs: update paths to rive files #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lancesnider wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs: update paths to rive files #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2fe0932
feat: add data binding
HayesGordon Jun 13, 2025
3bb0390
chore: clang formatting
HayesGordon Jun 13, 2025
0133ac5
chore: bump rive runtime submodule
HayesGordon Jun 15, 2025
b187809
feat: add windows build scripts
HayesGordon Jun 15, 2025
119715c
chore: fix build warnings
HayesGordon Jun 15, 2025
7442214
refactor: prefer camelCase
HayesGordon Jun 15, 2025
0ca10eb
docs: update paths to rive files
lancesnider Oct 29, 2025
caeb44f
Merge branch 'main' into update-db-docs
lancesnider Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ build/dependencies

# examples
examples/generated/
output/

# test
test/output/
Expand Down
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ See the [release workflow](.github/workflows/release_workflow.yaml) for release

The latest release can be downloaded from the [Releases](https://github.com/rive-app/rive-code-generator-wip/releases) page.

## Setup

See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed setup instructions.

## Usage

Run the code generator using:
Expand All @@ -64,15 +68,15 @@ Run the code generator using:
Example:

```sh
./build/out/lib/release/rive_code_generator -i ./examples/rive_files/animation.riv -o ./examples/generated_code.dart -l dart
./build/out/lib/debug/rive_code_generator -i ./samples/rewards.riv -o ./output/generated_code.dart -l dart
```

## Custom Templates

You can use custom Mustache templates for code generation:

```sh
./build/out/lib/release/rive_code_generator -i ./rive_files/ -o ./output/rive.json -t templates/json_template.mustache
./build/out/lib/debug/rive_code_generator -i ./samples/rewards.riv -o ./output/rive.dart -t templates/viewmodel_template.mustache
```

Sample templates are available in the [`templates`](./templates) directory.
Expand Down