SynapseSpur

SynapseSpur is a 3D single-player wave survival action game built in Godot 4.5.
Players choose a class (Mage / Knight / Archer), fight infinite enemy waves, collect upgrades, and earn coins/XP to unlock new abilities, weapons, cosmetics, and characters.

For design docs, gameplay stills, HUD mockups, etc., see the project wiki.

---

External Requirements

To build and run this project, you must have:

• Godot Engine 4.5
• Git (https://git-scm.com/downloads)
• A Windows machine (this is our primary dev environment / grading target)

Verify install:

godot --version
git --version

To Play Game

Requirements

• 4GB Ram
• 1G Disk Space
• Windows 11

Instructions

• Download zip file
• Extract zip file
• Double click SynapseSpur.exe to play game

Testing

This project uses GUT (Godot Unit Test) for automated unit and integration testing.

Testing Framework

• Framework: GUT (Godot Unit Test)
• Engine: Godot 4.5
• Tests included: Unit tests and integration/behavior-style tests

Test Locations

All tests are located under the res://test/ directory:

• Unit tests:
  res://test/unit/

  • Example:
    • test_basic_arrow_projectile.gd

• Integration / Behavior tests:
  res://test/integration/

  • Example:
    • testplayer.gd

---

How to Run Tests (Godot Editor)

1. Open the project in Godot
2. Go to the GUT tab (bottom panel)
3. Ensure the test root directory is set to: res://test
4. Click Run All

The test results will appear in the GUT output panel showing:

• Passed tests
• Failed tests (if any)
• Execution time

---

How to Run Tests (Command Line)

Tests can also be run headlessly using:

godot --headless --script res://addons/gut/gut_cmdln.gd -gdir=res://test