Setup

Armory engine is distributed as a Blender add-on:

• Download Blender 2.83 LTS.
• Download and unpack Armory SDK.
• In Blender, Select Edit - Preferences... and navigate to the Add-ons tab.
• Click Install... button.
• Select armory.py file located in the extracted ArmorySDK folder.
• Enable Armory add-on in Blender: Simply click the checkbox next to Render: Armory from within Preferences: Add-ons.
• Pick SDK Directory : (Optional, only in case the SDK Path is blank) still in the Armory add-on settings in Blender Preferences: fill the SDK Path field by clicking on the folder icon, then navigate to the location you have stored the Armory SDK folder (the SDK folder is the one that contains all the sub-folders: armory, iron, Kha, Krom, etc), and then click "Accept".
• Click the Install & Setup SDK Button and restart Blender.

---

• To verify everything is working correctly, save your .blend file and hit Play (F5) button, located in the Properties - Render - Armory Player panel.
• Continue to the Playground tutorial to learn more.
• Armory comes with a version of haxe and kha.

Code Editor

You can choose with which code editor Armory should open scripts.

• In Blender, select Edit - Preferences... and navigate to the Add-ons tab.
• Locate the Armory add-on.
• Activate Show Advanced
• Under Code Editor you can select the editor you want to use.

System default

Armory tries to automatically select the correct editor. This works as follows:
If an environment variable VISUAL is set, the editor is selected from the path specified there. If VISUAL does not exist, the environment variable EDITOR, which is actually intended for console-based editors, is used instead. If both variables do not exist, the operating system tries to choose the correct editor itself.

VS Code | Kode Studio (recommended)

• Download Visual Studio Code + Kha Extension pack or Kode Studio.
• Point Code Editor Executable to the executable file of your installed copy.
• Inside VS code, make sure your paths are setup properly for the extensions:

  "haxe.executable": "ArmorySDK/Kha/Tools/haxe/haxe-linux64",
  "kha.khaPath": "ArmorySDK/Kha",
  "krom.kromPath": "ArmorySDK/Krom"
  

Sublime Text

• Download Sublime Text + (optional) Haxe Bundle from Sublime's PackageControl
• Point Code Editor Executable to the executable file of your installed copy.
• Then, a basic [project_name].sublime-project file gets created if it doesn't exist yet.

Custom

• Point Code Editor Executable to the executable file of your custom editor.