Skip to main content

Automation

The automation tools are command line tools that can be used either manually with a terminal or with a CI system. These tools helps you managing your working environment, your project export and the localization management. It uses Python scripts with nox configuration to handle easily virtual envs and dependencies.

Here is the list of nox sessions available (use nox --list to get it from a command line):

  • build: Build Godot project.
  • export: Export Godot project.
  • publish: Publish Godot project.
  • setup: Setup development environment.
  • release_version: Release a version of the game.
  • update_localization: Update localization files.
  • translate: Translate english localization to another language using DeepL.
  • export_icon: Export icon png file to ico.

Configuration

The automation tools configuration is done in the file automation/common/__init__.py. 

You must set the following variables:

  • FORGEJO_API_URL: The api url of your repository (used to automatically create a release entry when releasing a new version of your game).
  • GAME_NAME: Should be automatically set up if you used the dotnet template.
  • PLATFORM_NAMES: The platforms you target (Supported values: "Windows", "Linux")
  • CONFIGURATION_NAMES: The configurations you want to uses.
  • DRM_NAMES: The list of DRMs you want to use (Supported values: "NoDrm", "Steam").  
  • STORE_NAMES: The list of store you want to publish on (supported values: "Steam", "Itch.io").
  • APPS: Register your apps.
  • STEAM_SDK_URL: The Steam sdk url compatible with your project.