ACE3/docs/wiki/development/setting-up-the-development-environment.md

layout	title	description	group	parent	order
wiki	Setting Up the Development Environment	This page describes how you can setup your development environment for ACE3, allowing you to properly build ACE and utilize file patching.	development	wiki	0

This page describes how you can setup your development environment for ACE3, allowing you to properly build ACE and utilize file patching.

1. Requirements

• Arma 3
• Arma 3 Tools (available on Steam)
• 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)

• [Windows] PowerShell v3.0+ (pre-installed on Windows 8 or newer)
• HEMTT (>=v1.3.2) in project root (Windows users can double-click tools/setup.bat)
  • hemtt (Linux) or hemtt.exe (Windows)

Mikero Tools:

• P-drive
• Python 3.x
• Mikero Tools: DePbo, DeOgg, Rapify, MakePbo, PboProject >=3.16
  • *.hpp removed from PboProject's "Exclude From Pbo" list
• Python, Mikero Tools and Git in PATH environment variable

2. Why so complicated?

If you have contributed to AGM you might be used to an easier build process, where there was even an .exe you could use for building. ACE3, however, makes use of CBA macros to simplify things and give the developer access to a better debug process, which requires a stricter build environment. Additionally, HEMTT and Mikero's Tools are stricter and report more errors than AddonBuilder does. The structure of this development environment also allows for file patching, which is very useful for debugging.

Not including .exes in the repository for the tools we use allows us to make easy changes without the hassle of compiling self-extracting exes all the time.

3. Getting Source Code

To actually get the ACE3 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.

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.

4. Setup and Building (HEMTT)

Replace hemtt with hemtt.exe on Windows. P-drive is not required for HEMTT or file patching.

4.1 Initial Setup

Execute tools\setup.bat (double-click on Windows) or download HEMTT and place the executable in project root (Windows and Linux - binarization supported only on Windows at this time).

4.1.1 File Patching Setup

ACE3 comes pre-configured for testing with file patching using only CBA's latest published version. You must subscribe to CBA_A3 on the Workshop.

If you intend to test using file patching with CBA versions different than latest published, or with other mods, further setup is required create the links manually. First, create a folder called z 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]\z\ace" "[location of the ACE3 project]/.hemttout/dev"

4.2 Creating a Development Build

Run $ hemtt dev to build the mod for use with file patching (with links to the original addon folders) without binarization (faster and often not needed for development). This will populate the .hemttout/dev folder with unbinarized PBOs, with links back to the original addon folders. You cannot distribute this build to others.

Run $ hemtt launch to run ACE3 with pre-configured file patching. Uses $ hemtt dev before launching Arma.

To launch a development build using file patching with CBA versions different than latest published, or with other mods, you must build the mod with $ hemtt dev and start the game by providing a modline:

-mod=@CBA_A3;z\ace -skipIntro -noSplash -showScriptErrors -debug -filePatching

4.3 Creating a Test Build

To create a development build to test changes or to debug something, execute build.bat (double-click on Windows) or run $ hemtt build in the root folder. This will populate the .hemttout/build folder with binarized PBOs. This type of build is meant for sharing, group testing, but not for release.

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

-mod=@CBA_A3;z\ace -skipIntro -noSplash -showScriptErrors -debug

4.4 Creating a Release Build

To create a complete build that you can use without the source files, with full binarization and all optimizations, run $ hemtt release in the root folder. This will populate the .hemttout/release folder with binarized PBOs and an archive in releases that you can redistribute. These handle like those of any other mod.

4. Setup and Building (Mikero Tools)

4.1 Initial Setup

Navigate to tools folder in command line.

cd "[location of the ACE3 project]\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 z 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]\z\ace" "[location of the ACE3 project]"
mklink /J "P:\z\ace" "[location of the ACE3 project]"

Then, copy the cba folder from the include\x 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.

4.2 Creating a Test Build

To create a development build of ACE3 to test changes or to debug something, run the build.py file 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;z\ace

4.3 Creating a Release Build

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

• 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> force checkexternal 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, an archive file will also be created in the folder. The folder and archive 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
• force - force rebuild all PBOs, even those already present in the release directory (combined with compile it will also rebuild all extensions)
• checkexternal - check external references (incompatible only with <component1> <component2> and force <component1> <component2>)
• 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)

7. 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 (since Arma 3 v1.50, file patching is disabled by default).

7.1 Disabling 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 optional 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 (prepared in each ACE3 component, simply uncomment):

#define DISABLE_COMPILE_CACHE

All functions in module with DISABLE_COMPILE_CACHE line can be recompiled without mission restart with [] call ACE_PREP_RECOMPILE; command. You can add a addAction/keybind/pfeh with this code and use it for fast recompiling.

7.2 Restrictions

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.

Configs are not patched during run time, only at load time. You do not 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_mergeConfigFile which takes a full system path (as in diag_mergeConfigFile ["p:\z\ace\addons\my_module\config.cpp"]) and allows you selectively reload config files.

If you need to add/remove files, then you'll need to run HEMTT/build.py again without the game running, and restart. That is all that is required to add new files for further use in testing.