Upstreet DocsGetting Started
Create worlds, characters, and assets with generative AI tools.
Maker
Create worlds, characters, and assets.
As a Maker, you use Upstreet's generative AI to design the building blocks of the world. Characters, environments, items, and stories you create can live inside the world and be shared with others.
Your Journey
Choose Your Creation Focus
Upstreet can generate many types of assets:
| Type | What It Creates |
|---|---|
character | Full 3D character with rigging |
sceneImage | 2D scene / environment art |
scene360 | 360-degree panoramic scene |
sceneSplat | 3D Gaussian splat scene |
model | 3D model from prompt or image |
characterRender | Rendered sprite sheet from a character |
item | In-world item asset |
sprite | 2D sprite sheet |
mob | Enemy / creature model |
music | AI-generated music track |
soundEffect | Sound effect |
voice | Voice clone / TTS voice |
image | General image generation |
video | AI video generation |
Generate Your First Asset
import { PUClient } from 'pu-client';
const client = new PUClient({ apiKey: process.env.PU_API_KEY! });
const id = await client.generations.create({
type: 'sceneImage',
input: {
prompt: 'A floating island with crystal waterfalls and bioluminescent trees',
smartPrompt: true,
},
});
console.log(`Generation started: ${id}`);Watch It Come to Life
Stream real-time progress:
const { events, unsubscribe } = client.generations.listen(id);
events.addEventListener('change', (ev: any) => {
const { state, logs } = ev.data;
console.log(`[${state}]`, logs);
});Place It in the World
Once generated, your asset appears in your Generations history. From there you can:
- Use it as a scene in the 3D Editor or Top-down Editor
- Assign it to an NPC as their character model
- List it on the Marketplace
- Feature it on the Wiki
Unlock Advanced Workflows
Combine multiple generations to build complex scenes. Generate a character, a scene, items, and music -- then compose them into a full playable level.
Generation Pipeline
graph LR
Prompt["Text Prompt"] --> GenAI["Generative AI"]
ImageRef["Reference Image"] --> GenAI
GenAI --> Asset["Generated Asset"]
Asset --> World["Virtual World"]
Asset --> Market["Marketplace"]
Asset --> NPC["NPC Character"]
Asset --> Wiki["Wiki / Blog"]