From 48ced08e141e91ca6a69cafd218cc0cbd46c94ff Mon Sep 17 00:00:00 2001 From: Sara Date: Mon, 13 Apr 2026 13:03:19 +0200 Subject: [PATCH] chore: added README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d67402c --- /dev/null +++ b/README.md @@ -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.