Relintai/voxelman
1
0
Fork 0
mirror of https://github.com/Relintai/voxelman.git synced 2025-04-25 21:25:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

More improvements to the readme.

Browse Source
This commit is contained in:
Relintai 2022-02-11 12:33:19 +01:00
parent 447db3a131
commit 5031187a59
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -27,11 +27,9 @@ If compile breaks, and I don't notice please report.
## Usage ## Usage
First create a scene, and add a VoxelWorldBlocky node into it. Create a VoxelLibrary, and assign it to the Library property. First create a scene, and add a VoxelWorldBlocky / VoxelWorldMarchingCubes node into it. Create a VoxelLibrary, and assign it to the Library property.
Also, add a VoxelSurface into your library. Also, add a VoxelSurface into your library.
(VoxelWorldBlocky is the only one that works properly for now, this will soon be fixed!)
Tick the editable property, deselect, then select the world again, and click the insert button at the top toolbar, or press B to insert a Tick the editable property, deselect, then select the world again, and click the insert button at the top toolbar, or press B to insert a
voxel at the inspector's camera's location. voxel at the inspector's camera's location.
@ -69,7 +67,7 @@ And if you have a third chunk which only has a Grass voxel used in it, it will g
## Worlds ## Worlds
The 2 base classes: The 2 base classes. These won't do meshing on their own:
VoxelWorld: Basic world, does not do anything until you implemnent the required virtual methods!\ VoxelWorld: Basic world, does not do anything until you implemnent the required virtual methods!\
VoxelWorldDefault: This adds threading, and LoD storage support to VoxelWorld. Will not create meshes for you! VoxelWorldDefault: This adds threading, and LoD storage support to VoxelWorld. Will not create meshes for you!
@ -86,6 +84,8 @@ A marching cubes based Voxel World. Actually it uses a modified version of the T
This is my own meshing algorithm, it's basicly a Minecraft style mesher that can take isolevel into account. This is my own meshing algorithm, it's basicly a Minecraft style mesher that can take isolevel into account.
It's kind of a pain to use, it might get removed.
### Level generation ### Level generation
Assign a VoxelManLevelGenerator to the `World`'s `Level Generator` property. Assign a VoxelManLevelGenerator to the `World`'s `Level Generator` property.
@ -124,10 +124,14 @@ This is the job that will generate vertex light based ao, random ao, and will ba
This will generate your terrain collider and mesh (with lods) for you, using the meshers that you add into it. This will generate your terrain collider and mesh (with lods) for you, using the meshers that you add into it.
Your lod setup is easily customizable with [VoxelMesherJobSteps](https://github.com/Relintai/voxelman/blob/master/world/jobs/voxel_mesher_job_step.h). The setup happens in your selected world's `_create_chunk` method.
### VoxelPropJob ### VoxelPropJob
This will generate your prop meshes (with lods). This will generate your prop meshes (with lods).
Also supports [VoxelMesherJobSteps](https://github.com/Relintai/voxelman/blob/master/world/jobs/voxel_mesher_job_step.h).
### Internal workings ### Internal workings
#### VoxelWorld #### VoxelWorld