Wiki aufgebaut

Konfiguration.md

@@ -0,0 +1,84 @@
+# Konfiguration
+
+## `config/shared.lua` — Client und Server
+
+| Option | Default | Bedeutung |
+|---|---|---|
+| `gearItem` / `fillItem` | `diving_gear` / `diving_fill` | Item-Namen für Ausrüstung und Füll-Kartusche |
+| `tanks` | 5 Flaschen | `name`, `capacity` (Sekunden), `pressure` (bar), `maxDepth` (Meter), `gas` (Label fürs Menü) |
+| `newTanksFull` | `true` | Flaschen ohne Metadata (Shop, `AddItem`, Admin-Befehl) gelten als voll. Auf `false` muss jede neue Flasche erst befüllt werden |
+| `syncIntervalSeconds` | `15` | Wie oft die Restluft an den Server gemeldet wird. Bei einem Crash gehen maximal so viele Sekunden verloren |
+| `maxDrainPerSecond` | `5.0` | Obergrenze der serverseitigen Prüfung |
+
+## `config/client.lua`
+
+### Ablauf
+
+| Option | Default | Bedeutung |
+|---|---|---|
+| `putOnSuitTimeMs` / `takeOffSuitTimeMs` / `refillTankTimeMs` | `5000` | Dauer der Progressbars |
+| `decayRate` | `1.0` | Sekunden Luft pro echter Sekunde, vor dem Tiefenfaktor |
+| `warnAtSeconds` | `{60, 30, 10}` | Warnschwellen, jede einmal pro Tauchgang |
+| `removeGearOnDeath` | `true` | Ausrüstung beim Tod abnehmen. Die Flasche bleibt im Inventar |
+| `gearWatchdogIntervalMs` | `1000` | Prüfintervall, ob die Props noch am Ped hängen |
+| `maxTimeUnderwater` | `50.0` | Sekunden unter Wasser ohne Ausrüstung (Vanilla-Verhalten) |
+| `maxTimeUnderwaterOutOfAir` | `1.0` | Sekunden, sobald die Flasche leer ist |
+
+### Tiefe
+
+| Option | Default | Bedeutung |
+|---|---|---|
+| `depthDecayEnabled` | `false` | Verbrauch steigt mit der Tiefe. Aus, damit die Laufzeiten exakt stimmen |
+| `depthDecayReference` | `30.0` | Faktor `1 + tiefe / referenz` |
+| `maxDecayFactor` | `4.0` | Deckel für den Faktor |
+| `deepWarningDepth` | `25.0` | Ab hier wird die Tiefenanzeige eingefärbt |
+
+### Tiefenrausch (`narcosis`)
+
+| Option | Default | Bedeutung |
+|---|---|---|
+| `enabled` | `true` | Komplett abschaltbar |
+| `warnBeforeMeters` | `5.0` | Vorwarnung so viele Meter vor der Grenze |
+| `engineDepthLimit` | `160.0` | Tiefe, ab der **das Spiel selbst** Schluss macht |
+| `engineWarnBeforeMeters` | `20.0` | Vorwarnung davor |
+| `stages` | 3 Stufen | Pro Stufe: `over`, `timecycle` + `strength`, `shake` + `shakeIntensity`, `drainFactor`, `damagePerTick` |
+
+`damagePerTick` steht überall auf `0` — Tiefenrausch kostet erstmal nur Sicht,
+Kontrolle und Luft, kein Leben. Wer es härter will, setzt es in der letzten Stufe
+auf z.B. `2`. Mehr dazu unter [Tiefe und Atemgas](Tiefe-und-Atemgas).
+
+### HUD
+
+| Option | Default | Bedeutung |
+|---|---|---|
+| `hudEnabled` | `true` | Ohne HUD bleibt die Ausrüstung voll nutzbar |
+| `hudUpdateIntervalMs` | `250` | 4 Updates pro Sekunde |
+| `hudScale` | `1.0` | Größenfaktor obendrauf. Das HUD skaliert schon selbst mit der Bildschirmhöhe |
+| `hudOnlyUnderwater` | `false` | Auf `false` schon sichtbar, sobald die Ausrüstung an ist |
+| `hudFollowGameHud` | `true` | Mit dem Spiel-HUD ausblenden |
+| `hudToggleKey` | `''` | Eigene Taste, leer = unbelegt |
+| `reservePressure` | `50` | Roter Bereich des Finimeters |
+| `depthDialMax` | `100.0` | Skalenende des Tiefenmessers. Tiefer schlägt der Zeiger an, die Zahl stimmt weiter |
+
+### Lampe
+
+| Option | Default | Bedeutung |
+|---|---|---|
+| `lampKey` | `'l'` | Vorbelegung der Taste |
+| `lampReconcileIntervalMs` | `500` | Wie oft der Lampen-Zustand auf die Peds in der Nähe nachgezogen wird |
+
+## Beim Balancing beachten
+
+`maxDrainPerSecond` (shared) muss über `maxDecayFactor` mal dem höchsten
+Narkose-`drainFactor` liegen. Sonst hält der Server den ehrlichen Verbrauch in
+großer Tiefe für Cheat und schreibt Luft zurück.
+
+Die HUD-**Position** ist bisher nur in `nui/style.css` einstellbar, nicht in der
+Config.
+
+---
+
+**Wiki:** [Übersicht](Home) · [Installation](Installation) · [Items](Items) ·
+[Bedienung](Bedienung) · [Konfiguration](Konfiguration) ·
+[Tiefe und Atemgas](Tiefe-und-Atemgas) · [Lampe](Lampe) · [Exports](Exports) ·
+[Entwicklung](Entwicklung)