voxel-plugin-tools

Voxel Plugin actions for ue-mcp. 60 actions and 1 flow.

Install

ue-mcp plugin install voxel-plugin-tools

Adds an entry under plugins: in ue-mcp.yml. Restart ue-mcp.

Requirements

• ue-mcp >= 1.0.15
• Voxel Plugin enabled in your .uproject (Plugins[].Name == "Voxel")
• Unreal Engine 5.7
• Node >= 18 to build (20+ recommended)

Usage

Actions are called as <category>(action="voxel_<name>", ...). Three categories: level, asset, pcg.

Spawn a rendering world:

flow(action="run", flowName="voxel_hello_world", params={ label: "MyVoxelWorld" })

Check readiness before sculpting, stamping, or sampling:

level(action="voxel_is_world_ready", actorLabel="MyVoxelWorld")
# => { returnValues: { ReturnValue: "true" } }

Build terrain from a heightmap:

asset(action="voxel_create_asset", name="Terrain01", type="heightmap")
level(action="voxel_spawn_stamp_actor", label="Terrain")
level(action="voxel_set_heightmap_stamp", actorLabel="Terrain",
      source="/Game/Terrain01.Terrain01", blendMode="max")

Actions

ue-mcp.plugin.yml is the source of truth for parameters and the C++ header each action wraps. Reference docs are under docs/. Each action wraps exactly one host call; sequencing belongs in flows.

level: spawns

level: world lifecycle and status

level: world config

level: volume sculpting (AVoxelVolumeSculptActor)

level: height sculpting (AVoxelHeightSculptActor)

level: stamps

level: sculpt save assets

level: query and export

level: instanced stamps (UVoxelInstancedStampComponent)

level: no-clipping (UVoxelNoClippingComponent)

asset

voxel_create_asset types: surface_type, smart_surface_type, layer_stack, mega_material, heightmap, static_mesh, height_graph, volume_graph, scatter_graph, height_spline_graph, volume_spline_graph, height_sculpt_graph, volume_sculpt_graph, surface_type_graph, height_sculpt_save, volume_sculpt_save, pcg_graph.

pcg

voxel_pcg_add_node node types: call_graph, sampler, sampler_v2, query, stamp_spawner, spawn_actor, apply_on_graph, create_spline, projection, elevation_isolines, wait_for_world, layer_sampler, landscape_sampler, landscape_projection, wait_for_landscape.

Flows

Parameters

• location, rotation, scale are { x, y, z } objects.
• Asset and object references are content paths (/Game/Foo.Foo) or class paths (/Script/...).
• Height stamp blend modes: max | min | override. Volume stamp blend modes: additive | subtractive | intersect | override.
• Return values come back as strings at data.returnValues.ReturnValue.
• Python-backed actions (stamps, asset create/set) report results on marker lines (VOXEL_CREATED_ASSET=, VOXEL_QUERY_RESULT=, and so on).
• voxel_set_asset_property takes value as a string; numeric and boolean strings are coerced. For a UObject reference, set valueIsAsset: true.
• level reads accept world (editor or pie).

Architecture

Task classes compile to dist/ and load into ue-mcp, which bridges to the editor:

MCP client -> ue-mcp server -> WebSocket bridge (C++ plugin) -> UE editor

Develop

git clone https://github.com/db-lyon/voxel-plugin-tools.git
cd voxel-plugin-tools
npm install
npm run build      # clean + tsc
npm run check      # static-check + schema-drift-check

See CONTRIBUTING.md.

License

MIT. See LICENSE.