Sample Game 1 PAK: Difference between revisions
Jump to navigation
Jump to search
imported>Dinoguy1000 No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
== PAK == | == PAK == | ||
{{GRAFPageMisc|date_posted=20:45, 26 Apr 2006 (EDT)}} | {{GRAFPageMisc|date_posted=20:45, 26 Apr 2006 (EDT)}}<!-- | ||
<!-- | |||
If your format is non-archive, add the parameter format_type= to it. You then choose from one of the following: {{FormatAudio}}, {{FormatMiscellaneous}}, or {{FormatVideo}}. For example, if my format is a picture format (video), I would place on the format page: {{GRAFPageMisc|format_type={{FormatVideo}}|date_posted=XXX}}. | If your format is non-archive, add the parameter format_type= to it. You then choose from one of the following: {{FormatAudio}}, {{FormatMiscellaneous}}, or {{FormatVideo}}. For example, if my format is a picture format (video), I would place on the format page: {{GRAFPageMisc|format_type={{FormatVideo}}|date_posted=XXX}}. | ||
If your format is not Little Endian (and thus Big Endian), add the text endian_order={{EndianBig}} to it. For example, this would be placed on the format page: {{GRAFPageMisc|endian_order={{EndianBig}}|date_posted=XXX}}. | If your format is not Little Endian (and thus Big Endian), add the text endian_order={{EndianBig}} to it. For example, this would be placed on the format page: {{GRAFPageMisc|endian_order={{EndianBig}}|date_posted=XXX}}. | ||
| Line 13: | Line 13: | ||
=== Format Specifications === | === Format Specifications === | ||
{{GRAFPageFormat|1=char {15} - Header {{Purple|(Sample Game PAK)}}<br> | {{GRAFPageFormat|1=char {15} - Header {{Purple|(Sample Game PAK)}}<br> | ||
byte {1} - null Padding<br> | byte {1} - null Padding<br> | ||
{{Blue|// For each file}}<br> | {{Blue|// For each file}}<br> | ||
:char {16} - File name (null padded) | :char {16} - File name (null padded) | ||
:uint32 {4} - File size | :uint32 {4} - File size | ||
:byte {x} - File data}} | :byte {x} - File data}}<!-- | ||
<!-- | |||
Note that when you use the {{GRAFPageFormat}} template, if you use any other templates within it, such as {{Green}} or {{Unknown}}, you need to place a 1= right after the pipe character (|). For instance, {{GRAFPageFormat|{{Blue|This is blue}}}} will display as '''None written yet'''. However, {{GRAFPageFormat|1={{Blue|This is blue}}}} will display as '''This is blue''', in blue text. | Note that when you use the {{GRAFPageFormat}} template, if you use any other templates within it, such as {{Green}} or {{Unknown}}, you need to place a 1= right after the pipe character (|). For instance, {{GRAFPageFormat|{{Blue|This is blue}}}} will display as '''None written yet'''. However, {{GRAFPageFormat|1={{Blue|This is blue}}}} will display as '''This is blue''', in blue text. | ||
Block section descriptions should be blue, like in the example above. | Block section descriptions should be blue, like in the example above. | ||
Field tags can be one of the following: | |||
uint16 {2} for 2-byte-long unsigned integers | |||
uint32 {4} for 4-byte-long unsigned integers | |||
char {x} for character data x bytes long | |||
byte {x} for hexadecimal data x bytes long | |||
int16 {2} for 2-byte-long signed integers | |||
int32 {4} for 4-byte-long signed integers | |||
char {1} or byte {1} should be used for any 1-byte-long fields, and if you need a tag for fields 3 bytes long, or 5 bytes or longer, you can use char {x} or something like uint48 {6}. If you use uintx {x} or intx {x}, note that the first number in the tag is equal to the field's length * 8, so if a field is 4 bytes long, the first number would be 32. Field tags themselves should be thirteen characters long from the beginning to the dash, with multiple spaces using , as seen in the above example. | |||
Unknown values should use the {{Unknown}} template. If you have an educated guess for what an unknown value might be, you should instead use {{Red| '' Educated guess '' }}, where Educated guess is, of course, your educated guess. | Unknown values should use the {{Unknown}} template. If you have an educated guess for what an unknown value might be, you should instead use {{Red| '' Educated guess '' }}, where Educated guess is, of course, your educated guess. | ||
Literal strings, such as "Hello world" or "Wuzup?" should be purple and enclosed within parenthesis following the field description. Non-printable characters (NPC's), such as nulls, can be written as just the character's ASCII code, e.g. 00 for a null, or they can be prefixed with "0x", e.g. 0x00. Multiple NPC's should be seperated from each other and any literal strings with commas. For instance, {{Purple|(Hello world,00,21)}} There may be another method or two used here, I've got to do some digging. | Literal strings, such as "Hello world" or "Wuzup?" should be purple and enclosed within parenthesis following the field description. Non-printable characters (NPC's), such as nulls, can be written as just the character's ASCII code, e.g. 00 for a null, or they can be prefixed with "0x", e.g. 0x00. Nulls themselves can also be represented by the word "null". Multiple NPC's should be seperated from each other and any literal strings with commas or spaces. For instance, {{Purple|(Hello world,00,21)}} There may be another method or two used here, I've got to do some digging. | ||
Any short notes should be in green after the field description. | Any short notes should be in green after the field description. Longer notes should go in the "Notes and Comments" section. | ||
--> | --> | ||
| Line 36: | Line 45: | ||
=== MultiEx BMS Script === | === MultiEx BMS Script === | ||
{{NoBMSScript}} | {{NoBMSScript}}<!-- | ||
<!-- | |||
IMPORTANT: DO NOT USE TEMPLATES WITH THE BMS SCRIPT TAG!!! | IMPORTANT: DO NOT USE TEMPLATES WITH THE BMS SCRIPT TAG!!! | ||
The current BMS plugin doesn't work with templates, and as a result, it cannot be put on a page partially contaied in a template. Therefore, assuming an oversimplified version of the BMS plugin, using something like | The current BMS plugin doesn't work with templates, and as a result, it cannot be put on a page partially contaied in a template. Therefore, assuming an oversimplified version of the BMS plugin, using something like | ||
| Line 57: | Line 66: | ||
=== Supported by Programs === | === Supported by Programs === | ||
{{NoProgramSupport}} | {{NoProgramSupport}}<!-- | ||
<!-- | |||
If your format is supported by any programs, you should list each program on its own line, and each line should start with an asterisk (*). This will automatically make a list. | If your format is supported by any programs, you should list each program on its own line, and each line should start with an asterisk (*). This will automatically make a list. | ||
If your format is supported by MultiEx Commander, replace the line {{NoProgramSupport}} with {{ProgramSupportMexcom}}. Note that if MexCom supports a given format, its tag should always be the first program on the list. | If your format is supported by MultiEx Commander, replace the line {{NoProgramSupport}} with {{ProgramSupportMexcom}}. Note that if MexCom supports a given format, its tag should always be the first program on the list. | ||
Revision as of 00:19, 24 December 2006
Back to index | Edit this page
NOTE: This is only an example of a GRAF page. As far as I know, there is no game called "Sample Game 1", and no game uses the exact archive format given below.
PAK
- Format type: Archive
- Endianness: Little-endian
Format Specifications
char {15} - Header (Sample Game PAK)
byte {1} - null Padding
// For each file
- char {16} - File name (null padded)
- uint32 {4} - File size
- byte {x} - File data
Notes and Comments
None
MultiEx BMS Script
None written yet.
Supported by Programs
Unknown
Links
None