Skip to main content

​
Prerequisites

Before deploying your World Engine project, ensure you have:

​
Deployment Overview

World Engine provides a comprehensive deployment system that allows you to deploy your projects to different environments:
  • Preview Environment: For testing and development
  • Live Environment: For production deployments

​
Deploy to Preview Environment

Deploy your project to the preview environment for testing: 
world deploy
This command will:
  1. Build your Cardinal shards
  2. Package your application
  3. Deploy to the preview environment
  4. Provide deployment status and URLs
The preview environment is perfect for testing your game before promoting to production.

​
Force Deploy

If you need to force a deployment (e.g., after configuration changes): 
world deploy --force
Force deployments will override any existing deployment and may cause downtime.

​
Check Deployment Status

Monitor the status of your deployed project: 
world status
This command provides information about:
  • Deployment status (running, failed, building)
  • Environment URLs
  • Health checks
  • Resource usage

​
Promote to Live Environment

Once you’re satisfied with your preview deployment, promote it to the live environment: 
world promote
Promoting to live will make your game available to end users. Ensure thorough testing in preview first.

​
View Application Logs

Monitor your application in real-time by tailing logs: 
# Default: us-west-2 region, preview environment
world logs

# Specify region and environment
world logs us-east-1 preview
world logs eu-central-1 live

​
Available Regions

  • us-west-2 (default)
  • us-east-1
  • eu-central-1
  • ap-southeast-1

​
Available Environments

  • preview (default)
  • live
Logs are streamed in real-time. Use Ctrl+C to stop the log stream.

​
Reset Deployment

If you need to restart your deployment with a clean state: 
world reset
This command will:
  1. Stop the current deployment
  2. Clear all data and state
  3. Redeploy with a fresh environment
Resetting will clear all game state and data. This action cannot be undone.

​
Destroy Deployment

Remove your project’s infrastructure from the cloud: 
world destroy
This command will:
  1. Stop all running services
  2. Remove all deployed resources
  3. Clean up infrastructure
Destroying your deployment will permanently remove all data and infrastructure. This action cannot be undone.
⌘I