DOCS: moved documentation of voxedit into docs/ folder
Martin Gerhardy
parent
cbad35fb62
commit
35d9e604c6
|
|
@ -0,0 +1,10 @@
|
|||
# Controls
|
||||
|
||||
* Placing voxels via left mouse button or SHIFT+[CTRL+]Cursors
|
||||
* Deleting voxels via right mouse button
|
||||
* Rotating viewport via middle mouse button or holding alt and moving the mouse
|
||||
* Holding the left or right mouse buttons spans an AABB to perform the action in
|
||||
* Using the keybinding for `+actionexecute` (v) command allows you to also span an AABB with
|
||||
the cursor keys (resp. the keys that are bound to the `+movecursor[direction]` commands).
|
||||
* Enter places the reference position at the current cursor position
|
||||
* SHIFT+Tab opens the console (type cmdlist and cvarlist)
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# Features
|
||||
|
||||
* Auto-saving
|
||||
* Console to script your modeling (CTRL+TAB cmdlist)
|
||||
* Key bindings via cfg file
|
||||
* Four viewport mode
|
||||
* Grid resolution
|
||||
* Layer support
|
||||
* Mirror mode
|
||||
* Auto cropping volumes
|
||||
* Auto generate content like trees or noise volumes
|
||||
* Import heightmaps
|
||||
* Undo/Redo
|
||||
* Custom color palettes
|
||||
* Reference positions to rotate around or create auto-generated structures at
|
||||
* Viewport screenshots
|
||||
* Modelling with the left and right mouse buttons
|
||||
* Modelling without the mouse - just via shortcuts and keyboard
|
||||
* Layer animation support
|
||||
* Skeletal character animation support
|
||||
* Custom key bindings
|
||||
* Show commands of actions (to configure your own key bindings)
|
||||
* Rotate around reference position or center of volume
|
||||
* Import bitmaps as plane
|
||||
* Copy/Cut/Paste - paste to cursor or reference position
|
||||
* Exporting single layers into meshes
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Formats
|
||||
|
||||
It can load a lot of different formats:
|
||||
|
||||
* MagicaVoxel vox
|
||||
* Qubicle qbt and qb
|
||||
* VoxEdit vxm
|
||||
* binvox
|
||||
* CubeWorld cub
|
||||
* Build engine kvx
|
||||
* SLAB6 kv6
|
||||
* Command and Conquer vxl
|
||||
* Ace Of Spades vxl
|
||||
|
||||
And can also save to a lot of those.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
# General
|
||||
|
||||
This is an opensource, cross platform voxel volume editor.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Palette
|
||||
|
||||
The editor is built around a palette of 256 colors. Custom palettes are supported.
|
||||
|
|
@ -19,5 +19,11 @@ nav:
|
|||
- Compilation.md
|
||||
- Setup.md
|
||||
- Configuration.md
|
||||
- VoxEdit:
|
||||
- voxedit/Index.md
|
||||
- voxedit/Formats.md
|
||||
- voxedit/Features.md
|
||||
- voxedit/Controls.md
|
||||
- voxedit/Palette.md
|
||||
- Game Design:
|
||||
- GameDesign.md
|
||||
|
|
|
|||
|
|
@ -12,6 +12,10 @@
|
|||
|
||||
namespace voxel {
|
||||
|
||||
const char *VoxFileFormat::magic() const {
|
||||
return "";
|
||||
}
|
||||
|
||||
const glm::vec4& VoxFileFormat::getColor(const Voxel& voxel) const {
|
||||
const voxel::MaterialColorArray& materialColors = voxel::getMaterialColors();
|
||||
return materialColors[voxel.getColor()];
|
||||
|
|
|
|||
|
|
@ -28,6 +28,7 @@ protected:
|
|||
public:
|
||||
virtual ~VoxFileFormat() = default;
|
||||
|
||||
virtual const char *magic() const;
|
||||
virtual bool loadGroups(const io::FilePtr& file, VoxelVolumes& volumes) = 0;
|
||||
virtual RawVolume* load(const io::FilePtr& file);
|
||||
virtual bool saveGroups(const VoxelVolumes& volumes, const io::FilePtr& file) = 0;
|
||||
|
|
|
|||
|
|
@ -13,45 +13,7 @@ my own engine and evolved into something that others might find useful, too.
|
|||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* Load vox, qbt, qb, vxm, binvox, cub
|
||||
* Save to vox, qbt, qb, cub
|
||||
* Auto-saving
|
||||
* Console to script your modeling (CTRL+TAB cmdlist)
|
||||
* Key bindings via cfg file
|
||||
* Four viewport mode
|
||||
* Grid resolution
|
||||
* Layer support
|
||||
* Mirror mode
|
||||
* Auto cropping volumes
|
||||
* Auto generate content like trees or noise volumes
|
||||
* Import heightmaps
|
||||
* Undo/Redo
|
||||
* Custom color palettes
|
||||
* Reference positions to rotate around or create auto-generated structures at
|
||||
* Viewport screenshots
|
||||
* Modelling with the left and right mouse buttons
|
||||
* Modelling without the mouse - just via shortcuts and keyboard
|
||||
* Layer animation support
|
||||
* Skeletal character animation support
|
||||
* Custom key bindings
|
||||
* Show commands of actions (to configure your own key bindings)
|
||||
* Rotate around reference position or center of volume
|
||||
* Import bitmaps as plane
|
||||
* Copy/Cut/Paste - paste to cursor or reference position
|
||||
* Exporting single layers into meshes
|
||||
|
||||
## Controls
|
||||
|
||||
* Placing voxels via left mouse button or SHIFT+[CTRL+]Cursors
|
||||
* Deleting voxels via right mouse button
|
||||
* Rotating viewport via middle mouse button or holding alt and moving the mouse
|
||||
* Holding the left or right mouse buttons spans an AABB to perform the action in
|
||||
* Using the keybinding for `+actionexecute` (v) command allows you to also span an AABB with
|
||||
the cursor keys (resp. the keys that are bound to the `+movecursor[direction]` commands).
|
||||
* Enter places the reference position at the current cursor position
|
||||
* SHIFT+Tab opens the console (type cmdlist and cvarlist)
|
||||
[more details](../../../docs/voxedit)
|
||||
|
||||
## Planned
|
||||
|
||||
|
|
@ -71,7 +33,6 @@ my own engine and evolved into something that others might find useful, too.
|
|||
* Extend palette widget to show the used colors
|
||||
* Add color dialog for ambient and diffuse color
|
||||
* Extrude
|
||||
* Improve vox extension import
|
||||
* Rigging support
|
||||
* Gizmo for rotate, scale and move
|
||||
* Scene graph
|
||||
|
|
|
|||
Loading…
Reference in New Issue