Contributing

Setting up an IDE

Prerequisites

• Godot C#
• .NET 8.0 SDK

I recommend using Visual Studio 2022 but if you want to use VSCode click here

Visual Studio 2022

1. Install Visual Studio 2022
2. Install the Godot Support Extension
3. In Godot Editor > Editor Settings, search for "external editor", Dotnet > Editor, set External Editor to Visual Studio
4. Click on any script in Godot to open the Godot project in VS2022

Fixes to common problems encountered in VS2022

Debugging

1. Navigate to Debug > Template Debug Properties
2. Delete the only profile there
3. Create a new "Executable" profile
4. Set the executable path to where Godot_v4.3-stable_mono_win64.exe is located
5. Set the working directory to '.' without the ''
6. Click the green arrow "Profile 1" to launch the game with debugging enabled

Working with GitHub Desktop

1. Install GitHub Desktop
2. In GitHub Desktop, File > Clone repository > URL > https://github.com/ValksGodotTools/Template
3. Go to Current Branch > New Branch, name your branch and click Create Branch
4. Make changes to the project
5. Click Commit to [branch-name] and then Push origin to push your changes
6. Create a new pull request through the GitHub website to merge your branch into the main branch

🛠️ Development Guidelines

• Coding Standards: Follow the existing coding style and conventions used in the project. Refer to the Coding Standards document if unsure.

• Testing: Ensure your changes do not break existing functionality.

• Assets: All contributed assets should be under the CC0 license.

If you have any questions you can contact me over Discord, my username is valky5

📚 Resources

• Godot C# Documentation
• ENet-CSharp Documentation
• Microsoft Learn - C#