The official HSU game. Play it in a modern browser!
The game is played by using the arrow keys or WASD to move your character around the map. You can zoom in or out by pressing "z"
There are icons that are part of the Heads up Display (HUD) Right underneath them, there is a clock and in-game timer.
You can bring up your current inventory by clicking on the backpack.
You can interact with certain NPCs by pressing the "C" button. Dialogs offer multiple choices of sub-questions and answers.
There is also looping background music playing.
See our roadmap for details on what features are coming up next.
Download and install nodejs
Download the repository (git clone)
git clone https://github.com/micahh2/hsu
Change your current directory
cd hsu
Install dependencies
npm i
Start local http server
npm start
The dev server opens a browser new tab when it starts, pointing to: http://localhost:8080
git status
to see the status of your local instance. If you are on a branch besides master, run git checkout master
to switch to the master branch. If you have changes you don't want anymore try staging them with git add
and using git stash
to hide them for the moment.git pull
to get changes. Pay attention to the output, if there are merge conflicts they will show up here.npm start
npm test
git checkout -b
, or git branch
and git checkout
. Try to give your branch a short but descriptive name.npm run fix-lint
, if there are errors fix themgit add
to stage files as ready for commitgit commit
to create a commit with a useful message describing your changesgit push
your new branch and use github's UI to create a pull request, don't forget to assign someone to merge the pull request. To start the test runner:
npm test
To generate a test report (test-report.md)
npm run test-report
View the test status' here
View the test code coverage here
Documentation can be found on the demo website here.
Building documentation
npm run build-docs
Starting local server for documentation
npm run serve-docs
The project uses a lightly modified version of Airbnb's eslint style guide. To run the linter and show errors:
npm run lint
To run the linter and auto-fix simple mistakes:
npm run fix-lint
While you do not need to do this before making a commit, it is encouraged. There are also a number of editor plugins that can show you linter errors and make it easier to write compliant code.
This software is licensed under AGPL