Hyperloop

Development

Preview of master branch builds can be found here.

Getting started

• Install Node.js

• Install Visual Studio Code

• Clone the source code:

  git clone git@github.com:/friendlyfiregame/hyperloop

• Initially run npm i in the project folder to install/update dependencies.

Building the game

In Visual Studio Code press Ctrl-Shift-B to start the compiler in watch mode. This compiles the TypeScript sources in the src folder to JavaScript in the lib folder. It also watches the src folder for changes so changed files are compiled on-save.

Alternatively you can run npm i on the CLI to compile the project once or npm run watch to continuously compile the project in watch mode.

Running the game in a browser

There are four alternatives to run the game in the browser:

• In Visual Studio Code press Ctrl-Shift-D and launch the webpack-dev-server and one of the available browsers that can be selected by clicking on the drop down menu next to the "launch" button.
• Run npm start and point your browser to http://localhost:8000/. The browser automatically reloads the game when changes are detected (You still need to run the compiler in watch mode in VS Code or on the CLI to receive code changes).
• If you already have a local webserver you can simply open the index.html file in the project folder in your browser. This only works with a http(s) URL, not with a file URL.
• Run npm run dist to package the game into the dist folder. Open the dist/index.html in your browser to run the game. To publish the game simply copy the contents of the dist folder to a public web server.
• If you want to skip the intro, mute the music or the random sounds, add ?skipintro&skipmusic&skiprandomfx behind the url.