Skip to content

Build Script

Saborknight edited this page May 23, 2020 · 4 revisions

The build script allows us to pack the mod into the appropriate format, with bisign keys and any extra files, by simply typing a command.

Check installation instructions here.

How to use it

To build the mod

  1. Double click on the file tools\make.ps1 This should open a powershell console that does stuff. It will give feedback on what it's doing and if there are any errors.
  2. Load the mod (now located in .build\@2BNB Framework) into the Arma 3 launcher by dragging it in.

When building a release version

  1. Tag the latest commit with a version number: git tag v3.4.0
  2. Run the build script as per above
  3. Login to Steam using the 2BNB Steam account
  4. Start up Arma 3 Tools and open the "Publisher" tool
    1. Select "2BNB Extras" in the left menu
    2. Point the "Mod content:" field to the location of the built mod (2bnb-extras -> .build -> @2BNB Extras)
    3. Fill in the Change Notes - these MUST be headed with the version number and then ================, as per the screenshot below
      1. Fill in the "Added: " items
      2. Fill in the "Removed: " items
      3. Fill in the "Fixed: " items
      4. Fill in the "Changed: " items
    4. Tick "I agree with Steamworks license"
    5. Click "Update"
  5. Announce to the world that you just did something awesome! (Specifically to the #announcements channel on Discord)

To remove things

The build script allows the flag -remove [category], where [category] can be anything from this list:

  1. all - All files within the .build folder
  2. extras - All files that are not keys or addons
  3. addons - All addon files within .build\@2BNB Framework\addons
  4. cache - The cache within .build\cache

However, this requires going into a powershell console, finding the tools\make.ps1 file and then typing .\make.ps1 -remove [x].

E.g. to remove all

.\make.ps1 -remove all