netplayjs-server

0.0.9 • Public • Published

netplayjs-server

This package contains the server-side code for NetplayJS. The server has two responsibilities.

  • Boostrap a P2P data channel between two browsers by forwarding WebRTC signaling messages.
  • Start matches between strangers online who are playing the same game.

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.

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.

Run from Docker Hub

docker run --publish 80:3000 varunramesh/netplayjs-server:0.0.7

Run from NPM

npm install -g netplayjs-server

Developing

git clone --recursive https://github.com/rameshvarun/netplayjs-server.git
cd netplayjs-server
npm install
npm start

Readme

Keywords

none

Package Sidebar

Install

npm i netplayjs-server

Weekly Downloads

1

Version

0.0.9

License

ISC

Unpacked Size

23.2 kB

Total Files

16

Last publish

Collaborators

  • vramesh