Skip to main content

Getting Started

Learn how to get up and running with D3kryptions Building Generator.

Workflow Overview

Flowchart of how parts connect (Definition -> Pieces -> Sockets -> Actor)

Installation

Plugin enabled in Unreal Engine

  1. Copy the D3kryptionsBuildingGenerator folder into your project's Plugins directory.
  2. Restart Unreal Engine.
  3. Enable the plugin in Edit > Plugins.

Your First Building

Building Generator Actor in Level

  1. Create a Building Definition: Create a Building Definition asset. This will be the root of your building.
  2. Create Building Pieces: Create several Building Piece Definition assets. Assign a Static Mesh to each one (e.g., a wall, a floor, a roof).
  3. Define Sockets: In your Building Piece assets, define Socket Rules where other pieces can connect.
  4. Place the Generator: Drag a Building Generator actor into your level.
  5. Assign the Definition: Select the Generator actor and assign your Building Definition to the Building Definition property.
  6. Generate: Click the Generate Building button in the actor's details panel.

Advanced Topics & Best Practices

To get the most out of the plugin, we recommend reading these additional guides:

Demo Level

The plugin includes a demo level that showcases various pre-generated buildings using basic assets. This is a great place to see how different scenarios are handled, such as:

  • Peasant Houses: Simple, small structures.
  • Upper Class: Medium-sized, more detailed buildings.
  • Royalty: Large, complex structures with multiple floors and ornate pieces.

You can find the demo level in the plugin's Content folder under Maps/DemoLevel.

Video Tutorials

For a visual guide on how to use the plugin, check out these videos: