https://github.com/troygoode/node-shuffle
node.js package for shuffling and dealing decks of cards (or anything else you'd like to shuffle)
https://github.com/troygoode/node-shuffle
Last synced: about 1 month ago
JSON representation
node.js package for shuffling and dealing decks of cards (or anything else you'd like to shuffle)
- Host: GitHub
- URL: https://github.com/troygoode/node-shuffle
- Owner: troygoode
- License: mit
- Created: 2011-05-05T19:56:02.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T06:50:51.000Z (over 2 years ago)
- Last Synced: 2025-03-28T13:51:19.632Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/shuffle
- Size: 85 KB
- Stars: 39
- Watchers: 6
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shuffle
Shuffle is a node.js package for shuffling and dealing decks of cards (or anything else you'd like to shuffle).
[](https://nodei.co/npm/shuffle/)
[](http://travis-ci.org/troygoode/node-shuffle)
## Installation (via [npm](https://npmjs.org/package/shuffle))
```bash
$ npm install shuffle
```
## Quick Start
Using shuffle is simple:
```javascript
var Shuffle = require('shuffle');
var deck = Shuffle.shuffle();
var card = deck.draw();
```
Alternatively you can draw multiple cards at once:
```javascript
var hand = deck.draw(5);
```
You can also use it to deal cards to multiple hands:
```javascript
var player1 = [], player2 = [], player3 = [], player4 = [];
deck.deal(5, [player1, player2, player3, player4]);
```
The above deals a card to player #1 then player #2 then player #3 then player #4 then back again to player #1 until each player has five cards.
If you need to reset and reshuffle the deck, it is as easy as:
```javascript
deck.reset(); //sets the deck back to a full 52-card deck, unshuffled
deck.shuffle();
```
## More Stuff
You don't have to shuffle standard playing cards. You can shuffle other stuff too:
```javascript
var Shuffle = require('shuffle');
var goFish = [{color: 'red', number: 1}, {color: 'blue', number: 2}, ...];
var deck = Shuffle.shuffle({deck: goFish});
```
You can also supply your own randomizer so that you can supply a custom seed:
```javascript
var Shuffle = require('shuffle');
var srand = require('srand'); //https://github.com/isaacs/node-srand (npm install srand)
srand.seed(1000);
var deck = Shuffle.shuffle({random: function(){ return srand.random(); }});
```
You can also supply number of decks to play with:
```javascript
var Shuffle = require('shuffle');
var deck = Shuffle.shuffle({numberOfDecks: 8});
```
Other deck methods:
```javascript
deck.drawFromBottomOfDeck() // 1 card
deck.drawFromBottomOfDeck(5) // array of 5 cards
deck.drawRandom() // 1 card
deck.drawRandom(5) // array of 5 cards
deck.putOnTopOfDeck(card)
deck.putOnTopOfDeck([card, card, card])
deck.putOnBottomOfDeck(card)
deck.putOnBottomOfDeck([card, card, card])
deck.length // integer (# of cards left in deck)
```
## License
[MIT License](http://www.opensource.org/licenses/mit-license.php)
## Author
[Troy Goode](https://github.com/TroyGoode) ([[email protected]](mailto:[email protected]))