Documentation hub

Everything from getting started to deep architecture and feature guides. These links open the project's Markdown documentation directly.

Start here

Getting oriented

README

Project overview, features, and quick start.

Getting Started

Install and run your first map.

GETTING_STARTED.md

User Guide

Complete guide for end users.

Feature guides

Deep-dives on each capability

3D GPKG Editing

The new Z-enabled FeatureServer + Editor (current branch).

3d_Editing_offline_GPKG.md

Local Map Server

The in-process server that turns a desktop into an endpoint.

LOCALMAPSERVER_GUIDE.md

Architecture

Authoritative tech stack and system design.

ARCHITECTURE.md

I3S SceneServer

Serving .slpk scene layers to ArcGIS.

I3S_SCENESERVER.md

Gaussian Splat Viewer

Photoreal splat rendering with camera sync.

GAUSSIAN_SPLAT_VIEWER.md

Tile Package Converter

.tpkx / .vtpk → MBTiles / GeoPackage, plus COG.

TILE_PACKAGE_CONVERTER.md

ESRI Geodatabase

Offline .geodatabase / .mmpk reading via ST_Geometry.

ESRI_GEODATABASE.md

Shadow Analysis (legacy)

Shadow and solar-potential assessment. Not compiled into the current .NET 10 build — see the csproj.

SHADOW_ANALYSIS_GUIDE.md

Collaboration (legacy)

XMPP, VoIP, WebRTC, PTT, Meshtastic. Backing services are excluded from the current build.

COLLABORATION_README.md

Grid Infrastructure · Flagship

Built for electric utilities

Operator guides and feature deep-dives for the transmission, distribution, and substation capabilities that make VoltGrid a utility platform.

Transmission Line Analyzer

NESC 2023 Rule 232-1 + Grade B/C · NERC FAC-003 · IEEE 738-2012 · IEEE 516-2021 · CIGRE · EPRI/IEEE 644.

promo/pages/transmission-analyzer.html · TRANSMISSION_GUIDE.md

PLS-CADD Integration

Import XML + KMZ exports as structures + conductors; round-trip to GPKG / GeoJSON / FileGDB / PostGIS.

promo/pages/pls-cadd.html · PLS_CADD_GUIDE.md

CAD & BIM Integration

DWG / DXF / DGN substation drawings, one-lines, and as-builts; IFC BIM models on the map.

promo/pages/cad.html · CAD_IMPORT.md

Substation & Asset Inventory

3D scans (point cloud / SLPK / I3S), BIM overlay, roofer LoD2.2 buildings, EXIF inspection photos.

promo/pages/substation-asset-inventory.html

Vehicle & Asset Tracking

StreamServer, OGC Moving Features, AIS, ADS-B, GTFS-RT, TAK, Skydio, GNSS/NMEA — unified tracks.

promo/pages/vehicle-asset-tracking.html

IoT & Sensor Integration

OGC SensorThings / SOS, MQTT, Kafka, StreamServer — SCADA overlays, weather, fault indicators.

promo/pages/iot-sensors.html

Recently shipped · feature docs

The latest capabilities

Deep-dives for the capabilities that landed in the newest releases — STAC, connectors, Full Motion Video, CAD import, SDR, and feed streaming.

STAC

Browse & ingest from Earth Search / Planetary Computer, plus an in-app STAC API server.

promo/pages/stac.html

Database Connectors

6 databases → MVT / OGC / FeatureServer via DuckDB ATTACH.

CONNECTORS_GUIDE.md

CAD Import

DWG / DXF / DGN conversion & georeferencing.

Full Motion Video

MISB ST 0601 / STANAG 4609 KLV, DJI→MISB, and an optional YOLO-E AI sidecar.

docs/FMV_AI_SIDECAR.md

SDR · ADS-B / RemoteID

Live crewed-aircraft & UAS tracks from a HackRF (readsb / dump978) onto the map.

docs/SDR_GUIDE.md

Feeds & StreamServer

SensorThings / SOS / GTFS / Moving Features → DuckDB, plus an Esri WebSocket StreamServer.

esri_streamserver_compatibleendpoint.md

STAC is documented on its promo page and in the route source (StacRoutes.cs / StacServerRoutes.cs, commit f714fcc75).

New in v1.3 – v1.4 New

The GEOINT-wave guides

Operator and developer guides for the newest capabilities — tactical, exploitation, sensing, routing, connectors, reconstruction, and the plugin SDK.

Routing & Navigation

Air-gapped A* over a DuckDB road graph, waypoints, GPX/KML.

SAR Exploitation

Sentinel-1 amplitude, speckle filters, SNAP sidecar.

AI / ML Guide

Local LLM chatbot, NL→SQL, SAM2, YOLO-E — offline inference.

Graph Analysis

Network algorithms over spatial graphs.

GRAPH_ANALYSIS.md

SharePoint Connector

Lists as editable layers via Microsoft Graph + Entra ID.

SHAREPOINT_GUIDE.md

EO Imagery Ordering

Planet · Sentinel Hub · Skywatch · SkyFi — search, task, order.

EO_IMAGERY_ORDERING.md

Roofer — LoD2.2

Building reconstruction from point cloud + roofprints.

ROOFER_GUIDE.md

Plugin Architecture

The one-folder plugin model and host extension points.

Plugin Developer Guide

Tutorial: three plugins from hello-world to layer types.

DEVELOPER_PLUGIN_GUIDE.md

Splat Training

Gaussian-splat pipeline: Postshot / COLMAP / OpenSplat.

SPLAT_TRAINING.md

APRS Guide

Amateur-radio stations, weather, and messages on the map.

docs/APRS_GUIDE.md

Audio Scanners

Marine VHF, NOAA + SAME, CB, GMRS-FRS, MURS monitoring.

docs/AUDIO_GUIDE.md

For builders & operators

Developer & deployment docs

Developer Guide

Build, extend, and contribute.

DEVELOPER_GUIDE.md

API Reference

Local server REST API.

DEVELOPER_API_DOCUMENTATION.md

AI Setup

Local-LLM assistant configuration.

AI_SETUP_GUIDE.md

Deployment Guide

Production deployment.

DEPLOYMENT_GUIDE.md

Network Sharing

LAN data sharing setup.

NETWORK_SHARING_README.md

GNSS Integration

Receiver & RTK setup.

GNSS_INTEGRATION_README.md

Links resolve to the repo's Markdown docs. Some docs describe roadmap/aspirational capability — cross-check against compiled sources for shipped status.

Ready to build with it?

Explore the 3D Editor View the deck