godot_voxel/README.md

63 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
2021-01-22 16:08:52 -08:00
![Blocky screenshot](doc/source/images/blocky_screenshot.png)
![Smooth screenshot](doc/source/images/smooth_screenshot.png)
![Textured screenshot](doc/source/images/textured-terrain.jpg)
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)
- Physics based collision and raycast support
2019-05-27 03:06:28 -07:00
- 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
2019-05-27 03:06:28 -07:00
- Minecraft-style blocky voxel terrain, with multiple materials and baked ambient occlusion
- Smooth terrain using Transvoxel
2019-10-04 03:28:46 -07:00
- Levels of detail for smooth terrain
2021-01-21 11:04:28 -08:00
- Voxel storage using 8-bit or 16-bit channels for any general purpose
2018-09-28 06:07:01 -07:00
Documentation
---------------
2021-01-21 11:04:28 -08:00
- [Main documentation](https://voxel-tools.readthedocs.io/en/latest/)
- [How to get the module](https://voxel-tools.readthedocs.io/en/latest/getting_the_module/)
- [Quick start](https://voxel-tools.readthedocs.io/en/latest/quick_start/)
2019-05-27 03:06:28 -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:
2021-01-21 11:04:28 -08:00
* Instancing for foliage and rocks
2020-08-17 14:31:00 -07:00
* Texturing on smooth terrain
* Editor preview and authoring
* Improving LOD performance
* Other meshing algorithms (e.g. dual contouring)
2020-08-17 14:31:00 -07:00
* GPU offloading (Maybe when Godot 4+ supports compute shaders)
2020-12-17 13:45:44 -08:00
Supporters
-----------
This module is a non-profit project developped by voluntary contributors. The following is the list of the current donors.
Thanks for your support :)
### Supporters
```
wacyym
Sergey Lapin (slapin)
Jonas (NoFr1ends)
lenis0012
2020-12-31 17:43:10 -08:00
Phyronnaz
2021-01-18 10:53:55 -08:00
RonanZe
2021-01-21 11:04:28 -08:00
furtherorbit
2021-03-02 13:10:27 -08:00
jp.owo.Manda (segfault-god)
2020-12-17 13:45:44 -08:00
```