Create an extremely biased, web-based slot machine game.
- Faux-panoramic reel animations (3D cylinder, 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.
Add to an existing React project using YARN.
React v19
$ yarn add react-slot-machine
React v18
$ yarn add react-slot-machine@1.4
import {Fragment, useState} from 'react';
import SlotMachine from 'react-slot-machine-gen'; // or '../dist/react-slot-machine';
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 function Demo() {
const [play, setPlay] = useState(false);
const clickEvent = () => setPlay(true);
const mouseEvent = () => setPlay(false);
return (
<Fragment>
<SlotMachine reels={reels} play={play} />
<button id="play-button" onClick={clickEvent} onMouseUp={mouseEvent}>Play</button>
</Fragment>
);
};| Name | Type | Description |
|---|---|---|
| reels | Array | Symbols configuration. |
| play | Boolean | Spins the reels if true |
| callback | Function | Returns winning symbols. |
| options | Object | Override game defaults. |
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
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)
This package is maintained under the Semantic Versioning guidelines.
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