Skip to content

ProjectDefinition

marchbold edited this page Feb 24, 2023 · 5 revisions

Project

A project file defines an AIR application and it's dependencies.

  • version
  • dependencies
  • configuration variables to be inserted into dependencies
  • deploy options to specify locations for apm to deploy package files to

This project file will be used to download dependencies for an application and construct the application descriptor.

Index

A file(s) containing information about the project.

project.apm:

{
    "identifier": "com.application.id",
    "name": "Example Application Project File",
    "version": "1.0",
    "configuration": {
        "packageParam": "12345678"
    },
    "dependencies": [
        "com.package.example:1.0.0",
        { 
            "id": "com.package.another", 
            "version": "3.1.0"
        }
    ],
    "repositories": [
        { 
            "url": "https://airnativeextensions.com/repository", 
            "credentials" : { "username": "", "password": "" }
        }
    ],
    "deployOptions": { 
        "aneDir": "relative/path/to/ane/folder",
        "swcDir": "relative/path/to/library/swc/folder",
        "srcDir": "relative/path/to/library/src/folder",
        "assetsDir": "relative/path/to/assets/folder",
        "packageCacheDir": "relative/path/to/apm_packages/folder",
        "configDir": "relative/path/to/config/folder",
    },
    "buildTypes": {
        "buildTypeName": {
            "configuration": {
                "packageParam": "alternative_value"
            }
        }
    },
}

This file will be created by

apm init