TTA Game Wrapper

Overview

The game wrapper is intended to be a stripped down template of the common behavior and content of a Training Arcade Game that games will inherit from. The primary goal is to allow game developers creating new games to be able to focus primarily on new game development without having to worry about the intricacies of backend API communication or the content surrounding the game.

Every TTA game is divided into five pieces:

Splash Screen -> Info Popup -> Registration -> Tutorial -> Game -> Game Over

The wrapper is being designed to take care of every aspect except the Tutorial and Game sections. By doing so the game developer will not need to worry about the logic behind pulling down game data, registering the user, starting a game session, etc. They can focus on making the games.

How does it work?

Our game template use this wrapper as a Git submodule and essentially overwrites any portion of this code base that the developer wishes to change. The intention is that the developer will not touch the portions that surround the tutorial and the game.

If changes/improvements need to be made to the logic/styling that surrounds the games they will be made in this repository.

Requirements

Please ensure that you have the following dependencies installed and globally available.

• NVM - Node Version Manager

Installation

1. Clone the repo
2. Navigate to the cloned folder and switch to the appropriate version of Node with nvm use. This may trigger the need to nvm install the right version.
3. install dependencies with npm install

Local Development

To start the local development environment use npm start