Documentation
Worldkiln guides, tutorials, and AeoScript API references.
Current public release: Worldkiln 1.0.0.
Start here
- Getting started
Write and run your first AeoScript file.
Worldkiln
- Getting started with Worldkiln
Create a project, build a small World, and test it.
- Building
Place, customize, select, and remove shapes in your World.
- Editor workspace
Find the tools that edit and test your project.
- Hierarchy
Organize Actors and their scripts.
- Characters
Use Character packages for objects that move and animate.
- Camera
Set the gameplay view and handle nearby obstacles.
- Physics
Choose how objects collide and move.
- Lighting
Choose the World lighting and test it while building.
- Projects and builds
Save authored work and package a standalone game.
- Settings
Adjust editor preferences and display options.
- Video Playback [BETA]
A short guide to project-local MP4 files and the UI video player.
- Script Debugger
Use diagnostics now and investigate breakpoints when supported.
- Experimental Lighting [BETA]
Recognize experimental settings without confusing them with established lights.
- Navigation Editor
Build navigation bounds, inspect paths and use navigation diagnostics.
- UI Editor
Build and test game interfaces, arrange controls and bind Button actions.
- AI Assistant [BETA]
Configure an AI provider, inspect your project and review editor changes.
- Asset Manager
Import, browse, inspect and organize project assets.
- Asset Packs
Find and install optional asset packs.
- Character Animation
Choose animation clips and attach props to Character joints.
- Particles and Effects
Create smoke, fire, and script-controlled particle effects.
- Materials
Choose textures and materials for objects and environments.
- Terrain and Landscaping [BETA]
Generate, shape, and paint playable landscapes.
- Water and Oceans [BETA]
Author oceans, lakes, rivers, waves, and shorelines.
Using Worldkiln
- Using the Worldkiln Editor
Locate the viewport, panels, saving and Play controls.
- Finding Features in Worldkiln
Find editor tools and confirm their destinations.
- Editing Objects in Worldkiln
Select, transform and undo authored edits.
- Managing Your Project Assets
Import and keep project-owned textures and audio.
- Importing 3D Models and Characters
Prepare and verify a user-supplied GLB asset.
- Creating Your First Game Interface
Author a Button and connect a standalone script.
- Camera and Controller Scripts
Choose camera behavior and call the camera API.
- Working With Save State
Persist a typed value between Play sessions.
- Physics and Collisions
Test anchored, solid and dynamic object behavior.
- Building and Publishing Your Game
Verify real game output on a clean Windows PC.
- Terrain Management
Generate, sculpt and paint Terrain, configure water and grass, and create Terrain using AeoScript.
Language
- Functions
Write code once. Call it when you need it.
- Variables
Keep a value and use it later.
- Control flow
Choose what runs and repeat work.
- Baskets
Store values in order.
- Maps
Store values by key.
- Types
Know what kind of value you have.
- Syntax
Read and write AeoScript statements.
- Operators
Calculate, compare, and combine values.
Scripting with Worldkiln
- Finding Objects
Choose a lookup that searches the objects you need.
- Events
Let scripts communicate without directly calling each other.
- Waiting
Pause a script and continue where it stopped.
- Actors and Modules
Attach behavior to an Actor or share functions between scripts.
- Cells
Read and change voxel World objects during Play.
- Entity scripts
Keep per-object state and respond to lifecycle calls.
- Live Entities
Control objects that exist during Play.
- UI
Create controls or find controls made in the editor.
- Input
React to keys or read gameplay input.
- Audio
Play sounds from AudioEmitter Cells.
- Script control
Enable or disable scripts during the game.
- Save data
Keep supported game values between sessions.
- Attributes
Add named values to Cells and Actors.
- Script bindings
Attach a script to a specific object.
- Names and IDs
Choose names for discovery and IDs for exact objects.
- Play-mode changes
Understand what resets when Play stops.
- Attaching Objects
Mount props to animated Character joints.
- Scheduled Tasks [BETA]
Run or delay functions with the script scheduler.
Tutorials
- Your first World
Build a floor and SpawnPoint; configure a Player separately when needed.
- Your first script
Print a message when Play starts.
- Make a pickup
Hide a pickup when the Player touches it.
- Create a runtime Cell
Create a temporary Block when Play starts.
- Your first game
Build a small collectible objective and display a win message.
- How to create a character
Import a GLB or AssetPack Actor, create a Character, and choose a Player.
Troubleshooting
- Debugging scripts
Read Output and check the values your script uses.
- Script errors
Fix the first error, then run the script again.