Difference between revisions of "Game Distribution/APKTool"

m
m
(14 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
To distribute your game for Android using APKTool:
 
To distribute your game for Android using APKTool:
  
{{notice|'''This method is shouldn't be used for 11.1 APK and earlier!''' Google requires that all apps in Play Store must be compatible with API level 26 and compiled for ARM64, which isn't the case for LOVE 11.1 APK. However, those requirements is satisfied with the new LOVE 11.2 APK that can be downloaded [https://bitbucket.org/rude/love/downloads/love-11.2-android.apk here].}}
+
{{notice|'''WARNING: This page is subject to deletion'''. Reason: [https://android-developers.googleblog.com/2020/08/recent-android-app-bundle-improvements.html Play Store will mandate Android Application Bundle in 2021!]}}
 +
 
 +
{{notice|Some notes before performing this method:
 +
1. '''This method is shouldn't be used for 11.1 APK and earlier!''' Google requires that all apps in Play Store compiled for ARM64, which isn't the case for LOVE 11.1 APK.
 +
 
 +
2. This method assume '''you have PC or Mac available'''. This means this method '''may not work''' when done from Termux or other terminal emulator from Android (YMMV)!
 +
 
 +
3. Make sure to specify valid, acceptable package name and '''sign the APK''' afterwards! Often errors include "Problem parsing package" and "App not installed" error. If you sure it's already signed and has valid package name, try to install via ADB.
 +
 
 +
4. The APK only contains binaries for '''ARMv7 and ARMv8'''! The APK won't work under normal AVD. You need real device, ARMv7 emulator, or 3rd-party emulator to run/test your game!
 +
 
 +
5. If you're compiling your own "embed" APK from [https://github.com/love2d/love-android master] branch, then skip step 7!}}
  
 
1. Download [https://ibotpeaches.github.io/Apktool/install/ APKTool] and follow the installation instructions.
 
1. Download [https://ibotpeaches.github.io/Apktool/install/ APKTool] and follow the installation instructions.
  
2. Download LÖVE APK from the [https://love2d.org/ main page] and put it somewhere in folder.
+
2. Download latest LÖVE APK from [https://github.com/love2d/love/releases/download/11.3/love-11.3-android-embed.apk here] and put it somewhere in folder.
  
3. In current folder (where you store the LÖVE APK), open Command Prompt/Terminal in the current directory and execute <code>apktool d -s -o love_decoded love-11.1-android.apk</code> and new folder <code>love_decoded</code> will be created. You can use any folder name, just make sure to make it consistent in later operations.
+
3. In current folder (where you store the LÖVE APK), open Command Prompt/Terminal in the current directory and execute <code>apktool d -s -o love_decoded love-11.3-android-embed.apk</code> and new folder <code>love_decoded</code> will be created. You can use any folder name, just make sure to make it consistent in later operations.
  
 
4. In <code>love_decoded</code> folder, create new folder named <code>assets</code> and put your <code>game.love</code> inside that folder. Your packaged game must be named exactly <code>game.love</code>!
 
4. In <code>love_decoded</code> folder, create new folder named <code>assets</code> and put your <code>game.love</code> inside that folder. Your packaged game must be named exactly <code>game.love</code>!
  
5. (Optional) Change the APK icon by replacing the LÖVE icon in <code>res/drawable-{mdpi,{x,{x,{x,}}}hdpi}</code> (mdpi, hdpi, xhdpi, xxhdpi, and xxxhdpi). Replace <code>love.png</code> with your game icon in those folders. Make sure the image dimensions are same!
+
5. Change the APK icon by replacing the LÖVE icon in <code>res/drawable-{mdpi,{x,{x,{x,}}}hdpi}</code> (mdpi, hdpi, xhdpi, xxhdpi, and xxxhdpi). Replace <code>love.png</code> with your game icon in those folders. Make sure the image dimensions are same!
  
 
6. Modify <code>AndroidManifest.xml</code> and use this template:
 
6. Modify <code>AndroidManifest.xml</code> and use this template:
Line 24: Line 35:
 
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
 
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
 
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
 
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
 +
    <!--Uncomment line below if your game uses microphone capabilities. !-->
 +
    <!--uses-permission android:name="android.permission.RECORD_AUDIO" /!-->
 
     <uses-feature android:glEsVersion="0x00020000"/>
 
     <uses-feature android:glEsVersion="0x00020000"/>
 
     <application
 
     <application
Line 34: Line 47:
 
             android:configChanges="orientation|screenSize"
 
             android:configChanges="orientation|screenSize"
 
             android:label="${GameName}"
 
             android:label="${GameName}"
             android:launchMode="singleTop"
+
             android:launchMode="singleTask"
 
             android:name="org.love2d.android.GameActivity"
 
             android:name="org.love2d.android.GameActivity"
 
             android:screenOrientation="sensorLandscape"
 
             android:screenOrientation="sensorLandscape"
Line 46: Line 59:
 
     </application>
 
     </application>
 
</manifest></source>
 
</manifest></source>
   Here are the explanation of the variables:
+
   Here are the explanation of the variables. You just have to substitute them:
 
   * <code>${GamePackageName}</code> is your game internal package name.
 
   * <code>${GamePackageName}</code> is your game internal package name.
 
   * <code>${GameVersionCode}</code> is the internal APK version code.
 
   * <code>${GameVersionCode}</code> is the internal APK version code.
Line 53: Line 66:
 
   Make sure to substitute those variables.
 
   Make sure to substitute those variables.
  
7. Back to folder where you put the LÖVE APK then execute <code>apktool b -o your_game.apk love_decoded</code>. You can use any name, but again, make it consistent.
+
7. Since LOVE 11.3 APK didn't received update for a while, you have to change the target SDK version. Open <code>apktool.yml</code> and change <code>targetSdkVersion</code> to 29.
 +
 
 +
8. Back to folder where you put the LÖVE APK then execute <code>apktool b -o your_game.apk love_decoded</code>. You can use any name, but again, make it consistent.
 +
 
 +
9. '''Sign the resulting APK!!!''' This page doesn't cover how to do that, because it can be too long. '''You can't install the APK if it's not signed!!!'''. Hint: https://github.com/patrickfav/uber-apk-signer
 +
 
 +
If you find something is wrong or having some problems, don't hesitate to edit or mention me in LOVE Discord: "AuahDark#4586".
 +
 
 +
== See Also ==
 +
* [[Game Distribution]]
  
8. '''Sign the resulting APK!!!''' This page doesn't cover how to do that, because it can be too long. '''You can't install the APK if it's not signed!!!'''  ([https://developer.android.com/studio/publish/app-signing Sign APK using Android studio])
+
{{#set:Since=112}}
 +
{{#set:PrettySince=11.2}}
  
If you find something is wrong or having some problems, don't heistate to edit or mention me in LOVE Discord: "AuahDark#4586".
+
== Other Languages ==
 +
{{i18n|Game_Distribution/APKTool}}

Revision as of 15:11, 24 November 2020

This method will assume the usage of APKTool. To distribute your game for Android using APKTool:

O.png WARNING: This page is subject to deletion. Reason: Play Store will mandate Android Application Bundle in 2021!  


O.png Some notes before performing this method:

1. This method is shouldn't be used for 11.1 APK and earlier! Google requires that all apps in Play Store compiled for ARM64, which isn't the case for LOVE 11.1 APK.

2. This method assume you have PC or Mac available. This means this method may not work when done from Termux or other terminal emulator from Android (YMMV)!

3. Make sure to specify valid, acceptable package name and sign the APK afterwards! Often errors include "Problem parsing package" and "App not installed" error. If you sure it's already signed and has valid package name, try to install via ADB.

4. The APK only contains binaries for ARMv7 and ARMv8! The APK won't work under normal AVD. You need real device, ARMv7 emulator, or 3rd-party emulator to run/test your game!

5. If you're compiling your own "embed" APK from master branch, then skip step 7!

 


1. Download APKTool and follow the installation instructions.

2. Download latest LÖVE APK from here and put it somewhere in folder.

3. In current folder (where you store the LÖVE APK), open Command Prompt/Terminal in the current directory and execute apktool d -s -o love_decoded love-11.3-android-embed.apk and new folder love_decoded will be created. You can use any folder name, just make sure to make it consistent in later operations.

4. In love_decoded folder, create new folder named assets and put your game.love inside that folder. Your packaged game must be named exactly game.love!

5. Change the APK icon by replacing the LÖVE icon in res/drawable-{mdpi,{x,{x,{x,}}}hdpi} (mdpi, hdpi, xhdpi, xxhdpi, and xxxhdpi). Replace love.png with your game icon in those folders. Make sure the image dimensions are same!

6. Modify AndroidManifest.xml and use this template:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<manifest package="${GamePackageName}"
      android:versionCode="${GameVersionCode}"
      android:versionName="${GameVersionSemantic}"
      android:installLocation="auto" xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.VIBRATE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
    <!--Uncomment line below if your game uses microphone capabilities. !-->
    <!--uses-permission android:name="android.permission.RECORD_AUDIO" /!-->
    <uses-feature android:glEsVersion="0x00020000"/>
    <application
        android:allowBackup="true"
        android:icon="@drawable/love"
        android:label="${GameName}"
        android:theme="@android:style/Theme.NoTitleBar.Fullscreen"
    >
        <activity
            android:configChanges="orientation|screenSize"
            android:label="${GameName}"
            android:launchMode="singleTask"
            android:name="org.love2d.android.GameActivity"
            android:screenOrientation="sensorLandscape"
        >
            <intent-filter>
                <action android:name="android.intent.action.MAIN"/>
                <category android:name="android.intent.category.LAUNCHER"/>
                <category android:name="tv.ouya.intent.category.GAME"/>
            </intent-filter>
        </activity>
    </application>
</manifest>
 Here are the explanation of the variables. You just have to substitute them:
 * ${GamePackageName} is your game internal package name.
 * ${GameVersionCode} is the internal APK version code.
 * ${GameVersionSemantic} is the readable APK version string. Example: 2.1.0
 * ${GameName} is your game name which is going to be displayed in home screen/launcher.
 Make sure to substitute those variables.

7. Since LOVE 11.3 APK didn't received update for a while, you have to change the target SDK version. Open apktool.yml and change targetSdkVersion to 29.

8. Back to folder where you put the LÖVE APK then execute apktool b -o your_game.apk love_decoded. You can use any name, but again, make it consistent.

9. Sign the resulting APK!!! This page doesn't cover how to do that, because it can be too long. You can't install the APK if it's not signed!!!. Hint: https://github.com/patrickfav/uber-apk-signer

If you find something is wrong or having some problems, don't hesitate to edit or mention me in LOVE Discord: "AuahDark#4586".

See Also



Other Languages