chore: added README

This commit is contained in:
Sara Gerretsen 2026-04-13 13:03:19 +02:00
parent 38f935d081
commit 48ced08e14

12
README.md Normal file
View file

@ -0,0 +1,12 @@
# Terrain Editor Module
- Godot Engine Module for Terrain Generation
- Multi-threaded
## Architecture
`Terrain` (terrain.h/cpp) responsible for managing and dispatching mesh generation tasks to its pool of threads. Attempts to stay as light as possible outside of load-time.
`TerrainMeshChunk` (terrain_chunk.h/cpp) the substance of the terrain. Contains functionality to generate meshes from terrain modifiers and data to display and collide with a terrain. Independent from other chunks. Dependent on terrain.
`TerrainModifier` (terrain_modifier.h/cpp) Core of the interface, 3D markers that designers place to define how the terrain should be generated.