⚠️ This project is still in early development! Feel free to poke around the code, but there is no game here yet!

Spectral Shift

A 2D puzzle adventure into color and a reality ripped apart.

This game is under active development. It is intended to be the full-fledged version of Spectral Shift which was built during a 72-hour game jam.

Check out the Wiki for more information about the game and developer documentation.

Setting up for development

The only required install is the game engine: Godot Engine 3.x

Other things to install are:

Code editor: Visual Studio Code
- Language support: godot-tools
- Unit testing support: gut-extension
Unit testing addon: Gut 7.x
Asset creation and management: Plastic SCM Cloud Edition
Godot Toolkit and Mdformat (Markdown formatter): install Python ≥ 3.7 then pip install -r .github/requirements.txt
- Installing with pipx may be of interst as well

Install the Godot Engine (required)
(Optional) Install the optional applications.
- Asset creation and management are currently limited to the maintainers of this game due to the limited number of free seats in the asset management system.
- Autoformatting, linting, static analysis, testing, builds, and code documentation generation happen automatically when you make a pull request on GitHub. However, these tools can be installed locally by running pip install -r .github/requirements.txt in the root of the repository.
- Configure VSCode to be Godot's default code editor
Clone this repo with git clone https://github.com/Option-2-Games/Spectral-Shift.git
Launch Godot, and import the cloned repo

Start creating!