README.md

Voxel-Art

Voxel Art Plugin — This is a tool that allows you to create entire worlds that you can modify directly in game mode. Landscapes can be completely different shapes, flat, ribbed, planetary, dune, it all depends on your imagination. Voxels can be not only cubic, but also smoothed. Which allows you to unleash your full creative potential, as well as enjoy the speed and great functionality of the plugin.

All of you know the game of mancraft, and what fantastic things you can make inside this amazing game. The world itself inside of minecraft is made up of voxels - cubes, but the voxels themselves can have completely different shapes. The Voxel Art plugin gives you the opportunity to create your own game with completely bizarre shapes and landscapes, in totally different styles. And the smart multi-threading and generation optimisation allows you to exploit the full potential of your computer power.

Unreal Engine Version 4.25-4.26

Features:

• Voxel Storage System
• Voxel Importer
• Voxel Splines
• Voxel Preview mode
• Voxel Multithreading
• Voxel Task prioritisation
• Any shapes for the world
• Realtime Editing

Support:

• My Twitter
• Discord channel

Documentation

Set up plugin:

• Create a new directive inside your main UE4 project and name it Plugins (If there is no such directive)
• Place the plugin in new directive
• Start the project and confirm the pop-up window for creating new builds
  

Create new Voxel World:

As soon as the project starts, select the right area of the Place Actors editor and enter Voxel World in the search box

• Place the new Voxel World component on the scene
• To be able to edit the game world directly in the game. You must select a new class in the game mod as your primary controller.
• Generate noise in a new file or use an existing one for the World Generator category
• You can click on the "Create World" button to preview the world
  
• You can manually change the size of the entire world, the amount of LOD detail, the size of each voxel, and the size of the chunk.

Create custom Generator:

Generate noise in a new file or use an existing one for the World Generator category By default, you can choose already ready-made examples of the generated landscape, which has been set up beforehand in the C++ class.

• Voxel World Generator
  Default empty generator. Can be used for heightmap importing
• Voxel World Flat Generator
  Generates default flat world
• Voxel World Planet Generator
  Generates planet world using Fractal Noise + Sphere

Of course you can create your own noise for the world, for this you need the following:

Create a new C++ class that inherits from the main Voxel World Generator class



Name the class with any free name. The recommended name is VoxelWorld[YourName]Generator. And then select the VoxelArt module and the VoxelArt/Public/Generators directory, as shown below



In the class that opens, you will need to redefine two methods

• Get Density Map - this method defines the shape of your landscape (noise)
• Get Color Map - in charge of what color your landscape will be. Do as shown below.
  

If the class was created without the U prefix, add it
Name this as UVoxelWorld[YourName]Generator

VoxelWorldMyNameGenerator.h

#pragma once

#include "CoreMinimal.h"
#include "Generators/VoxelWorldGenerator.h"
#include "VoxelWorldMyNameGenerator.generated.h"

/**
*
*/
UCLASS()
class VOXELART_API UVoxelWorldMyNameGenerator : public UVoxelWorldGenerator
{
  GENERATED_BODY()

private:

  virtual float GetDensityMap(const FIntVector& CellPosition);
  virtual FColor GetColorMap(const FIntVector& CellPosition);
};

You must also add a VoxelTools directive to the cpp file header in order to use special plugin tools (Such as: logging, ready-made colors, etc.). For the example I used a formula to display a flat world (More examples in the Generators file)

If the editor gives an error like "The file was not found in the directory
Add #include "Generators/VoxelWorld[YourName]Generator.h" instead of #include "VoxelWorld[YourName]Generator.h"
(Provided the class was created exactly in the Generators directory)

VoxelWorldMyNameGenerator.cpp

#include "Generators/VoxelWorldMyNameGenerator.h"
#include "Helpers/VoxelTools.h"

float UVoxelWorldMyNameGenerator::GetDensityMap(const FIntVector& CellPosition)
{
  Super::GetDensityMap(CellPosition);

  float Value = CellPosition.Z + Height + VoxelTools::VoxelOffset;
  return Value;
}

FColor UVoxelWorldMyNameGenerator::GetColorMap(const FIntVector& CellPosition)
{
  Super::GetColorMap(CellPosition);
  
  return VOXEL_COLOR;
}

Once you compile the finished class. Select a new generator class in the Voxel World properties. If you have done everything correctly, the new generator class should appear in the corresponding window in the Voxel World properties. Select it and click Play or create a preview of the world by clicking Create World

If the new class does not appear in the list - restart the editor

Screenshots