LHDF Data

# LHDF Data

Sends data from your Arma Reforger server to a website, so the website can show it: live server status, the LHDF reports and the world for the website's 3D map. Gameplay events come in a later version. All charts, reports and maps are made by the website; the server only collects and sends.

**This mod sends data over the internet when you turn it on.** It is off by default. Nothing is sent until the server owner sets `enabled`, `serverId` and `apiKey` in `Data.json`. Player names are never sent.

## What it sends (version 0.3)

- A heartbeat every 30 seconds: player count, player limit, server FPS, uptime, world and scenario name.
- The LHDF reports of the loaded mods (performance, encounters, loot, shop) whenever a Game Master writes one in the LHDF tab, and the encounter, shop and loot reports once after the start. Nothing is scheduled.
- The world for the website's 3D map (terrain, trees, objects, roads, water, buildings and places), once per map version, collected in the background in about a minute.
- Traders, safe and no-build zones and vehicle spots, once after the start, so the map shows where they are (also the ones Game Masters placed).

## Settings

`$profile:LHDF/<namespace>/Data.json`:

| Key | Default | |
|---|---|---|
| `enabled` | `false` | Turn sending on |
| `endpoint` | `https://losthopesurvival.online/api/ingest/v1/` | The website's ingest API, ending with `/` |
| `serverId` | | This server's id on the website |
| `apiKey` | | The key the website issued for this server. Keep this file private. |
| `heartbeatSeconds` | `30` | |
| `timeoutSeconds` | `15` | |
| `maxQueueKB` | `4096` | Data kept while the website cannot be reached |
| `worldExport` | `true` | Send the world when the website does not have this map yet |
| `startupReports` | `["report.encounters", "report.shop", "report.loot"]` | Reports sent once after the start; the rest only from Game Masters |

## Required on server and clients

Yes, like every mod in a server's list: players download it automatically when they join. It only runs on the server and does nothing on clients.

## Dependencies

- LHDF Core

Beta: feedback welcome on the Lost Hope Survival Discord: https://discord.gg/uDzYTTdsM6