wassname/GarageServer.IO
1
0
Fork 0
mirror of https://github.com/wassname/GarageServer.IO.git synced 2026-07-24 12:50:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

Progress: Documentation

Browse Source
This commit is contained in:
Jeremiah Billmann
2013-07-29 13:06:27 -04:00
parent 9ca852fddc
commit 586b40fb1a
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -3
View File
@@ -12,7 +12,7 @@ A simple, lightweight, HTML multiplayer game server (and client) for Node.js
## Quick Start
Create a quick game whereby players simply move squares along the x-axis. (I know, it's boring, but it keeps things simple.) For a more thorough demonstration of how GarageServer.IO works, look at the example included in the source code.
Create a quick game whereby players simply move squares along the x-axis. I know, it's boring, but it keeps things simple and to the point. For a more thorough demonstration of how GarageServer.IO works, look at the example included in the source code.
### Server
@@ -113,8 +113,10 @@ var playerStates = GarageServerIO.getPlayerStates(),
GarageServerIO.initializeGarageServer(path, options)
```
Establish connection to GarageServer.IO on the server via Socket.IO and register events.
**path**
Type: string
```js
path
```
**Type:** string
The URL that points to where GarageServer.IO is running at on the server.
**options**
Type: object literal