Practical overview
When it fits
Use WorldGen when you want a locally run, code-oriented workflow for generating and exploring scenes from prompts or images, or exporting generated results as PLY assets.
Who it is for
- Developers prototyping text-to-scene or image-to-scene generation.
- Technical artists and researchers preparing 3D environments for games, simulations, robotics or virtual reality.
Documented uses
- Generate an indoor or outdoor 3D scene from a text description.
- Turn an input image into a 3D scene, optionally guided by a prompt.
- Explore a generated scene through a local browser-based viewer.
- Save scene output as a Gaussian splat or a mesh in PLY format.
Requirements & limits
The project is available as a public GitHub repository under the Apache-2.0 license. The documented setup requires accepting the gated FLUX.1-dev model license.
- The documented setup is Python-based and specifies Python 3.11, GPU-enabled PyTorch and additional model and 3D-processing dependencies.
- The README suggests low_vram mode when GPU VRAM is below 24 GB.
- The demo starts a local Viser server for viewing generated scenes; mesh display calls for the project’s customized Viser build.
- ml-sharp support and background inpainting are labeled experimental in the README.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Generate and explore a scene with the demo
Run the documented demo to create a scene from a prompt or image and inspect it in a browser.
Before you start
- WorldGen repository cloned recursively and installed in a Python 3.11 Conda environment.
- PyTorch and torchvision with GPU support, plus the documented DA-2 and PyTorch3D dependencies.
- For the documented gated model setup, accept the FLUX.1-dev license and log in to Hugging Face.
Steps
Install the project and dependencies using the repository instructions.
Run the command below for text input, or use the command below for image input.
python demo.py -p "A beautiful landscape with a river and mountains"python demo.py -i "path/to/your/image.jpg" -p ""Open the local Viser server at
http://localhost:8080to explore the generated scene.
Expected outcome
A generated scene that can be explored in real time through the local Viser server.
Guide limitations
- The README recommends setting low_vram to True when GPU VRAM is below 24 GB.
- The
--use_sharpgeneration path is labeled experimental. - The image demo example includes
--use_sharp; the README labels that feature experimental.
Save a generated scene as a Gaussian splat or mesh
Use the Python API examples to generate a scene and save its output as a PLY file.
Before you start
- WorldGen installed with its documented Python dependencies.
- A Python environment with PyTorch available; the example selects CUDA when available and otherwise CPU.
Steps
Import
WorldGenand select a device withtorch.device("cuda" if torch.cuda.is_available() else "cpu").For a Gaussian splat, create
WorldGen(mode="t2s", device=device, low_vram=False), callgenerate_worldwith a text prompt, and save the result withsplat.save("path/to/your/output.ply").For a mesh, call
generate_worldwithreturn_mesh=Trueand save it usingo3d.io.write_triangle_mesh("path/to/your/output.ply", mesh).
Expected outcome
A generated Gaussian-splat or mesh scene saved in PLY format.
Guide limitations
- The README notes low_vram can be set to True when GPU VRAM is below 24 GB.
- The mesh demo specifies a customized Viser installation for correct mesh visualization without backface culling.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 16 October 2026
- Original website title
- ZiYang-xie/WorldGen · Official homepage title · retained in its source language

