# keylessabyss/abyssalkey architecture

> Architecture diagram of the GitHub repository keylessabyss/abyssalkey, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-08-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/keylessabyss/abyssalkey
- Repository: https://github.com/keylessabyss/abyssalkey

## Overview

#### Purpose and Entry Points
This repository is a built documentation distribution for an engine/editor plus a bundled sample game project, “Morninghollow Dayfall.” The primary static-site entry point is `docs/index.html`; built documentation pages are under `docs/build/docs/index.html`. The compiled browser application is delivered through `docs/build/assets/index-D6RQyC-b.js` and `docs/build/assets/index-DfQINvNW.css`.

#### Documentation and Product Surface
The static documentation describes the engine, editor, rendering, input, gameplay, assets, and architecture. It is pre-rendered HTML rather than source documentation or application source:
- `docs/build/docs/engine-overview.html`
- `docs/build/docs/editor.html`
- `docs/build/docs/rendering.html`

This repository contains no visible server, API, build configuration, or engine source; deployment can be static-file hosting.

#### Sample Project Boundary
The sample project is a self-contained, file-based content package rooted at:
- `docs/build/sample-projects/morninghollow-dayfall/abyssal.project.json`
- `docs/build/sample-projects/morninghollow-dayfall/bundled-project.json`
- `docs/build/sample-projects/morninghollow-dayfall/assets/`

Project descriptors establish project identity and bundling; the `assets/` tree holds runtime-editable game content. This separates engine/documentation distribution from game-specific data.

#### World, Scene, and Gameplay Content
Gameplay composition appears data-driven. A main scene references or coordinates world and scripted content:
- `docs/build/sample-projects/morninghollow-dayfall/assets/scenes/Main.scene.json`
- `docs/build/sample-projects/morninghollow-dayfall/assets/wingsworlds/MorninghollowPrologue.wingsworld.json`
- `docs/build/sample-projects/morninghollow-dayfall/assets/wingscripts/Morninghollow.Prologue.wingscript.json`

The likely flow is project load → scene/world load → execute Wingscript-driven gameplay/prologue logic. These JSON assets form the principal control/content boundary, rather than compiled game code.

#### Rendering Asset Pipeline
Renderable entities are assembled from fragment definitions, mesh geometry, and material descriptors:
- `docs/build/sample-projects/morninghollow-dayfall/assets/fragments/Standard_A.fragment.json`
- `docs/build/sample-projects/morninghollow-dayfall/assets/meshes/standard_a_ship.mesh.json`
- `docs/build/sample-projects/morninghollow-dayfall/assets/materials/M_Player_1_ship_color.material.json`

OBJ files accompany mesh JSON assets, indicating source/interchange geometry alongside engine-oriented mesh metadata. Fragments likely define reusable entity/model composition and connect meshes to materials.

#### Audio, Effects, UI, and Sequencing
Non-visual runtime content is modularized by asset type:
- Audio instruments: `docs/build/sample-projects/morninghollow-dayfall/assets/instruments/Weapons.Railgun.wngins`
- Cues: `docs/build/sample-projects/morninghollow-dayfall/assets/cues/Cue1785917775128.wngcue`
- Particles: `docs/build/sample-projects/morninghollow-dayfall/assets/particles/Particle1785182623798.wngprt`
- UI and tracks: `docs/build/sample-projects/morninghollow-dayfall/assets/ui/UI1786069767206.wngui`, `docs/build/sample-projects/morninghollow-dayfall/assets/tracks/Track1785858162715.wngtrk`

These specialized formats suggest runtime services for synthesized/playable audio, particle simulation, UI presentation, and timed/cinematic sequencing.

#### Runtime and Infrastructure
The material runtime is browser-delivered static content: HTML, CSS, and a hashed JavaScript bundle. No external backend, database, cloud service, package manifest, or deployment automation is represented in the tree. Engine particle resources are separately published at `docs/build/engine/particles/`, while sample-project settings such as `docs/build/sample-projects/morninghollow-dayfall/settings/content-browser.json` support editor/content-browser behavior.

Main entry points: [`docs/build/sample-projects/morninghollow-dayfall/assets/wingscripts/Morninghollow.Prologue.wingscript.json`](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/wingscripts/Morninghollow.Prologue.wingscript.json) (Prologue Wingscript), [`docs/build/sample-projects/morninghollow-dayfall/abyssal.project.json`](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/abyssal.project.json) (Project Descriptor), [`docs/build/sample-projects/morninghollow-dayfall/assets/scenes/Main.scene.json`](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/scenes/Main.scene.json) (Main Scene), [`docs/index.html`](https://github.com/keylessabyss/abyssalkey/blob/main/docs/index.html) (Documentation Entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_distribution["Static Distribution"]
  node_site_entry["Documentation Entry<br/>static HTML<br/>[index.html]"]
  node_doc_pages["Built Documentation<br/>pre-rendered HTML<br/>[index.html]"]
  node_browser_bundle["Browser Application<br/>JavaScript bundle<br/>[index-D6RQyC-b.js]"]
  node_site_styles["Site Styles<br/>CSS bundle<br/>[index-DfQINvNW.css]"]
  node_engine_particles["Engine Particle Resources<br/>engine assets"]
end

subgraph group_project["Morninghollow Dayfall Package"]
  node_project_descriptor["Project Descriptor<br/>project manifest"]
  node_bundle_descriptor["Bundle Descriptor<br/>bundle manifest"]
  node_content_browser_settings["Content Browser Settings<br/>editor settings"]
end

subgraph group_gameplay["World and Gameplay"]
  node_main_scene["Main Scene<br/>scene definition<br/>[Main.scene.json]"]
  node_prologue_world["Prologue World<br/>world definition"]
  node_prologue_script["Prologue Wingscript<br/>gameplay script"]
end

subgraph group_media["Runtime Content Assets"]
  node_fragment["Standard A Fragment<br/>entity fragment"]
  node_ship_mesh["Ship Mesh<br/>mesh metadata"]
  node_ship_material["Ship Material<br/>material descriptor"]
  node_audio_content["Railgun Audio<br/>instrument asset"]
  node_particle_content["Particle Effect<br/>particle asset"]
  node_ui_content["UI Definition<br/>UI asset"]
  node_sequence_track["Sequence Track<br/>timeline asset"]
end

node_site_entry -->|"links to"| node_doc_pages
node_site_entry -->|"loads"| node_browser_bundle
node_site_entry -->|"loads"| node_site_styles
node_browser_bundle -->|"loads project"| node_project_descriptor
node_project_descriptor -->|"bundled as"| node_bundle_descriptor
node_project_descriptor -.->|"editor behavior"| node_content_browser_settings
node_project_descriptor -->|"opens content"| node_main_scene
node_main_scene -->|"coordinates"| node_prologue_world
node_main_scene -->|"executes"| node_prologue_script
node_main_scene -->|"uses entities"| node_fragment
node_fragment -->|"assembles"| node_ship_mesh
node_fragment -->|"assigns"| node_ship_material
node_prologue_script -.->|"triggers"| node_audio_content
node_prologue_script -.->|"triggers"| node_particle_content
node_prologue_script -.->|"presents"| node_ui_content
node_prologue_script -.->|"drives"| node_sequence_track
node_particle_content -.->|"uses resources"| node_engine_particles

click node_site_entry "https://github.com/keylessabyss/abyssalkey/blob/main/docs/index.html"
click node_doc_pages "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/docs/index.html"
click node_browser_bundle "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/assets/index-D6RQyC-b.js"
click node_site_styles "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/assets/index-DfQINvNW.css"
click node_project_descriptor "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/abyssal.project.json"
click node_bundle_descriptor "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/bundled-project.json"
click node_content_browser_settings "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/settings/content-browser.json"
click node_main_scene "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/scenes/Main.scene.json"
click node_prologue_world "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/wingsworlds/MorninghollowPrologue.wingsworld.json"
click node_prologue_script "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/wingscripts/Morninghollow.Prologue.wingscript.json"
click node_fragment "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/fragments/Standard_A.fragment.json"
click node_ship_mesh "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/meshes/standard_a_ship.mesh.json"
click node_ship_material "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/materials/M_Player_1_ship_color.material.json"
click node_audio_content "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/instruments/Weapons.Railgun.wngins"
click node_particle_content "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/particles/Particle1785182623798.wngprt"
click node_ui_content "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/ui/UI1786069767206.wngui"
click node_sequence_track "https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/tracks/Track1785858162715.wngtrk"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_site_entry,node_doc_pages,node_browser_bundle,node_site_styles,node_engine_particles toneBlue
class node_project_descriptor,node_bundle_descriptor,node_content_browser_settings toneAmber
class node_main_scene,node_prologue_world,node_prologue_script toneMint
class node_fragment,node_ship_mesh,node_ship_material,node_audio_content,node_particle_content,node_ui_content,node_sequence_track toneRose
```

## Components

### Static Distribution

Browser-served documentation and application assets.

- [Documentation Entry](https://github.com/keylessabyss/abyssalkey/blob/main/docs/index.html): static HTML · `docs/index.html`
- [Built Documentation](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/docs/index.html): pre-rendered HTML · Engine, editor, and rendering reference pages. · `docs/build/docs/index.html`
- [Browser Application](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/assets/index-D6RQyC-b.js): JavaScript bundle · `docs/build/assets/index-D6RQyC-b.js`
- [Site Styles](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/assets/index-DfQINvNW.css): CSS bundle · `docs/build/assets/index-DfQINvNW.css`
- **Engine Particle Resources**: engine assets · Published engine-level particle resources.

### Morninghollow Dayfall Package

Self-contained sample game content.

- [Project Descriptor](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/abyssal.project.json): project manifest · Establishes sample-project identity. · `docs/build/sample-projects/morninghollow-dayfall/abyssal.project.json`
- [Bundle Descriptor](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/bundled-project.json): bundle manifest · Defines the bundled project package. · `docs/build/sample-projects/morninghollow-dayfall/bundled-project.json`
- [Content Browser Settings](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/settings/content-browser.json): editor settings · `docs/build/sample-projects/morninghollow-dayfall/settings/content-browser.json`

### World and Gameplay

Data-driven scene, world, and prologue content.

- [Main Scene](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/scenes/Main.scene.json): scene definition · Primary gameplay composition. · `docs/build/sample-projects/morninghollow-dayfall/assets/scenes/Main.scene.json`
- [Prologue World](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/wingsworlds/MorninghollowPrologue.wingsworld.json): world definition · `docs/build/sample-projects/morninghollow-dayfall/assets/wingsworlds/MorninghollowPrologue.wingsworld.json`
- [Prologue Wingscript](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/wingscripts/Morninghollow.Prologue.wingscript.json): gameplay script · `docs/build/sample-projects/morninghollow-dayfall/assets/wingscripts/Morninghollow.Prologue.wingscript.json`

### Runtime Content Assets

Modular visual, audio, UI, effects, and sequence assets.

- [Standard A Fragment](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/fragments/Standard_A.fragment.json): entity fragment · Reusable renderable entity composition. · `docs/build/sample-projects/morninghollow-dayfall/assets/fragments/Standard_A.fragment.json`
- [Ship Mesh](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/meshes/standard_a_ship.mesh.json): mesh metadata · `docs/build/sample-projects/morninghollow-dayfall/assets/meshes/standard_a_ship.mesh.json`
- [Ship Material](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/materials/M_Player_1_ship_color.material.json): material descriptor · `docs/build/sample-projects/morninghollow-dayfall/assets/materials/M_Player_1_ship_color.material.json`
- [Railgun Audio](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/instruments/Weapons.Railgun.wngins): instrument asset · `docs/build/sample-projects/morninghollow-dayfall/assets/instruments/Weapons.Railgun.wngins`
- [Particle Effect](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/particles/Particle1785182623798.wngprt): particle asset · `docs/build/sample-projects/morninghollow-dayfall/assets/particles/Particle1785182623798.wngprt`
- [UI Definition](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/ui/UI1786069767206.wngui): UI asset · `docs/build/sample-projects/morninghollow-dayfall/assets/ui/UI1786069767206.wngui`
- [Sequence Track](https://github.com/keylessabyss/abyssalkey/blob/main/docs/build/sample-projects/morninghollow-dayfall/assets/tracks/Track1785858162715.wngtrk): timeline asset · `docs/build/sample-projects/morninghollow-dayfall/assets/tracks/Track1785858162715.wngtrk`

## Connections

- Documentation Entry → Built Documentation: links to
- Documentation Entry → Browser Application: loads
- Documentation Entry → Site Styles: loads
- Browser Application → Project Descriptor: loads project
- Project Descriptor → Bundle Descriptor: bundled as
- Project Descriptor → Content Browser Settings: editor behavior
- Project Descriptor → Main Scene: opens content
- Main Scene → Prologue World: coordinates
- Main Scene → Prologue Wingscript: executes
- Main Scene → Standard A Fragment: uses entities
- Standard A Fragment → Ship Mesh: assembles
- Standard A Fragment → Ship Material: assigns
- Prologue Wingscript → Railgun Audio: triggers
- Prologue Wingscript → Particle Effect: triggers
- Prologue Wingscript → UI Definition: presents
- Prologue Wingscript → Sequence Track: drives
- Particle Effect → Engine Particle Resources: uses resources
