Skip to content

ADVAD1D/advad-containers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ADVAD Godot Exporter (Docker)

This project provides a Docker-based environment to automatically build and export the ADVAD1D Godot project without needing to install the Godot Engine or its export templates on your local machine.

By default, it is configured to use Godot 4.6-stable in "headless" mode (without a GUI) and can generate clean, automated exports for Web and Windows.

Prerequisites

Project Structure

  • Dockerfile: Defines and builds an Ubuntu-based image, installing Godot in headless mode along with the required export templates.
  • docker-compose.yml: Defines the export service, mounting the necessary volumes to read the source project and output the builds.
  • scripts/entrypoint.sh: Main script executed upon container startup. It orchestrates the Godot client execution to generate exports.
  • .env.example: Example environment variables file, used to configure the default target platform.

Configuration and Volumes

The docker-compose.yml file is configured to interact with your local filesystem by mapping the following volumes:

  1. ../ADVAD1D -> /project (Read-only): Directory where the game's source code is retrieved from. Make sure your game folder is named ADVAD1D and is placed at the same parent directory level as this folder (advad-containers).
  2. ./exports -> /exports: Local directory within this repository where the binaries generated by Godot will be saved.

Environment Variables

You can define the default behavior by configuring a .env file at the root of this directory (you can copy from .env.example):

cp .env.example .env

Inside this file, you can set the EXPORT_PLATFORM value. Available options are: web, windows, all, or shell.

Usage

Building and exporting is done simply by starting the service with Docker Compose.

Option 1: Export using the .env file

If you have configured your .env file, just build and spin up the container:

docker compose up --build

The container will perform the export and shut down automatically when finished.

Option 2: Specify the platform on the fly (Recommended)

You can ignore the .env file and explicitly specify the target platform when running the command:

Export for Web (HTML5):

EXPORT_PLATFORM=web docker compose up --build

Export for Windows:

EXPORT_PLATFORM=windows docker compose up --build

Export everything (Web and Windows sequentially):

EXPORT_PLATFORM=all docker compose up --build

Shell Mode (Interactive & Debugging)

If you need to enter the container to diagnose an issue or run manual shell commands with the Godot tools available:

EXPORT_PLATFORM=shell docker compose run --rm godot-export

Export Output (Builds)

Once the container finishes the process successfully, you will find the generated builds in the exports/ folder at the root of this project:

  • Web Build: exports/web/index.html (and all required .wasm, .pck files)
  • Windows Build: exports/windows/Advad.exe (and its corresponding .pck)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors