Go to file
Marc Gilleron b16d8ff00d Update XML API docs, add a few more descriptions and fix some functions 2020-09-14 01:58:35 +01:00
.github/workflows Remove debug symbols from Linux builds 2020-09-13 02:14:14 +01:00
doc Update XML API docs, add a few more descriptions and fix some functions 2020-09-14 01:58:35 +01:00
edition Update XML API docs, add a few more descriptions and fix some functions 2020-09-14 01:58:35 +01:00
editor Added basic icons for terrain nodes, but needs engine fix to show properly 2020-08-24 13:54:30 +01:00
generators Removed unused class 2020-09-12 21:08:55 +01:00
math Allow to specify bounds in VoxelTerrain 2020-09-13 22:36:28 +01:00
meshers Fix GCC warnings 2020-09-13 02:36:06 +01:00
server Cancel block tasks if they are too far away 2020-09-06 23:57:41 +01:00
streams Unused variable 2020-09-13 02:59:12 +01:00
terrain Allow to specify bounds in VoxelTerrain 2020-09-13 22:36:28 +01:00
thirdparty/lz4 Moved lz4 to a thirdparty folder 2019-08-24 23:07:30 +01:00
util Removed unused class 2020-09-12 21:08:55 +01:00
.gitignore Fix build warnings on other platforms 2020-04-03 20:46:29 +08:00
CHANGELOG.md Update changelog 2020-09-13 02:35:03 +01:00
CODE_GUIDELINES.md No long lines 2020-09-13 02:14:41 +01:00
LICENSE.md Added license 2016-07-28 00:21:21 +02:00
README.md Update readme 2020-09-11 00:32:34 +01:00
SCsub Added cubes mesher with greedy meshing support 2020-09-11 00:36:23 +01:00
config.py Add missing classes to doc 2020-09-06 19:36:53 +01:00
cube_tables.cpp No longer copy voxels before scheduling threaded tasks. VoxelBuffers now have a lock. 2020-08-29 22:09:54 +01:00
cube_tables.h No longer copy voxels before scheduling threaded tasks. VoxelBuffers now have a lock. 2020-08-29 22:09:54 +01:00
octree_tables.h Moved ObjectPool to util/ and moved OctreeTables to root 2019-04-29 21:31:08 +01:00
register_types.cpp Color palette support in .vox loader and Cubes mesher 2020-09-13 02:17:11 +01:00
register_types.h Added project: first working prototype, but lots of TODOs 2016-05-01 15:00:02 +02:00
voxel_buffer.cpp Update XML API docs, add a few more descriptions and fix some functions 2020-09-14 01:58:35 +01:00
voxel_buffer.h Added cubes mesher with greedy meshing support 2020-09-11 00:36:23 +01:00
voxel_constants.h Fix split scale not being clamped properly. Also reorganized debug functions a bit 2020-01-15 21:04:23 +00:00
voxel_memory_pool.cpp Profile block channel allocation 2020-08-30 18:51:45 +01:00
voxel_memory_pool.h Fix memory leak in VoxelBuffer::fill() 2020-01-26 01:59:53 +00:00
voxel_string_names.cpp Implemented block events for VoxelTerrain 2020-08-10 20:57:03 +01:00
voxel_string_names.h Implemented block events for VoxelTerrain 2020-08-10 20:57:03 +01:00

README.md

Voxel Tools for Godot

A C++ module for creating volumetric worlds in Godot Engine.

Features

  • Realtime editable, 3D based terrain (Unlike a heightmap based terrain, this allows for overhangs, tunnels, and user creation/destruction)
  • Physics based collision and raycast support
  • Infinite terrains made by paging sections in and out
  • Voxel data is streamed from a variety of sources, which includes the ability to write your own generators
  • Minecraft-style blocky voxel terrain, with multiple materials and baked ambient occlusion
  • Smooth terrain using Transvoxel
  • Levels of detail for smooth terrain
  • Voxel storage using 8-bit channels for any general purpose

What This Module Doesn't Provide

  • Levels of detail for blocky terrain
  • Game specific features such as cave generation or procedural trees (though it might include tools to help doing them)
  • Editor tools (only a few things are exposed)
  • Import and export of voxel formats

How To Install And Use

Voxel Tools is a custom C++ module for Godot 3.1+. It must be compiled into the engine to work.

Prebuilt binaries

Ready-to-use versions of Godot including the module exist, though they might not be 100% up to date.

Compiling

Compiling the source yourself is the best way to get your own version and export template. Please see the Getting Started Guide for instructions.

Examples

Roadmap

These are some ideas that may or may not be implemented in the future:

  • Texturing on smooth terrain
  • Editor preview and authoring
  • Improving LOD performance
  • Other meshing algorithms (e.g. dual contouring)
  • GPU offloading (Maybe when Godot 4+ supports compute shaders)