DOCS: restructured

added mapview and server section
added more images
moved changelog into docs/
master
Martin Gerhardy 2020-06-29 21:37:14 +02:00
parent 82a310b068
commit 7df0bb9eb6
11 changed files with 116 additions and 77 deletions

View File

@ -1,23 +1,29 @@
A more detailed changelog can be found at: https://github.com/mgerhardy/engine/commits/
# Changelog
#### 0.0.5 (2020-XX-XX)
A more detailed changelog can be found at: [on github](https://github.com/mgerhardy/engine/commits/)
## 0.0.5 (2020-XX-XX)
VoxConvert:
VoxConvert:
- Support different palette files (cvar `palette`)
- Support writing outside the registered application paths
- Allow to overwrite existing files
General:
General:
- Switched to qb as default volume format
- Improved scene graph support for Magicavoxel vox files
- Fixed invisible voxels for qb and qbt (Qubicle) volume format
- Support automatic loading different volume formats for assets
- Support Command&Conquer vxl files
- Support Ace of Spades map files (vxl)
- Perform mesh extraction in dedicated threads for simple volume rendering
#### 0.0.4 (2020-06-07)
## 0.0.4 (2020-06-07)
General:
General:
- Added support for writing binvox files
- Added support for reading kvx (Build-Engine) and kv6 (SLAB6) voxel volumes
- Performed some AFL hardening on voxel format code
@ -28,23 +34,28 @@ A more detailed changelog can be found at: https://github.com/mgerhardy/engine/c
- Improved tracy profiling support
- A few highdpi fixes
Server:
Server:
- Allow to specify the database port
- Fixed loading database chunks
VoxEdit:
VoxEdit:
- Added `scale` console command to produce LODs
VoxConvert:
VoxConvert:
- Added ability to merge all layers into one
#### 0.0.3 (2020-05-17)
## 0.0.3 (2020-05-17)
Assets:
Assets:
- Added music tracks
- Updated and added some new voxel models
VoxEdit:
VoxEdit:
- Made some commands available to the ui
- Tweak `thicken` command
- Updated default tree generation ui values
@ -53,7 +64,8 @@ A more detailed changelog can be found at: https://github.com/mgerhardy/engine/c
- Changed default reference position to be at the center bottom
- Reduced max supported volume size
General:
General:
- Print stacktraces on asserts
- Improved tree generation (mainly used in voxedit)
- Fixed a few asserts in debug mode for the microsoft stl
@ -64,17 +76,20 @@ A more detailed changelog can be found at: https://github.com/mgerhardy/engine/c
- Fixed timing issues
- Fixed invalid GL states after deleting objects
VoxConvert:
VoxConvert:
- Added a new tool to convert different voxel volumes between supported formats
Currently supported are cub (CubeWorld), vox (MagicaVoxel), vmx (VoxEdit Sandbox), binvox
and qb/qbt (Qubicle)
Client:
Client:
- Added footstep and ambience sounds
#### 0.0.2 (2020-05-06)
## 0.0.2 (2020-05-06)
VoxEdit:
VoxEdit:
- Static linked VC++ Runtime
- Extract voxels by color into own layers
- Updated tree and noise windows
@ -82,7 +97,8 @@ A more detailed changelog can be found at: https://github.com/mgerhardy/engine/c
- Escape abort modifier action
- Added L-System panel
General:
General:
- Fixed binvox header parsing
- Improved compilation speed
- Fixed compile errors with locally installed glm 0.9.9
@ -96,19 +112,22 @@ A more detailed changelog can be found at: https://github.com/mgerhardy/engine/c
- Improved compile speed and further removed the STL from a lot of places
- Updated all dependencies to their latest version
Server/Client:
Server/Client:
- Added DBChunkPersister
- Built-in HTTP server to download the chunks
- Replaced ui for the client
Voxel rendering
Voxel rendering
- Implemented reflection for water surfaces
- Apply checkerboard pattern to voxel surfaces
- Up-scaling effect for new voxel chunks while they pop in
- Optimized rendering by not using one giant vbo
#### 0.0.1 "Initial Release" (2020-02-08)
## 0.0.1 "Initial Release" (2020-02-08)
VoxEdit:
VoxEdit:
- initial release

7
docs/mapview/Index.md Normal file
View File

@ -0,0 +1,7 @@
# General
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/mapview.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/mapview2.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/twitter_2020_02_05.gif)

View File

@ -1,18 +1,20 @@
# General
Create thumbnailer images of all supported voxel formats. In combination with a mimetype definition and a `.thumbnailer` defintiion file
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/thumbnailer.jpg)
Create thumbnailer images of all supported voxel formats. In combination with a mimetype definition and a `.thumbnailer` definition file
that must be installed in `/usr/share/mime/packages` and `/usr/share/thumbnailer` this will e.g. create small preview images for
`vox`, `qb`, `qbt`, `vxm`, `cub`, ... files.
`vox`, `qb`, `qbt`, `vxm`, `cub`, `vxl`, ... files.
It works for any file manager that supports `.thumbnailer` entries, including Nautilus, Thunar (when tumbler is installed), Nemo, Caja,
and PCManFM.
# Example
## Example
This allows you to create the thumbnails manually.
```bash
for i in $(find $HOME/dev/engine -name "*.vox" -or -name "*.cub" -or -name "*.qbt" -or -name "*.qb" -or -name "*.vxm"); do
for i in $(find $HOME/dev/engine -name "*.vox" -or -name "*.cub" -or -name "*.qbt" -or -name "*.qb" -or -name "*.vxl" -or -name "*.vxm"); do
fullpath=$(readlink -f $i)
md5=$(echo -n "file://$fullpath" | md5sum -z | awk ' { print $1.".png" }')
vengi-thumbnailer -s 128 $i $HOME/.cache/thumbnails/large/$md5

View File

@ -5,3 +5,19 @@ Convert voxel volume formats between each other.
Support for loading: vox, qbt, qb, vxm, binvox, cub, kvx, kv6, vxl
Support for writing: vox, qbt, qb, binvox, cub, vxl
## Usage
`./vengi-voxconvert --merge --scale infile outfile`
* `--merge`: will merge a multi layer volume (like vox, qb or qbt) into a single volume of the target file
* `--scale`: perform lod conversion of the input volume (50% scale per call)
Just type `vengi-voxconvert` to get a full list of commands and options.
Using a different target palette is also possible by setting the `palette` config var.
`./vengi-voxconvert -set palette /path/to/palette.png infile outfile`
The palette file has to be in the dimensions 1x256. It is also possible to just provide the basename of the palette.
This is e.g. `nippon`. The tool will then try to look up the file `palette-nippon.png` in the file search paths.

View File

@ -1,15 +0,0 @@
# Usage
`./vengi-voxconvert --merge --scale infile outfile`
* `--merge`: will merge a multi layer volume (like vox, qb or qbt) into a single volume of the target file
* `--scale`: perform lod conversion of the input volume (50% scale per call)
Just type `vengi-voxconvert` to get a full list of commands and options.
Using a different target palette is also possible by setting the `palette` config var.
`./vengi-voxconvert -set palette /path/to/palette.png infile outfile`
The palette file has to be in the dimensions 1x256. It is also possible to just provide the basename of the palette.
This is e.g. `nippon`. The tool will then try to look up the file `palette-nippon.png` in the file search paths.

View File

@ -1,26 +0,0 @@
# 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

View File

@ -7,3 +7,40 @@ This is an opensource, cross platform voxel volume editor.
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/voxedit-custom-shader.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/voxedit-quad-view.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/animation-frames.gif)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/quad-view-knight.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/voxedit-command_and_conquer.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/voxedit-duke.png)
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/voxedit-import-planes.png)
## 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

View File

@ -17,18 +17,17 @@ nav:
- Basics:
- Dependencies.md
- Compilation.md
- Setup.md
- Configuration.md
- Formats.md
- CHANGELOG.md
- VoxEdit:
- voxedit/Index.md
- voxedit/Formats.md
- voxedit/Features.md
- voxedit/Controls.md
- voxedit/Palette.md
- VoxConvert:
- voxconvert/Index.md
- voxconvert/Usage.md
- Thumbnailer:
- thumbnailer/Index.md
- Game Design:
- GameDesign.md
- Client/Server:
- server/Index.md
- server/Setup.md
- VoxConvert: voxconvert/Index.md
- Thumbnailer: thumbnailer/Index.md
- MapView: mapview/Index.md
- Game Design: GameDesign.md