A swiss army knife for creating, managing, and deploying World Engine projects

Overview

Key Features:

• Create — Initialize a new World Engine project based on starter-game-template
• Dev Mode — Run your game shard in dev mode (with editor support) for fast iteration
• [Soon] Deploy — Get a prod-ready World Engine deployment in the cloud easier than deploying a smart contract.

Need help getting started with World Engine? Check out the World Engine docs!

Installation

Before installing World CLI, you'll need to have Go installed on your system. If you haven't installed Go yet, follow the official Go installation guide to get started.

Windows Users: Windows Subsystem for Linux 2 (WSL2) is required for running World CLI on Windows.

World CLI Installation

Install latest release:

go install pkg.world.dev/world-cli/cmd/world@latest

Install a specific release:

go install pkg.world.dev/world-cli/cmd/world@<tag>

Development

This section is for developers who want to contribute to the World CLI. If you want to develop a World Engine project using World CLI, see the World Engine quickstart guide

For detailed instructions on setting up your development environment, building, testing, and contributing to the World CLI, please refer to the Developer Guide.

Building from source:

task build

Testing your local build:

You can test your local build of World CLI by running the following command. This will install the World CLI binary in your Go bin directory.

task install