basket-simulation-game v1.0.0

basket-simulation-game

Installation

npm i basket-simulation-game

Usage

Generate a random game

const { generateGame } = require('basket-simulation-game');

const gameConfig = {
  style: 'nba',
  teams: [{
    name: 'New York Knicks',
    speed: 'fast',
    players: [{...}, {...}] // use basket-simulation-player to generate players
  }, {
    name: 'Boston Celtics',
    speed: 'normal',
    players: [{...}, {...}]
  }]
};

const randomGame = generateGame(gameConfig);

When generateGame is called with its configuration, it returns an object like this:

{
  history: [{...}, {...}], // what happened for each possession
  score: [100, 99],
  teamWithBall: 0,
  possessionsPlayed: 152,
  overtime: false,
  remainingPossessions: 0
}

The objects inside the history array look like this:

{
  action: 'shootMissed', // or shootMade
  id: 'BS9111AY63OYH811550N', // player id
  result: 2 // type of shoot made by the player
}

Build the boxscore for the game

const { boxscore } = require('basket-simulation-game');

const boxscoreForGame = boxscore(gameConfig, randomGame); // see constants defined above

The boxscore function primarly add to each player of the teams the following properties:

{
  stats: {
    ft: [0, 0],
    twoPts: [0, 0],
    threePts: [0, 0],
    pts: 0,
    eval: 0
  }
}

Those properties will be updated with the player performance during the game.