Skip to main content

Documentation Index

Fetch the complete documentation index at: https://world.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Before you begin, make sure you have:

​
Scaffold a basic example

world create --example basic
The basic example is a close to barebones example of how to use World Engine. The Cardinal shard contains the following:
  • Player entities
  • Health component
  • Regen system
  • Attack command
  • Player death event
While the client is a minimal Go client that operates via command-line. Once scaffolded, you can run the World Engine stack (Cardinal shard, gateway, etc.) with: 
world dev # TODO
Once Tilt is running, you can play around with the client. 
go run cmd/client/main.go create-player johndoe
# go run cmd/client/main.go to see all commands

​
What’s next?

Learn more about World Engine:

Introduction to Cardinal (Shard)

Learn about Cardinal (Shard)