Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/love-actions/love-actions-android
Build Android .apk and .abb packages
https://github.com/love-actions/love-actions-android
android love2d
Last synced: 3 months ago
JSON representation
Build Android .apk and .abb packages
- Host: GitHub
- URL: https://github.com/love-actions/love-actions-android
- Owner: love-actions
- Created: 2022-07-08T14:29:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T10:22:37.000Z (6 months ago)
- Last Synced: 2024-10-01T08:04:14.842Z (3 months ago)
- Topics: android, love2d
- Homepage:
- Size: 21.5 KB
- Stars: 14
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# love-actions-android
## About
Github Action for building & deploying Android `.apk` and `.abb` packages of a [LÖVE](https://love2d.org/) framework based game.
### Related actions
See related actions below:
[Love actions bare package](https://github.com/marketplace/actions/love-actions-bare-package)
[Love actions for testing](https://github.com/marketplace/actions/love-actions-for-testing)
[Love actions for iOS](https://github.com/marketplace/actions/love-actions-for-ios)
[Love actions for Linux](https://github.com/marketplace/actions/love-actions-for-linux)
[Love actions for macOS portable](https://github.com/marketplace/actions/love-actions-for-macos-portable)
[Love actions for macOS App Store](https://github.com/marketplace/actions/love-actions-for-macos-app-store)
[Love actions for Windows](https://github.com/marketplace/actions/love-actions-for-windows)
## Quick example
```yaml
- name: Build love android
id: build-love
uses: love-actions/love-actions-android@v1
with:
app-name: "My Love Game"
bundle-id: "org.love2d.my_game"
resource-path: "./assets/android/res"
icon-specifier: "@mipmap/app"
love-ref: "0b0ff5551fae8b2079749481cd2b54adbbb25bd"
love-patch: "./love.patch"
love-package: "./game.love"
libs-path: "./assets/android/libs"
extra-assets: ./README.md ./license.txt
product-name: "my-game"
version-string: "2.3.4"
version-code: 234
output-folder: "./dist"
keystore-alias: ${{ secrets.ANDROID_KEYSTORE_ALIAS }}
keystore-base64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
keystore-key-password: ${{ secrets.ANDROID_KEYSTORE_KEYPASSWORD }}
keystore-store-password: ${{ secrets.ANDROID_KEYSTORE_STOREPASSWORD }}
```
## With [Love actions bare package](https://github.com/marketplace/actions/love-actions-bare-package) and [Love actions for testing](https://github.com/marketplace/actions/love-actions-for-testing)
```yml
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@v3
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@v3
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@v3
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-android:
runs-on: ubuntu-latest
needs: [build-core, auto-test]
env:
OUTPUT_FOLDER: ./build
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
# Download your core love package here
- name: Download core love package
uses: actions/download-artifact@v3
with:
name: ${{ env.CORE_LOVE_ARTIFACT_NAME }}
# This is an example dynamic library
- name: Download ColdClear
uses: ./.github/actions/get-cc
with:
platform: Android
dir: ./ColdClear
- name: Process ColdClear
shell: bash
run: |
mkdir -p ./libAndroid/armeabi-v7a/
mkdir -p ./libAndroid/arm64-v8a/
mv ./ColdClear/armeabi-v7a/libCCloader.so ./libAndroid/armeabi-v7a/
mv ./ColdClear/arm64-v8a/libCCloader.so ./libAndroid/arm64-v8a/
- name: Build Android packages
id: build-packages
uses: love-actions/love-actions-android@v1
with:
app-name: ${{ env.PRODUCT_NAME }}
bundle-id: ${{ env.BUNDLE_ID }}
icon-specifier: "@mipmap/icon"
keystore-alias: ${{ secrets.ANDROID_KEYSTORE_ALIAS }}
keystore-base64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
keystore-key-password: ${{ secrets.ANDROID_KEYSTORE_KEYPASSWORD }}
keystore-store-password: ${{ secrets.ANDROID_KEYSTORE_STOREPASSWORD }}
love-package: ${{ env.CORE_LOVE_PACKAGE_PATH }}
resource-path: ./.github/build/android/${{ env.BUILD_TYPE }}/res
libs-path: ./ColdClear/
extra-assets: ./libAndroid/
product-name: ${{ env.PRODUCT_NAME }}
version-string: "1.0.0"
version-code: 100
output-folder: ${{ env.OUTPUT_FOLDER }}
- name: Upload artifact
uses: actions/upload-artifact@v3
with:
name: ${{ needs.get-info.outputs.base-name }}_Android_release
path: ${{ env.OUTPUT_FOLDER }}/${{ env.PRODUCT_NAME }}-release.apk
```
## All inputs
| Name | Required | Default | Description |
| :-------------------------- | --------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `app-name` | `false` | `"LÖVE for Android"` | App display name. Used in `app/src/main/AndroidManifest.xml` |
| `bundle-id` | `false` | `"org.love2d.android"` | App bundle id. Used in `app/build.gradle` |
| `resource-path` | `true` | `""` | Path to the android resources folder. Would copy all contents to `app/src/main/res` excluding top folder |
| `icon-specifier` | `false` | `"@drawable/love"` | App icon specifier. Used in `app/src/main/AndroidManifest.xml` |
| `love-ref` | `false` | `"11.4"` | `love-android` git ref. Could be commit hash, tags or branch name |
| `love-patch` | `false` | `""` | Git patch file path for the `love-android` repo. The patch must start from `love-ref`. You can use `git diff -p ` to get the patch file |
| `love-package` | `false` | `"./game.love"` | `.love` game package file path |
| `libs-path` | `false` | `""` | Path to the JNI libraries folder. Would copy all contents to `app/libs` excluding top folder |
| `extra-assets` | `false` | `""` | List of folder & file paths to be added to `app/src/embed/assets/`. Separated by spaces |
| `product-name` | `false` | `"love-app"` | Base name of the package. Used to rename products |
| `version-string` | `false` | `"0b0ff5551fae8b2079749481cd2b54adbbb25bd9"` | App version string no more than 3 numbers. Used in `app/build.gradle` |
| `version-code` | `false` | `"30"` | Numeric app version code . Used in `app/build.gradle` |
| `output-folder` | `false` | `"./build"` | Built packages output folder |
| `keystore-alias` | `false` | `""` | Signing keystore's alias. Won't build release packages if not specified |
| `keystore-base64` | `false` | `""` | Signing keystore's content in `base64` string. Won't build release packages if not specified |
| `keystore-key-password` | `false` | `""` | Signing keystore's key password. Won't build release packages if not specified |
| `keystore-store-password` | `false` | `""` | Signing keystore's store password. Won't build release packages if not specified |
## All outputs
| Name | Example | Description |
| :---------------- | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `package-paths` | `./build/my-game-debug.apk ./build/my-game-release.apk` | Built packages' paths in a bash-style list relative to the repository root, separated by spaces |