build-godot-action/ReadMe.md

# Build Godot Project

This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you can easily automate builds.

## Usage

This action will create a `build` folder with subdirectories for linux, windows, and mac. You must have the export preset configured for each platform to successfully export.

Example:

```yaml
steps:
- uses: josephbmanley/build-godot-action@master
  env:
    PROJECT: godot-project
    SUBDIRECTORY: project
```

### Environment Variables

- #### PROJECT **REQUIRED**

    Name of the project files to output.

    Eg. `godot-project` will export to `godot-project.exe`

- #### SUBDIRECTORY

    Subdirectory to export project into.

    Eg. `project` will export to `$GITHUB_WORKSPACE/build/windows/project/godot-project.exe`

- #### PACKAGE

    Boolean value on whether or not to zip game files. Packages will be placed in the `$GITHUB_WORKSPACE/package` directory.

    Default Value: `false`

## Credits

This action uses the [godot-ci](https://github.com/aBARICHELLO/godot-ci) docker image from [BARICHELLO](https://github.com/aBARICHELLO)