User Tools

Site Tools


voxel_editor

This is an old revision of the document!


Voxel Editor


Overview

The Voxel Editor is used to create the voxel models for your game's tiles, objects, and characters.

Main Toolbar

IconFunctionDescriptionShortcut Key
New ResourceOpens the New Resource dialog (with “Tile” selected for the resource type).
SaveSaves changes to the model.
Save AsSaves a copy of the model to a new file.
Import from External FormatOpens the Import dialog, allowing you to import data from MagicaVoxel .vox files or Qubicle .qb files.
Export to External FormatOpens the Export dialog, allowing you to export the model to MagicaVoxel .vox format, OBJ format, or a PNG image.
UndoReverts the most recent modification made to the model.Ctrl + Z
RedoReapplies the last modification that was undone.Ctrl + Y
Display GridEnables/disables display of the boundary grid lines.
Display Voxel OutlinesEnables/disables display of outlines drawn along voxel edges.
Display Surface EdgesEnables/disables display of outlines drawn along the perimeter of each flat surface.
Display Ambient OcclusionEnables/disables display of ambient occlusion in the editor.
Display GroundEnables/disables the ground surface displayed underneath the model.
Preview Game MeshDisplays the generated mesh as it will appear in-game.
Capture ThumbnailCaptures an image to use for the model's preview thumbnail.
Editor SettingsOpens the Voxel Editor section of the Editor Settings dialog.
Fullscreen ModeToggles the editor's fullscreen mode.F11

Camera Controls

Control/KeyDescription
Right Mouse Button + DragRotate camera
Middle Button + DragMove camera
Scroll Wheel UpZoom camera in
Scroll Wheel DownZoom camera out

Editor Tools

IconFunctionDescriptionShortcut Key
Attach/Place VoxelsMode for adding voxels to the model. New voxels can be attached to existing ones or onto the grid boundaries by left-clicking. In “Box” mode, you can click and drag to place a box area of voxels across three dimensions. In “Face” mode, clicking a voxel will “extrude” the face (all adjoining voxels of the same color) outward by one.F1
Paint VoxelsMode for painting voxels. Left-click an existing voxel to change its color to the currently selected color. In “Box” mode, you can click and drag to paint a three dimensional area. In “Face” mode, clicking a voxel's face will paint all voxels of the same color that adjoin that face.F2
Erase VoxelsMode for removing voxels from the model. Left-click to remove the voxel currently highlighted by the voxel cursor. In “Box” mode, you can click and drag to remove a box area of voxels across three dimensions. In “Face” mode, clicking a voxel's face will remove all voxels of the same color that adjoin that face.F3
Replace ColorMode for replacing the colors of multiple voxels at once. Left-clicking a voxel will replace the color of that voxel and any others of the same color with the currently selected color. With “All Frames” checked, the color replacement will occur across all frames of the model. With “Contiguous” checked, only adjoining voxels will be replaced.F4
Move VoxelsMode for moving voxels along one axis. The voxels will be moved in the direction of the mouse drag and based on the orientation of the voxel cursor. If any voxels are selected, only the selection will be moved, otherwise the entire model will be moved.F5
Select VoxelsMode for selecting one or more voxels that can then be moved or deleted independently from the rest of the model.F6
Pick ColorMode for sampling the color of a voxel. Left-clicking a voxel will set its color as the palette's selected color.F7
Create Attach PointMode for adding attach points to the model. Left-clicking a voxel will create an attach point at that voxel's coordinate. See Attach Points for more information.F8
Rotate Model ClockwiseRotates the entire model clockwise by 90 degrees (current frame only).
Flip Model HorizontallyFlips the entire model horizontally, relative to the camera view (current frame only).
Apply PaletteAttempts to match all voxel colors in the model to those of the currently selected palette. A dialog will open allowing you to adjust the results before the colors are applied.

Viewport Panels

These panels are located at the corners of the main viewport where the model itself is displayed.

PanelDescription
Grid DimensionsSets the grid dimensions (width, depth, and height in voxels) for the model. For tiles, this should match the tile size (16×16, 24×24, etc.) of any maps in which the tile will be placed.
Movement/Rotation ButtonsLocated in the upper right corner, these buttons move and rotate either the entire model or the selection if any voxels are currently selected. Movements and rotations are relative to the camera view.
Current ViewDisplays which side of the model is currently being viewed. The “Center Current View” button () will reset the camera to be centered on the current view. Selecting an option from the dropdown will rotate the camera to that side.
Surface Level (Tiles Only)Determines the vertical positioning of the tile when placed into a map. This can be used to ensure that all tiles of a set (e.g. water, shore, and any variations) will automatically have their vertical placement align correctly without needing to adjust the grid height. See Surface Level for more information.

Other Controls

Control/KeyDescription
Alt + Left Mouse ButtonPick color with eyedropper tool
Ctrl + Left Mouse Button + DragMove the model (or selection if any voxels are selected) while any tool mode is active
Hold Backtick Key (`)Hide extras (grid, voxel outlines, surface edges, and ground)
BSwitch to “Box” mode for Attach, Paint, and Erase tools
VSwitch to “Voxel” mode for Attach, Paint, and Erase tools
FSwitch to “Face” mode for Attach, Paint, and Erase tools

The Voxel Editor's palette allows you to select which color to use when attaching or painting voxels. The table below describes the actions that can be performed by clicking on a color slot within the palette grid.

ActionDescription
Left Mouse ButtonSelects the color to use for attaching and painting voxels.
Right Mouse ButtonOpens the color picker to modify the color.
Middle Mouse ButtonReplaces the color slot with the currently selected color.

Animation Toolbar

IconFunctionDescriptionShortcut Key
Frame NumberDisplays the current frame number and total number of frames. Clicking on the frame numbers will display a slider that can be used to quickly navigate through multiple frames.
First FrameJumps to the first frame.Ctrl + Up Arrow
Previous FrameMoves to the previous frame.Ctrl + Left Arrow
Next FrameMoves to the next frame.Ctrl + Right Arrow
Last FrameJumps to the last frame.Ctrl + Down Arrow
Frame Length MultiplerDefines how long the current frame will be shown when part of an animation (in number of frames).
Insert New FrameAdd a new blank frame after the current frame.Ctrl + N
Duplicate Current FrameCreates a copy of the current frame.Ctrl + D
Delete Current FrameDeletes the current frame.
Move Current Frame LeftReorders the frames by moving the current animation frame to the left.Shift + Left Arrow
Move Current Frame RightReorders the frames by moving the current animation frame to the right.Shift + Right Arrow
Play AnimationPlays the selected animation.
Add AnimationDisplays a dialog that will allow you to define a new animation for this model. These values can be adjusted afterward from the Model Properties panel.
Remove AnimationRemoves the selected animation.
voxel_editor.1600726515.txt.gz · Last modified: 2020/09/21 15:15 by justin