Edit me

This page describes how you can setup your development environment for ACRE2, allowing you to properly build ACRE2 and utilize file patching. ACRE2 currently supports HEMTT (recommended) on Windows and Linux and Mikero Tools on Windows.

Requirements

  • Arma 3
  • Arma 3 Tools (available on Steam)
  • P-drive
  • Run Arma 3 and Arma 3 Tools directly from Steam once to install registry entries (and again after every update)
  • CBA mod (release or development version)

HEMTT: (recommended)

Mikero Tools:

  • Python 3.x
  • Mikero Tools: DePbo, DeTex, DeOgg, Rapify, MakePbo, pboProject
    • *.hpp removed from PboProject’s “Exclude From Pbo” list
    • -F rebuild RequiredAddons disabled
  • Python, Mikero Tools and Git in PATH environment variable

Why so complicated?

ACRE2 uses macros to simplify things and give the developer access to a better debug process, which requires a stricter build environment. The structure of this development environment also allows for file patching, which is very useful for debugging.

Additionally, Mikero Tools are stricter and report more errors than Addon Builder does. HEMTT is still in development and may contain unforseen errors, however it is much simpler to use without any extra requirements and aims to provide a much easier build process with sensible defaults.

Not offering executables for the Python scripts we use allows us to make easy changes without the hassle of compiling self-extracting exes all the time.

Getting Source Code

To actually get the ACRE2 source code on your machine, it is recommended that you use Git. Tutorials for this are all around the web, and it allows you to track your changes and easily update your local copy.

You can clone ACRE2 with any Git command line client using the following command:

git clone https://github.com/IDI-Systems/acre2.git

If you just want to create a quick and dirty build, you can also directly download the source code using the “Download ZIP” button on the front page of the GitHub repo.

Setup and Building (HEMTT)

Initial Setup

Execute setup.bat in tools folder (Windows) or download tools (HEMTT and ArmaScriptCompiler) and place the executables in project root (Windows and Linux - ArmaScriptCompiler supported only on Windows at this time).

File Patching Setup

Not available on Linux as there is no officially supported Arma 3 client for Linux.

You can use provided setup.py if you have a P-drive setup by following the same instructions as for Mikero Tools. P-drive is not required for HEMTT or file patching!

Otherwise navigate to tools folder in command line.

cd <path-to-cloned-repository>/tools

Create the following link manually. First, create a folder called idi in your Arma 3 directory. Then run the following command as admin, replacing the text in brackets with the appropriate paths:

mklink /J "[Arma 3 installation folder]\idi\acre" "[location of the ACRE2 project]"

Create a Test Build

To create a development build to test changes or to debug something, execute build.bat (Windows) or run $ hemtt build (Linux) in the root folder. This will populate the addons folder with binarized PBOs. These PBOs still point to the source files in their respective folders however, which allows you to use file patching. This also means that you cannot distribute this build to others.

To start the game using this build, you can use the following modline:

-mod=@CBA_A3;idi\acre

Create a Release Build

To create a complete build that you can use without the source files, execute build_release.bat (Windows) or run $ hemtt build --release (Linux) in the root folder. This will populate the releases folder with binarized PBOs that you can redistribute. These handle like those of any other mod.

Setup and Building (Mikero Tools)

Initial Setup

Navigate to tools folder in command line.

cd <path-to-cloned-repository>\tools

Execute setup.py to create symbolic links to P-drive and Arma 3 directory required for building.

Should the script fail, you can create the required links manually. First, create idi folders both in your Arma 3 directory and on your P-drive. Then run the following commands as admin, replacing the text in brackets with the appropriate paths:

mklink /J "[Arma 3 installation folder]\idi\acre" "[location of the ACRE2 project]"
mklink /J "P:\idi\acre" "[location of the ACRE2 project]"

Then, copy the cba folder from the tools folder to P:\x\cba. Create the x folder if needed. That folder contains the parts of the CBA source code that are required for the macros to work.

Create a Test Build

To create a development build of ACRE2 to test changes or to debug something, execute build.py in the tools folder. This will populate the addons folder with binarized PBOs. These PBOs still point to the source files in their respective folders however, which allows you to use file patching. This also means that you cannot distribute this build to others.

To start the game using this build, you can use the following modline:

-mod=@CBA_A3;idi\acre

You will also need acre.dll and ACRE2Arma.dll (or acre_x64.dll and ACRE2Arma_x64.dll for 64-bit) placed in idi\acre folder. You can obtain those from last release or build them yourself. TeamSpeak plugin is not required for basic operation.

Create a Release Build

To create a complete build of ACRE2 that you can use without the source files you will need:

  • All C++ requirements
  • msbuild in PATH environment variable (usually C:\Program Files (x86)\MSBuild\14.0\Bin)
  • Ensure .hpp is NOT in pboProject’s “Exclude From Pbo” list

When the requirements are met:

  • Execute make.py version increment_build <other-increment-args> compile force release in the tools folder, replacing <other-increment-args> with the part of version you want to increment (options described below)

This will populate the release folder with binarized PBOs, compiled extensions, copied extras, bisigns and a bikey. Additionally, 2 archive files will also be created in the folder, one general and one for Steam which includes the required Steam extension. The folder and archives handle like those of any other mod.

Different make.py command line options include:

  • version - update version number in all files and leave them in working directory (leaving this out will still update the version in all files present in the release folder, but they will be reverted to not disturb the working directory)
  • increment_build - increments build version number
  • increment_patch - increments patch version number (ignored with increment_minor or increment_major)
  • increment_minor - increments minor version number and resets patch version number to 0 (ignored with increment_major)
  • increment_major - increments major version number and resets minor and patch version numbers to 0
  • compile - compile extensions incrementally (leaving this out will simply copy extensions if already present)
  • force - force rebuild all PBOs, even those already present in the release directory (combined with compile it will also rebuild all extensions)
  • release - create release packages/archives
  • <component1> <component2> - build only specified component(s) (incompatible with release)
  • force <component1> <component2> - force rebuild specified component(s) (incompatible with release)

File Patching

File Patching allows you to change the files in an addon while the game is running, requiring only a restart of the mission. This makes it great for debugging, as it cuts down the time required between tests.

To run Arma 3 with file patching add the -filePatching startup parameter.

Files must exist in the built PBOs for file patching to work. If you create a new file you must rebuild the PBO or Arma will not find it in your file paths.

Disable CBA Function Caching

By default CBA caches a compiled version of functions to reduce mission load times. This interferes with file patching. There are three ways to disable function caching:

  • Load cba_cache_disable.pbo (included in CBA’s optionals folder - simply move it to addons folder for the time being)
  • Add the following to your test missions description.ext:
class CfgSettings {
    class CBA {
        class Caching {
            compile = 0;
            xeh = 0;
            functions = 0;
        };
    };
};
  • To only disable caching for a single module, hence greatly improving mission restart time, add the following line to the script_component.hpp file of said module:
#define DISABLE_COMPILE_CACHE

Restrictions

Configs are not patched during run time, only at load time. You do not have have to rebuild a PBO to make config changes, just restart Arma. You can get around this though if you are on the dev branch of Arma 3 and running the diagnostic exe. That includes diag_mergeConfig which takes a full system path (as in p:\idi\clients\acre\addons\my_module\config.cpp) and allows you to selectively reload config files.