flockbay 0.10.15

package/tools/unreal-mcp/upstream/Docs/Tools/blueprint_tools.md

@@ -0,0 +1,268 @@
+# Unreal MCP Blueprint Tools
+
+This document provides detailed information about the Blueprint tools available in the Unreal MCP integration.
+
+## Overview
+
+Blueprint tools allow you to create and manipulate Blueprint assets in Unreal Engine, including creating new Blueprint classes, adding components, setting properties, and spawning Blueprint actors in the level.
+
+## Blueprint Tools
+
+### create_blueprint
+
+Create a new Blueprint class.
+
+**Parameters:**
+- `name` (string) - The name for the new Blueprint class
+- `parent_class` (string) - The parent class for the Blueprint
+
+**Returns:**
+- Information about the created Blueprint including success status and message
+
+**Example:**
+```json
+{
+  "command": "create_blueprint",
+  "params": {
+    "name": "MyActor",
+    "parent_class": "Actor"
+  }
+}
+```
+
+### add_component_to_blueprint
+
+Add a component to a Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint
+- `component_type` (string) - The type of component to add (use component class name without U prefix)
+- `component_name` (string) - The name for the new component
+- `location` (array, optional) - [X, Y, Z] coordinates for component's position, defaults to [0, 0, 0]
+- `rotation` (array, optional) - [Pitch, Yaw, Roll] values for component's rotation, defaults to [0, 0, 0]
+- `scale` (array, optional) - [X, Y, Z] values for component's scale, defaults to [1, 1, 1]
+- `component_properties` (object, optional) - Additional properties to set on the component
+
+**Returns:**
+- Information about the added component including success status and message
+
+**Example:**
+```json
+{
+  "command": "add_component_to_blueprint",
+  "params": {
+    "blueprint_name": "MyActor",
+    "component_type": "StaticMeshComponent",
+    "component_name": "Mesh",
+    "location": [0, 0, 0],
+    "rotation": [0, 0, 0],
+    "scale": [1, 1, 1],
+    "component_properties": {
+      "bVisible": true
+    }
+  }
+}
+```
+
+### set_static_mesh_properties
+
+Set the mesh for a StaticMeshComponent.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint
+- `component_name` (string) - The name of the StaticMeshComponent
+- `static_mesh` (string, default: "/Engine/BasicShapes/Cube.Cube") - Path to the static mesh asset
+
+**Returns:**
+- Result of the mesh setting operation including success status and message
+
+**Example:**
+```json
+{
+  "command": "set_static_mesh_properties",
+  "params": {
+    "blueprint_name": "MyActor",
+    "component_name": "Mesh",
+    "static_mesh": "/Engine/BasicShapes/Sphere.Sphere"
+  }
+}
+```
+
+### set_component_property
+
+Set a property on a component in a Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint
+- `component_name` (string) - The name of the component
+- `property_name` (string) - The name of the property to set
+- `property_value` (any) - The value to set for the property
+
+**Returns:**
+- Result of the property setting operation including success status and message
+
+**Example:**
+```json
+{
+  "command": "set_component_property",
+  "params": {
+    "blueprint_name": "MyActor",
+    "component_name": "Mesh",
+    "property_name": "StaticMesh",
+    "property_value": "/Game/StarterContent/Shapes/Shape_Cube.Shape_Cube"
+  }
+}
+```
+
+### set_physics_properties
+
+Set physics properties on a component.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint
+- `component_name` (string) - The name of the component
+- `simulate_physics` (boolean, optional) - Whether to simulate physics, defaults to true
+- `gravity_enabled` (boolean, optional) - Whether gravity is enabled, defaults to true
+- `mass` (float, optional) - The mass of the component, defaults to 1.0
+- `linear_damping` (float, optional) - Linear damping value, defaults to 0.01
+- `angular_damping` (float, optional) - Angular damping value, defaults to 0.0
+
+**Returns:**
+- Result of the physics properties setting operation including success status and message
+
+**Example:**
+```json
+{
+  "command": "set_physics_properties",
+  "params": {
+    "blueprint_name": "MyActor",
+    "component_name": "Mesh",
+    "simulate_physics": true,
+    "gravity_enabled": true,
+    "mass": 10.0,
+    "linear_damping": 0.05,
+    "angular_damping": 0.1
+  }
+}
+```
+
+### compile_blueprint
+
+Compile a Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint to compile
+
+**Returns:**
+- Result of the compilation operation including success status and message
+
+**Example:**
+```json
+{
+  "command": "compile_blueprint",
+  "params": {
+    "blueprint_name": "MyActor"
+  }
+}
+```
+
+### set_blueprint_property
+
+Set a property on a Blueprint class default object.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint
+- `property_name` (string) - The name of the property to set
+- `property_value` (any) - The value to set for the property
+
+**Returns:**
+- Result of the property setting operation including success status and message
+
+**Example:**
+```json
+{
+  "command": "set_blueprint_property",
+  "params": {
+    "blueprint_name": "MyActor",
+    "property_name": "bCanBeDamaged",
+    "property_value": true
+  }
+}
+```
+
+### set_pawn_properties
+
+Set common Pawn properties on a Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint (must be a Pawn or Character)
+- `auto_possess_player` (string, optional) - Auto possess player setting (None, "Disabled", "Player0", "Player1", etc.), defaults to empty string
+- `use_controller_rotation_yaw` (boolean, optional) - Whether the pawn should use the controller's yaw rotation, defaults to false
+- `use_controller_rotation_pitch` (boolean, optional) - Whether the pawn should use the controller's pitch rotation, defaults to false
+- `use_controller_rotation_roll` (boolean, optional) - Whether the pawn should use the controller's roll rotation, defaults to false
+- `can_be_damaged` (boolean, optional) - Whether the pawn can be damaged, defaults to true
+
+**Returns:**
+- Response indicating success or failure with detailed results for each property
+
+**Example:**
+```json
+{
+  "command": "set_pawn_properties",
+  "params": {
+    "blueprint_name": "MyPawn",
+    "auto_possess_player": "Player0",
+    "use_controller_rotation_yaw": true,
+    "can_be_damaged": true
+  }
+}
+```
+
+### spawn_blueprint_actor
+
+Spawn an actor from a Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - The name of the Blueprint to spawn
+- `actor_name` (string) - The name for the spawned actor
+- `location` (array, optional) - [X, Y, Z] coordinates for the actor's position, defaults to [0, 0, 0]
+- `rotation` (array, optional) - [Pitch, Yaw, Roll] values for the actor's rotation, defaults to [0, 0, 0]
+- `scale` (array, optional) - [X, Y, Z] values for the actor's scale, defaults to [1, 1, 1]
+
+**Returns:**
+- Information about the spawned actor including success status and message
+
+**Example:**
+```json
+{
+  "command": "spawn_blueprint_actor",
+  "params": {
+    "blueprint_name": "MyActor",
+    "actor_name": "MyActorInstance",
+    "location": [0, 0, 100],
+    "rotation": [0, 45, 0],
+    "scale": [1, 1, 1]
+  }
+}
+```
+
+## Error Handling
+
+All command responses include a "success" field indicating whether the operation succeeded, and a "message" field with details in case of failure.
+
+```json
+{
+  "success": false,
+  "message": "Failed to connect to Unreal Engine"
+}
+```
+
+## Implementation Notes
+
+- All transform arrays (location, rotation, scale) must contain exactly 3 float values
+- Empty lists for transform parameters will be automatically converted to default values
+- The server maintains detailed logging of all operations
+- All commands require a successful connection to the Unreal Engine editor
+- Failed operations will return detailed error messages in the response
+- Component types should be specified without the 'U' prefix (e.g., "StaticMeshComponent" instead of "UStaticMeshComponent")
+- For socket-based communication, refer to the test scripts in unreal-mcp/Python/scripts/blueprints for examples

package/tools/unreal-mcp/upstream/Docs/Tools/editor_tools.md

@@ -0,0 +1,104 @@
+# Unreal MCP Editor Tools
+
+This document provides detailed information about the editor tools available in the Unreal MCP integration.
+
+## Overview
+
+Editor tools allow you to control the Unreal Editor viewport and other editor functionality through MCP commands. These tools are particularly useful for automating tasks like focusing the camera on specific actors or locations.
+
+## Editor Tools
+
+### focus_viewport
+
+Focus the viewport on a specific actor or location.
+
+**Parameters:**
+- `target` (string, optional) - Name of the actor to focus on (if provided, location is ignored)
+- `location` (array, optional) - [X, Y, Z] coordinates to focus on (used if target is None)
+- `distance` (float, optional) - Distance from the target/location (default: 1000.0)
+- `orientation` (array, optional) - [Pitch, Yaw, Roll] for the viewport camera
+
+**Returns:**
+- Response from Unreal Engine containing the result of the focus operation
+
+**Example:**
+```json
+{
+  "command": "focus_viewport",
+  "params": {
+    "target": "PlayerStart",
+    "distance": 500,
+    "orientation": [0, 180, 0]
+  }
+}
+```
+
+### take_screenshot
+
+Capture a screenshot of the viewport.
+
+**Parameters:**
+- `filename` (string, optional) - Name of the file to save the screenshot as (default: "screenshot.png")
+- `show_ui` (boolean, optional) - Whether to include UI elements in the screenshot (default: false)
+- `resolution` (array, optional) - [Width, Height] for the screenshot
+
+**Returns:**
+- Result of the screenshot operation
+
+**Example:**
+```json
+{
+  "command": "take_screenshot",
+  "params": {
+    "filename": "my_scene.png",
+    "show_ui": false,
+    "resolution": [1920, 1080]
+  }
+}
+```
+
+## Error Handling
+
+All command responses include a "status" field indicating whether the operation succeeded, and an optional "message" field with details in case of failure.
+
+```json
+{
+  "status": "error",
+  "message": "Failed to get active viewport"
+}
+```
+
+## Usage Examples
+
+### Python Example
+
+```python
+from unreal_mcp_server import get_unreal_connection
+
+# Get connection to Unreal Engine
+unreal = get_unreal_connection()
+
+# Focus on a specific actor
+focus_response = unreal.send_command("focus_viewport", {
+    "target": "PlayerStart",
+    "distance": 500,
+    "orientation": [0, 180, 0]
+})
+print(focus_response)
+
+# Take a screenshot
+screenshot_response = unreal.send_command("take_screenshot", {"filename": "my_scene.png"})
+print(screenshot_response)
+```
+
+## Troubleshooting
+
+- **Command fails with "Failed to get active viewport"**: Make sure Unreal Editor is running and has an active viewport.
+- **Actor not found**: Verify that the actor name is correct and the actor exists in the current level.
+- **Invalid parameters**: Ensure that location and orientation arrays contain exactly 3 values (X, Y, Z for location; Pitch, Yaw, Roll for orientation).
+
+## Future Enhancements
+
+- Support for setting viewport display mode (wireframe, lit, etc.)
+- Camera animation paths for cinematic viewport control
+- Support for multiple viewports

package/tools/unreal-mcp/upstream/Docs/Tools/node_tools.md

@@ -0,0 +1,274 @@
+# Unreal MCP Node Tools
+
+This document provides detailed information about the Blueprint node tools available in the Unreal MCP integration.
+
+## Overview
+
+Node tools allow you to manipulate Blueprint graph nodes and connections programmatically, including adding event nodes, function nodes, variables, and creating connections between nodes.
+
+## Node Tools
+
+### add_blueprint_event_node
+
+Add an event node to a Blueprint's event graph.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `event_type` (string) - Type of event (BeginPlay, Tick, etc.)
+- `node_position` (array, optional) - [X, Y] position in the graph (default: [0, 0])
+
+**Returns:**
+- Response containing the node ID and success status
+
+**Example:**
+```json
+{
+  "command": "add_blueprint_event_node",
+  "params": {
+    "blueprint_name": "MyActor",
+    "event_type": "BeginPlay",
+    "node_position": [100, 100]
+  }
+}
+```
+
+### add_blueprint_input_action_node
+
+Add an input action event node to a Blueprint's event graph.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `action_name` (string) - Name of the input action to respond to
+- `node_position` (array, optional) - [X, Y] position in the graph (default: [0, 0])
+
+**Returns:**
+- Response containing the node ID and success status
+
+**Example:**
+```json
+{
+  "command": "add_blueprint_input_action_node",
+  "params": {
+    "blueprint_name": "MyActor",
+    "action_name": "Jump",
+    "node_position": [200, 200]
+  }
+}
+```
+
+### add_blueprint_function_node
+
+Add a function call node to a Blueprint's event graph.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `target` (string) - Target object for the function (component name or self)
+- `function_name` (string) - Name of the function to call
+- `params` (object, optional) - Parameters to set on the function node
+- `node_position` (array, optional) - [X, Y] position in the graph (default: [0, 0])
+
+**Returns:**
+- Response containing the node ID and success status
+
+**Example:**
+```json
+{
+  "command": "add_blueprint_function_node",
+  "params": {
+    "blueprint_name": "MyActor",
+    "target": "Mesh",
+    "function_name": "SetRelativeLocation",
+    "params": {
+      "NewLocation": [0, 0, 100]
+    },
+    "node_position": [300, 300]
+  }
+}
+```
+
+### connect_blueprint_nodes
+
+Connect two nodes in a Blueprint's event graph.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `source_node_id` (string) - ID of the source node
+- `source_pin` (string) - Name of the output pin on the source node
+- `target_node_id` (string) - ID of the target node
+- `target_pin` (string) - Name of the input pin on the target node
+
+**Returns:**
+- Response indicating success or failure
+
+**Example:**
+```json
+{
+  "command": "connect_blueprint_nodes",
+  "params": {
+    "blueprint_name": "MyActor",
+    "source_node_id": "node_1",
+    "source_pin": "exec",
+    "target_node_id": "node_2",
+    "target_pin": "exec"
+  }
+}
+```
+
+### add_blueprint_variable
+
+Add a variable to a Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `variable_name` (string) - Name of the variable
+- `variable_type` (string) - Type of the variable (Boolean, Integer, Float, Vector, etc.)
+- `default_value` (any, optional) - Default value for the variable
+- `is_exposed` (boolean, optional) - Whether to expose the variable to the editor (default: false)
+
+**Returns:**
+- Response indicating success or failure
+
+**Example:**
+```json
+{
+  "command": "add_blueprint_variable",
+  "params": {
+    "blueprint_name": "MyActor",
+    "variable_name": "Health",
+    "variable_type": "Float",
+    "default_value": 100.0,
+    "is_exposed": true
+  }
+}
+```
+
+### create_input_mapping
+
+Create an input mapping for the project.
+
+**Parameters:**
+- `action_name` (string) - Name of the input action
+- `key` (string) - Key to bind (SpaceBar, LeftMouseButton, etc.)
+- `input_type` (string, optional) - Type of input mapping (Action or Axis, default: "Action")
+
+**Returns:**
+- Response indicating success or failure
+
+**Example:**
+```json
+{
+  "command": "create_input_mapping",
+  "params": {
+    "action_name": "Jump",
+    "key": "SpaceBar",
+    "input_type": "Action"
+  }
+}
+```
+
+### add_blueprint_get_self_component_reference
+
+Add a node that gets a reference to a component owned by the current Blueprint.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `component_name` (string) - Name of the component to get a reference to
+- `node_position` (array, optional) - [X, Y] position in the graph (default: [0, 0])
+
+**Returns:**
+- Response containing the node ID and success status
+
+**Example:**
+```json
+{
+  "command": "add_blueprint_get_self_component_reference",
+  "params": {
+    "blueprint_name": "MyActor",
+    "component_name": "Mesh",
+    "node_position": [400, 400]
+  }
+}
+```
+
+### add_blueprint_self_reference
+
+Add a 'Get Self' node to a Blueprint's event graph.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `node_position` (array, optional) - [X, Y] position in the graph (default: [0, 0])
+
+**Returns:**
+- Response containing the node ID and success status
+
+**Example:**
+```json
+{
+  "command": "add_blueprint_self_reference",
+  "params": {
+    "blueprint_name": "MyActor",
+    "node_position": [500, 500]
+  }
+}
+```
+
+### find_blueprint_nodes
+
+Find nodes in a Blueprint's event graph.
+
+**Parameters:**
+- `blueprint_name` (string) - Name of the target Blueprint
+- `node_type` (string, optional) - Type of node to find (Event, Function, Variable, etc.)
+- `event_type` (string, optional) - Specific event type to find (BeginPlay, Tick, etc.)
+
+**Returns:**
+- Response containing array of found node IDs and success status
+
+**Example:**
+```json
+{
+  "command": "find_blueprint_nodes",
+  "params": {
+    "blueprint_name": "MyActor",
+    "node_type": "Event",
+    "event_type": "BeginPlay"
+  }
+}
+```
+
+## Error Handling
+
+All command responses include a "success" field indicating whether the operation succeeded, and an optional "message" field with details in case of failure.
+
+```json
+{
+  "success": false,
+  "message": "Blueprint 'MyActor' not found in the project",
+  "command": "add_blueprint_event_node"
+}
+```
+
+## Type Reference
+
+### Node Types
+
+Common node types for the `find_blueprint_nodes` command:
+
+- `Event` - Event nodes (BeginPlay, Tick, etc.)
+- `Function` - Function call nodes
+- `Variable` - Variable nodes
+- `Component` - Component reference nodes
+- `Self` - Self reference nodes
+
+### Variable Types
+
+Common variable types for the `add_blueprint_variable` command:
+
+- `Boolean` - True/false values
+- `Integer` - Whole numbers
+- `Float` - Decimal numbers
+- `Vector` - 3D vector values
+- `String` - Text values
+- `Object Reference` - References to other objects
+- `Actor Reference` - References to actors
+- `Component Reference` - References to components

package/tools/unreal-mcp/upstream/MCPGameProject/Plugins/UnrealMCP/Config/FilterPlugin.ini

@@ -0,0 +1,8 @@
+[FilterPlugin]
+; This section lists additional files which will be packaged along with your plugin. Paths should be listed relative to the root plugin directory, and
+; may include "...", "*", and "?" wildcards to match directories, files, and individual characters respectively.
+;
+; Examples:
+;    /README.txt
+;    /Extras/...
+;    /Binaries/ThirdParty/*.dll