2016-05-01 14:45:54 -07:00
Voxel Tools for Godot
=========================
2019-05-27 03:06:28 -07:00
A C++ module for creating volumetric worlds in Godot Engine.
2016-05-01 14:45:54 -07:00
2019-05-27 03:06:28 -07:00
< img src = "doc/images/blocky_screenshot.png" width = "800" / >
< img src = "doc/images/smooth_screenshot.png" width = "800" / >
< img src = "doc/images/textured-terrain.jpg" width = "800" / >
2016-05-04 05:52:41 -07:00
2019-05-27 03:06:28 -07:00
Features
2018-09-28 06:07:01 -07:00
---------------------------
2016-05-04 05:52:41 -07:00
2019-08-10 09:49:25 -07:00
- Realtime editable, 3D based terrain (Unlike a heightmap based terrain, this allows for overhangs, tunnels, and user creation/destruction)
2020-02-12 08:48:18 -08:00
- Physics based collision and raycast support
2019-05-27 03:06:28 -07:00
- Infinite terrains made by paging sections in and out
2020-02-12 08:48:18 -08:00
- Voxel data is streamed from a variety of sources, which includes the ability to write your own generators
2019-05-27 03:06:28 -07:00
- Minecraft-style blocky voxel terrain, with multiple materials and baked ambient occlusion
2020-02-12 08:48:18 -08:00
- Smooth terrain using Transvoxel
2019-10-04 03:28:46 -07:00
- Levels of detail for smooth terrain
2019-05-27 03:06:28 -07:00
- Voxel storage using 8-bit channels for any general purpose
2018-09-28 06:07:01 -07:00
2019-05-27 03:06:28 -07:00
What This Module Doesn't Provide
2018-09-28 06:07:01 -07:00
-----------------------------------
2019-10-04 03:28:46 -07:00
- Levels of detail for blocky terrain
2018-09-28 06:09:06 -07:00
- Game specific features such as cave generation or procedural trees (though it might include tools to help doing them)
2018-09-28 06:07:01 -07:00
- Editor tools (only a few things are exposed)
- Import and export of voxel formats
2019-04-27 20:25:27 -07:00
2019-05-27 03:06:28 -07:00
How To Install And Use
-------------------------
2020-08-17 14:31:00 -07:00
Voxel Tools is a custom C++ module for Godot 3.1+. It must be compiled into the engine to work.
2019-05-27 03:06:28 -07:00
2020-08-17 14:31:00 -07:00
### Prebuilt binaries
Ready-to-use versions of Godot including the module exist, though they might not be 100% up to date.
2020-09-09 12:23:59 -07:00
- Tokisan Games (editor and export templates)
2020-08-17 14:31:00 -07:00
- [Tokisan Games binaries ](http://tokisan.com/godot-binaries )
2020-09-09 12:23:59 -07:00
- Master builds (editor)
- Windows: https://github.com/Zylann/godot_voxel/actions?query=workflow%3A%22%F0%9F%9A%AA+Windows+Builds%22
- Linux: https://github.com/Zylann/godot_voxel/actions?query=workflow%3A%22%F0%9F%90%A7+Linux+Builds%22
- Warning, these can be unstable, as they come from the very latest commits. Click on one of the recent commits and a build artifact should be available.
2020-08-17 14:31:00 -07:00
### Compiling
2020-08-20 21:41:55 -07:00
Compiling the source yourself is the best way to get the very latest version.
2020-08-17 14:31:00 -07:00
Please see the [Getting Started Guide ](doc/01_get-started.md ) for instructions.
### Examples
- Documentation: [Getting Started Guide ](doc/01_get-started.md )
- Zylann's demos: [Zylann's demos ](https://github.com/Zylann/voxelgame )
- TinmanJuggernaut's demos: [TinmanJuggernaut's demo ](https://github.com/tinmanjuggernaut/voxelgame )
2019-05-27 03:06:28 -07:00
2019-04-27 20:25:27 -07:00
Roadmap
---------
2019-05-27 03:06:28 -07:00
These are some ideas that may or may not be implemented in the future:
2020-08-17 14:31:00 -07:00
* Texturing on smooth terrain
* Editor preview and authoring
* Improving LOD performance
2020-02-12 08:48:18 -08:00
* Other meshing algorithms (e.g. dual contouring)
2020-08-17 14:31:00 -07:00
* GPU offloading (Maybe when Godot 4+ supports compute shaders)
