Skip to content

Export Godot 3.x and 4.x games to Android with Github Actions

License

Notifications You must be signed in to change notification settings

dulvui/godot-android-export

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

godot-android-export

Github Action to export a Godot Engine 3 and 4 game for Android to apk/aab.
If you are facing problems with the action or this README feels not complete, pull requests are welcome or open an issue.

Table of contents

Godot 4.x

Godot 4.x is the current active stable version and will be actively maintained. You can find the code in the main branch.

Requirements

  • Godot Project
  • A valid exports_preset.cfg with an Android config
  • A valid export_credentials.cfg

Parameters

key required default description
godot-version true . Godot Engine version. Supported are 4.x versions. Check versions here
godot-channel false stable Godot Engine release channel (stable, beta, rc1, rc2, rc3...). Defaults to 'stable' Check release channels here
working-directory false . Path to project.godot file

How to use

Use the 4.x tag

- name: Godot Android export
  uses: dulvui/godot-android-export@v4
  with:
    godot-version: 4.2.2

Working examples

You an find a working examples here:
https://github.com/dulvui/futsal-manager/blob/main/.github/workflows/upload-android.yml

Godot 3.x

Godot 3.x is the current LTS version and will be less actively maintained. You can find the code in the godot-3 branch.

Requirements

  • Godot Project
  • A valid exports_preset.cfg with an Android config

Parameters

key required default description
working-directory false . Path to project.godot file
godot-version false 3.x Check versions here

How to use

Use the 3.x tag

- name: Godot Android export
  uses: dulvui/[email protected]
  with:
    working-directory: game
    godot-version: 3.5.3

Working examples

You an find a working examples here:
https://github.com/dulvui/pocket-broomball/blob/main/.github/workflows/upload-android.yml https://github.com/dulvui/ball2box/blob/main/.github/workflows/upload-android.yml

Version 2 breaking changes

The repository and action has been renamed from godot-android-upload to simply godot-android-export to simplify the action and to remove third party actions dependencies. Now this actions follows the Unix philosophy of simply doing one thing well. You can then upload the aab/apk export of your game where ever you want.

License

This software is licensed under the MIT license.