From f162aa899068f6cbd0e5fc35c144d1c6603c960e Mon Sep 17 00:00:00 2001 From: Owen Date: Fri, 9 Mar 2018 17:00:34 -0500 Subject: [PATCH] Updated README to Markdown --- README.md | 24 +++++++++++++++++++ README.txt | 68 ------------------------------------------------------ 2 files changed, 24 insertions(+), 68 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a52c19 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Air Hockey +A simple browser-based air hockey game using socket.io with Electron desktop client + +## Development Environment +node 8.9.4 +npm 5.7.1 +Tested on MacOS 10.13.2 + +## Dependencies +node.js, Electron, socket.io + +# Installation Instructions +..* Clone to local machine +..* Run _npm install_ from root directory and Electron Client directory to install node module Dependencies + +# Running the App +## Starting the server +..* Execute _node app.js_ from root directory to start the app server + +## Browser Client +..* Navigate to http://localhost:3000/airhockey.html from your browser + +## Electron Client +..* Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client diff --git a/README.txt b/README.txt deleted file mode 100644 index af8e9c7..0000000 --- a/README.txt +++ /dev/null @@ -1,68 +0,0 @@ --------------------------------------------------------------------------------- - Air Hockey - - A simple browser-based air hockey game using - web sockets - --------------------------------------------------------------------------------- -Developer: - Owen LeJeune - -Date: - March 8, 2018 - --------------------------------------------------------------------------------- -Version: - node 8.9.4 - npm 5.7.1 - Tested on MacOS 10.13.2 - --------------------------------------------------------------------------------- -Install - run "npm install" inside the root project directory - if that fails, run "npm install socket.io" - - Requires node.js installed - --------------------------------------------------------------------------------- -Launch - "node app.js" from root project directory - --------------------------------------------------------------------------------- -Testing - Visit http://localhost:3000/airhockey.html - To join the game, click "Join Game" and enter your name - Once another player has joined from another browser window, - the game will begin and puck will pick a random direction - to travel - Use the arrow keys on your keyboard to move your paddle - 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 - 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 - You can toggle collision and goal sounds using the Toggle - Sounds button - --------------------------------------------------------------------------------- -Organization: - app.js - html - airhockey.html - ding.mp3 - game.js - hit.mp3 - mute.png - rink.jpg - sound.png - style.css - node_modules - all modules required by node and socket.io - package-lock.json - package.json - README.txt - ---------------------------------------------------------------------------------