Yaml file

## Your game configuration Your project has a _flambe.yaml_ file. This is the place to configure your game at higher level and configure some global and target specific options.

name/description

Basic information about the game.

name: Your Game
description: A short one-line description.

developer

Information about the game developer.

developer:
  name: Your Company Name
  url: http://yourwebsite.com

id

The game's unique identifier. For app-builds (android,ios) this ID is also the app bundle identifier. For Android build this will also be part of the url in the Google PlayStore.

id: com.yourdomain.yourgame

version

The game's version string.

version: 1.0.0

main

The main class name.

main: urgame.Main

default_platform

The platform to use when invoking flambe run or flambe build with no arguments. Options: html, flash, android, ios, firefox

default_platform: html

orientation/fullscreen

The initial orientation and fullscreen state on mobile devices.

orientation: portrait
fullscreen: true

Options: portrait/landscape Additional flags to pass to the Haxe compiler.

haxe_flags: -lib nape -D foobar

More on flags on Conditional compilation

extra_paths

Additional paths to include in the build. You can use an array-like style (see web) or space-separated style (see src) in yaml

extra_paths:
   assets: dir1 dir2
   libs: dir1 dir2
   src: ../dir1 ../dir2
   web: ["dir1 with spaces", "dir2"]

android

Android-specific configuration. This is piece of XML is added to the Adobe Air descriptor file.

android:
  # https://developer.android.com/guide/topics/manifest/manifest-intro.html
  AndroidManifest.xml: |
    <manifest android:installLocation="auto">
      <uses-permission android:name="android.permission.INTERNET" />
    </manifest>

This is piece of XML is added to the Adobe AIR descriptor file.

ios

iOS-specific configuration. This is piece of XML is added to the Adobe Air descriptor file.

ios:
  # http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference
  Info.plist: |
    <key>UIDeviceFamily</key>
    <array>
      <string>1</string>
      <string>2</string>
    </array>
    <key>UIPrerenderedIcon</key>
    <true/>

This is piece of XML is added to the Adobe AIR descriptor file.

firefox

Firefox App-specific configuration. This is piece of JSON is added to the Firefox OS manifest file.

firefox:
  # https://developer.mozilla.org/en-US/docs/Web/Apps/Manifest
  manifest.webapp:
    {
      default_locale: "en",
      # type: "privileged",
      # permissions: [...]
    }