contribute

Contribute

Creating a pull request

• Install Git
• Click the Fork button on GitHub
• Pick a location, open a command line here and clone your forked repository

git clone https://github.com/my_username/armory

• Apply your changes, then open a command line in your forked repository and push the changes

git add .
git commit -m "My armory patch description"
git push origin master

• Create pull request by clicking compare across forks and selecting your fork

• Thanks for contributing!

Local Armory setup

When working on Armory patches, it is useful to setup the SDK locally and apply your modification there.

Note: Disable Armory Project - Flags - Cache Build to always recompile the project when you hit Play. There is no need to compile Armory itself, you will see the changes in action instantly.

Armory

• Fork and clone the armory repository into blend_location/Libraries/armory, it will automatically get picked up for that project

Iron

• Fork and clone the iron repository into blend_location/Libraries/iron, it will automatically get picked up for that project

HaxeBullet

• Setup and Update Guide HaxeBullet Documentation

Full SDK

Alternatively, you can clone the whole SDK at once.

• Clone armsdk into blend_location/armsdk, it will automatically get picked up for that project - this lets you have a fully self-contained and portable project setup

• You can also point Armory to use the armsdk at specific location

Contributing docs

Docs can be edited directly on this GitHub wiki! Just click on Edit at the top of the article you want to edit. If you want to add or edit images, please open a pull request with the new/edited images here and embed them via link in your article. GitHub does not currently allow non-repository members to edit images in wiki articles.

Building API docs

API docs are built using dox. After building empty project with Krom target selected, follow the instructions at dox readme.