Overview

World Engine

Welcome to World Engine — the seed of future worlds

Introduction

Start developing your first World Engine game in under 5 minutes

Quickstart

Cardinal — High-performance onchain game framework

Introduction to ECS

How Cardinal's loop-driven runtime makes developing games on the blockchain easier

Loop-driven Runtime

Best practice for structuring your Cardinal game shard code

Project Structure

Component

Message

Query

Cardinal Query Language (CQL)

EVM+ Message and Query

Persona (Game Account)

EVM to Cardinal

Evaluate a custom pre-registered Cardinal query endpoint

/query/game/{queryType}

Query the Cardinal ECS state using Cardinal Query Language (CQL)

/query/game/cql

/query/persona/signer

/query/receipts/list

/tx/game/{txType}

/tx/persona/create-persona

/query/debug/state

/events

Getting Started

Query & Transaction Relay

Enable monitoring for Nakama with Jaeger and Prometheus

Monitoring Nakama

GitHub

Twitter

Telegram Dev Chat

Cardinal (Game Shard)

Game Engine/Client Integration

Get Started

Support

How to create and manage your Cardinal world

API Reference

Create/Remove Entity

Get/Set/Remove Component

Event

This section configures Cardinal, which handles shard routing, logging, and rollup modes.

Cardinal

This section configures the Ethereum Virtual Machine (EVM) settings, including chain IDs, mnemonics, and faucet configurations.

This section configures Nakama, including allowlist, metrics, and tracing settings.

Client/Game Engine Integration

Integrate via Nakama SDK

Integrate via REST API

Overview