> For the complete documentation index, see [llms.txt](https://mrcmodding.gitbook.io/arma-3-object-builder/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mrcmodding.gitbook.io/arma-3-object-builder/quick-start-reference.md).

# Quick Start Reference

## Requirements

* **Blender** 2.90.0 or higher
* **Arma 3 Tools** from steam (not strictly needed, but recommended)

Aside from the technical requirements, to utilize the add-on, knowledge of the content creation process for **Arma 3** is required, as well as familiarity with **Blender**.

***

{% embed url="<https://youtube.com/playlist?list=PL1L8e_Shj5DErJinP8vtLTImQ5PY4K9IN&si=-XHrFqLjGxQagV_b>" %}

## Installation

The add-on can be downloaded from the public [GitHub repository](https://github.com/MrClock8163/Arma3ObjectBuilder) either as a prepacked release, or as a clone of the live repository.

For **Blender** 4.2 and higher, the add-on can also be installed from the official [Extensions repository](https://extensions.blender.org/add-ons/arma3objectbuilder/).

### Releases

The [packed releases](https://github.com/MrClock8163/Arma3ObjectBuilder/releases) are prepared as ZIP files and can be installed like any other add-on for **Blender**. If you are unsure about how to install add-ons for **Blender**, you can reference the [Blender Manual](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html).

### Live repository

{% hint style="warning" %}
Only use the live code base if you know what you are doing, and you want to:

* try a new feature that's not in a release yet
* there's a bug in the last release that's not yet fixed in a new release
  {% endhint %}

Using the live code base is a little more involved as you'll have to do the packaging yourself.

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FF4kaxSUNrPutiuTDopuC%2Fguide_code_clone.png?alt=media&amp;token=63d50534-460f-4d33-9bef-d222a8590cd0" alt=""><figcaption></figcaption></figure>

1. Download the code base as a ZIP
2. It should look like this (only folders are shown here):

   <figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2Fnv1bwfbuw1ek9OPz6ToY%2Fguide_code_downloaded.png?alt=media&amp;token=08ab865a-dcb9-412e-8b2a-d60ed775d5a5" alt=""><figcaption></figcaption></figure>
3. Unpack it to a convenient location
4. Find the `Arma3ObjectBuilder` folder
5. Put the folder into a new ZIP file identically named `Arma3ObjectBuilder`

At the end, you should get a ZIP file just like a prepacked release (only folders are shown here):

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FrNpxlA0k0Q009HEv4Opr%2Fguide_code_zip.png?alt=media&amp;token=06e060cd-1fbc-4b03-b106-94455c34dd1c" alt=""><figcaption></figcaption></figure>

The add-on can then be installed in **Blender** like any other add-on with this ZIP file.

***

## Setup

The setup is relatively straight forward. Once the add-on is installed, navigate to the add-on preferences. For a quick start most settings can be left on the default value, only a few options need to be touched.

{% hint style="info" %}
You can read further about the options on the [Add-on Preferences](/arma-3-object-builder/general/add-on-preferences.md) page.
{% endhint %}

### **Arma 3 Tools**

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FEChiq4y5LCboTGUDtP0R%2Faddon_preferences_paths.png?alt=media&amp;token=98bad8b6-fd86-48e8-8a9e-046a057c6965" alt=""><figcaption></figcaption></figure>

Most functions will work regardless if this path is set, but to use everything, you want to set up this path (currently only the the [Rigging](/arma-3-object-builder/tools/rigging.md) tools rely partially on it).

The typical path is `C:\Program Files (x86)\Steam\steamapps\common\Arma 3 Tools\`

### **Project Root**

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FEChiq4y5LCboTGUDtP0R%2Faddon_preferences_paths.png?alt=media&amp;token=98bad8b6-fd86-48e8-8a9e-046a057c6965" alt=""><figcaption></figcaption></figure>

The **Project Root** is used during P3D [export](/arma-3-object-builder/export/p3d.md) and [import](/arma-3-object-builder/import/p3d.md). Relative paths are created by stripping the Project Root from the path, and absolute paths are attempted to be reconstructed by attaching the root back to the path. For most cases the default `P:\` should be fine. If you don't want to deal with automatic path transformations, and would rather export the paths exactly as you input them, disable the **Export Relative** and **Reconstruct Absolute Paths** options during P3D export and import.

***

## User Interface

A few useful links are included in the `Help -> Object Builder` menu.

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FTBaA9lxd3TZy6jAGGXE3%2Fhelp.png?alt=media&amp;token=28f4e138-8f19-476d-b172-cf2d7e20d628" alt=""><figcaption></figcaption></figure>

One of the main goals of the add-on project is to have an interface that is in-line with the design of **Blender**, so the tools and options are where you'd normally expect them.

The elements can be found in 4 distinct places, depending on their context.

### Import-Export

All import and export options can be found in the `File -> Import` and `File -> Export` menus.

{% hint style="info" %}
You can read further about import and export options in the **IMPORT** and **EXPORT** categories, and about object setups related to them in the **SETUP** category.
{% endhint %}

### Utility Functions

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2F9mj7U8QW6gIDHqzmn8IP%2Fguide_ui_utilities.png?alt=media&amp;token=e2e3e654-527e-48a9-9a60-efcff56173c0" alt=""><figcaption></figcaption></figure>

A few utility functions can be found in the `Object Builder` menu at the top of the 3D View.

{% hint style="info" %}
You can find references about the functions on the [Utility Functions](#utility-functions) page.
{% endhint %}

### Tools

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FspFqNvI4oGiDdJKFWENh%2Faddon_preferences_help_links.png?alt=media&amp;token=66ab8844-1a99-40a4-b232-23b56bf3da37" alt=""><figcaption></figcaption></figure>

The tools are organized into panels on the sidebar of the 3D View. The panels can be found in the `Object Builder` category.

Each panel is home to one or more operators belonging to the same context, like proxy operations, or weight painting.

{% hint style="info" %}
You can read further about the specific tools in the **TOOLS** category.
{% endhint %}

### Properties

<figure><img src="https://418903991-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNJv4RINtC1OtMV3u9E73%2Fuploads%2FFnZleOoTz1l7btS2Gdh2%2Fguide_ui_properties.png?alt=media&amp;token=68e82acf-4e54-42a8-99ca-0f3759320c8a" alt=""><figcaption></figcaption></figure>

Object and material properties can be found in the properties area, in the Object Data and Material tabs respectively. The name of every property panel starts with Object Builder. These panels show the properties of the currently selected object, or material.

{% hint style="info" %}
You can read further about the topic in the **PROPERTIES** category.
{% endhint %}