Sample Game 1 PAK: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
imported>Dinoguy1000 No edit summary |
||
| Line 6: | Line 6: | ||
{{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: | ||
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}}. | {{GRAFPageMisc|format_type={{FormatVideo}}|date_posted=XXX}}. | ||
You can also use these together. For example, if my above examples were for the same format: {{GRAFPageMisc|format_type={{FormatVideo}}|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: | ||
Lastly, note that the exact order of the parameters isn't important. For example, {{GRAFPageMisc|date_posted=XXX|endian_order={{EndianBig}}|format_type={{FormatVideo}}}} will display just the same as {{GRAFPageMisc|format_type={{FormatVideo}}|date_posted=XXX|endian_order={{EndianBig}}}} or {{GRAFPageMisc|format_type={{FormatVideo}}|endian_order={{EndianBig}}|date_posted=XXX}}. | {{GRAFPageMisc|endian_order={{EndianBig}}|date_posted=XXX}}. | ||
You can also use these together. For example, if my above examples were for the same format: | |||
{{GRAFPageMisc|format_type={{FormatVideo}}|endian_order={{EndianBig}}|date_posted=XXX}} | |||
Lastly, note that the exact order of the parameters isn't important. For example, | |||
{{GRAFPageMisc|date_posted=XXX|endian_order={{EndianBig}}|format_type={{FormatVideo}}}} | |||
will display just the same as | |||
{{GRAFPageMisc|format_type={{FormatVideo}}|date_posted=XXX|endian_order={{EndianBig}}}} | |||
or | |||
{{GRAFPageMisc|format_type={{FormatVideo}}|endian_order={{EndianBig}}|date_posted=XXX}}. | |||
--> | --> | ||
| Line 16: | Line 24: | ||
byte {1} - null Padding<br> | byte {1} - null Padding<br> | ||
{{ | {{BlockDescription|// For each file}}<br> | ||
:char {16} - File name (null padded) | :char {16} - File name {{InlineComment|(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 {{ | Note that when you use the {{GRAFPageFormat}} template, if you use any other templates within it, such as {{InlineComment}} 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. | ||
| Line 34: | Line 42: | ||
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. | 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 | Unknown values should use the {{Unknown}} template. If you have an educated guess for what an unknown value might be, you should use {{Unknown| '' 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, | Literal strings, such as "Hello world" or "Wuzup?" should be purple and enclosed within parenthesis following the field description. E.g. {{Purple|("Hello world")}} Non-printable characters (NPC's), such as nulls, should be written as just the character's ASCII code, e.g. 00 for a null. Nulls themselves can also be represented by the word "null". Multiple NPC's should be seperated from each other and any literal strings with spaces. For instance, {{Purple|("Hello world" 00 21)}} or {{Purple|("Hello world" null 21)}} | ||
Any short notes should be in | Any short notes should be enclosed in parenthesis and use the InlineComment template after the field description, e.g. {{InlineComment|(This is a comment)}}. Longer notes should go in the "Notes and Comments" section. | ||
--> | --> | ||
| Line 48: | Line 56: | ||
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 | The current BMS plugin doesn't work with templates, and as a result, it cannot be put on a page partially contained in a template. Therefore, assuming an oversimplified version of the BMS plugin, using something like | ||
{{Script|author=someguy|ext=abc|script=foobar}} | {{Script|author=someguy|ext=abc|script=foobar}} | ||
| Line 54: | Line 62: | ||
with Template:Script containing | with Template:Script containing | ||
<bms author="{{author}}" ext="{{ext}}"> | <bms author="{{{author}}}" ext="{{{ext}}}"> | ||
{{script}} | {{{script}}} | ||
</bms> | </bms> | ||
| Line 70: | Line 78: | ||
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. | ||
If your format is supported by Game Extracter, replace the line {{NoProgramSupport}} with {{ProgramSupportGameExtracter}}. Note that if Game Extracter supports a given format, its tag should always be either directly below MexCom's tag, if MexCom also supports that format, or it should be at the top of the list. | If your format is supported by Game Extracter, replace the line {{NoProgramSupport}} with {{ProgramSupportGameExtracter}}. Note that if Game Extracter supports a given format, its tag should always be either directly below MexCom's tag (it should be second on the list), if MexCom also supports that format, or it should be at the top of the list. | ||
If your format is supported by any other programs, list them in alphabetical order, and if they have pages on the WIKI, link the name to the corresponding page. For example, if my format is supported by a program called FooBar3000, and there is a page on the WIKI for that program, the link would look like [[FooBar3000]] (if the page name was the same as the name of the program). | If your format is supported by any other programs, list them in alphabetical order, and if they have pages on the WIKI, link the name to the corresponding page. For example, if my format is supported by a program called FooBar3000, and there is a page on the WIKI for that program, the link would look like [[FooBar3000]] (if the page name was the same as the name of the program). | ||
| Line 97: | Line 105: | ||
=== Games === | === Games === | ||
* [[Sample Game 1]] [[PAK|*.pak]] [[ZIP|*.zip]] | * [[Sample Game 1]] [[PAK|*.pak]] [[ZIP|*.zip]] | ||
<!-- | |||
Each game listed here should link to its own page. Before you do this, be absolutely sure that the game title is spelled correctly, etc. Also, each extension used by the given game for that format should link to its own page, as seen above. | |||
--> | |||
{{GRAFPageFooter}} | {{GRAFPageFooter}} | ||
[[Category:Complete Complete| ]] [[Category:Platform PC| ]] | [[Category:Complete Complete| ]] [[Category:Platform PC| ]] | ||
<!-- | |||
Categories are used for... what do you know... categorizing WIKI pages. There are a number of categories used on the WIKI (somewhere around 50, IIRC), but by the time your page is finished, it will only have between 7 to 10 categories listed in most cases, and you will have to manually list even fewer. The categories you should worry about are those concerning how complete the Format Specifications are, those concerning a BMS script, those concerning what platform the game(s) using the format are for, and those concerning whether the format uses compression/encryption. | |||
Keep in mind that all category tags should include the line {{subst:PAGENAME}} after the pipe character (|), e.g. [[Category:Category|{{subst:PAGENAME}}]]. After a page is saved, the WIKI automatically replaces this line with the page's name. In general, category tags should take the form [[Category:Cat Name Here|{{subst:PAGENAME}}]] | |||
The specification completion categories are fairly straightforward to use. If most of a file's format is unknown (and chances are therefore god that it can't be supported by MexCom), one should use the category Complete WIP, indicating that the format is a work in progress. If the format is reasonably complete (few unknown values), you should use the category Complete Almost Done, and if the format is completely known, you should use Complete Complete. | |||
More to come, I ran out of time. | |||
--> | |||
Revision as of 19:46, 20 January 2007
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