Skip to main content

Install Godot Frog Framework

First time setup

Linux

Install the software dependencies by entering the following command in a terminal:

Linux Mint

sudo apt install -y git git-lfs python3 python3-pip python3-nox nox dotnet8 gettext libmagickwand-dev pre-commit

Debian

On debian, you need to add the Microsoft apt repository before installing the dotnet-sdk-8.0 package.

wget https://packages.microsoft.com/config/debian/13/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
sudo apt-get update
sudo apt-get install -y dotnet-sdk-8.0

Install GFF project

Then cloneClone the starter template project and run its setup script:

# Clone StarterProject
git clone git@git.collectivit.fr:frog-collective/godot-starter-project.git
cd godot-starter-project

# Setup the starter project
nox -s setup

Windows

Install the software dependencies by entering the following command in a Powershell command prompt with administrator rights:

winget install Git.Git Python.Python.3.12 Microsoft.DotNet.SDK.8 mlocati.GetText ImageMagick.ImageMagick

Then clone the starter template project and run its setup script:

# Clone StarterProject
git clone git@git.frog-collective.com:frog-collective/godot-starter-project.git
cd godot-starter-project

# Install python dependencies
pip install --user --upgrade nox pre-commit
$PATH = [Environment]::GetEnvironmentVariable("PATH", "User")
[Environment]::SetEnvironmentVariable("PATH", "$PATH;$env:APPDATA\Python\Python312\Scripts", "User")

# Setup the starter project
python -m nox -s setup

Create a Godot shortcut (for example on your desktop) that references the version configured by the setup script (this is useful to allow you to work on projects that use different version of Godot).

  • In an explorer, go to %USERPROFILE%/AppData/Local/Programs/Godot/ActiveVersion/
  • Create a shortcut from Godot-stable_mono_win64.exe

Install dotnet project template

Dotnet project template allow you to create new projects automatically based on our Godot project template. See the documentation here.

Build export configuration

To export your game, you need to install Godot build export template.
In Godot, go to the Export menu (Project -> Export...):

  • Click on Manage Export Templates 
  • Click on Download and Install 
  • Wait for install to finish

You can now build the project by using the command nox -s export (or using the Export VSCode task).

Configure your default text editor

This framework is configured to work with NeoVim or Visual Studio Code. You can choose your default text editor by calling the setup script with --text-editor argument:

nox -s setup -- --text-editor nvim

The setting will be stored in the file .editor-config so you don't need to specify it any time you call the setup script.

The setup script will automatically configure godot to open in the specified text editor.

VS Code special configuration

nox -s setup -- --text-editor code
  • Install the recommended extensions, vscode should ask you after opening the workspace, if not hit CTRL+P and type Show Recommended Extensions.
  • Setup VS Code User Setting (File -> Preferences -> Settings), set property godot.csharp.executablePath to the Godot executable path:
    • For Linux: ~/.local/opt/godot/ActiveVersion/Godot-stable_mono_linux.x86_64.
    • For Windows: ${env:UserProfile}/AppData/Local/Programs/Godot/ActiveVersion/Godot-stable_mono_win64.exe.

Note: You can run the setup script by running the Setup Environment task (Ctrl+Shift+P -> Run Task -> Setup Environment).