Skip to content

Docs: Create ARCHITECTURE.md#126

Merged
niyazmft merged 3 commits into
mainfrom
feat/issue-80-architecture-md
Jun 3, 2026
Merged

Docs: Create ARCHITECTURE.md#126
niyazmft merged 3 commits into
mainfrom
feat/issue-80-architecture-md

Conversation

@niyazmft
Copy link
Copy Markdown
Owner

@niyazmft niyazmft commented Jun 2, 2026

Fixes #80

Adds comprehensive architectural documentation for Emberfall, including sections on the visual 2.5D system, deterministic math, FSMs, and the updated GdUnit4 testing methodology.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request integrates the GdUnit4 unit testing framework into the project, replacing legacy shell-based testing with robust test suites, runners, and assertions. The code review identified several critical issues in the newly added framework files: potential runtime crashes in GdObjects.gd and GdUnitSceneRunnerImpl.gd due to missing validity checks on freed objects and loaded scenes; a redundant directory opening and potential null dereference in GdUnitFileAccess.gd; a strict typing mismatch in GdScriptParser.gd where a base Token is returned instead of a Variable; and a logic gap in GdUnitTestSessionRunner.gd where tests are executed even if the session startup hook fails.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread addons/gdUnit4/src/core/GdObjects.gd
Comment thread addons/gdUnit4/src/core/GdUnitFileAccess.gd
Comment thread addons/gdUnit4/src/core/parse/GdScriptParser.gd
Comment thread addons/gdUnit4/src/core/runners/GdUnitTestSessionRunner.gd Outdated
Comment thread addons/gdUnit4/src/core/GdUnitSceneRunnerImpl.gd
niyazmft added 3 commits June 3, 2026 21:43
Fixes #80

- Added comprehensive system overview
- Documented 2.5D visual layer and state machines
- Updated testing section to reflect recent GdUnit4 migration
@niyazmft niyazmft force-pushed the feat/issue-80-architecture-md branch from aed3ec0 to 0de1325 Compare June 3, 2026 18:44
@niyazmft niyazmft merged commit c7e65ed into main Jun 3, 2026
4 checks passed
@niyazmft niyazmft deleted the feat/issue-80-architecture-md branch June 3, 2026 18:46
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.

Task 3.3: Create ARCHITECTURE.md documentation

1 participant