Skip to content

Docs: engine edge-cases, naming, screenshots, docs URL - #15

Open
BJDubb wants to merge 2 commits into
masterfrom
docs-update
Open

Docs: engine edge-cases, naming, screenshots, docs URL#15
BJDubb wants to merge 2 commits into
masterfrom
docs-update

Conversation

@BJDubb

@BJDubb BJDubb commented Jun 30, 2026

Copy link
Copy Markdown
Owner

Documentation-only (no app code).

  • Naming Requirements expanded: how name hashing works (case must be consistent), safe charset a-z 0-9 _, near-duplicate/collision note.
  • New 'Limits & Edge Cases' page grounded in the RAGE engine: the ~7-second wave-slot budget per AWC (the real reason packs build but play silent), the 7-soundset limit, mono 16-bit PCM result, hex names, build-agnostic note.
  • Fresh UI screenshots on the soundset, siren, and export pages (the latter two had no images).
  • Docs URL surfaced: README badges + link; repo homepage set to docs.sirensharp.dev.

Note: MP3/OGG + trim docs are intentionally NOT here yet - those features are on the unmerged feature-audio-import branch (PR #14). Add once that ships.

Merging publishes to GitBook (and triggers a no-op release skip since v0.5.1 exists).

BJDubb added 2 commits June 30, 2026 21:53
Document how the game resolves siren/AWC names by hash, the first-8-character
AWC identity rule, and the real audio constraints (per-pack wave-slot size and
the server-wide AudioHeap), with practical workarounds.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant