Files
d4rk_divegear/README.md
T
D4rkst3randClaude Opus 5 08f8f34b31 docs: Referenz ins Wiki, README entschlankt
Die README war auf 300 Zeilen gewachsen und enthielt die komplette
Config-Referenz, alle Item-Tabellen und drei Erklaerkapitel. Das gehoert ins
Wiki, wo es sich navigieren laesst.

Neun Wiki-Seiten angelegt: Home, Installation, Items, Bedienung, Konfiguration,
Tiefe und Atemgas, Lampe, Exports, Entwicklung. Jede mit Navigationsleiste.

README behaelt, was jemand in den ersten dreissig Sekunden braucht: was es ist,
ein Bild, die Features, die Abhaengigkeiten, drei Installationsschritte und die
Wegweiser. Von 300 auf 65 Zeilen.

ENTSCHEIDUNGEN.md bleibt bewusst im Repo statt im Wiki - es erklaert, warum der
Code so aussieht, und gehoert damit neben den Code und in dessen Historie.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-11 10:29:15 +02:00

59 lines
2.5 KiB
Markdown

# d4rk_divegear
Tauchausrüstung für QBox. Fork von [qbx_divegear](https://github.com/Qbox-project/qbx_divegear)
mit Flaschengrößen, gesyncter Lampe, Tiefen- und Druckanzeige — und Ausrüstung,
die bei Animationen nicht mehr verschwindet.
![HUD](docs/hud-normal.svg?v=konsole)
## Features
- **Fünf Flaschen** — 5, 10, 15, 20 Minuten Pressluft plus Trimix. Die Restluft
liegt in der Item-Metadata und überlebt Ablegen, Relog, Restart und Tod.
- **Tauchkonsole als HUD** — Finimeter, Restluft und Tiefenmesser mit Zeigern und
farbigen Gefahrenbereichen. Skaliert mit der Bildschirmauflösung.
- **Gesyncte Tauchlampe** über die spieleigene Scuba-Lampe.
- **Tiefengrenze übers Atemgas** — mit Pressluft ab 45 m Tiefenrausch, mit Trimix
erst ab 100 m. Macht ein Tiefenlimit mechanisch statt zur Absprache.
- **Ausrüstung bleibt dran** — bei Emotes, Ragdoll, Kleiderwechsel und
aufräumenden Fremd-Scripts.
- **Serverseitige Prüfung** — die Restluft kann nur sinken, und nicht schneller
als physikalisch möglich.
## Abhängigkeiten
[`qbx_core`](https://github.com/Qbox-project/qbx_core) ·
[`ox_lib`](https://github.com/overextended/ox_lib) ·
[`ox_inventory`](https://github.com/overextended/ox_inventory)
## Installation
1. `ensure d4rk_divegear` in der `server.cfg`, **nach** `ox_inventory` und `qbx_core`
2. [`items_for_ox_inventory.lua`](items_for_ox_inventory.lua) in
`ox_inventory/data/items.lua` einfügen
3. Die sieben PNGs aus [`icons/`](icons) aufs Icon-CDN hochladen
Ausführlich, inklusive der beiden häufigsten Stolpersteine:
**[Wiki → Installation](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Installation)**
## Dokumentation
Alles Weitere steht im
**[Wiki](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki)**:
[Items](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Items) ·
[Bedienung](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Bedienung) ·
[Konfiguration](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Konfiguration) ·
[Tiefe und Atemgas](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Tiefe-und-Atemgas) ·
[Lampe](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Lampe) ·
[Exports](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Exports) ·
[Entwicklung](https://git.d4rkst3r.de/D4rkst3r/d4rk_divegear/wiki/Entwicklung)
Warum die Dinge so gebaut sind und welche Fallstricke dahinterstecken, steht
code-nah hier im Repo: [ENTSCHEIDUNGEN.md](ENTSCHEIDUNGEN.md).
## Lizenz
GPL-3.0, wie das Original. Die Upstream-Historie ist erhalten und liegt auf dem
Remote `upstream`.