Getting Started

Install

1. Copy the ModularKitSnapping folder into your project's Plugins/ directory.
2. Right-click your .uproject and Generate Visual Studio project files.
3. Build your project. The plugin is a C++ code plugin with two modules: ModularKitSnappingRuntime and ModularKitSnappingEditor.
4. Open the editor. Confirm the plugin is enabled under Edit -> Plugins -> Level Design.

Quick start

1. Make a Blueprint that inherits from ModularPieceActor. Set its MeshComponent to a wall, floor, or corridor mesh.
2. Drop one or more SnapPointComponents on it. For each, set:
   • SnapType (Wall, Door, Floor, ...)
   • SnapDirection (Left, Right, Up, ...) -- the outward-facing axis
   • SnapRadius -- how close another snap point must be to match
3. (Optional) Tick Is Anchor on pieces that should never move during auto-snap.
4. Place pieces in your level. They don't need to be perfectly aligned.
5. Add a SnapConnectionManager component to a "kit root" actor and call Auto Snap All In World on BeginPlay.

That's the whole setup. Misaligned pieces snap into place when the level starts.

A minimal Blueprint flow

Event BeginPlay
   -> SnapConnectionManager: Auto Snap All In World (Self)
   -> Print String: "Made N connections"

For a custom workflow, you can:

• Call FindBestSnap / MakeConnection manually
• Listen to OnConnectionMade / OnConnectionBroken for gameplay logic, UI, or audio
• Run ValidateStructure to surface missing mandatory connections

Editor visualization

Once snap points are placed, the viewport shows:

Element	Meaning
Colored dot	Snap location (color = type or state)
Direction arrow	Outward-facing direction (60 cm)
Diamond outline	Snap radius
Green line	Live connection to another actor

See Snap Points for the full color key.

Next steps

• Configure a rule set for your kit
• Read the Auto-Snap page to understand anchors and ordering
• Browse the presets included with the plugin