Voxel Editor

From Wiki | RPG in a Box
Jump to: navigation, search

Overview

The Voxel Editor is where you will create the voxel models for your tiles, objects, and characters. It is similar to drawing pixel art but with a third dimension. You select a color and then click (or click and drag) to draw voxels. The depth of the cursor (forward and backward) is adjusted using the scroll wheel on your mouse. In the Voxel Editor, you can create frame-by-frame animations for your models.


Components

Toolbar

Voxel editor toolbar.png

  • Page white add.png New: Opens the New Resource dialog.
  • Disk.png Save: Saves the voxel model. This will become enabled any time changes have been made to the model.
  • Disk multiple.png Save As: Saves the voxel model to a new file with a different name. A dialog will open to prompt for the new name and type (tile, object, or character). Once saved, the voxel model will be opened in a new tab.
  • Clear.png Clear: Removes all voxels from the current frame.
  • Brick add.png Import: Imports voxel data from the MagicaVoxel (.vox) format (experimental feature).
  • Lorry go.png Export: Exports the current frame into a .OBJ format file that can be loaded into external applications such as Blender.
  • View: Changes the viewing angle for "Paint Mode". The available views are Front, Back, Left, Right, Top, and Bottom.
  • Paintbrush.png Paint Mode: Changes to "Paint Mode". In this mode, you can place and delete voxels to build your model.
  • Eye.png View Mode: Changes to "View Mode". In this mode, you can right-click and drag to get a full 360-degree view of your model.
  • Color swatch.png Voxel Color: Selects the color to use when painting voxels.
  • Replace Color: Displays a color picker to replace the currently selected voxel color with a new color. All animation frames will be affected.
  • Arrow up.png Shift Model Up: Shifts the entire model up by one voxel (relative to Front View). Only the current animation frame will be affected.
  • Arrow down.png Shift Model Down: Shifts the entire model down by one voxel (relative to Front View). Only the current animation frame will be affected.
  • Arrow left.png Shift Model Left: Shifts the entire model left by one voxel (relative to Front View). Only the current animation frame will be affected.
  • Arrow right.png Shift Model Right: Shifts the entire model right by one voxel (relative to Front View). Only the current animation frame will be affected.
  • Blue arrow down.png Shift Model Forward: Shifts the entire model forward by one voxel (relative to Front View). Only the current animation frame will be affected.
  • Blue arrow up.png Shift Model Backward: Shifts the entire model backward by one voxel (relative to Front View). Only the current animation frame will be affected.


3D View

The main 3D view is used for drawing your model. A semi-transparent voxel will display where your cursor is to indicate where the voxel will be drawn. There are also markers that will display along the grid to serve as guides as to the position of the cursor. You can change which side of the voxel model you are viewing by selecting an option from the View dropdown on the Voxel Editor toolbar.

Voxel editor 3d view.png


Animation Toolbar

Animation toolbar.png

  • Film.png Frame: Displays the current frame number and total number of frames.
  • Resultset first.png View First Frame: Jumps to the first animation frame.
  • Blue arrow left.png View Previous Frame: Shows the previous animation frame.
  • Blue arrow right.png View Next Frame: Shows the next animation frame.
  • Resultset last.png View Last Frame: Jumps to the last animation frame.
  • Page white add.png Add Blank Frame: Add a new blank frame after the current one.
  • Film duplicate.png Duplicate Current Frame: Creates a copy of the current animation frame.
  • Film delete.png Delete Current Frame: Deletes the current animation frame
  • Film move left.png Move Current Frame Left: Reorders the frames by moving the current animation frame to the left.
  • Film move right.png Move Current Frame Right: Reorders the frames by moving the current animation frame to the right.
  • Control play blue.png Play Animation: Plays the selected animation.
  • Add.png Add Animation: Displays a dialog that will allow you to define a new animation for this model. These values can be adjusted afterward from the Properties panel.
  • Clear.png Remove Animation: Removes the selected animation.


Properties Panel

The Properties panel displays various information pertaining to the voxel model, most of which can be edited.

Voxel properties.png

  • User go.png Walkable: Specifies whether or not the player can pass through this object by default when placing onto a map. For example, a basic grass tile or a small rock should be marked as walkable, but a fence or a tree should be marked as not walkable. This property is used by the Map Editor to calculate the initial navigation paths for characters.
  • Tag blue.png Tags: The tags field should contain a comma-separated list of keywords that describe the model, for example a fitting tag for a chair object would be "furniture". In the resource selection sidebar, a list of all tags are available to be selected from the filter at the top to help search for a particular resource.
  • Lightbulb.png Light Source: Specifies whether or not this model should be a source of light. This is useful for objects such as torches where you will always want light to be emitted when placed onto a map. Several attributes can be adjusted, including color, intensity, and diameter. The arrow buttons can be used to modify the position of the light.
  • Film.png Animation: Any animations that have been defined for this voxel model from the animation toolbar will be listed here. From here, you can adjust any of the animation's attributes, such as the Start Frame, End Frame, Type, and Speed.


Controls/Shortcut Keys

Edit Mode

  • Left Mouse Button: Place voxel at cursor position.
  • Scroll Wheel: Adjust depth of voxel cursor.
  • D: Delete voxel at cursor position.
  • E or Middle Mouse Button: Grab voxel color at cursor position (eyedropper).
  • Right Mouse Button + Drag: Rotate camera.

View Mode

  • Right Mouse Button + Drag: Rotate model.