Directories

assets/ Contains all imagery, animations, videos and JSON files needed for the game to function.

By default, you will be given dev 'watermarked' assets to protect copyright and publishing of the game.

Development assets are deployed to itch.io.

To get production commercial assets you will need access permissions to the production repository and use the prod assets. It should be assumed by developers and game designers working on the project that watermarked assets will be used. Either a release manager or the creator will need these assets to release the official game.

Ensure you close the Godot project first before running this so it can reimport images!

sh tools/bin/fetch-prod-assets.sh 

Directory List

addons/ Contains all third party code, by default this is added to source control (not ideal).

devlog/ Contains snapshots of the game used for Marketing and other promotional purposes.

docs/ Contains all of the documentation that is hosted on a unique URL per branch + the main URL hosted on Netlify.

helpers/ Source code we ideally don't want in the production release, and is used for aiding debugging development + taking snapshots.

sandbox/ is used to trial out certain features in scenes that are not part of the official codebase.

script_templates/ Scripts to generate end to end tests.

src/ Contains all of the production code.

test/ Stores the main test.tscn scene to run tests in src/**.test.gd.

tools/ contains Bash scripts and JavaScript scripts to help speed up development and be more efficient.

wwise/ contains all SoundBanks for the game to work with sophisticated audio. Check out wwise/README.md for more information.