owen/AirHockey
1
0
Fork 0
mirror of https://github.com/owenlejeune/AirHockey.git synced 2025-12-01 11:32:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Owen
2018-03-10 17:10:44 -05:00
parent f6ad461579
commit 359fce14e0
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -11,16 +11,16 @@ node.js, Electron, socket.io
# Installation Instructions # Installation Instructions
* Clone to local machine * Clone to local machine
* Run _npm install_ from root directory and Electron Client directory to install node module Dependencies * Run _npm install_ from root directory and Electron Client directory to install node module dependencies
# Running the App # Running the App
### Starting the server ### Starting the server
* Execute _node app.js_ from root directory to start the app server * Execute _node app.js_ from root directory to start the app server
### Browser Client ### Launching Browser Client
* Navigate to http://localhost:3000/airhockey.html from your browser * Navigate to http://localhost:3000/airhockey.html from your browser
### Electron Client ### Launching Electron Client
* Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client * Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client
### Usage ### Usage
@@ -29,5 +29,6 @@ node.js, Electron, socket.io
* Use the arrow keys on your keyboard to move your paddle * Use the arrow keys on your keyboard to move your paddle
* The paddle will not move until 2 players are present * The paddle will not move until 2 players are present
* When the puck enters one of the purple goals on either end, the opposing player will score a point and the player's positions will be reset, with the puck traveling in a new random direction * When the puck enters one of the purple goals on either end, the opposing player will score a point and the player's positions will be reset, with the puck traveling in a new random direction
* If you attempt to join a game with 2 players, you will not be allowed, but your name will appear in the Spectator box below * If you attempt to join a game with 2 players, you will not be allowed, but your name will appear in the _Spectator_ box below the game
* You can toggle collision and goal sounds using the Toggle Sounds button * If you are currently a Spectator and a paddle becomes available, clicking _Join Game_ will automatically assign your name to that paddle
* You can toggle collision and goal sounds using the _Toggle Sounds_ button