@createlex/createlexgenai
v1.0.28
Published
CLI tool and MCP server for CreatelexGenAI - Unreal Engine AI integration
Maintainers
Readme
@createlex/createlexgenai
CLI tool for integrating AI-powered tools with Unreal Engine. Works as an MCP server for AI CLI tools (Claude Code, Codex CLI, Gemini CLI, etc.) or as a standalone command-line interface.
71+ tools for spawning actors, creating Blueprints, managing materials, UI widgets, physics, project architecture, and more — all without requiring a custom UE plugin.
Quick Start
# Install globally
npm install -g @createlex/createlexgenai
# Authenticate
createlex login
# Check everything is working
createlex status
# Set up your AI tool
createlex setup claude-codeRequirements
- Node.js 18+
- Unreal Engine 5.x with at least one backend enabled (see below)
- Python 3.10+ (for MCP serve mode)
- CreateLex account with active subscription
Setup Guide (No Plugin Required)
Step 1: Install the CLI
npm install -g @createlex/createlexgenaiOr run without installing:
npx @createlex/createlexgenai --versionStep 2: Authenticate
createlex loginThis opens your browser to sign in. Your token is saved to ~/.createlex/auth.json.
Verify:
createlex statusStep 3: Enable UE Built-in Backends
You need at least one of these enabled in your Unreal project. Both are built into UE — no custom plugin required.
Option A: Web Remote Control (Recommended)
- Open your UE project
- Go to Edit > Plugins
- Enable "Remote Control API" and "Remote Control Web Interface"
- Restart the editor
- Go to Edit > Project Settings > Plugins > Remote Control
- Under Remote Control Web Server, check "Auto Start Web Server"
- Set "Remote Control HTTP Server Port" to 30010 (default)
- Under Remote Control > Security, check "Enable Remote Python Execution"
Option B: Python Remote Execution
- Open your UE project
- Go to Edit > Plugins
- Enable "Python Editor Script Plugin"
- Restart the editor
- Go to Edit > Project Settings > Plugins > Python
- Under Python Remote Execution, check "Enable Remote Execution?"
- Multicast Group Endpoint:
239.0.0.1:6766, Multicast Bind Address:127.0.0.1(defaults)
Tip: Enable both for maximum reliability. If one backend is unavailable, the CLI automatically falls back to the other.
Step 4: Verify Connection
createlex connectExpected output (without plugin):
Plugin (TCP 9878): Not connected
Web Remote Control (HTTP 30010): Connected
Remote Execution (UDP 6766): AvailableStep 5: Configure Your AI Tool / IDE
Automatic Setup
# Set up a specific IDE
createlex setup <ide>
# Set up all detected IDEs at once
createlex setup --allSupported IDEs
| IDE | Command | Config Location |
|---|---|---|
| Claude Code | createlex setup claude-code | CLI command (manual) |
| Cursor | createlex setup cursor | ~/.cursor/mcp.json |
| Windsurf | createlex setup windsurf | ~/.codeium/windsurf/mcp_config.json |
| Claude Desktop | createlex setup claude-desktop | %APPDATA%/Claude/claude_desktop_config.json |
| VS Code | createlex setup vscode | .vscode/settings.json |
| Antigravity | createlex setup antigravity | ~/.gemini/antigravity/mcp_config.json |
| Gemini CLI | createlex setup gemini-cli | ~/.gemini/settings.json |
| Kiro | createlex setup kiro | ~/.kiro/settings/mcp.json |
| Trae | createlex setup trae | %APPDATA%/Trae/User/mcp.json |
| Augment | createlex setup augment | ~/.augment/mcp.json |
| Codex | createlex setup codex | ~/.codex/config.toml |
Manual IDE Configuration
All IDEs use the same MCP server command:
npx @createlex/createlexgenai serveClaude Code:
claude mcp add createlex-unreal -- npx @createlex/createlexgenai serveCodex CLI (~/.codex/config.toml):
[mcp_servers.createlex-unreal]
command = "npx"
args = ["@createlex/createlexgenai", "serve"]JSON-based IDEs (Cursor, Windsurf, Claude Desktop, etc.):
{
"mcpServers": {
"createlex-unreal": {
"command": "npx",
"args": ["@createlex/createlexgenai", "serve"]
}
}
}Step 6: Start Using It
Once configured, your AI tool has access to all 71+ Unreal Engine tools. Try:
- "Spawn a cube at the origin"
- "Create a Blueprint called BP_Enemy based on Character"
- "List all actors in the scene"
- "Create a medieval town"
CLI Commands
# MCP server mode (for AI CLI tools)
createlex serve # stdio MCP server
createlex serve --port 38080 # TCP MCP server
# Direct tool execution
createlex exec <tool> [--key value ...]
createlex exec get_all_scene_objects
createlex exec spawn_object --actor-class StaticMeshActor --location "0,0,0"
createlex exec execute_python_script --script "print('Hello from UE!')"
# List available tools
createlex tools # Formatted list
createlex tools --json # JSON output
# Auth
createlex login # Browser auth flow
createlex logout # Clear credentials
# Status & connection
createlex status # Auth + subscription + UE connection info
createlex connect # Test UE connection, show setup tips
# Configuration
createlex config list # Show all settings
createlex config get unrealPort # Get a specific value
createlex config set unrealPort 9879
createlex config reset # Reset to defaults
# IDE setup
createlex setup # List supported IDEs
createlex setup claude-code # Set up specific IDE
createlex setup --all # Set up all detected IDEsHow Connection Fallback Works
When a tool is executed, the CLI tries backends in this order:
- CreatelexGenAI Plugin (TCP port 9878) — Fastest, direct JSON. Used if the plugin is installed.
- Web Remote Control (HTTP port 30010) — Translates commands to Python, executes via UE's built-in HTTP API.
- Python Remote Execution (UDP port 6766) — Translates commands to Python, executes via UE's multicast remote execution protocol.
All 71 tools work through all backends. The ue_native_handler.py module translates every command into standalone Python that runs inside UE's interpreter.
Available Tools (71+)
| Category | Tools |
|---|---|
| General | get_all_scene_objects, execute_python_script, execute_unreal_command |
| Script | execute_python_script, run_automation_test |
| Actors | spawn_object, delete_actor, find_actors_by_name, set_actor_transform, set_actor_property, get_actor_properties, duplicate_actor, rename_actor, set_actor_mobility, set_actor_physics |
| Blueprint | create_blueprint, spawn_blueprint, compile_blueprint, add_component_to_blueprint, set_blueprint_variable, get_blueprint_details |
| Blueprint Nodes | add_node, connect_nodes, add_variable, add_function, add_event, set_pin_value, get_blueprint_graph |
| Materials | create_material, apply_material_to_actor, set_material_parameter, create_material_instance |
| Mesh | set_static_mesh, create_procedural_mesh, merge_meshes |
| Physics | simulate_physics, add_physics_constraint, set_collision_profile, add_force, set_physics_material |
| UI/Widgets | create_widget, modify_widget, bind_widget_event, add_widget_animation, create_widget_component |
| UI Slicing | upload_ui_image, slice_ui_image, generate_ui_from_slices |
| Project | create_project_folder, get_files_in_folder, import_asset, create_level, set_level_settings |
| Architecture | create_town, construct_house, construct_building, create_road, create_landscape, place_foliage, create_water_body, create_sky_atmosphere, create_lighting_scenario, create_marketplace, create_wall, create_floor |
Configuration
Settings are stored in ~/.createlex/config.json:
| Key | Default | Description |
|---|---|---|
| unrealPort | 9878 | CreatelexGenAI plugin TCP port |
| mcpPort | 38080 | MCP TCP server port (for serve --port) |
| apiBaseUrl | https://api.createlex.com/api | CreateLex API endpoint |
| webBaseUrl | https://createlex.com | CreateLex web app URL |
| debug | false | Enable debug logging |
Troubleshooting
"No backends connected to Unreal Engine"
- Make sure UE is running with your project open
- Enable Web Remote Control or Python Remote Execution (see Step 3)
- Run
createlex connectfor detailed diagnostics
"Authentication: Not logged in"
createlex login"Subscription: Inactive"
- Visit createlex.com to check your subscription status
- Run
createlex statusto see the specific error
Web Remote Control not responding
- Check Edit > Project Settings > Plugins > Remote Control in UE
- Ensure "Enable Remote Control Web Server" is checked
- Verify port 30010 is not blocked by firewall
Python Remote Execution not available
- Check Edit > Project Settings > Plugins > Python in UE
- Ensure "Enable Remote Execution" is checked
- Verify UDP port 6766 is not blocked
License
Proprietary. Requires an active CreateLex subscription.
