react-slot-machine-gen

React Slot Machine Generator

Create an extremely biased, web-based slot machine game.

Features

• Faux-panoramic reel animations (without <canvas>)
• Support for single/multi-line reels and pay-lines.
• Pseudo-random selections by configured weight.
• Configurable RNG (to make it less biased)
• Configurable sound clips for reel animations.
• Easy to set-up and customize.

Checkout the demo for examples of use.

Dependencies

• Node.js

Installation

Add to an existing React project using YARN.

$ yarn add react-slot-machine-gen

Usage

import React       from 'react';
import SlotMachine from 'react-slot-machine-gen'; // or '../dist/react-slot-machine-gen';

const reels = [
  {
    imageSrc: 'path/to/image.png',
    symbols: [
      {
        title: 'cherry',
        position: 100,
        weight: 2
      },
      {
        title: 'plum',
        position: 300,
        weight: 6
      },
      {
        title: 'orange',
        position: 500,
        weight: 5
      },
      {
        title: 'bell',
        position: 700,
        weight: 1
      },
      {
        title: 'cherry',
        position: 900,
        weight: 3
      },
      {
        title: 'plum',
        position: 1100,
        weight: 5
      }
    }
  },

  // add more reels ...
]

export default class Demo extends React.Component {
  constructor() {
    super();

    this.state = {
      play: false
    };
  }

  playEvent() {
    this.setState({
      play: !this.state.play
    });
  }

  render() {
    return (
      <React.Fragment>
        <SlotMachine reels={reels} play={this.state.play} />

        <button id="play-button" onClick={() => this.playEvent()}>Play</button>
      </React.Fragment>
    );
  }
};

Component Props

Name	Type	Description
reels	Array	Symbols configuration.
play	Boolean	Spins the reels if true
callback	Function	Returns winning symbols.
options	Object	Override game defaults.

Documentation

• Methods
• Reels configuration
• Game options
• Callback
• Customizing symbols

Developers

CLI options

Run ESLint on project sources:

$ npm run lint

Transpile ES6 sources (using Babel) and minify to a distribution:

$ npm run build

Bundle demo sources (using Webpack):

$ npm run webpack

Contributions

If you fix a bug, or have a code you want to contribute, please send a pull-request with your changes. (Note: Before committing your code please ensure that you are following the Node.js style guide)

Versioning

This package is maintained under the Semantic Versioning guidelines.

License and Warranty

This package is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

react-slot-machine-gen is provided under the terms of the MIT license

Author

Marc S. Brooks