Difference between revisions of "Piñata Vision barcode/Encoded data"

From PinataIsland.info, the Viva Piñata wiki
Jump to: navigation, search
(Add Appear Mate, and Journal UnlockArt subtypes. Organize data by type in ToC)
(Add name data, including currently known encodings for the 5-bit character set.)
Line 87: Line 87:
 
*If the pinata won't be wearing accessories, clear the accessory flag.  No further encoding needs to be done, as the optional accessory data will not be present.
 
*If the pinata won't be wearing accessories, clear the accessory flag.  No further encoding needs to be done, as the optional accessory data will not be present.
  
 +
== Name ==
 +
 +
{| style="width:200px; padding:0.3em; float:right; margin-left:15px; margin-bottom:8px; border:1px solid #A3B1BF; background:#f5faff; text-align:left; font-size:95%; line-height:1.5em;"
 +
|-
 +
!colspan="2" style="text-align:center; background:#cee0f2; padding:0.3em; font-size:1.1em;"|'''Name'''
 +
|-
 +
|'''Optional:'''||Yes
 +
|-
 +
|'''Parent:'''||PlaceTag
 +
|-valign="top"
 +
|'''Offset:'''||Varies<br />41 (AF=0)<br />?? (?)
 +
|-valign="top"
 +
|'''Size:'''||Varies<br />5 x (length + 1)
 +
|-
 +
|colspan="2"|
 +
{| width=100% style="background:#f5faff; text-align:left; font-size:95%; line-height:1.5em;"
 +
|-
 +
!colspan="2" style="text-align:center; background:#cee0f2; padding:0.3em; font-size:1.1em;"|'''Character 1'''
 +
|-
 +
|'''Optional:'''||No
 +
|-
 +
|'''Parent:'''||Name
 +
|-
 +
|'''Offset:'''||0
 +
|-
 +
|'''Size:'''||5 bits
 +
|-
 +
!colspan="2" style="text-align:center; background:#cee0f2; padding:0.3em; font-size:1.1em;"|'''Character 2'''
 +
|-
 +
|'''Optional:'''||No
 +
|-
 +
|'''Parent:'''||Name
 +
|-
 +
|'''Offset:'''||5
 +
|-
 +
|'''Size:'''||5 bits
 +
|-
 +
!colspan="2" style="text-align:center; background:#cee0f2; padding:0.3em; font-size:1.1em;"|'''Character 3, ...'''
 +
|-
 +
|'''Optional:'''||Yes
 +
|-
 +
|'''Parent:'''||Name
 +
|-
 +
|'''Offset:'''||10, 15, 20, ...
 +
|-
 +
|'''Size:'''||5 bits
 +
|}
 +
|-
 +
|colspan="2" style="text-align:center;"|'''See also'''
 +
|-
 +
|colspan="2"|[[#Name flag|Name flag]]
 +
|}
 +
This optional pinata name data is present if the name flag is set.
 +
 +
Its offset appears to vary, based on other optional data such as accessories.
 +
 +
Unlike the accessory data, it does not appear to contain a count (length) preceeding the name characters.  The name is possibly null-terminated (NUL).
 +
 +
=== Decoding ===
 +
 +
*?
 +
 +
The game likely auto-capitalizes the name, by capitalizing the first letter of the name and any letter that follows a space (SP) character.
 +
 +
=== Encoding ===
 +
 +
*?
 +
 +
The name character set appears to be 5-bit, with no shift bit to distinguish between upper and lower case.  Based on names from scanned cards, the character set also apparently includes the space character, and the period.  (See the [[:Image:B._Orchid-Killer_Instinct-PV.jpg|B. Orchid Killer Instinct card]].)
 +
 +
{| border="1" class="pii_species_variants" style="text-align:center"
 +
|-
 +
!Char!!Bits!!Char!!Bits!!Char!!Bits!!Char!!Bits
 +
|-
 +
|NUL?||00000||G/g||01000||O/o||10000||W/w||11000
 +
|-
 +
|?||00001||H/h||01001||P/p||10001||X/x||11001
 +
|-
 +
|A/a||00010||I/i||01010||Q/q||10010||Y/y||11010
 +
|-
 +
|B/b||00011||J/j||01011||R/r||10011||Z/z||11011
 +
|-
 +
|C/c||00100||K/k||01100||S/s||10100||?||11100
 +
|-
 +
|D/d||00101||L/l||01101||T/t||10101||?||11101
 +
|-
 +
|E/e||00110||M/m||01110||U/u||10110||?||11110
 +
|-
 +
|F/f||00111||N/n||01111||V/v||10111||?||11111
 +
|-
 +
|}
 +
 +
More name data needs to be decoded to identify the remaining characters in the set, including the existence of a NUL termination character.
 +
<div style="clear:right;"></div>
 
== Name flag ==
 
== Name flag ==
  

Revision as of 06:52, 27 February 2011

000 PlaceTag

Accessory

Accessory
Optional: Yes
Parent: PlaceTag
Offset: Varies
36 (?)
?? (?)
Size: Varies
3 + n x AC
Accessory count
Optional: No
Parent: Accessory
Offset: 0
Size: 3 bits
Accessory item
Optional: No
Parent: Accessory
Offset: 3
Size: ? bits
See also
Accessory flag

This optional accessory data is present if the accessory flag is set.

Its offset appears to vary, based on other optional data such as pinata name.

Decoding

  • ?

Encoding

  • ?

Accessory flag

Accessory flag
Optional: No
Parent: PlaceTag
Offset: 29
Size: 1 bit
See also
Accessory

The accessory flag indicates whether or not optional accessory data is encoded on the card. The accessory flag is present for all PlaceTag cards, even if the item being placed is not a pinata.

Decoding

  • If the accessory flag is clear, no optional accessory data is encoded on the card
  • If the accessory flag is set, accessory data is encoded on the card. The inclusion of this optional data appears to shift offsets for fields that follow.

Encoding

  • If the pinata will be wearing accessories, set the accessory flag, and encode the accessory details.
  • If the pinata won't be wearing accessories, clear the accessory flag. No further encoding needs to be done, as the optional accessory data will not be present.

Name

Name
Optional: Yes
Parent: PlaceTag
Offset: Varies
41 (AF=0)
?? (?)
Size: Varies
5 x (length + 1)
Character 1
Optional: No
Parent: Name
Offset: 0
Size: 5 bits
Character 2
Optional: No
Parent: Name
Offset: 5
Size: 5 bits
Character 3, ...
Optional: Yes
Parent: Name
Offset: 10, 15, 20, ...
Size: 5 bits
See also
Name flag

This optional pinata name data is present if the name flag is set.

Its offset appears to vary, based on other optional data such as accessories.

Unlike the accessory data, it does not appear to contain a count (length) preceeding the name characters. The name is possibly null-terminated (NUL).

Decoding

  • ?

The game likely auto-capitalizes the name, by capitalizing the first letter of the name and any letter that follows a space (SP) character.

Encoding

  • ?

The name character set appears to be 5-bit, with no shift bit to distinguish between upper and lower case. Based on names from scanned cards, the character set also apparently includes the space character, and the period. (See the B. Orchid Killer Instinct card.)

Char Bits Char Bits Char Bits Char Bits
NUL? 00000 G/g 01000 O/o 10000 W/w 11000
? 00001 H/h 01001 P/p 10001 X/x 11001
A/a 00010 I/i 01010 Q/q 10010 Y/y 11010
B/b 00011 J/j 01011 R/r 10011 Z/z 11011
C/c 00100 K/k 01100 S/s 10100 ? 11100
D/d 00101 L/l 01101 T/t 10101 ? 11101
E/e 00110 M/m 01110 U/u 10110 ? 11110
F/f 00111 N/n 01111 V/v 10111 ? 11111

More name data needs to be decoded to identify the remaining characters in the set, including the existence of a NUL termination character.

Name flag

Name flag
Optional: No
Parent: PlaceTag
Offset: Varies
39 (AF=0)
?? (?)
Size: 1 bit
See also
Name

The name flag indicates whether or not a pinata name is present.

Its offset appears to vary, based on other optional data such as accessories.

Decoding

  • If the name flag is clear, no optional name data is encoded on the card.
  • If the name flag is set, name data is encoded on the card. The inclusion of this optional data appears to shift offsets for fields that follow.

Encoding

  • If the pinata will have a name, set the name flag, and encode the name data.
  • If the pinata won't have a name, clear the name flag. No further encoding needs to be done, as the optional name data will not be present.

Use cost

Use cost
Optional: No
Parent: PlaceTag
Offset: Varies

41 (AF=0)
?? (AF=1)

Size: 10 bits
Use cost value
Optional: No
Parent: Use cost
Offset: 0
Size: 7 bits
Use cost magnitude
Optional: No
Parent: Use cost
Offset: 7
Size: 3 bits
See also
Use cost flag, accessory flag

The use cost holds the cost to scan the card (if the card is not flagged as free to scan).

Its offset appears to vary, based on other optional data such as accessory information.

Decoding

  • If the use cost flag is clear, the card is free to scan, and the (non-zero) use cost data should be ignored.
  • If the use cost flag is set, use the encoded use cost as the cost to scan the card.

To obtain the use cost, multiply the value by the order of magnitude (power of 10). For example, a use cost value of 18 and a use cost magnitude of 2 would be a use cost of 18 x 102 = 18 x 100 = 1800.

Encoding

  • If the card has a cost to scan, ensure that the use cost flag is set, and encode the use cost value and magnitude.

There does seem to be some variance on how a use cost of 1000 is encoded. Some cards have it stored as 100 x 10, while others have it encoded as 10 x 100. It's uncertain whether the representations are interchangeable or not, although a particular representation may affect other fields such as a checksum.

  • If the card is free to scan, ensure that the use cost flag is clear, and store an ID-derived non-zero value in the use cost to possibly help mask a noticable barcode pattern due to a run of 0s occurring within the encoded data.
Bit(s) Value to encode
V6 to V3 0
V2 1
V1 !ID11
V0 !ID10
M2 ID9
M1 ID8
M0 ID7

Use cost flag

Use cost flag
Optional: No
Parent: PlaceTag
Offset: 35
Size: 1 bit
See also
Use cost

The use cost flag indicates whether or not there is a cost to scan the card.

Decoding

  • If the use cost flag is clear, the card is free to scan (and the non-zero encoded use cost should be ignored).
  • If the use cost flag is set, the cost to scan the card is encoded in the use cost.

Encoding

  • If the card will have a cost to scan, set the use cost flag, and encode the use cost.
  • If the card will be free to scan, clear the use cost flag, and store an ID-derived non-zero value in the use cost.

It's uncertain whether the game ignores the use cost data for free cards, or checks it to see if it was encoded properly.

101 Reference

Appear Mate subtype

Appear Mate subtype
Optional: No
Parent: Reference (AM)
Offset: 36
Size: 1 bit
See also
?

The Appear Mate subtype differentiates between View Appear Cutscene and View Mate Cutscene cards (which both share the same card type).

Decoding

  • If the Appear Mate subtype is 0(?), the card is a View Appear Cutscene card.
  • If the Appear Mate subtype is 1(?), the card is a View Mate Cutscene card.

Encoding

  •  ?

Journal UnlockArt subtype

Journal UnlockArt subtype
Optional: No
Parent: Reference (JU)
Offset: 45
Size: 1 bit
See also
?

The Journal UnlockArt subtype differentiates between ViewTagInJournal and UnlockArt cards (which both share the same card type).

Decoding

  • If the Journal UnlockArt subtype is 0(?), the card is an UnlockArt card.
  • If the Journal UnlockArt subtype is 1(?), the card is a ViewTagInJournal card.

Encoding

  •  ?
Retrieved from "https://pinataisland.info/viva/index.php?title=Piñata_Vision_barcode/Encoded_data&oldid=31513"