> For the complete documentation index, see [llms.txt](https://docs.deemos.dev/addon/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.deemos.dev/addon/readme-godot.md).

# Rodin add-on for Godot

### Introduction

The Rodin Bridge for Godot is a powerful integration tool that supports most of the functions available on [Rodin's webpage](https://hyper3d.ai), allowing users to access image-based generation capabilities directly within the Godot editor environment. It enables users to replace target images, adjust generation settings, utilize ControlNet with selected objects, and choose between automatic and manual generation modes—all while maintaining a seamless workflow between Godot and the Rodin web interface through the convenient floating window functionality.

<figure><img src="/files/wOjRCyqTB0oeFNBg4m42" alt=""><figcaption></figcaption></figure>

### Installation

**Requirements**

Godot ≥ 4.4\
Google Chrome ≥ 116

**Step-by-Step Instruction**

Copy the `/RodinBridge` folder into the `/addons` folder within your Godot project.

Then, enable RodinBridge in Project → Project Settings → Plugins.

<figure><img src="/files/s3xXHofPzxpYn53aCYAB" alt=""><figcaption></figcaption></figure>

### Basic Usage

The RodinBridge integrates most Rodin's generation functions directly in Godot. Operation requires interaction in both Godot and the Rodin webpage.

**Single Image Generation**

1. Click 'Replace Image' to replace the default image with the image you want to generate the 3D asset with.
2. Choose 'None' in ControlNet options and choose 'One Click' for the fastest generation experience. The rest of the settings are identical to those on Rodin webpage.
3. Once they are adjusted, click 'Submit' to begin the process.

<figure><img src="/files/tlr1Ir60x3M7e8RxJ766" alt=""><figcaption></figcaption></figure>

The Rodin webpage will automatically appear if not already open. On the Rodin webpage, activate the floating window using the toggle switch.

You can monitor the generation process in the floating window. The generated asset will be automatically imported into Godot.

<figure><img src="/files/Hkci7tcJusxPsOkXQJx3" alt=""><figcaption></figcaption></figure>

You can also import featured assets or generated assets by hovering on the target asset and press the emerged **Export** button

<figure><img src="/files/0sHC7qKVNki6fR3evUem" alt=""><figcaption></figcaption></figure>

### Advanced Functions

**ControlNet:**

To enable ControlNet, select an object in scene and choose your desired ControlNet mode. You can the adjest ControlNet settings as needed (Identical to Rodin webpage settings).

<figure><img src="/files/Bsn57jjLlZaxQZ73uLmY" alt=""><figcaption></figcaption></figure>

**Multiview Mode:**

You can use 'Load Image' to add more images as the input for generation. Rodin will automatically process them as the input for multiview generation.

<figure><img src="/files/y5miHpLbKL6ClCCJbyR5" alt=""><figcaption></figcaption></figure>

**Generation Mode:**

You can choose between **One Click** mode and **Manual mode**.

**One Click**: Process runs without step-by-step guidance.

<figure><img src="/files/kEyZOEW7a3ClvXwmlthe" alt=""><figcaption></figcaption></figure>

**Manual**: Requires step-by-step operation in the floating window. The process is identical to that on Rodin webpage.

<figure><img src="/files/B7vzupgzqBMHQXpAlrUW" alt=""><figcaption></figcaption></figure>