Dodge the Creeps!

This is an implementation of the Godot "Dodge the Creeps!" tutorial game using godot-cpp 3.2, with some additional features.

Running The Binary Packages

Packaged versions can be found on the Releases page. Recent releases support both Linux and Windows.

Linux

After downloading and extracting the package, you may need to mark the Dodge the Creeps!.x86_64 file, located in the folder Dodge the Creeps! (Linux 64) as executable. Afterwards, simply launch the executable file.

Windows

After downloading and extracting the package, you should be able execute the Dodge the Creeps!.exe executable.

Building From Source

You may also build this project from source. You will need the following tools, regardless of your target platform:

Tool	Tested Version	Description
Python	3.8	Used to build godot-cpp
Conan	1.28	Used to build godot-cpp
CMake	3.14	Used to build the game
Git LFS	2.11	Used to store and fetch game assets
Godot	3.2	Used as the game engine

Compilation is currently supported on both Linux and Windows. On Linux, you may install Godot either via your package manager, or via Flatpak. On Windows, you can use Chocolatey to install Godot.

Before running the game, you have to compile the scripts used in the implementation. Follow the guides below to do so. Of course you will also need to clone or download the source code before continuing.

NOTE All commands have been tested in bash on Linux and Powershell on Windows.

Building on Linux

In addition to the basic tools, you will need the at least GCC version 9.2 to build the project on Linux. After installing gcc, you can build the project using the following commands from the root of the source:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build

Building on Windows

Before starting the build process, make sure that the tools mentioned above are installed and accessible in your PATH.

When building on Windows, you will need to have a recent version of the Microsoft Builds Tools for Visual Studio. Currently, all builds on Windows have only been tested with version the Microsoft Builds Tools for Visual Studio 2019 After installing the build tools, you can use the following commands from the root of the source:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release

Packaging

The Godot game engine is capable of exporting a game so that it can easily be deployed. Follow the instructions below to export the game for packaging. Make sure you have compiled the scripts as described above.

NOTE All commands have been tested in bash on Linux and Powershell on Windows.

Packaging on Linux

To export the game for Linux, you can use the following command:

godot --path godot --export "Linux" '../pkg/Dodge the Creeps!.x86_64'

You will be left with an executable and a script library called libdodgetc.so. To further bundle them, use the following command from the root folder of your clone:

tar -czf "Dodge.the.Creeps.Linux.64.tzst" --transform 's/pkg/Dodge the Creeps! (Linux 64)/' pkg/*

Packaging on Windows

To export the game for Linux, you can use the following command:

godot --path godot --export 'Windows Desktop' '../pkg/Dodge the Creeps!.exe'

You will be left with an executable and a script library called dodgetc.dll. To further bundle them, use the following command from the root folder of your clone:

New-Item -Path 'pkg\Dodge the Creeps! (Windows 64)' -ItemType Directory
Get-ChildItem -Path 'pkg\*' -Include '*.exe','*.dll' | Copy-Item -Destination 'pkg\Dodge the Creeps! (Windows 64)'
Compress-Archive -Path '.\pkg\Dodge the Creeps! (Windows 64)' -DestinationPath 'Dodge.the.Creeps.Windows.64.zip'

Asset Licenses

All assets used in this project are licensed as follows:

Asset Group	Author	License Identifier
Death Sparkle	Felix Morgner	CC-BY-SA-4.0
House In a Forest Loop	HorrorPen	CC-BY-3.0
Player and Mob Sprites	kenney.nl	CC0-1.0
Xolonium Font	Severin Meyer	OFL-1.0
Godot Engine Logo	Andrea Calabró	CC-BY-3.0
Game Over Sound	<UNKNOWN>	<UNKNOWN>
Coin Animation	DontMind8	CC-BY-4.0
SFX Pickup 19	jalastram	CC-BY-3.0