vengi/docs
Martin Gerhardy c11729a505 VOXCONVERT: removed --src-palette 2022-05-23 20:37:46 +02:00
..
img DOCS: added new grid lua script 2022-02-06 14:18:05 +01:00
mapview ALL: project rename 2022-01-23 23:22:47 +01:00
openworld VOXCONVERT: added scripting support 2021-12-15 22:35:28 +01:00
theme ALL: project rename 2022-01-23 23:22:47 +01:00
thumbnailer ALL: project rename 2022-01-23 23:22:47 +01:00
voxconvert VOXCONVERT: removed --src-palette 2022-05-23 20:37:46 +02:00
voxedit DOCS: updated voxedit features 2022-03-27 21:27:31 +02:00
AIRemoteDebugger.md ALL: project rename 2022-01-23 23:22:47 +01:00
Animations.md CMAKE: disable animation hot reload by default 2022-02-16 20:25:43 +01:00
Attributes.md DOCS: moved more documentation over to the mkdocs portal 2020-12-01 00:25:24 +01:00
Basics.md DOCS: basic docs 2022-01-14 16:36:06 +01:00
CHANGELOG.md VOXCONVERT: removed --src-palette 2022-05-23 20:37:46 +02:00
Compilation.md CMAKE: disable animation hot reload by default 2022-02-16 20:25:43 +01:00
ComputeShaderTool.md DOCS: restructured docs 2020-09-17 18:16:59 +02:00
Configuration.md DOCS: restructured documentation a little bit 2021-12-27 12:57:34 +01:00
CubicSurfaceExtractor1.png DOXYGEN: added missing images 2016-05-06 20:58:06 +02:00
CubicSurfaceExtractor2.png DOXYGEN: added missing images 2016-05-06 20:58:06 +02:00
CubicSurfaceExtractor3.png DOXYGEN: added missing images 2016-05-06 20:58:06 +02:00
Dependencies.md DOCS: updated dependencies and added missing files 2021-12-27 13:14:12 +01:00
Formats.md DOCS: add missing cvars 2022-05-23 16:51:36 +02:00
LUAScript.md VOXELGENERATOR: added region:size() 2022-05-03 22:52:50 +02:00
MinecraftAndVoxatron.jpg DOXYGEN: added missing images 2016-05-06 20:58:06 +02:00
Network.md DOCS: moved more documentation over to the mkdocs portal 2020-12-01 00:25:24 +01:00
Palette.md DOCS: restructured documentation a little bit 2021-12-27 12:57:34 +01:00
Persistence.md DOCS: moved more documentation over to the mkdocs portal 2020-12-01 00:25:24 +01:00
README.md ALL: project rename 2022-01-23 23:22:47 +01:00
ShaderTool.md DOCS: restructured docs 2020-09-17 18:16:59 +02:00
TestAnimation.md ALL: project rename 2022-01-23 23:22:47 +01:00
VisualTests.md DOCS: added new visual tests to the docs 2022-02-17 19:57:36 +01:00
aidebugger.png AI: missing docu images 2019-05-27 13:22:22 +02:00
complement.png AI: missing docu images 2019-05-27 13:22:22 +02:00
difference.png AI: missing docu images 2019-05-27 13:22:22 +02:00
intersection.png AI: missing docu images 2019-05-27 13:22:22 +02:00
union.png AI: missing docu images 2019-05-27 13:22:22 +02:00

README.md

Welcome to vengi

This is a C++ voxel game engine and its tools. It includes a voxel editor with character animation support and loading/saving into a lot of voxel volume formats. There are other tools like e.g. a thumbnailer for your filemanager and a command line tool to convert or modify between several voxel formats.

Find out more about features and status updates on my twitter profile.

The project source code is located at github/mgerhardy/vengi. We also provide debian and windows binaries here.

Join our discord Server.

If you just came here to use a voxel editor or to convert your voxel models into an obj or ply file, you should just go to the download page and check out the documentation of the tool as given in the navigation bar.

If you came here as a developer, make sure to check out the dependencies and set up your development environment. The build scripts are cmake based, so make sure to have it installed and generate the project files for your desired ide. After setting up everything, make sure to check out the compilation guide.

Images

image

image

image