Files
2026-11-12 11:06:58 -05:00

93 lines
7.2 KiB
Markdown

---
last_mapped_commit: bdca29d3aa31face0c0023537ff98783716dbc45
last_mapped_at: 2026-11-12
---
# External Integrations
**Analysis Date:** 2026-11-12
## APIs & External Services
**Game runtime:**
- No hosted runtime service is required; offline operation and no telemetry are requirements in `AGENTS.md`. Runtime entry/configuration and resource loading reside in `src/GamePort/Program.cs`.
- Vulkan is a local native graphics API, accessed through Silk.NET.Vulkan/KHR/EXT `2.23.0` (`GamePort.csproj`, `src/GamePort/Rendering/Vulkan/VulkanRenderer.cs`). Authentication: not applicable.
- SDL3 is a local native window/input/audio API, accessed through project P/Invoke (`src/GamePort/Platform/Sdl.cs`, `src/GamePort/Audio/SdlAudio.cs`). Authentication: not applicable.
**Dependency acquisition (development only):**
- Microsoft SDK archives, SDL release archives and optional Ubuntu packages are downloaded by `scripts/bootstrap.sh`; the SDK and SDL archive hashes are pinned there.
- NuGet resolves managed packages through `dotnet restore` in `scripts/bootstrap.sh`, with direct versions in `GamePort.csproj` and resolved dependencies in `packages.lock.json`.
- These download sources are build-time inputs, not runtime asset storage or telemetry destinations (`scripts/bootstrap.sh`, `AGENTS.md`).
**Local reverse-engineering tools:**
- `scripts/rea.sh` launches local REA with Ghidra/full JDK prerequisites. `tools/binary/rea_decompile_batch.py` communicates using local stdio JSON-RPC and saves complete replies/Evidence separately from originals.
- Use generated target copies; the batch wrapper rejects original-directory targets and output (`tools/binary/rea_decompile_batch.py`). This is developer analysis infrastructure, not game networking.
## Data Storage
**Databases:**
- No database server, ORM or connection-string configuration is detected in the runtime/project manifest; assets and game data are read through local readers (`GamePort.csproj`, `src/GamePort/Assets/GamLevel.cs`, `src/GamePort/Assets/OriginalSave.cs`).
**File Storage:**
- Local filesystem only: source assets are selected by `--assets` or discovery of `Original`/`original`/`assets` directories; use case-insensitive bounded path resolution in `src/GamePort/Assets/AssetPath.cs`.
- Local prepared scene/animation/entity JSON, binary mesh/texture data and WAV files are emitted by `tools/extractors/prepare.py`; its default output is `artifacts/extracted`.
- `scripts/package.sh` copies required original assets and prepared resources into local package `assets/`, `scenes/` and `audio/` directories. Original files remain separate and byte-identical (`AGENTS.md`).
- Original-format TSK checkpoint reads/writes are exposed through `--load-save` and `--write-save`; output is kept outside assets, with temporary-file replacement in `src/GamePort/Program.cs` and encoding in `src/GamePort/Assets/OriginalSave.cs`.
- Debug checkpoint defaults to `debug-checkpoint.tsk` beside the executable; the debug smoke path is separate in `src/GamePort/Program.cs`. These are checkpoint/progression snapshots, not arbitrary full live-game saves (`README.md`).
**Caching:**
- Local generated SDK/dependency/prepared-resource caches only: `scripts/env.sh` configures `.nuget/packages` and local SDK paths; `tools/extractors/prepare.py` manages prepared output.
- No distributed cache or hosted asset cache is declared in `GamePort.csproj` or `scripts/package.sh`.
## Authentication & Identity
**Auth Provider:**
- None for the game runtime; no account/login integration is configured in `src/GamePort/Program.cs` or `GamePort.csproj`.
- Gitea source-control authentication is outside runtime configuration. `AGENTS.md` authorizes pushing completed, verified source commits to existing `Gitea`, with `main` tracking `Gitea/main`; do not embed credentials in documentation.
## Monitoring & Observability
**Error Tracking:**
- No external error-tracking service is declared in `GamePort.csproj`. Top-level exceptions print to stderr and exit unsuccessfully in `src/GamePort/Program.cs`.
- Optional local Khronos validation output uses `VK_LAYER_KHRONOS_validation` and EXT debug utils; errors increment a renderer counter and messages print to stderr in `src/GamePort/Rendering/Vulkan/VulkanRenderer.cs`.
**Logs:**
- Console runtime/resource/audio/smoke diagnostics in `src/GamePort/Program.cs` and `src/GamePort/Audio/SdlAudio.cs`.
- In-process live diagnostics/debug overlay in `src/GamePort/Application/DebugDiagnostics.cs` and `src/GamePort/Application/DebugMenuOverlay.cs`; GPU readback screenshots are local outputs exposed by `src/GamePort/Program.cs`.
- Analysis evidence is written locally by `tools/binary/rea_decompile_batch.py`; current validation scope and provenance are recorded in `docs/compatibility.md` and `docs/progress.md`.
## CI/CD & Deployment
**Hosting:**
- Native local executables, not a hosted application: `scripts/build-linux.sh` and `scripts/build-windows.sh` publish self-contained platform binaries; `scripts/package.sh` assembles local packages and launchers.
- Native SDL is bundled; the host supplies a Vulkan 1.3 graphics loader/driver (`GamePort.csproj`, `scripts/package.sh`).
- Existing Gitea remote is for verified source commits only; original assets and generated packages must not be uploaded (`AGENTS.md`). Workspace `../.git` is reserved; project Git operations belong to `GamePort/` (`../AGENTS.md`).
**CI Pipeline:**
- Local scripts only: `scripts/test.sh`, `scripts/test-window-transitions.sh`, `scripts/build-linux.sh`, `scripts/build-windows.sh`, `scripts/package.sh`.
- No cloud CI is desired or authorized (`AGENTS.md`, `../prompt.MD`). This absence is intentional.
- Cross-publish success does not establish native Windows runtime behavior; retain the scope distinctions in `docs/compatibility.md`.
## Environment Configuration
**Required env vars:**
- No runtime service keys or credentials required (`AGENTS.md`, `src/GamePort/Program.cs`).
- Development shell setup exports `DOTNET_CLI_HOME`, `DOTNET_CLI_TELEMETRY_OPTOUT`, `DOTNET_SKIP_FIRST_TIME_EXPERIENCE` and `NUGET_PACKAGES`; conditionally sets `DOTNET_ROOT`, `PATH`, `LD_LIBRARY_PATH`, `VK_LAYER_PATH` (`scripts/env.sh`).
- Test audio can use `SDL_AUDIODRIVER=dummy` (`scripts/test.sh`).
- Local analysis launcher uses `GHIDRA_INSTALL_DIR`, `JAVA_HOME`, `NEUTRON_REA_JAVA_HOME`, `NEUTRON_REA_NODE` and `NEUTRON_REA_LAUNCHER` (`scripts/rea.sh`). These are developer tool selectors, not game configuration.
**Secrets location:**
- No runtime secret store is required (`AGENTS.md`). Source-control credentials remain external to runtime and this map.
- `scripts/rea.sh` optionally sources ignored `.tools/rea.env`; only the launcher reference is inspected, not the environment file contents.
## Webhooks & Callbacks
**Incoming:**
- No HTTP webhook endpoints are declared in `GamePort.csproj` or `src/GamePort/Program.cs`. SDL events and Vulkan validation callbacks are local API callbacks (`src/GamePort/Platform/Sdl.cs`, `src/GamePort/Rendering/Vulkan/VulkanRenderer.cs`).
**Outgoing:**
- No runtime webhooks are declared in `src/GamePort/Program.cs` or `GamePort.csproj`. Development dependency downloads and source pushes are separate workflows (`scripts/bootstrap.sh`, `AGENTS.md`).
---
*Integration audit: 2026-11-12*