Difference between revisions of "Piñata Vision barcode"

Revision as of 15:28, 11 July 2012

A Tigermisu Piñata Vision card, created with the camera tool. The card has 2 barcode rows.

The barcode for a Piñata Vision card (PVC, or card for short) is based on the EAN-13 barcode, with some minor modifications.

A card's barcode consists of one or more rows of bars. Most cards contain either one or two rows of bars, although a few cards released by Rare contain 3 or 4 rows of bars. No cards have been seen yet with 5 or more rows.

The barcode digits

Each row consists of 113 bars, broken down into sixteen groups of 7-bar patterns (16 x 7 = 112), followed by a single "stop" bar.

The valid barcode patterns (where a 1 represents a black bar, and 0 represents a white space), correspond to a 4-bit value (0-9A-F in hexadecimal), as follows:

This chili card's barcode is F4E079E4CEB7204D.

The barcode checksum

Each barcode row consists of 15 digits, plus a check digit. (The check digit also identifies the specific method used to obfuscate that row's data.)

The Piñata Vision barcode checksum is based on the EAN check digit. Alternating weights of 3 and 1 are used, with the 15th digit having a weight of 3. The weighted values are summed. The check digit is the value which when added to the sum yields a number evenly divisible by 16. (I.e., modulo 16 of the sum plus the check digit will equal 0.)

The barcode data

To conceal the underlying data, the information is obfuscated (on a per-row basis) before being coded as bars. This makes it difficult to recognize cards with sequential or nearly identical data, since their barcodes would appear quite distinct from each other. The obfuscation set article discusses how a particular obfuscation is selected for a card.

Each barcode row decodes to 16x4=64 bits of data. The first 60 bits are encoded data. The last 4 (least significant) bits per row are used for the checksum/obfuscation set.

Since the data is obscured differently across the cards, the encoded information (such as ID), will appear in differing bits, depending on the specific obfuscation used for a card. See the Use cost example for an illustration of how (value) bits are obfuscated.

A tab-delimited list of barcodes for the wiki's collection of cards is available to anyone who wants to discover more about the Piñata Vision barcode.

Encoded information

One of the goals of the barcode project is to identify the underlying representation of a card's data.

For example, we know that cards have a use cost, such as 50,000 chocolate coins for a higher-level wildcard. Since the cards have a limited number of bits for data, it's not efficient to store large values as 32- or 16-bit integers. So a use cost value has to be packed to fit into a smaller (fixed) number of bits reserved for the use cost.

Payload type

Although there are many different types of cards, the payload type groups the many similar sets of cards together into a small number of common types for the game to process. The payload type field itself is 5 bits.

The payload type is the key (most significant) field that tells the game exactly what type of data follows. Sub-type values can be found further within the encoded data so the game can distinguish between similar cards such as Appear cutscene and Mate cutscene.

The three different card types seen so far are grouped as follows:

• Cards which drop an something into the garden:
  • PlaceTag
  • Blackariant
  • GoodVariants
• Cards which reference a pinata or item:
  • Learn/Perform Primary/Secondary Trick
  • UnlockArt
  • Journal
  • Appear and mate cutscene
  • Other cards likely included within this card type would be House interior
• Cards which perform an independent action:
  • Sparse callback (e.g., adjust credits balance, change dinosaur color, send in Ruffian)
  • Romance music tracks (official name of card type unknown)
  • Other cards likely included within this card type would be Weather and Timewarp
• Cards which reskin the trick stick.

The card type example gives a quick visual glance of cards with differing type bits.

Each of these types of cards may share some data that's common to most cards (such as an ID). Other fields might be unique to a that particular card type, such asthe color of dinosaur, or type of weather.

ID

Some of the developer cards include a number near the end of the filename, e.g., Vision_Single_PlaceTag_Home_parrot_586.jpg. This value, 586, is an ID value that identifies the card's item to the game. In short, the barcode says "Place item 586 (a Parrybo home) into the garden (for free)."

All PlaceTag cards are a single payload type, regardless of type of item (e.g., Home, Egg, Fruit, Paving, Prop, ...), and it's possible to change the (type of) item merely by changing an ID bit. The ID appears to serve as an index into an ID table consisting of many types of items.

Since the largest ID seen so far is 2249, it's likely that the ID field is 12 bits long. This has been verified by observing that ID bit 11 immediately follows the payload type field for ID bits.

Low-value IDs (0-160?) appear to serve as species IDs, with several similar types of cards utilizing a common species ID (e.g., unlock art for Raisant, view journal for Raisant, learn trick for Raisant).

Use cost

Player-created cards have a use cost associated with them, and the game will display the cost as part of a prompt, when asked if you want to use the card. The use cost is also shown at VivaPinata.com, when looking at a specific card.

Since the cost could be a large value for an expensive pinata, the cost is encoded on the card as a smaller value, and a magnitude (power of 10).

Smaller values (likely less than 128) are represented as that value, with a magnitude of 0 (10^0 = 1). Larger values such as 650, are represented as 65, with a magnitude of 1 (10^1 = 10).

The value is a 7-bit field. The magnitude is a 3-bit field. This representation supports packing large use costs (millions or billions of coins) into a far-smaller field than a 32-bit integer would use.

There does seem to be some variance on how a use cost such as 1000 is encoded. Looking at use costs for obfuscation set A, 2 cards have encoded 1000 as 100 x 10, while 2 others have it encoded as 10 x 100.

One further note about the use cost is that some (developer) cards are free to use. They have no encoded use cost value at all.

The Use cost example illustrates an early example of finding known information within an obfuscated card's data.

Other fields

There's certainly more data that's stored on the card, depending on its type. For example, some cards contain a name field (e.g., Image:Chewnicorn-TroubleInParadise-Black-Francesca-PV.jpg. That particular card type also appears to contain a variant field that's likely shared between the Blackariants and GoodVariants card types.

Other examples of data on a card are optional accessories that a pinata might be wearing, a gamertag if the card happens to be locked, or the type and duration of weather that the game should feature.

Goals

Short-term goals

Discover the unreleased Choclodocus egg card

The Choclodocus egg card was discovered on May 3, 2010 by shrly, who volunteered to help scan cards for the barcode project.

This project has ended. Read more about it.

Discover the unreleased amber gem card

The amber gem card was discovered on May 10, 2010 by shrly, who volunteered to help scan cards for the barcode project.

This project has ended. Read more about the method used for its discovery.

Discover the "Change dinosaur color to 3" card

The elite neon green reskin card was discovered on April 5, 2011 by FeralKitty.

This project has ended.

Discover the unreleased red sour cards

We have Rare's cards for black variant sours, and have now discovered all the red sour cards.

This project has ended. Read more about it.

Discover the remaining romance music cards

We have a few jukebox track cards that Rare has released. It would be nice to generate barcodes for the remaining species.

This project is not yet underway, but any member is welcome to start working on it.

Long-term goals

Discover the garden store card

This building is missing from the PlaceTag cards.

This project is not yet underway, but any member is welcome to start working on it.

Discover more about the encoded data fields

Now that the barcode data has been deobfuscated, some details have been discovered about the encoded data. Remaining data to be decoded includes:

• Learning about the remaining payload types (5-bits),
• the wildcard field (2-bits, trait 1, 2, 3, or normal?),
• the variant field (2 4 bits, 0-15, black is 15),
• the gamertag field,
• the locked card bit,
• a "instantly reusable" bit, and
• various other type-specific fields, such as:
  • weather type, duration
  • romance music track

One-row cards

• Normal species (non-variant, non-wildcard)
• Vision_Single_PlaceTag cards (These plants are one-row)

Two-row cards

• SpeciesPV cards (species + 3 accessories)
• Learn/Perform Trick
• Romance Music
• Species wildcards
• Species variants (in-game, Blackariants, and GoodVariants)
• Plants (user-created plant cards are 2-row unlike PlaceTag plants)
• Named species (Blackariants and GoodVariants, but likely also named normal species and/or wildcards)
• Locked dino cards

Possible data (fields) in row 2

• Wildcard trait (2 bits? values 0-2? 1-3?)
• Variant color (4 bits? values 0-15? Black is apparently 15)
• Gamertag (? bits. Unique integer? Hash? Alphanumeric?)
  • A gamertag can be 15 characters max... acceptable chars are Aa-Zz, 0-9, single spaces, and it can't start with a number.

Read cards to dump their data

Currently the reader script can dump payloads for ID, use costs, name, accessories, wildcard and variant data, and several other fields for all of the obfuscation sets. Eventually, it would be nice to decode all the data about a card (e.g., accessory items) into a human-readable format.

% ./barcodetxt2bitdiff.pl --short < barcodes.txt | egrep '(RaisantHome|02-Goobaa|Christmas)' | ./reader.pl --parse --verbose
RaisantHome         	502	B1D5D1C45F6ECF18
 00000: Start of data
 00001/ID: 502
 10110/Reuse: 00001
 11000/UseCost: 500
 00000: End of data

02-GoobaaPV         	108	8694B4C37FF5ED8895AC845BE84BDD4C2AE67C7BE7660C2D
 00000: Start of data
 00001/ID: 108
 11101/Accessory: 3 items 43 103 80
 00111/Name: Bigsheep
 01010/Variant: 2
 00000: End of data

Christmas-12.25.2008	28	B18177A5BDFE1C9362BF4624050612F2F64D2CA27C7452174ED8F0B56F061703
 00000: Start of data
 00001/ID: 28
 11101/Accessory: 3 items 95 28 92
 00011/StartDate: 12/24
 00100/EndDate: 12/26
 00111/Name: Rudolph
 01001/Wildcard: 3
 01010/Variant: 2
 00000: Start of data
 00001/ID: 28
 00000: End of data

There is also a barcode reader at this site (that will convert the EAN barcode to its obfuscated hex data).

Generate cards

Work on a card generator has started. The card generator can currently create named varianted pinata cards, as well as a few other types of cards (e.g., Weather).

% ./generate_barcode.pl --id=51 --variant=1 --name=Feral --verbose
Encoded data = 00840CEC039CD31C 340A10046998C0A5  Shuffled/Negated = EE2D18643D60061C ED8283EC4391A215  Obfuscated = 995D6E134D17716C 9DE5E49C34F6A562
Card			51	995D6E134D17716C9DE5E49C34F6A562

There is also a web-based card generator at this site, as well as a PV Creator for the iPhone and iPod touch, and a PV Creator HD for the iPad.

How you can help

• Volunteer to scan generated cards, to see what, if anything, turns up. Maybe you'll be the member who makes the next big discovery. You can volunteer by signing up in the forum's Unlocking the Secrets of the Pinata Vision Barcode thread.

• Help scan recently discovered cards to ensure that they're 100% valid before being announced to the community.

• Learn more about the barcodes on your own, such as by deciding on an interest (e.g., the card type field)

• Start the hunt for a specific card, or to learn more about specific card data (such as the card type field). Try one of the documented discovery methods, or come up with a different approach to discovering more about the barcode.

• Mail your locked neon Choclodocus reskin card to pinatavision at gmail dot com to help with future discoveries. More details and answers can be found at the forum.

See also

• List of barcodes