Voxel Plugin
1.2 Legacy
1.2 Legacy
  • Getting Started
    • Quick Start
      • Examples
    • World Generation
      • C++ World Generators
      • Voxel Graph Quick Start
      • Floating Islands
  • Core Systems
    • VoxelWorlds
      • Import Content
      • Voxel Data Items
      • Collisions and Navmesh
      • World Size and Level Of Details
      • Save and Load
      • Multiplayer
      • Easy Systems RPG
    • Voxel Graphs
      • Voxel Graph General Concepts
      • Voxel Graphs Tips and Tricks
      • Voxel Graph Nodes Reference
      • Voxel Graph Outputs
      • Voxel Graph Parameters
      • Custom Graph Nodes
    • Voxel Spawners
    • Materials
      • Multi Index Materials
  • Technical Notes
    • Performance and Profiling
    • Console Commands
    • Blueprint API
    • Release Notes
      • Release Notes 1.1
      • Release Notes 1.2
    • UE5.1 - Material Crash
Powered by GitBook
On this page
  • First Steps
  • Compatibility between Free and Pro
  • Additional setup
  • What next?
  • Using the Beta / Building from source

Was this helpful?

  1. Getting Started

Quick Start

NextExamples

Last updated 11 months ago

Was this helpful?

We recommend using Unreal Engine 5.4 alongside Voxel Plugin Legacy - it is significantly more stable than on previous engine versions.

First Steps

  • For good results, make sure all your lights and skylights are set to Movable

To get started with voxels, switch into the Voxels editor mode.

You should see a flat world appear:

  • Start sculpting using the included tools

  • Hit Save. You will see the following popup:

Click Yes, and in the following popup, click Save. Unlike Unreal Landscapes, Voxel World do not store the edit data themselves: they delegate that to a Voxel World Save Object.

This distinction makes it easier to switch between saves without reloading entire levels.

  • Hit play. You should spawn in your edited voxel world, and should be able to edit it at runtime too!

Compatibility between Free and Pro

Free and Pro have the same blueprint API. However, free is missing the implementation of some functions, and will show a Voxel Plugin Pro only popup if you try to use them.

This means that you can start a project with Free, and painlessly migrate it to Pro later on.

Additional setup

Additionally, you can do the following:

  • Reparent your character class from Character to Voxel Character. This prevents your character from teleporting around when playing.

What next?

You can check the following pages:

  • VoxelSimpleController to see an example on how to apply the tools directly

You should also watch this awesome video about marching cubes to get a deeper understanding of the plugin inner workings:

Using the Beta / Building from source

If you are using the plugin beta or the plugin source from GitHub, you will need to build it from source.

  • Make sure your project is a C++ project. To do that, you can simply add a new C++ class to it (leave everything to default and just click next):

  • Create a Plugins folder next to your .uproject

  • Extract the plugin in it. You should have the following path: MyProject/Plugins/VoxelPro/VoxelPro.uplugin (same for Free with VoxelFree)

  • Open your .uproject, and click Yes on the following popup:

Set your player controller to Voxel Complex Controller. If you don't see it, add the example assets (see ) or tick Show Engine Content.

Add a Voxel Invoker Component to your character. See for more info on Voxel Invokers

Make sure to join the official Voxel Plugin Discord!

If you're starting with unreal, you might want to give a go!

to know how to download the example projects

to learn all about materials in the plugin!

for world generation using Voxel Graphs (pro only)

to see the included world generators examples, and to learn about world generation using C++

to learn how to procedurally spawn foliage on voxel worlds! (pro only)

to learn how to import external assets to the plugin (pro only)

The reference

The C++ API reference:

If you have any issue, first check .

Install Visual Studio as instructed here:

Examples
World_Size_and_Level_Of_Details
https://discord.voxelplugin.com
Easy Systems RPG
Examples
Materials
Voxel Graph Quick Start
C++ World Generators
Voxel Spawners
Import Content
Blueprint API
https://wiki.voxelplugin.com/CppAPIReference/
Common Issues
https://docs.unrealengine.com/en-US/Programming/Development/VisualStudioSetup/index.html