Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Latest commit

 

History

History
55 lines (34 loc) · 2.46 KB

contribute.md

File metadata and controls

55 lines (34 loc) · 2.46 KB
Raw

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

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 GitHub. Open desired .md file at the armory_docs repository and click the pencil icon to edit.

To edit docs locally, clone armory_docs repository like described in the Creating a pull request section. Afterwards, you can drag and drop .md files into KodeStudio which comes bundled with Armory SDK. Click Open Preview to the Side (Ctrl + K V) button to preview the changes.