novemtails / blocky-world-editor

3d Tilemap Editor for Unity

BlockyWorldEditor

Code from "Creating a 3D Tilemap Editor and World Builder in Unity" YouTube videos

###Quick Start Video

Installation

Requires Unity 2021.2+ Can be installed via the Package Manager > Add Package From Git URL... https://github.com/peartreegames/blocky-world-editor.git

Overview

The BlockyWorldEditor allows you to quickly place GameObjects into your scenes on a 1x1x1 unit grid. (Size is potentially modifiable and something which could be added to this package.)

To start click Tools > BlockyEditor

Architectural Overview

Palettes

Create > Blocky > Palette

A collection of IBlockyPieces to place in your scene. Will automatically be added to the dropdown selection.

Layers

Create > Blocky > Layer

A composite key for the placement of IBlockyPieces. Layers can be anything you like, but typical layers may include something like Terrain, Props, Water, etc. Essentially groupings where only one GameObject of that layer type can occupy the same space.

BlockyObject

MonoBehaviour to be added to GameObjects you wish you place.

BlockyRuleSet

Collection of BlockyObjects which change based on their neighbours. Good for paths, fences, walls, etc.

BlockyRandomizer

Collection of BlockyObjects which will choose one at random. Good for landscaping or rubbish, essentially fast placement of inconsequential items strewn about a level to add texture.

BlockyParentSetter

To create your own ParentSetter create a new class derived from the BlockyParentSetter, which will return a Transform. This allows you to place your objects however you wish. See the BlockyWorldStreamer for an example.

IBlockyScenePreprocessor

When finishing painting it's convenient (and advised) to process a scene for optimizations or data collection. Any class which implements this interface will be called for all opened scenes when the mode changes.

void ProcessScene(BlockyEditorWindow window, Scene scene);
void RevertScene(BlockyEditorWindow window, Scene scene);

Hotkeys

Key	Description
W/S	Grid Height
Shift	Box drag
Ctrl	Remove
Q/E	Rotate 90 degress
R	Random Rotation
1-4	Brush Size
+/-	Increase/Decrease Brush Size

Notes

BlockyObjects have a "allowRandomRotation" flag, when using RandomRotation in the editor only those set will be rotated, otherwise will be set to the current rotation (or BlockyParentSetter's rotation).

Todo

• Implement random rotation
• Implement placement visualization
• Better refresh (editor/palettes) on changes