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 Feb 11, 2016 · 37 revisions

####Flair properties overview with their default value:

flair {
  moduleName "app"
  packageName null
  autoGenerateVariantDirectories true

  debug false
  generateAtfTexturesFromDrawables false

  appId "{packageName}"
  appIdSuffix ""
  appName project.name
  appNameSuffix ""
  appFileName "{appName}{appNameSuffix}"
  appVersion "1.0.0"
  appFullScreen true
  appAspectRatio "any"
  appAutoOrient true
  appDepthAndStencil false
  appDefaultSupportedLanguage "en"

  compileMainClass //default is platform dependent
  compileOption // add a compile argument
  compileOptions // add multiple compile arguments

  packageTarget //default is platform dependent
  packageX86 false
  packageExcludeResources //default is platform dependent
  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
  signingStorePass //default is platform dependent
  signingProvisioningProfile //default is package target dependent

  adlScreenSize "540x920:540x960"
  adlScreenDpi 240
  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, appVersion, appFullScreen, appAspectRatio, appAutoOrient, 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.

=== ####Compile properties Properties to configure compilation when using compileXxx tasks from build group.

  • compileMainClass Compilation main class, default is "{packageName}.MainIos" for IOS platform, "{packageName}.MainAndroid" for Android platform and "{packageName}.MainDesktop" for Desktop platform.

  • compileOption , compileOptions Additional options you may want to add to compiler, for example:

compileOption "-swf-version=30"
compileOptions "-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.

  • packageExcludeResources This property 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 [ "drawable*-ldpi*/**" , "drawable*-mdpi*/**" , "drawable*-hdpi*/**" , "drawable*-xxxhdpi*/**" ]

    only xhdpi and xxhdpi (x2 et x3) are packaged. By default Flair exclude mdpi (x1) drawables, this mean 1st generation devices will use scaled drawables from xhdpi.

    • Android [ "drawable*-ldpi*/**" , "drawable*-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 need it will be scaled down from mdpi bucket.

    • Desktop [ "drawable*-ldpi*/**" , "drawable*-hdpi*/**" , "drawable*-xxhdpi*/**" , "drawable*-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

  • adlScreenDpi Adl emulator screen dpi (undocumented from Adobe documentation)

  • adlPubId

  • adlNoDebug

  • adlAtLogin

  • adlParameter, adlParameters

Check Adobe documentation for adl options.

Clone this wiki locally