Skip to content

apples/ggj2020

Repository files navigation

BoardhouseTS

This is a game framework / engine written in TypeScript to rapidly develop prototypes.

Includes:

  • Three.js rendering library
  • Event pump for updating and rendering game objects
  • State system for managing menu / game / scene states
  • Entity-component system
  • Simple animation engine (swaps out textures)
  • Texture loader

To-Do:

  • React-like virtual DOM for UI components
  • Entity registry for automating component setting
  • Loaders for audio and geometries
  • Sophisticated animation engine using tilemaps
  • Level editor

Build Instructions:

npm install
Development:
npm start
Production:
npm run build
node server.js

Go to localhost:8080 to test it out. All production files will be contained in the dist folder.


FAQ:

Q: How do I pull in as a package.json dependency?

A: The API is being fleshed out and I will bundle up the core features as an npm package once finished.

Q: How do I use it?

A: Once the project is considered "feature complete" I will add a wiki detailing the steps to get a simple project started using the framework.

About

Global Game Jam 2020

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •