Skip to main content
To develop on the Worlds Platform, install the following tools:
  • Deno, latest version: For the server, SDK, and CLI.
  • Node.js, v20 or higher: For the console and documentation.
  • Git: For version control.

​
Setup the console

The console orchestrates all other resources. In local mode, it uses a mock identity provider file.
1

Clone and install

git clone https://github.com/wazootech/worlds.git
cd worlds # Navigate to the Console directory
npm install
2

Configure environment

Copy the example environment file. Skip the WorkOS variables to trigger local development mode.
cp .env.example .env
3

Run console

npm run dev
Open http://localhost:3000 in your browser.

​
Booting world instances

Once the console runs, it automatically manages local Worlds API processes.
  • Automatic boot: On startup, the console checks the local identity database and spawns a server process for every local organization.
  • Dynamic provisioning: When you create a new organization in the console UI:
    1. The system generates a local API key.
    2. The system creates a local organization database.
    3. The system spawns a new Worlds API server on an available local port.

​
Customizing the local user

In local development mode, you can customize the identity of the mock user session by setting environment variables in the Console configuration file: 
LOCAL_USER_ID="admin"
LOCAL_USER_EMAIL="admin@wazoo.dev"
LOCAL_USER_FIRST_NAME="System"
LOCAL_USER_LAST_NAME="Admin"
The system uses these values to initialize the mock identity file if it does not exist.

​
Configuration reference

VariableDescription
LIBSQL_URLOptional. SQLite URL. Defaults to file:./worlds.db.
LOCAL_USER_EMAILOptional. Email for the mock local user.
LOCAL_USER_FIRST_NAMEOptional. First name for the mock local user.
LOCAL_USER_IDOptional. User ID for the mock local user.
LOCAL_USER_LAST_NAMEOptional. Last name for the mock local user.
OLLAMA_BASE_URLOptional. Ollama API URL. Defaults to http://localhost:11434.
OLLAMA_EMBEDDINGS_MODELOptional. Ollama model. Defaults to nomic-embed-text.
OPENROUTER_API_KEYOptional. API key for cloud-based embeddings via OpenRouter.
OPENROUTER_EMBEDDINGS_MODELOptional. OpenRouter model. Defaults to openai/text-embedding-3-small.
WORLDS_BASE_DIROptional. Base directory for world data. Defaults to ./worlds.
WORLDS_EMBEDDINGS_DIMENSIONSOptional. Unified vector dimensions for DB and AI. Defaults to 768.

​
Local embeddings with Ollama

By default, the Worlds Platform uses Ollama for local embeddings.
1

Install Ollama

Download and install Ollama from ollama.com.
2

Pull embedding model

The platform defaults to nomic-embed-text:
ollama pull nomic-embed-text
3

Configure server

The Worlds API server automatically attempts to connect to the local Ollama instance at http://127.0.0.1:11434. Override this in your environment:
OLLAMA_BASE_URL="http://your-ollama-host:11434"
OLLAMA_EMBEDDINGS_MODEL="nomic-embed-text"