# Use our API to generate a 3D scene
worldgen = WorldGen()
worldgen.generate_world("")

Image-to-Scene Generation

# Clone the repository 
git clone https://github.com/ZiYang-xie/WorldGen.git
cd WorldGen

# Create a new conda environment
conda create -n worldgen python=3.11
conda activate worldgen

# Install torch and torchvision
pip install torch torchvision

# Install worldgen
pip install .

# 🖼️ Generate a 3D scene from an image
worldgen = WorldGen(mode=”i2s”, device=device)
image = Image.open(“path/to/your/image.jpg”)
splat = worldgen.generate_world(
image=image,
prompt=”“,
)

# Save splat file as a .ply file, which can be load and visualized use standard gaussian splatting viewer
splat.save(“path/to/your/output.ply”)” dir=”auto”>

# Example using the Python API
from worldgen import WorldGen
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")

# 📝 Generate a 3D scene from a text prompt
worldgen = WorldGen(mode="t2s", device=device)
splat = worldgen.generate_world("")

# 🖼️ Generate a 3D scene from an image
worldgen = WorldGen(mode="i2s", device=device)
image = Image.open("path/to/your/image.jpg")
splat = worldgen.generate_world(
    image=image,
    prompt="",
)

# Save splat file as a .ply file, which can be load and visualized use standard gaussian splatting viewer
splat.save("path/to/your/output.ply")

Tip

We also support background inpainting in for better scene generation, but it’s currently an experimental feature, which may not work for all scenes.
It can be enabled by setting WorldGen(inpaint_bg=True).

# If want to use background inpainting feature, install iopaint
pip install iopaint --no-dependencies

🕹️ Demo with 3D Scene Visualization

# Generate a 3D scene from a text prompt
python demo.py -p "A beautiful landscape with a river and mountains"

# Generate a 3D scene from an image
python demo.py -i "path/to/your/image.jpg"

# You can also provide a text prompt to describe the image and the scene
python demo.py -i "path/to/your/image.jpg" -p ""

Free-viewpoint Exploration in 3D Scene

Note

WorldGen internally support generating a 3D scene from a 360° panorama image 📸, which related to how WorldGen works:
You can try it out if you happen to have a 360° panorama (equirectangular) image. Aspect ratio of the panorama image should be 2:1.

 pano_image = Image.open("path/to/your/pano_image.jpg")
 splat = worldgen._generate_world(pano_image=pano_image)

@misc{worldgen2025ziyangxie,
  author = {Ziyang Xie},
  title = {WorldGen: Generate Any 3D Scene in Seconds},