Files
siege_deck/Docs/SiegeDeck/Decision Log.md
T
darman 45b246c1d7 docs: Initialize comprehensive project documentation
Migrates existing GDD and engine design notes from HacknPlan into a new Obsidian vault.

This establishes a centralized, version-controlled knowledge base covering engine architecture, game constraints, design decisions, and open questions.
2026-09-24 23:55:48 +02:00

3.6 KiB

tags
tags
decisions

Decision Log

Newest at the bottom. Status is one of: accepted, proposed, rejected, superseded.

Phased time model with a fixed-step simulation

  • Date: 2026-09-23 · Status: accepted
  • Context: rounds are a paused planning phase followed by a real-time wave (Game Constraints).
  • Decision: a fixed 60 Hz SimClock (pausable, speed via extra steps) and a separate real-time FrameClock for UI; interpolated rendering.
  • Consequences: planning is just speed 0; combat stays stable at every speed. See Main Loop and Time.

Seeded run generation, non-deterministic combat

  • Date: 2026-09-23 · Status: accepted
  • Decision: named RNG streams with our own distributions; no requirement for combat to replay bit-exactly.
  • Consequences: floats are allowed in the simulation, and there's no lockstep constraint. See Randomness.

Grid with fixed lanes

  • Date: 2026-09-23 · Status: accepted
  • Decision: enemies follow predefined lanes; towers are placed on buildable tiles and never block paths.
  • Consequences: no pathfinding system; lane following is a waypoint or spline walk.

Rigid-part 3D on SDL_GPU

  • Date: 2026-09-23 · Status: accepted
  • Context: we want 3D presentation without the engine and art cost of skeletal animation.
  • Decision: render with SDL_GPU (not SDL_Renderer); models are rigid node hierarchies animated by glTF node clips plus procedural overrides; a Renderer2D overlay for the UI.
  • Consequences: a shader build step (SPIR-V, Vulkan on Linux and Windows); instancing from the start; skinning deferred. See Rendering, Rigid-Part Animation.

The simulation stays 2D

  • Date: 2026-09-23 · Status: accepted
  • Decision: gameplay positions are 2D on the ground plane; height is visual only.
  • Consequences: gameplay code and scripts are unaffected by the 3D presentation.

C# not used for scripting

  • Date: 2026-09-23 · Status: rejected
  • Reason: CoreCLR hosting, an interop layer, fragile hot reload and runtime distribution cost too much for event-only content hooks. It would only fit as the main game language, which isn't the goal.

Scripting language shortlist

  • Date: 2026-09-23 · Status: proposed
  • Decision: the candidates are Lua (5.4 or Luau) and AngelScript, to be decided by a spike. See Scripting.

Error handling split

  • Date: 2026-09-24 · Status: accepted
  • Context: principle 6 of the Engine Overview ("errors as values") was written for loaders, then stretched to platform startup. There, it forced static Create() factories, private constructors, and move constructors with a "moved-from" flag, just to return non-movable things like the SDL context through std::expected.
  • Decision: errors you can recover from are values; fatal errors are exceptions.
    • std::expected for failures the caller really handles on the spot: loading assets, compiling scripts, parsing definitions. The caller falls back and keeps running, which hot reload depends on.
    • Exceptions (std::runtime_error for now) for failures with nothing to fall back to: SDL/window/GPU startup, broken invariants. Thrown from constructors and caught once in main, which logs and exits with 1.
  • Consequences: platform types are plain RAII classes: a constructor that throws, non-movable when they mean "exactly one" (SdlContext, Window), and no empty state. The STL throws anyway, so -fno-exceptions was never an option. Exceptions must not cross C callbacks (SDL, the script VM): script bindings need a catch boundary.