Skip to content
RevZero edited this page Jun 8, 2020 · 9 revisions

The first step is (obviously) to download the latest stable release. There should be a zip archive available from the "Assets" section, just below the release notes.

General procedure

If you are installing AML for the first time or you want to have a "fresh" installation:

  • Extract all files from the ZIP archive into a folder of your choice. The only restriction is, that AML requires a folder with write access. The safest option is, to create a folder on your Desktop. Avoid system folders like c:\Program Files\ or c:\Windows.
  • There is no installer. You can just start the "XCOM2 Launcher" application (XCOM2 Launcher.exe). If you can not find the application (.exe) file, you probably managed to download the wrong archive (containing the source code only).

Updating an existing version

If you are already using AML and want to update your existing version to a new version:

  • Extract all files from the ZIP archive into the existing AML folder and make sure that you overwrite all existing files.
  • If you copy files from one AML folder to another (instead of extracting a fresh archive), be careful that you do not accidentally overwrite the settings.json file that contains your most up to date AML configuration.

Compatibility note:
The settings.json file that contains the current configuration is guaranteed to be compatible with newer versions that share the same major version number. However, settings from a newer version may not be compatible with an older version of any version number.

Examples:

  • 1.3.2 -> 1.4.0 = Compatible when major version is identical
  • 1.4.0 -> 2.0.0 = Potentially NOT (fully) compatible when major version is different
  • 1.4.0 -> 1.3.2 = Likely NOT compatible when switching back to older version

Using multiple versions alternately

If you decide to try out a new version before overwriting your old installation (recommended for alpha/beta releases):

  • Perform the steps as you would for a fresh installation.
  • If you want to try and run the new version with your existing configuration, copy the file settings.json from your existing version to the new folder.
  • As the settings file resides locally in each AML folder, changes are obviously not synchronized between different AML installations.

-> Continue with Getting started