How spimort/terrabrush works
TerraBrush is a Godot GDExtension terrain editor. The main workflow is to configure a TerraBrush node, create or import zone-based terrain data, edit it with terrain tools, and refresh the runtime terrain. The README documents the broad editing capabilities; source excerpts confirm key runtime construction and import behavior. Several subsystems are represented by their exact enclosing directories because their implementation files were not sampled, so those links are documented rather than inferred from unseen calls.
Main entry points: terra_brush.cpp TerraBrush node · terra_brush_plugin.cpp Editor plugin · importer_engine.cpp Image importer · terra_brush_editor.cpp In-game editor
Components 22
Godot editor
- Godot editor
- Editor plugin
src/terra_brush_plugin.cpp - In-game editor
src/terra_brush_editor.cpp
Terrain editing
- Editing tools
src/editor_tools - Sculpt tools
src/editor_tools/sculpt_tool.cpp - Angle tools
src/editor_tools/set_angle_tool.cpp - Tool base
src/editor_tools/tool_base.cpp - Tool menus
src/editor_nodes/tools_pie_menu.h - Key bindings
src/misc/keybind_manager.cpp - Brushes
src/terra_brush.cpp
Terrain data
- Zone collection
src/editor_resources/zones_resource.cpp - Zone images
src/editor_resources/zone_resource.h - Terrain definitions
src/editor_resources
Terrain runtime
- TerraBrush node
src/terra_brush.cpp - Terrain mesh
src/nodes/terrain.cpp - LOD clipmap
src/nodes/clipmap.cpp - Foliage rendering
src/nodes/foliage.cpp - Object scattering
src/nodes/objects.cpp - Water and snow
src/nodes
Import and export
- Image importer
src/misc/importer_engine.cpp - Terrain exporter
src/misc/exporter_engine.cpp
Other components
- Godot user
Connections 26
- Godot user → Godot editor: edits in
- Godot editor → Editor plugin: loads plugin
- Editor plugin → TerraBrush node: creates terrain
src/terra_brush_plugin.cpp - Godot user → In-game editor: edits in game
- In-game editor → Editing tools: dispatches tools
src/terra_brush_editor.cpp - In-game editor → Tool menus: shows menus
src/terra_brush_editor.cpp - Editor plugin → Key bindings: configures keys
src/terra_brush_plugin.cpp - Editing tools → Sculpt tools: includes sculpting
src/editor_tools/sculpt_tool.cpp - Editing tools → Angle tools: includes angle setting
src/editor_tools/set_angle_tool.cpp - Sculpt tools → Tool base: inherits behavior
- Angle tools → Tool base: inherits behavior
- Tool base → Key bindings: uses bindings
src/editor_tools/tool_base.cpp - Godot user → Brushes: selects brush
- TerraBrush node → Zone collection: loads zones
- TerraBrush node → Terrain mesh: creates terrain
src/terra_brush.cpp - Terrain mesh → LOD clipmap: uses clipmap
src/nodes/terrain.cpp - TerraBrush node → Foliage rendering: creates foliage
src/terra_brush.cpp - TerraBrush node → Object scattering: manages objects
src/terra_brush.cpp - TerraBrush node → Water and snow: creates water
src/terra_brush.cpp - TerraBrush node → Terrain definitions: uses definitions
- Image importer → TerraBrush node: imports into
- Image importer → Zone collection: updates zones
src/misc/importer_engine.cpp - Image importer → Zone images: writes images
src/misc/importer_engine.cpp - Editor plugin → Image importer: invokes import
src/terra_brush_plugin.cpp - Editor plugin → Terrain exporter: invokes export
src/terra_brush_plugin.cpp - Terrain exporter → TerraBrush node: exports terrain