Skip to main content

​
Prerequisites

Before you begin, make sure your local machine has the following installed:
  • Go: World Engine games are written in Go. This guide requires a minimum Go version of v1.25.4. To check that Go is installed on your computer, run go version.
  • Docker: The World Engine development server runs several local services inside containers. Follow the official instructions to install Docker.
Alternatively, you can also use other Docker-compatible container runtimes. We recommend OrbStack for macOS users and Podman for Linux users.

​
Installing World CLI

The World CLI is the command-line tool for creating, managing, and deploying World Engine projects. To install the latest version:

​
Creating a Project

Now you are ready to create a new World Engine project. The setup command will launch an interactive tool to help you configure your project:
When prompted, select the Basic template.
TODO: Add an updated image of the selection UI
Once the project has been created, you can start the local development server:
This command builds the game server and runs the World Engine stack. It will take some time during your first run to download the required container images.

​
Stopping the Server

Press Ctrl+C to stop the server, or run world stop from another terminal. To reset the world state, run world purge. This removes all game data and restores the world to a clean state, which is useful when you want to start fresh during development.