Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@socialgorithm/game-server

Package Overview
Dependencies
Maintainers
2
Versions
40
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@socialgorithm/game-server

JS Game Server library

  • 0.4.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
2
Weekly downloads
 
Created
Source

JavaScript Game Server

Creates a socket server (default port 5433) that serves games. To use this server, you provide functions that will be called on game or player actions, and call functions to communicate with players or to broadcast game state to spectators.

Integrating

Install the dependency:

npm install @socialgorithm/game-server

Start the game server and supply a new game function:

  new GameServer({ name: "My Game Name" }, newGameFunction, { port: 5433 });

The new game function must accept game start parameters and can take an output channel on which to communicate with players/spectators. It must return an implementation of the Game interface (i.e. must implement callback to listen for player communication).

  newGameFunction(gameStartMessage: GameStartMessage, outputChannel: GameOutputChannel): Game {
    debug("Started new game");
    return new MyGame(gameStartMessage.players, outputChannel);
  }

In your game, you can then use GameOutputChannel to communicate with players or spectators (e.g. the Tournament Server).

Example

See tic-tac-toe for an example of integration.

Contributing

The rest of this guide is for contributors.

Publishing to NPM

To publish to NPM, make sure you've incremented the version number (e.g. npm version patch) and run:

npm publish

Keywords

FAQs

Package last updated on 12 Jul 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc