Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhartland/love-build
GitHub Action for building a LÖVE Project
https://github.com/nhartland/love-build
Last synced: 3 days ago
JSON representation
GitHub Action for building a LÖVE Project
- Host: GitHub
- URL: https://github.com/nhartland/love-build
- Owner: nhartland
- License: mit
- Created: 2020-04-05T17:23:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T09:07:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T08:17:30.078Z (about 1 month ago)
- Language: Shell
- Homepage: https://github.com/marketplace/actions/love-build
- Size: 102 KB
- Stars: 52
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-love2d - LÖVE Build - GitHub Action for automated cross-platform builds. (Development)
README
# love-build
GitHub Action for building a [LÖVE](https://love2d.org/) Project.
This action produces a LÖVE file, along with macOS and Windows executable
packages for a LÖVE project. For projects making use of
[luarocks](https://luarocks.org/) packages, this build action supports the
bundling of dependencies via a user-defined
[rockspec](https://github.com/luarocks/luarocks/wiki/Rockspec-format).
For macOS application configuration, you can supply an `Info.plist` file in the
source directory which will be copied into the built application. If not
provided, the default LÖVE `Info.plist` will be used.
### Basic Configuration
To build and upload a LÖVE 11.4 project with the `main.lua` at the root of your
repository, use the following job steps:
```yaml
steps:
- uses: actions/checkout@v3
# Build the applications
- uses: nhartland/love-build@master
with:
app_name: 'hello_world'
love_version: '11.4'
# Upload the built applications
- uses: actions/upload-artifact@v1
with:
name: built-applications
path: 'release'
```
### Extended configuration
```yaml
steps:
- uses: actions/checkout@v3
- uses: nhartland/love-build@master
with:
app_name: 'hello_world'
love_version: '11.4'
# Use when the `main.lua` is in a subdirectory of your repository (here in `src/love`).
source_dir: 'src/love'
# Specifies the output location for the distributables, by default 'release'.
result_dir: 'nondefault_result_dir'
# Sets up luarocks dependencies according to provided rockspec
# Use the path relative to your repository root.
dependencies: 'dependencies-1-1.rockspec'
```
To see the full options specification please refer to the [action.yml](action.yml).
### Produced artifacts
The built applications are located in the `results_dir` path, by default the
root of your repository. This action returns four output variables specifying
the filenames relative to the working directory.
```yaml
love-filename:
description: 'Filename of built love file'
win32-filename:
description: 'Filename of built win32 application'
win64-filename:
description: 'Filename of built win64 application'
macos-filename:
description: 'Filename of built macos application'
```
The applications can therefore be built and individually uploaded with the
following steps:
```yaml
steps:
- uses: actions/checkout@v3
- uses: nhartland/love-build@master
id: love-build
with:
app_name: 'hello_world'
love_version: '11.4'
- uses: actions/upload-artifact@v1
with:
name: macos-build
path: ${{ steps.love-build.outputs.macos-filename }}
- uses: actions/upload-artifact@v1
with:
name: win32-build
path: ${{ steps.love-build.outputs.win32-filename }}
- uses: actions/upload-artifact@v1
with:
name: win64-build
path: ${{ steps.love-build.outputs.win64-filename }}
- uses: actions/upload-artifact@v1
with:
name: love-build
path: ${{ steps.love-build.outputs.love-filename }}
```
### LuaRocks dependencies
**Important Note:** LÖVE Build can only handle pure Lua dependencies and cannot
correctly build native libraries.
You can specify the dependencies of your LÖVE application using a rockspec.
These dependencies will be bundled in with the packaged LÖVE executables
and the required include paths added to the LÖVE path by means of prepending
[module_loader.lua](module_loader.lua) to your `main.lua`. The LuaRocks
integration depends only on the LuaRocks command line utilities and
not on the LuaRocks API.
The rockspec doesn't need to specify anything about your application other
than the dependencies. For example:
```lua
-- dependencies-1-1.rockspec
package = "dependencies"
version = "1-1"
source = {
url = 'none' -- Not required for local build
}
-- List your required dependencies here in the standard
-- rockspec format
dependencies = {
"etlua ~> 1.3",
"argparse ~> 0.5",
"loadconf >= 0.3.4, < 0.4"
}
build = {
type = "none"
}
```
### Working Examples
In this directory are two test cases, a basic "Hello World" with no
dependencies, and a Game of Life simulation showing how LuaRocks dependencies
are bundled.
- [Test Applications](tests)
- [Test Workflow](.github/workflows/master.yml)
### Limitations
This action so far only performs the minimal build required for getting
applications running, for example icons are not yet configurable.
Furthermore the macOS build is unverified by Apple and therefore will need
to be manually opened in the Security and Preferences pane at least for the
first time it is run.
Only projects based on LÖVE version 0.8.0 or greater are supported. Before
0.8.0, no win64 binaries were provided.