love-actions-linux

Which version to use?

• For the 11.5 version of the LÖVE framework, use the v2 tag or v2.x.x tags.
• For the 11.4 version of the LÖVE framework, use the v1 tag or v1.x.x tags.

Branches

This branch is for the latest release version of the LÖVE framework.

For the 11.4 version, please refer to the 11.4 branch.

About

Github Action for building & deploying Linux .AppImage packages of a LÖVE framework based game.

Related actions

See related actions below:

Love actions bare package

Love actions for testing

Quick example

- name: Build Linux packages
  id: build-packages
  uses: love-action/love-actions-linux@v2
  with:
    app-name: Love App
    bundle-id: com.example.loveapp
    description: My awesome love app
    version-string: "1.0.0"
    icon-path: ./.github/build/linux/dev/icon.png
    love-ref: "11.5"
    love-package: ./game.love
    lib-path: ./lib
    share-path: ./share
    build-deb: true
    product-name: love_app
    output-folder: ./dist

Notice

If you want to load dynamic libraries in love runtime, you should place them in the {lib-path}/lua/5.1/ dir.

Your library folder should look like this:

 - lib
    |- a.so
    |- b.so
    |- lua
        |-5.1
           |- load_in_lua.so

With Love actions bare package and Love actions for testing

env:
  BUILD_TYPE: ${{ fromJSON('["dev", "release"]')[startsWith(github.ref, 'refs/tags/v')] }}
  CORE_LOVE_PACKAGE_PATH: ./core.love
  CORE_LOVE_ARTIFACT_NAME: core_love_package
  PRODUCT_NAME: my_love_app
  BUNDLE_ID: com.example.myloveapp

jobs:
  build-core:
    runs-on: ubuntu-latest
    env:
      OUTPUT_FOLDER: ./build
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      - name: Build core love package
        uses: love-actions/love-actions-core@v1
        with:
          build-list: ./media/ ./parts/ ./Zframework/ ./conf.lua ./main.lua ./version.lua
          package-path: ${{ env.CORE_LOVE_PACKAGE_PATH }}
      - name: Upload core love package
        uses: actions/upload-artifact@v4
        with:
          name: ${{ env.CORE_LOVE_ARTIFACT_NAME }}
          path: ${{ env.CORE_LOVE_PACKAGE_PATH }}
  auto-test:
    runs-on: ubuntu-latest
    needs: build-core
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      - name: Love actions for testing
        uses: love-actions/love-actions-test@v1
        with:
          font-path: ./parts/fonts/proportional.otf
          language-folder: ./parts/language
  build-linux:
    runs-on: ubuntu-latest
    needs: [build-core, auto-test]
    env:
      OUTPUT_FOLDER: ./build
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      # Download your core love package here
      - name: Download core love package
        uses: actions/download-artifact@v4
        with:
          name: ${{ env.CORE_LOVE_ARTIFACT_NAME }}
      # This is an example dynamic library
      - name: Download ColdClear
        uses: ./.github/actions/get-cc
        with:
          platform: Linux
          dir: ./ColdClear
      # Notice the subdir /lua/5.1
      - name: Process ColdClear
        shell: bash
        run: |
          cd ./ColdClear
          mkdir -p ./lib/lua/5.1
          mv ./x64/CCloader.so ./lib/lua/5.1
      - name: Build Linux packages
        id: build-packages
        uses: love-actions/love-actions-linux@v2
        with:
          app-name: Love App
          bundle-id: com.example.loveapp
          description: My awesome love app
          version-string: "1.0.0"
          icon-path: ./.github/build/linux/${{ env.BUILD_TYPE }}/icon.png
          love-package: ${{ env.CORE_LOVE_PACKAGE_PATH }}
          lib-path: ./ColdClear/lib
          product-name: ${{ env.PRODUCT_NAME }}
          output-folder: ${{ env.OUTPUT_FOLDER }}
      - name: Upload AppImage artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ needs.get-info.outputs.base-name }}_Linux_AppImage
          path: ${{ env.OUTPUT_FOLDER }}/${{ env.PRODUCT_NAME }}.AppImage

All inputs

Name	Required	Default	Description
app-name	false	"Love App"	App display name. Would be used in desktop file
bundle-id	false	"org.loveactions.love"	App bundle ID. Would be used to rename debian package's desktop file
description	false	"love"	App description. Would be used in control file and desktop file
version-string	false	"11.5"	App version string. Recommend using 3 numbers seperated by dots
icon-path	false	""	Path to the png icon. Would be used in desktop file
love-ref	false	"11.5"	love release ref. Could only be release tags like 11.5
love-package	false	"./game.love"	Love package. Used to assemble the executable
lib-path	false	""	Path to the library folder. Would copy all contents excluding top folder
share-path	false	""	Path to the share folder. Would copy all contents excluding top folder
build-deb	false	"true"	Switch to control build debian package or not
product-name	false	"love_app"	Base name of the package. Used to rename products
output-folder	false	"./build"	Packages output folder. All packages would be placed here
love-actions-folder	false	"love-actions-linux"	Path to the love-actions-linux folder. Would be used to run all the action steps

All outputs

Name	Example	Description
package-paths	./build/love_app.AppImage	built packages' paths in a bash-style list relative to the repository root, separated by spaces

Other platforms

If you need to build game for other platforms, please check links below:

Love actions for android

Love actions for iOS

Love actions for macOS portable

Love actions for macOS AppStore

Love actions for Windows