Skip to content

Contributing

Valk edited this page Dec 7, 2025 · 75 revisions

Prerequisites

In order to run the game you will need the latest Godot C# and .NET 8.0 SDK and a Custom Build of ENet if you are a Linux or Mac user.

You will need to setup an IDE, here are setup guides for Visual Studio 2022 (highly recommended) and Visual Studio Code. While not required, I highly recommend installing GitHub Desktop App as it greatly simplifies interactions with git.

Clone the repository with git clone --recurse-submodules https://github.com/CSharpGodotTools/Template and open the project.godot file to open the project.

In Godot > Editor > Editor Settings, search for "external" and make sure Use External Editor is enabled and External Editor is set to your IDE.

image image

Open up a script from Godot at least once so Godot has a chance to generate the proper assemblies otherwise you may see some missing types.

Guidelines

Normally, when setting up a new project using Template, you would run the setup scene, which replaces the root namespace __TEMPLATE__ in various scripts with the game name you specify. However, since we are contributing directly to Template, we should avoid running this setup.

Please have a brief look at the Template's Coding Standards.

Ready to start contributing? Start by looking to see if there are any issues or pull requests.

Contact

If you have any questions you can send me a message over Discord, my username is valky5.

Resource Links

Clone this wiki locally