godot_voxel/README.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

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)
2019-05-27 03:06:28 -07:00
- Full collision 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
- Minecraft-style blocky voxel terrain, with multiple materials and baked ambient occlusion
- Smooth terrain using Dual Marching Cubes
- Levels of details for smooth terrain (though not user editable yet)
- 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
-----------------------------------
- Level 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-05-27 03:06:28 -07:00
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.
Please see the [Getting Started Guide](doc/01_get-started.md) guide for instructions, or the [the demo](https://github.com/Zylann/voxelgame) for working examples.
Roadmap
---------
2019-05-27 03:06:28 -07:00
These are some ideas that may or may not be implemented in the future:
* LOD (in development)
* Support general voxel use (not just terrains)
* Transvoxel and other meshing algorithms
* GPU Offloading (Maybe when Godot 4+ supports compute shaders)