https://github.com/cat-lips/f00f

My Godot 4 C# Git Template
https://github.com/cat-lips/f00f

csharp godot template

Last synced: about 1 month ago
JSON representation

My Godot 4 C# Git Template

• Host: GitHub
• URL: https://github.com/cat-lips/f00f
• Owner: Cat-Lips
• License: mit
• Created: 2024-05-07T08:28:56.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-24T09:18:20.000Z (about 2 months ago)
• Last Synced: 2024-11-24T10:21:46.443Z (about 2 months ago)
• Topics: csharp, godot, template
• Language: C#
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# F00F

Godot 4 C# Git Template

This [template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) can be used to create a C#-ready repository for Godot projects.

## Features:

 - Configured for 3D by default (but contains preferred 2D pixel-art settings as comments)

 - Contains Launch Settings to run game/editor from Visual Studio IDE (tip: use [symlinks](https://schinagl.priv.at/nt/hardlinkshellext/linkshellextension.html) to manage versions)

 - Contains a GitHub Workflow to export game to a WIP release whenever wip branch is updated (tip: recreate branch to trigger export)

 - Contains a setup script that can be run with Git Bash to download external addons and git repos (see extras)

 - Contains VS editor & filenesting config with corresponding csproj inclusions

 - Contains GD export presets with default project settings

 - Contains basic Assets/Game/addons folder structure

 - Contains shortcut to user data folder

 - Configured for .NET8

## Usage:

Set name & description in project.godot, build and run in Visual Studio:

 - Updates README.md with new name (line 1) and description (line 2)

   - (Template text auto trimmed if renaming from F00F)

 - Updates Github Workflow to use current Godot version

 - Updates export presets with new name

 - Renames sln & csproj with new name

NB: After running, you will need to exit Visual Studio (without saving) to open renamed sln

Also functions as a plugin to track changes made in editor (enabled by default)

(currently .appdata shortcut must be updated manually)

## Tips:

 - For Visual Studio, a minimal install of the '.NET Desktop Development' workload is all that's required (as it now includes .NET8)

 - To open Godot Editor from within Visual Studio, right-click project.godot in Solution Explorer (Solution Items) to set the default OpenWith option to symlinked path

## Extras:

 - Contains a setup script that can be run with Git Bash to download external addons and git repos

   - Negates having to store addons or create submodules in your repository (pros & cons)

   - The addons folder contains a default .gitignore file to exclude all externals (edit/remove as required)

     - (eg, can unignore zip files to fix addon version)

   - The GitHub Workflow is configured to run setup script if present

   - Requires **Developer Mode** or **Admin Privileges** to create symlinks (see setup.sh for alternative)