# louis-e/arnis architecture

> Architecture diagram of the GitHub repository louis-e/arnis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/louis-e/arnis
- Repository: https://github.com/louis-e/arnis

## Overview

Arnis is a geospatial world generator: users select a real-world area and settings, the program gathers geographic and terrain data, interprets it into terrain and built features, then writes a playable world in supported game formats. The graph emphasizes that workflow and includes documented optional capabilities such as Mapillary imagery and gameplay datapacks. Some subsystem links are supported by the SOURCE INDEX rather than excerpts; unsampled implementation details and UI-to-generation wiring are not inferred.

Main entry points: [`src/world_editor/mod.rs`](https://github.com/louis-e/arnis/blob/main/src/world_editor/mod.rs) (World editor), [`src/retrieve_data.rs`](https://github.com/louis-e/arnis/blob/main/src/retrieve_data.rs) (Data retrieval), [`src/osm_parser.rs`](https://github.com/louis-e/arnis/blob/main/src/osm_parser.rs) (OSM parsing), [`src/elevation/mod.rs`](https://github.com/louis-e/arnis/blob/main/src/elevation/mod.rs) (Elevation data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_input["Selection and data"]
  node_cli["CLI settings<br/>[args.rs]"]
  node_gui["Desktop GUI<br/>[gui.rs]"]
  node_fetch["Data retrieval<br/>[retrieve_data.rs]"]
end

subgraph group_geodata["Geospatial preparation"]
  node_osm["OSM parsing<br/>[osm_parser.rs]"]
  node_overture["Overture data<br/>[mod.rs]"]
  node_projection["Projection<br/>[mod.rs]"]
  node_elevation["Elevation data<br/>[mod.rs]"]
  node_landcover["Land cover<br/>[mod.rs]"]
end

subgraph group_generation["World generation"]
  node_elements["Feature processing<br/>[mod.rs]"]
  node_buildings["Building generation<br/>[buildings.rs]"]
  node_ground["Terrain generation"]
  node_caves["Cave generation<br/>[mod.rs]"]
end

subgraph group_output["World output"]
  node_editor["World editor<br/>[mod.rs]"]
  node_formats["Game world formats<br/>[common.rs]"]
end

subgraph group_extras["Optional features"]
  node_datapack["Gameplay datapacks<br/>[mod.rs]"]
  node_mapillary["Mapillary imagery<br/>[mod.rs]"]
  node_mapillary_pipeline["Facade pipeline<br/>[pipeline.rs]"]
  node_models["3D models<br/>[pipeline.rs]"]
  node_progress["Progress reporting<br/>[progress.rs]"]
end

node_user(("Area selector"))
node_game(("Minecraft / Luanti"))

node_user -->|"selects area"| node_gui
node_user -->|"sets options"| node_cli
node_cli -->|"configures retrieval"| node_fetch
node_fetch -->|"provides OSM data"| node_osm
node_fetch -.->|"uses coordinates"| node_projection
node_fetch -.->|"fetches elevation"| node_elevation
node_osm -->|"dispatches features"| node_elements
node_overture -->|"parses map features"| node_osm
node_projection -->|"transforms coordinates"| node_osm
node_elevation -->|"supplies heights"| node_ground
node_landcover -->|"informs surfaces"| node_ground
node_elements -->|"dispatches buildings"| node_buildings
node_elements -.->|"places features"| node_editor
node_ground -.->|"sets terrain"| node_editor
node_caves -->|"carves terrain"| node_editor
node_editor -->|"writes world"| node_formats
node_formats -->|"opens generated world"| node_game
node_editor -->|"adds gameplay extras"| node_datapack
node_mapillary -->|"provides imagery"| node_mapillary_pipeline
node_mapillary_pipeline -.->|"exports facade textures"| node_buildings
node_models -->|"places 3D models"| node_editor
node_fetch -->|"reports progress"| node_progress
node_elevation -->|"reports progress"| node_progress

click node_cli "https://github.com/louis-e/arnis/blob/main/src/args.rs"
click node_gui "https://github.com/louis-e/arnis/blob/main/src/gui.rs"
click node_fetch "https://github.com/louis-e/arnis/blob/main/src/retrieve_data.rs"
click node_osm "https://github.com/louis-e/arnis/blob/main/src/osm_parser.rs"
click node_overture "https://github.com/louis-e/arnis/blob/main/src/overture/mod.rs"
click node_projection "https://github.com/louis-e/arnis/blob/main/src/projection/mod.rs"
click node_elevation "https://github.com/louis-e/arnis/blob/main/src/elevation/mod.rs"
click node_landcover "https://github.com/louis-e/arnis/blob/main/src/land_cover/mod.rs"
click node_elements "https://github.com/louis-e/arnis/blob/main/src/element_processing/mod.rs"
click node_buildings "https://github.com/louis-e/arnis/blob/main/src/element_processing/buildings.rs"
click node_ground "https://github.com/louis-e/arnis/blob/main/src/ground_generation.rs"
click node_caves "https://github.com/louis-e/arnis/blob/main/src/caves/mod.rs"
click node_editor "https://github.com/louis-e/arnis/blob/main/src/world_editor/mod.rs"
click node_formats "https://github.com/louis-e/arnis/blob/main/src/world_editor/common.rs"
click node_datapack "https://github.com/louis-e/arnis/blob/main/src/datapack/mod.rs"
click node_mapillary "https://github.com/louis-e/arnis/blob/main/src/mapillary/mod.rs"
click node_mapillary_pipeline "https://github.com/louis-e/arnis/blob/main/src/mapillary/pipeline.rs"
click node_models "https://github.com/louis-e/arnis/blob/main/src/models_3d/pipeline.rs"
click node_progress "https://github.com/louis-e/arnis/blob/main/src/progress.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_gui,node_fetch toneBlue
class node_osm,node_overture,node_projection,node_elevation,node_landcover toneAmber
class node_elements,node_buildings,node_ground,node_caves toneMint
class node_editor,node_formats toneRose
class node_datapack,node_mapillary,node_mapillary_pipeline,node_models,node_progress,node_user,node_game toneIndigo
```

## Components

### Selection and data

- [CLI settings](https://github.com/louis-e/arnis/blob/main/src/args.rs): `src/args.rs`
- [Desktop GUI](https://github.com/louis-e/arnis/blob/main/src/gui.rs): `src/gui.rs`
- [Data retrieval](https://github.com/louis-e/arnis/blob/main/src/retrieve_data.rs): `src/retrieve_data.rs`

### Geospatial preparation

- [OSM parsing](https://github.com/louis-e/arnis/blob/main/src/osm_parser.rs): `src/osm_parser.rs`
- [Overture data](https://github.com/louis-e/arnis/blob/main/src/overture/mod.rs): `src/overture/mod.rs`
- [Projection](https://github.com/louis-e/arnis/blob/main/src/projection/mod.rs): `src/projection/mod.rs`
- [Elevation data](https://github.com/louis-e/arnis/blob/main/src/elevation/mod.rs): `src/elevation/mod.rs`
- [Land cover](https://github.com/louis-e/arnis/blob/main/src/land_cover/mod.rs): `src/land_cover/mod.rs`

### World generation

- [Feature processing](https://github.com/louis-e/arnis/blob/main/src/element_processing/mod.rs): `src/element_processing/mod.rs`
- [Building generation](https://github.com/louis-e/arnis/blob/main/src/element_processing/buildings.rs): `src/element_processing/buildings.rs`
- [Terrain generation](https://github.com/louis-e/arnis/blob/main/src/ground_generation.rs): `src/ground_generation.rs`
- [Cave generation](https://github.com/louis-e/arnis/blob/main/src/caves/mod.rs): `src/caves/mod.rs`

### World output

- [World editor](https://github.com/louis-e/arnis/blob/main/src/world_editor/mod.rs): `src/world_editor/mod.rs`
- [Game world formats](https://github.com/louis-e/arnis/blob/main/src/world_editor/common.rs): `src/world_editor/common.rs`

### Optional features

- [Gameplay datapacks](https://github.com/louis-e/arnis/blob/main/src/datapack/mod.rs): `src/datapack/mod.rs`
- [Mapillary imagery](https://github.com/louis-e/arnis/blob/main/src/mapillary/mod.rs): `src/mapillary/mod.rs`
- [Facade pipeline](https://github.com/louis-e/arnis/blob/main/src/mapillary/pipeline.rs): `src/mapillary/pipeline.rs`
- [3D models](https://github.com/louis-e/arnis/blob/main/src/models_3d/pipeline.rs): `src/models_3d/pipeline.rs`
- [Progress reporting](https://github.com/louis-e/arnis/blob/main/src/progress.rs): `src/progress.rs`

### Other components

- **Area selector**
- **Minecraft / Luanti**

## Connections

- Area selector → Desktop GUI: selects area (evidence: `README.md`)
- Area selector → CLI settings: sets options (evidence: `README.md`)
- CLI settings → Data retrieval: configures retrieval (evidence: `src/args.rs`)
- Data retrieval → OSM parsing: provides OSM data (evidence: `src/retrieve_data.rs`)
- Data retrieval → Projection: uses coordinates
- Data retrieval → Elevation data: fetches elevation
- OSM parsing → Feature processing: dispatches features (evidence: `src/osm_parser.rs`)
- Overture data → OSM parsing: parses map features (evidence: `src/overture/mod.rs`)
- Projection → OSM parsing: transforms coordinates (evidence: `src/osm_parser.rs`)
- Elevation data → Terrain generation: supplies heights (evidence: `src/elevation/mod.rs`)
- Land cover → Terrain generation: informs surfaces (evidence: `src/land_cover/mod.rs`)
- Feature processing → Building generation: dispatches buildings (evidence: `src/element_processing/mod.rs`)
- Feature processing → World editor: places features
- Terrain generation → World editor: sets terrain
- Cave generation → World editor: carves terrain (evidence: `src/caves/mod.rs`)
- World editor → Game world formats: writes world (evidence: `src/world_editor/mod.rs`)
- Game world formats → Minecraft / Luanti: opens generated world (evidence: `README.md`)
- World editor → Gameplay datapacks: adds gameplay extras (evidence: `src/datapack/mod.rs`)
- Mapillary imagery → Facade pipeline: provides imagery (evidence: `src/mapillary/pipeline.rs`)
- Facade pipeline → Building generation: exports facade textures
- 3D models → World editor: places 3D models (evidence: `src/models_3d/pipeline.rs`)
- Data retrieval → Progress reporting: reports progress (evidence: `src/retrieve_data.rs`)
- Elevation data → Progress reporting: reports progress (evidence: `src/elevation/mod.rs`)
