Skip to content

prefko/preferans-deck-js

Repository files navigation

prefko

preferans-deck-js

build status codacy coverage npm

Gitpod ready-to-code

preferans deck of cards

Documentation

TypeDoc documentation

Install

yarn add preferans-deck-js

Usage

const preferansDeckJs = require("preferans-deck-js");
const Deck = preferansDeckJs.default;
const Card = preferansDeckJs.Card;

let card = new Card('7');
console.log(card.unicode);
// K♠

let deck = new Deck();
let deal = deck.deal;
console.log("Hand 1:", deal.hand1.unicode);
console.log("Hand 2:", deal.hand2.unicode);
console.log("Hand 3:", deal.hand3.unicode);
console.log("Talon:", deal.talon.talon1.unicode + deal.talon.talon2.unicode);

// Hand 1: 7♠8♠9♠X♠J♠8♥9♥X♥J♥Q♥
// Hand 2: Q♠K♠A♠7♦8♦K♥A♥7♣8♣9♣
// Hand 3: 9♦X♦J♦Q♦K♦X♣J♣Q♣K♣A♣
// Talon: A♦7♥

Labels and meaning

Mostly from Wikipedia.

  • card - duh
  • deck - deck of 32 cards, from 7 to A in all 4 suits
  • hand - cards in one players hands
  • extra - two extra cards left over while dealing
  • reject - two cards the main player rejected
  • round - 3 hands and the extra 2 cards
  • trump - the trump suit per round
  • plain suit - any suit that is not a trump suit
  • trick - cards thrown
  • shuffle - rearrange (a deck of cards)
  • seat - position relative to the dealer
  • ppn - Portable Preferans Notation (patent pending)

API

Wiki API