Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.73 KB

README.md

File metadata and controls

52 lines (31 loc) · 2.73 KB
Raw

Want to Contribute?

  1. Fork this repository.

  2. Commit new code to the forked repository.

  3. Open a pull-request for the forked repository to propose changes:
    armory_web repository [main branch] ⬅️ Forked repository [main branch]

Prerequisites

  1. Node
    The ArmSDK ships with Node and can be found in: armsdk\nodejs.

  2. Python
    Blender ships with Python and can be found in: Blender\2.93\python\bin.

  3. A Localhost that provides 403 & 404 redirecting
    This provided localhost service works well with the armory_web source setup. Apache, Node, and some other localhost software can accomplish the source setup, but you'll need to setup it up yourself.

Development Process

  • The Armory3D website is hosted with Github Pages. The HTML files that reside in the armory_web directory are the webpages that are hosted. DO NOT edit these HTML files. Instead, modify the HTML files in armory_web/templates directory instead, then inject the new changes to their main counterparts.

  • Each webpage in the armory_web directory is comprised of 3 separate webpage sections: Header Content, Main Content, Footer Content.

  • The armory_web/templates directory contains a HTML file for each template section, including the Header & Footer global webpages. Use these HTML files for implementing new changes, NOT the HTML files that reside in the armory_web directory.

  • Update any new changes from the HTML files in the armory_web/templates directory to the armory_web directory by running the make.js script with Node.

Example: How to update Header Content

To make changes for the Header section:

  • Make changes to the armory_web/templates/header.html HTML file.
  • Then run make.js with Node to update the new changes globally to all HTML files that reside in the armory_web directory.

Example: How to update Main Content

To make changes for the Community section:

  • Make changes to armory_web/templates/community.html
  • Then run make.js with Node to update the new changes to the community.html HTML file that resides in the armory_web directory.

Example: How to update Footer Content

To make changes for the Footer section:

  • Make changes to the armory_web/templates/footer.html HTML file.
  • Then run make.js with Node to update the new changes globally to all HTML files that reside in the armory_web directory.