Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.

Gradle properties

Jump to bottom
SamYStudiO edited this page Mar 19, 2017 · 37 revisions

Flair properties overview with their default values:

flair {
  moduleName "app"
  packageName null
  autoGenerateVariantDirectories false

  debug false
  generateAtfTexturesFromDrawables false

  appId "{packageName}"
  appIdSuffix ""
  appName {projectName}
  appNameSuffix ""
  appFileName {projectName.replace( " " , "_" ).toLowerCase()}
  appVersionLabel "1.0.0"
  appVersionNumber "1"
  appFullScreen true
  appAspectRatio "any"
  appAutoOrients true
  appDepthAndStencil false
  appDefaultSupportedLanguage "en"

  compilerMainClass //default is platform dependent, see details below
  compilerOption // add a compiler argument
  compilerOptions // add multiple compiler arguments

  packageFileName {projectName.replace( " " , "_" ).toLowerCase()}_{productFlavors}_{buildType}_{version}
  packageTarget //default is platform dependent, see details below
  packageX86 false
  packageExcludeDrawable // exclude a drawable folder, see details below
  packageExcludeDrawables //exclude multiple drawable folder, see details below
  packageConnect null
  packageListen null //7936 if debug is true
  packageSampler false
  packageHideAneLibSymbols false
  packagePlatformSdk null

  signingAlias null
  signingProviderName null
  signingTsa null
  signingKeyPass null
  signingStoreType "pkcs12"
  signingKeyStore //default is platform dependent, see details below
  signingStorePass //default is platform dependent, see details below
  signingProvisioningProfile //default is package target dependent, see details below

  adlScreenSize "540x920:540x960"
  adlScreenDpi //default is platform dependent, see details below
  adlPubId null
  adlNoDebug false
  adlAtLogin false
  adlParameter // add a adl argument
  adlParameters // add multiple adl arguments
}

Flair properties

Properties used to configure Flair.

  • moduleName Name of the root directory containing all project files.

  • packageName Name of the root package containing actionscript files (for example com.hello.world).

  • autoGenerateVariantDirectories if true a variant directory is automatically added under src folder when you add a new variant.

App descriptor properties

Theses properties will be written in your app descriptor files when using assembleXxx tasks from build group or any task that depends on assembleXxx.

  • appId, appName, appFileName, appVersionLabel, appVersionNumber, appFullScreen, appAspectRatio, appAutoOrients, appDepthAndStencil These properties will be written in their equivalent from app descriptor.

  • appIdSuffix Add a suffix to current app id this may be useful when using different variants.

  • appNameSuffix Add a suffix to current app name this may be useful when using different variants.

  • appDefaultSupportedLanguage This is the default language to add in supportedLanguages node from your app descriptor xml, only set your default language since others languages will be automatically detected from your resources by scanning values folders. Valid languages are en, de, es, fr, it, ja, ko, pt, ru, cs, nl, pl, sv, tr, zh.

Compiler properties

Properties to configure compilation when using compileXxx tasks from build group.

  • compilerMainClass Compilation main class, default is {packageName}.MainIos for IOS platform, {packageName}.MainAndroid for Android platform and {packageName}.MainDesktop for Desktop platform (for example com.hello.world.MainIos).

  • compilerOption , compilerOptions Additional options you may want to add to compiler, for example:

    compilerOption "-swf-version=30"
compilerOptions "-swf-version=30" , "-define+=CONFIG::HELLO,world"

Check Adobe documentation for compiler options.

Package properties

Properties to configure packaging when using tasks from package group.

  • packageFileName This property is used to customize your packaged ipa, apk or exe file name. By default file name is {projectName.replace( " " , "_" ).toLowerCase()}_{productFlavors}_{buildType}_{version}, for example hello_world_armv7_debug_1.0.0. Do not add file extension here, extension will be added automatically.

  • packageExcludeDrawable , packageExcludeDrawables These properties allow to configure each drawable buckets that will be packaged into your application. For example on iOS including hdpi assets is useless since no iOS device is hdpi. Defaults are as following :

    • Ios [ "ldpi" , "hdpi" , "xxxhdpi" ]

    mdpi, xhdpi and xxhdpi (x1, x2 and x3) are packaged. If you targeting handsets only you should exclude mdpi as well since no device from iOS 7 are using this bucket (iOS 7 is minimum requirement since AIR 20.0). If you are targeting tablets only you should exclude xxhdpi as well since only iPhone 6+ use this bucket.

    • Android [ "ldpi" , "xxxhdpi" ]

    include all but ldpi and xxxhdpi, google recommended not using xxxhdpi at the moment since larger devices are x3.5 and scaling up xxhdpi (x3) is fine. Exclude ldpi by default since not much devices using this bucket anymore and if needed it will be scaled down from mdpi bucket.

    • Desktop [ "ldpi" , "hdpi" , "xxhdpi" , "xxxhdpi" ]

    exclude all but mdpi (standard screens) and xhdpi (for retina mac screens).

  • packageTarget If you don't set package target default will be as following:

    • Ios ipa-debug if debug is true else ipa-test
    • Android apk-debug if debug is true else apk-captive-runtime
    • Desktop native as this is the only supported target for Desktop platform

  • packageX86 Set to true to use x86 architecture instead of armv7 (Android only).

  • packageConnect

  • packageListen

  • packageSampler

  • packageHideAneLibSymbols

  • packagePlatformSdk

Check Adobe documentation for packaging options.

Signing properties

Properties to configure signing when packaging.

  • signingProvisioningProfile
  • signingKeyStore
  • signingStorePass
  • signingAlias
  • signingProviderName
  • signingTsa
  • signingKeyPass
  • signingStoreType

Check signing your application and Adobe documentation for signing options.

ADL properties

Properties to configure ADL emulator when using tasks from launch group.

  • adlScreenSize Adl emulator screen size, default is 540x920:540x960.

  • adlScreenDpi Adl emulator screen dpi (undocumented from Adobe documentation), default is 200 for iOS and 240 for Android.

  • adlPubId

  • adlNoDebug

  • adlAtLogin

  • adlParameter, adlParameters

Check Adobe documentation for adl options.

Clone this wiki locally