godot_voxel/README.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2016-05-01 23:45:54 +02:00
Voxel Tools for Godot
=========================
2017-04-07 23:44:26 +02:00
C++ module for creating volumetric worlds in Godot Engine.
2016-05-01 23:45:54 +02:00
2016-05-04 14:52:41 +02:00
![Example screenshot](screenshots/2016_05_04_0319_w800.png)
Setup
------
Install the contents of the repo in a folder under "modules/", named "voxel".
IMPORTANT: if you clone the repo, Git will create the folder as the repo name, "godot_voxel". But because Godot SCons scripts consider the folder name as the module's name, it will generate wrong function calls, so you must rename the folder "voxel".
2018-09-28 15:07:01 +02:00
What this module provides
---------------------------
2016-05-04 14:52:41 +02:00
2018-09-28 15:07:01 +02:00
- Fully editable terrain as long as you call the right functions (see demo: https://github.com/Zylann/voxelgame)
- Voxel storage using 8-bit channels like images for any general purpose
2017-04-01 20:34:44 +02:00
- Data segmentation using blocks of 16x16x16 voxels (so the world can be theoretically infinite)
2018-09-28 15:07:01 +02:00
- Main development oriented for minecraft-style terrain by using voxels as types
- Experimental support for smooth terrain using Transvoxel http://transvoxel.org/, by using voxels as isolevels
- Vertex-based ambient occlusion on voxel edges
- Simple interface for deferred terrain generators (block by block using threads)
- Uses threads to stream terrain as the camera moves
- Optional performance statistics
What this module doesn't provides
-----------------------------------
- Level of detail (not a priority for my project)
2018-09-28 15:09:06 +02:00
- Game specific features such as cave generation or procedural trees (though it might include tools to help doing them)
2018-09-28 15:07:01 +02:00
- Editor tools (only a few things are exposed)
- Import and export of voxel formats
- For reasons why I don't work on X or Y, see https://github.com/Zylann/godot_voxel/issues/17