cr8-app/backend/cr8_engine/README.md

Cr8-xyz Engine (WebSocket Server)

Overview

The Cr8_engine is a FastAPI WebSocket server that acts as the central communication hub between:

• The Cr8-xyz frontend interface
• The Blender Cr8tive Engine addon
• AI agent processes

Key Features

WebSocket Architecture

• Dual WebSocket endpoints (/blender and /browser)
• Message routing based on command patterns
• Session management with exponential backoff retries

Agent Integration

• MCP server for tool integration
• Context management for AI agents
• Command validation and processing

Setup & Installation

# Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Set up environment variables (copy from .env.example)
cp .env.example .env

Running the Server

# Development mode (auto-reload)
uvicorn main:app --reload --host 0.0.0.0 --port 8000

# Production mode
uvicorn main:app --host 0.0.0.0 --port 8000

Configuration

Environment Variables

• WS_URL: WebSocket connection URL
• API_KEY: Authentication key
• LOG_LEVEL: Debug/Info/Warning/Error

Main Configuration

• Edit main.py for:
  • Host/port settings
  • CORS configuration
  • Logging levels

API Endpoints

WebSocket

• /ws/blender - Blender addon connection
• /ws/browser - Frontend connection

REST API

• /api/v1/... - Additional HTTP endpoints

Troubleshooting

• Connection issues: Check firewall and port settings
• Authentication errors: Verify API keys
• Message processing: Check logs in logs/cr8_engine.log