Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.17 KB

File metadata and controls

18 lines (13 loc) · 1.17 KB

Welcome to the Forge Engine Context

Project Overview

This project is a game engine, called Forge. The engine follows a "Game Tree" concept, where each node in the tree is a Part, and the parent node is the game itself. A parent node (Part) calls its act() method each tick, then calls its childrens act() methods. There is a web-based engine that uses the engine core to facilitate easier build of games.

Overview

  • You are running on a windows machine. Please use powershell commands by defualt
  • Runtime is Bun. Build commands are build:engine, build:editor, and build:all. These is no need to call any of these, watchers are running in the background building on the fly.

Code Overview

  • Examine ./docs for documentation of the project
  • Examine ./Parts for the code on each built-in part
  • Examine ./engine for the code that runs the web engine. Ignore the .js files (specifically, bundle.js, editor.js, script.bak.js, and defs.bak.js), as the project is built using ts and these are just the build files.
  • Examine ./engine/spriteBuilder.html and .ts for the spriteBuilder functionality.

Current Task

Update documentation and definitions for all parts and functionality.