Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rameshvarun committed Apr 3, 2023
1 parent ea46697 commit faf9003
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion netplayjs-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ This package contains the server-side code for NetplayJS. The server has two res

The server is designed to be completely generic and game-agnostic - you can point any NetplayJS game at any `netplayjs-server` instance. The protocol used to communicate with the server is defined in [matchmaking-protocol.ts](https://github.com/rameshvarun/netplayjs/blob/master/netplayjs-common/matchmaking-protocol.ts).

I host a shared instance of the server that NetplayJS games use by default. If you are hosting a high-traffic game or if the shared server goes down, you should host your own. Old NetplayJS games can easily be pointed to the new server by simply adding `#server=https://your-server-url.com` to the URL of the game. For example, `https://rameshvarun.github.io/netplayjs/pong/#server=https://your-server-url.com`.
I host a shared instance of the server that NetplayJS games use by default. If you are hosting a high-traffic game or if the shared server goes down, you should host your own.

NetplayJS games can easily be pointed a new server without changing any code. Simply append `#server=https://your-server-url.com` to the URL of the game. For example, `https://rameshvarun.github.io/netplayjs/pong/#server=https://your-server-url.com`.

## Run from Docker Hub
```bash
Expand Down

0 comments on commit faf9003

Please sign in to comment.