Development - Intro

• The Armory3D website is hosted on Github Pages.
• make.js is a Node.js script that:
  • Builds webpages in /templates/ and its sub-directories, both on init and when new changes are detected.
  • Serves webpages via HTTP on port 80 (feel free to change it to a different port).
  • Sends 302 redirect if you attempt to access a webpage without inserting its .html extension.
  • Sends 404 if error or missing content occurs.

Development - Setup

• The Armory SDK (armsdk) ships with Node.js: no need to download it seperately.
  
  • The Node.js executables can be found in your armsdk/nodejs directory.
    
    • Use the right executable depending on your operating system (e.g. Windows, Linux, Apple).
• To run make.js with Node.js via the commandline:

Windows (proven code)

@echo off
SET PATH=node;"D:\Blender\armsdk\nodejs"
SET MAKE_DIR=D:\Websites\armory_web
SET MAKE_SCRIPT=D:\Websites\armory_web\make.js
cd %MAKE_DIR%
node %MAKE_SCRIPT%

Linux & Mac (untested code)

@set +v
EXPORT PATH="$node:D:\Blender\armsdk\nodejs"
EXPORT MAKE_DIR=D:\Websites\armory_web
EXPORT MAKE_SCRIPT=D:\Websites\armory_web\make.js
cd $MAKE_DIR
node $MAKE_SCRIPT

Development - Process

Build - Main : Intro

• HTML files that reside in the parent, /armory_web/ root directory are webpages meant to be hosted on Github Pages.
  • DO NOT edit these HTML files.
    • Instead, modify their component counterparts that reside in the /armory_web/templates directory.
      • These webpage components are later on dynamically injected into their main counterparts using make.js and Node.js.

Build - Main : Header + %Main Content% + Footer

• Each webpage in the parent, /armory_web/ root directory; except header.html, footer.html & notes.html is comprised of 3 separate webpage sections:
  • header.html, %MAIN_CONTENT%, footer.html.
    • %MAIN_CONTENT% can be any component, such as community.html or download.html.

Build - Examples:

How to update Header content

• Make changes to /armory_web/templates/header.html.
• Save.
• Run make.js if you haven't already.
• Refresh your Armory website page if you have it open. How to update Header content
• Make changes to /armory_web/templates/header.html.
• Save.
• Run make.js if you haven't already.
• Refresh your Armory website page if you have it open. How to update Footer content
• Make changes to /armory_web/templates/header.html.
• Save.
• Run make.js if you haven't already.
• Refresh your Armory website page if you have it open.

Build - Notes - Intro

• notes.html (release notes) is comprised of six components:
  • /templates/header.html
  • /templates/notes.html
  • /templates/changelogs/content.html
  • /templates/changelogs/data.json
  • /templates/changelogs/releases/%MONTH_&_YEAR_CONTENT.html%
  • /templates/footer.html

Build - Examples:

How to update Header or Footer content

• Same setup, as described above.

How to update Month/Year selection content

• With: /templates/notes.html.

How to update Monthly content

• /templates/changelogs/data.json & /templates/changelogs/releases/%MONTH_&_YEAR_CONTENT%.html
  • Replace %MONTH_&_YEAR_CONTENT from the string above with the date of the webpage for that particular month + year.
    e.g. 2022.01 or 2021.02.