STEM Career Paths Game

Development Notes

• Godot 4.2.x
• Follow GDQuest's Godot GDScript guidelines

Configuration

Run the install_hooks.sh script after cloning the project to install the pre-commit hooks. You can run this script from the command line by going to the directory containing the project and issuing this command:

sh install_hooks.sh

Having set up that hook will ensure that all the automated tests are run prior to each commit. For this to work, you need to be able to run Godot Engine from the command line as godot. Here is a recommended approach for Windows and Git Bash users:

1. Download Godot Engine and extract the executable (.exe file) from the archive.
2. Rename that executable to godot.exe.
3. Move that file to the bin folder of your home directory. (Your home directory is something like c:\Users\username.)

That executable is now on your default path, so you can now run godot from the command line and the automated tests will work. You can still create a shortcut to that executable on your Desktop for ease of mouse access, though there's real value to just opening the project you want from the command line.

Locally testing the HTML build

The Godot documentation describes the approach that we can use to locally test a web build. This requires using the serve.py Python script, which comes from the Godot Engine repository and is copied locally into the build/web folder.

First, export the project as an HTML5 Web build as normal. Then, from the build/web directory, run:

python serve.py --root .

It should bring up a browser that loads the web build from the build folder.

Per-Developer Project Settings Override

The override.cfg file, which can be used to override project settings, is not version controlled. Each developer can have their own settings in this file. The most common use case for this is that a developer may need to adjust the test game window's resolution to fit on their current display. For example, in this case, putting the following into a override.cfg in the project folder will run the game at 360x640.

display/window/size/window_width_override=360
display/window/size/window_height_override=640

Legal

©2024 Paul Gestwicki

This software is licensed under GNU General Public License v3.0.

Assets are licensed under Creative Commons Attribution-ShareAlike 4.0 International.

Third-Party Assets

• Shantell Sans font licensed under OFL

• Rounds Black font licensed under OFL

• OpenSans licensed under OFL

• Button click sound is a modification of Mouse Button Clicks licensed under CC0

• Gear image is licensed under CC0