@imtbl/gu-deckcode v1.0.4

gu-deckcode

gu-deckcode is a JS library for encoding/decoding Gods Unchained deck codes.

To use in any web project

npm i @imtbl/gu-deckcode

or

yarn add @imtbl/gu-deckcode

Then import into your script with

const guDeckcode = require("gu-deckcode");

What is a deck code?

A string of text that encodes a Gods Unchained deck.

It follows a format of:

GU_<format>_<domain>_<cards>

This code can be used to share decks, and can be imported into the deck builder.

Encoding a deck

This requires two things:

• A list of library IDs (these are in the form LX-YYY)
• A domain (i.e 'death')
• (Optionally) a format code (only costructed decks are supported, which have a format code of 1). This defaults to 1.

Assuming you have these things:

const libraryIds = ["L0-001", "L0-001"];
const domain = "deception";

const deckCode = guDeckcode.encodeDeck(libraryIds, domain);

// deckCode -> "GU_1_2_AABAAB"

Decoding a deck

const { libraryIds, domain, formatCode } = decodeDeck("GU_1_1_AABAAB");

// libraryIds -> ["L0-001", "L0-001"]
// domain -> "deception"
// formatCode -> 1

FAQs

Where can I find a cards library ID?

This is found in the lib_id field of the https://api.godsunchained.com/v0/proto?format=flat endpoint.

How do domain mappings work?

Domains are mapped alphabetically.

1 -> 'death'
2 -> 'deception'
3 -> 'light'
4 -> 'magic'
5 -> 'nature'
6 -> 'war'