Rivet Godot 4 Plugin

---

📦 Installation

Godot Asset Library (recommended)

1. Within your Godot project, click Asset Library
2. Search for "Rivet"
3. Install the plugin
4. Support the project by giving the Rivet GitHub repo a star.

Using gd-plug

1. Add this line to your plug.gd:

plug("rivet/plugin-godot")

2. Support the project by giving the Rivet GitHub repo a star.

Build from source

1. Ensure the prerequisites are installed:
   • Git LFS
   • Rust
   • Deno
2. Clone this repository
3. Build the plugin using deno run -A scripts/build_dev.ts
4. Copy the plugin-godot/addons/rivet folder to your-godot-project/addons/rivet.
5. Enable this addon within the Godot settings Project > Project Settings > Plugins
6. Support the project by giving the Rivet GitHub repo a star.

Manual installation

1. Download the desired release from: https://releases.rivet.gg/plugin-godot/{VERSION}/rivet-plugin-godot.zip
   • Replace {VERSION} with the desired release, e.g. v2.3.0. See all releases here.
2. Copy the plugin-godot/addons/rivet folder to your-godot-project/addons/rivet.
3. Enable this addon within the Godot settings Project > Project Settings > Plugins
4. Support the project by giving the Rivet GitHub repo a star.

🚀 Getting started

Head over to our Documentation to get started with Rivet and Godot.

🏗️ Contributing

1. Look for any issue that describes something that needs to be done - or, if you're willing to add a new feature, create a new issue with an appropriate description.
2. Submit your pull request.
3. Rivet team will review your changes.
4. Join Rivet's Discord to ask questions & showcase your game.

📷 Examples

Each folder in the examples/ folder is its own independent Godot project.

See Enabling support for symbolic links on Windows below.

Troubleshooting

Enabling support for symbolic links on Windows

Only relevant for testing examples.

This repository relies on use of symbolic links in order to re-use the addons/rivet/ folder inside of examples/*/addons/rivet/.

If you don't files in the folder examples/*/addons/rivet/, do the following:

Enable developer mode

1. Open Settings

2. Navigate to Updates & Security > For Developers

3. Enable Developer Mode

   

Enable symlinks in Git

1. Delete the plugin-godot folder

2. Download and run the Git installer (even if Git is already installed)

3. Uncheck Only show new options at the bottom of the window

4. Click Next until you see the Configuring extra options screen

5. Check Enable symbolic links

6. Finish the installation

7. Re-clone the repository. You should see files under examples/*/addons/rivet/.