Skip to content

Commit 75aa24b

Browse files
authored
Update README.md
1 parent b79ca46 commit 75aa24b

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# scripted-renderer-dev
1+
# FORG3D Rendering Tool
22

3-
This project is a **3D rendering tool** that takes any 2 Blender objects and renders them on a plane with customizable orientations, positions, distances, and camera angles.
3+
**FORG3D** _(Flexible Object Rendering for Generation of 3D Vision-Language Spatial Reasoning Datasets)_ is a **3D rendering tool** that takes any 2 Blender objects and renders them on a plane with customizable orientations, positions, distances, and camera angles.
44

55
## Setup
66

@@ -32,6 +32,17 @@ Download and install **[Blender 4.3](https://www.blender.org/download/)**.
3232
echo "/path/to/scripted-renderer-dev/src" > /path/to/blender/site-packages/scripted-renderer-dev.pth
3333
```
3434
- _Note: if you encounter errors on Windows, ensure the file encoding is **UTF-8 with BOM**._
35+
36+
### Step 4: Load Preset Objects or Add Your Own
37+
38+
- We have created 21 preset objects available in [this repository](https://github.com/compling-wat/FORG3D-object-data). You can load them into your `data` directory by:
39+
```bash
40+
cd data
41+
./load_objects.sh
42+
```
43+
44+
- Alternatively, you can add your own objects by placing `.blend` files inside the `data/objaverse/shapes` folder and specifying their properties in `properties.json`.
45+
3546

3647
## Usage
3748

@@ -101,6 +112,4 @@ _The goal is to enable comparisons between a fine-tuned spatial reasoning model
101112

102113
## Configuration
103114

104-
The tool's settings, such as **output directories, image resolution, and other scene configurations**, can be customized in `config.json` under the `src` directory.
105-
106-
You can also add your own objects by placing `.blend` files inside the `data` folder and specifying their properties in `properties.json`.
115+
The tool's general settings, such as **output directories, image resolution, and other scene configurations**, can be customized in `config.json` under the `src` directory.

0 commit comments

Comments
 (0)