Skip to content
Manabrew

Deck

The whole deck - its identity, the maindeck and sideboard, the supplementary zones, and the preserved client-side metadata.

interface Deck {
  version?: string;
  id?: string;
  name: string;
  description?: string;
  color?: string;
  format?: DeckFormat;
  cards: Array<DeckCard>;
  sideboard: Array<DeckCard>;
  attractions?: Array<DeckCard>;
  contraptions?: Array<DeckCard>;
  schemes?: Array<DeckCard>;
  planes?: Array<DeckCard>;
  commanders?: Array<DeckCard>;
  companion?: DeckCard;
  maybeboard?: Array<DeckCard>;
  draft?: boolean;
  labels?: Array<DeckLabel>;
  customTags?: Array<string>;
  cardTags?: Record<string, Array<string>>;
  editor?: DeckEditorMetadata;
  coverCardName?: string;
  coverCardFace?: number;
  /**
   * The hub fills this from `playmat_asset_id` and ignores whatever a write
   * supplies.
   */
  playmatUrl?: string;
  playmatAssetId?: string;
  playmatSettings?: PlaymatSettings;
  stackPositions?: Record<string, { x: number; y: number }>;
  tokens?: Array<DeckCard>;
}

References: DeckCard , DeckEditorMetadata , DeckFormat , DeckLabel , PlaymatSettings

DeckCard

Section titled “DeckCard”

One entry in a deck: a nested identity (which card and printing) plus a flattened rules summary and the UI-only uris.

interface DeckCard {
  identity: DeckCardIdentity;
  uris: CardImageUris;
  imageLanguage?: string;
  allParts?: Array<CardPart>;
  color: string;
  colorIdentity: Array<string>;
  manaCost: string;
  cmc: number;
  types: Array<string>;
  subtypes: Array<string>;
  supertypes: Array<string>;
  keywords?: Array<string>;
  power?: string;
  toughness?: string;
  text: string;
  layout?: string;
  isDoubleFaced?: boolean;
  /**
   * Back face of a transform / modal_dfc card, captured at deck import.
   * Absent on single-faced cards and on decks saved before it existed.
   */
  backFace?: CardBackFaceSummary;
}

References: CardBackFaceSummary , CardImageUris , CardPart , DeckCardIdentity

DeckCardIdentity

Section titled “DeckCardIdentity”

Which card a DeckCard is - name, printing (setCode/cardNumber), and an optional foil flag. id is a client-side instance id.

interface DeckCardIdentity {
  id: string;
  name: string;
  setCode: string;
  cardNumber: string;
  oracleId?: string;
  tokenScript?: TokenScript;
  foil?: boolean;
}

References: TokenScript

DeckLabel

Section titled “DeckLabel”

A user-defined label attached to a deck.

interface DeckLabel {
  name: string;
  color?: string;
}