README.md

# WorldGen • Text-to-3D Scene Generator

This Hugging Face Space allows you to generate 3D scenes from English text prompts using the WorldGen framework.

## 🚀 How to Use

1. Enter a scene description in English (e.g., `a neon-lit cyberpunk street with rain reflections, highly detailed`)
2. Click **Generate 3D Scene**
3. Download the ZIP file containing the generated 3D assets

## 🔐 Hugging Face Token

This app downloads model files from Hugging Face Hub. If you encounter `401 Unauthorized` errors, you may need to provide a Hugging Face token.

### Setting Token in Space

1. Go to your Space → **Settings** → **Secrets**
2. Add a new secret:
   - Name: `HF_TOKEN`
   - Value: your Hugging Face access token

The app will automatically read this token via `os.getenv("HF_TOKEN")`.

## ⚙️ Runtime Notes

- CPU-only mode is enabled by default to avoid CUDA errors
- Temporary files are cleaned automatically after each run
- Model files are downloaded from `mit-han-lab/svdq-int4-flux.1-dev`

## 📦 Dependencies

See `requirements.txt` for full dependency list.