config values

Overview

The <config /> tag has a large number of options, too many to document in the XML Format glossary.

Most targets share the output-directory option, which allows you to choose where in your Export folder that target goes.

<config:android output-directory="android" /> <!-- Export/android/ -->
<config:windows output-directory="my-windows-folder" /> <!-- Export/my-windows-folder/ -->
<config:flash output-directory="swf" /> <!-- Export/swf/ -->

The following targets have additional unique options.

C++

The following options are shared by all targets that use C++, including Android, iOS, Windows, macOS, and Linux.

<config:cpp requireBuild="true" />
<config:cpp buildLibrary="hxcpp" />

These options configure how lime rebuild compiles a C++ library project.

<config:project>
	<rebuild path="project" /> <!-- C++ code is stored in project/. -->
	<rebuild file="Build.xml" /> <!-- Get build info from project/Build.xml. -->
	<rebuild fullDebug="true" /> <!-- Also build debug NDLL if debug/release not specified. -->
</config:project>

Adobe AIR

The following options are available for Adobe AIR only.

<config:air sdk-version="28.0" />
<config:air profile="extendedDesktop" /> <!-- set a custom AIR device profile -->
<config:air connect="hostString" /> <!-- connect to a remote debugger at the specified host -->
<config:air listen="port" /> <!-- listen for a connection from a remote debugger on the specified port  -->

<config:ios device="universal" /> <!-- See iOS section. -->

Android

The following options are available for Android only.

<config:android install-location="auto" />
<config:android minimum-sdk-version="21" />
<config:android target-sdk-version="30" />
<config:android build-tools-version="30.0.2" />

<!-- <https://developer.android.com/reference/android/Manifest.permission.html> -->
<config:android permission="android.permission.INTERNET" />
<config:android permission="android.permission.ACCESS_NETWORK_STATE" />

<!-- Use `openfl create extension` to create an extension. This will also generate the correct config tag. -->
<config:android extension="path/to/extension" />

<config:android gradle-version="7.4.2" />
<config:android gradle-plugin="7.3.1" />
<config:android useAndroidX="true" />
<config:android enableJetifier="false" />
<!-- Build files will be created in gradle-build-directory. This helps work around Windows's file path length limit, and shouldn't be needed unless you run into that limit. -->
<config:android gradle-build-directory="C:/gradle-builds" />

Use the following syntax to set <application /> and <activity /> values in AndroidManifest.xml.

<config:android>
	<application android:appCategory="game" android:supportsRtl="true" />
	<activity android:immersive="false" />
	<activity android:persistableMode="persistAcrossReboots" />
</config:android>

<config:android>
	<!-- Repeating an attribute overwrites the previous value. -->
	<activity android:persistableMode="persistNever" />
	
	<!-- ...Even if the previous value was set by Lime. -->
	<application android:theme="@android:style/Theme.Fullscreen" />
	
	<!-- Passing an empty string removes that attribute. -->
	<application android:appCategory="" />
</config:android>

HTML5

The following options are available for HTML5 only.

<config:html5 dependency-path="lib" />

iOS

The following options are available for iOS only.

<config:ios device="universal" /> <!-- supported device types; other options: "iphone", "ipad" -->
<config:ios deployment="9.0" /> <!-- minimum iOS version to target -->

<config:ios prerenderedIcon="false" /> <!-- disable iOS mask and shine effect on icon -->

<config:ios identity="iPhone Developer" /> <!-- the identity to use for code signing -->
<config:ios provisioning-profile="12345678-9012-3456-7890-123456789012" /> <!-- the provisioning profile to use for code signing -->
<config:ios team-id="ABCDEFGHIJ" /> <!-- the team id to use for code signing -->

<config:ios non-exempt-encryption="true" />  <!-- set ITSAppUsesNonExemptEncryption key in Info.plist -->
<config:ios allow-insecure-http="*" /> <!-- set NSExceptionDomains key in Info.plist -->

<config:ios enable-bitcode="false" />
<config:ios compiler="clang" />
<config:ios linker-flags="-stdlib=libc++" />

tvOS

The following options are available for tvOS only.

<config:tvos device="appletv" /> <!-- supported device types -->
<config:tvos deployment="9.0" /> <!-- minimum iOS version to target -->

<config:tvos identity="tvOS Developer" /> <!-- the identity to use for code signing -->

<config:tvos prerenderedIcon="false" /> <!-- disable tvOS mask and shine effect on icon -->

<config:tvos non-exempt-encryption="true" /> <!-- set ITSAppUsesNonExemptEncryption key in Info.plist -->

<config:tvos compiler="clang" />
<config:tvos linker-flags="-stdlib=libc++" />

WebAssembly

The following options are available for WebAssembly only.

<config:webassembly dependency-path="lib" />


Improve this page