bridge-player

1.1.0 • Public • Published

Bridge Player

Travis build status Coverage Status npm version

A bridge-player allows a human or robot to play electronic bridge using the Blue Chip Bridge Table Manager Protocol. It processses/generates the protocol messages and only asks the player to make a bid or play a card.

The change log is automatically produced with the help of semantic-release.

Getting started

bridge-player is available for Node.js and most modern browsers. If you want to know if your currrent browser is compatible, run the online test suite.

Install the latest version with npm

> npm install bridge.js bridge-player --save

Usage

Include the packages

let Player = require('bridge-player'),
    seat = require('bridge.js').seat,
    net = require('net');

Create a player

let me = new Player({
    seat: seat.south,
    teamName: 'Red Team'
});

// The human or robot MUST respond to these events
me
    .on('make-bid', player => player.bid(...))
    .on('make-play', player => player.play(...))
    .on('make-dummy-play', player => player.playFromDummy(...));

Connect the player to the table. The table is a Duplex stream, typically a TCP socket.

table = net.connect(port, host);
me.connect(table);

Browser

Include the package from your project

<script src="./node_modules/bridge-player/dist/bridge-player.min.js" type="text/javascript"></script>

or from the unpkg CDN

<script src="https://unpkg.com/bridge-player/dist/bridge-player.min.js"></script>

This will provide BridgePlayer as a global object, or define it if you are using AMD.

License

The MIT license.

Copyright © 2016 Richard Schneider (makaretu@gmail.com)

Package Sidebar

Install

npm i bridge-player

Weekly Downloads

1

Version

1.1.0

License

MIT

Last publish

Collaborators

  • makaretu