Item Placement: Difference between revisions
m (→External links: clean up,) |
(contributions from myself, Aschratt, LINK2012, Seemann, and Solom) |
||
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{IplSection | {{IplSection | ||
| noheader=1 | | noheader=1 | ||
}} | }} | ||
'''Item placement''' files, | '''Item placement''' files, usually identified by the file extension <code>.ipl</code>, are a part of the [[map system]] and used to create and place (for example) different objects, zones of special behaviour or paths in the world. All games support standard item placement files which are mostly stored in plain text format that can be opened and edited using any text-editing program (like [[Wikipedia:Notepad|Notepad]]), but there are tools to simplify editing. [[Grand Theft Auto: San Andreas|San Andreas]] is the first game to introduce a binary format for item placement files. Most of the placement information in [[Grand Theft Auto IV]] is stored inside of binary files (see [[WPL]]). | ||
== | == Overview == | ||
:''See also: [[Item Definition#Overview|Item Definition § Overview]]'' | |||
The structure and format of the plain text item placement files are similar to that of the [[Item Definition|item definition]] files. | |||
=== Binary format === | |||
''San Andreas'' introduced an simple binary format of item placement files. They are stored as ''"streaming files"'' inside the [[IMG Archive|archive files]]. Editing them requires an special editor (see [[IPL#Tools|below]]). The format is pretty simple and their possibilities are not completely used by ''Rockstar''. By default they do only support <code>inst</code> and <code>cars</code> sections. It is unconfirmed if other sections also can be used or if they are just stubs which are not implemented. Anyway their binary format is completely unknown. | |||
{{Incomplete}} | |||
<!--- How do binary IPLs get recognized by the game? ---> | |||
==== Header ==== | |||
Each binary placement information file starts with an 4-Byte identifier followed by a header containing information about the files content. | |||
4b - CHAR[4] - Always "bnry" | |||
4b - INT32 - Number of [[INST|item instances]] | |||
4b - INT32 - Number of unknown 1 (''CULL'' ?) | |||
4b - INT32 - Number of unknown 2 (''GRGE'' ?) | |||
4b - INT32 - Number of unknown 3 (''ENEX'' ?) | |||
4b - INT32 - Number of [[CARS (IPL Section)|parked cars]] | |||
4b - INT32 - Number of unknown 4 (''PICK'' ?) | |||
4b - INT32 - Offset of item instances (0x4C by default) | |||
4b - INT32 - Size of item instances (unused - always 0) | |||
4b - INT32 - Offset of unknown 1 | |||
4b - INT32 - Size of unknown 1 (unused - always 0) | |||
4b - INT32 - Offset of unknown 2 | |||
4b - INT32 - Size of unknown 2 (unused - always 0) | |||
4b - INT32 - Offset of unknown 3 | |||
4b - INT32 - Size of unknown 3 (unused - always 0) | |||
4b - INT32 - Offset of parked cars | |||
4b - INT32 - Size of parked cars (unused - always 0) | |||
4b - INT32 - Offset of unknown 4 | |||
4b - INT32 - Size of unknown 4 (unused - always 0) | |||
The header is followed by the arrays of the entries. For more information about their format see the articles about the sections. | |||
== Format == | |||
The following table contains all known sections in the item placement. The supported games column lists games that support the sections but it doesn't necessarily means they're functional in the games. Mouse over the game icons to see if the games are supported. | |||
{|class=" | {|class="mw-collapsible wikitable center-col-1 center-col-2" style="width: 100%;" | ||
! | !style="width: 7em;"|Section | ||
!style="width: 8em;"|Supported games | |||
!Description | !Description | ||
|- | |- | ||
|< | |<code>[[INST|inst]]</code>||{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Places objects defined in <code>[[OBJS|objs]]</code>, <code>[[TOBJ|tobj]]</code>, <code>[[ANIM|anim]]</code> or <code>[[TANM|tanm]]</code> into the world. | ||
| | |||
|< | |||
|- | |- | ||
|< | |<code>[[ZONE|zone]]</code>||{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates map, navigation, and info zones. | ||
|- | |- | ||
|< | |<code>[[CULL|cull]]</code>||{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates zones with special attributes. | ||
|- | |- | ||
|< | |<code>[[PICK|pick]]</code>||{{Icon|SA}}||Creates pickups. This section exists in GTA III, GTA Vice City, and GTA IV, but is only functional in GTA San Andreas. | ||
|- | |- | ||
| | |<code>[[PATH|path]]</code>||{{Icon|VC}}||Creates waypoints for random ''NPC'' spawns.<br>Note: this section is also present in ''San Andreas'' and ''GTA IV''. It is used as a base for ''Rockstar's'' paths compiler, but gets ignored by the games. For more information see: [[Paths]]. | ||
Creates | |||
''San Andreas | |||
|- | |- | ||
|< | |<code>[[OCCL|occl]]</code>||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates occlusion zones. | ||
|- | |- | ||
|< | |<code>[[MULT|mult]]</code>||||This section exists in GTA San Andreas and GTA IV but is not functional. | ||
|- | |- | ||
|< | |<code>[[GRGE|grge]]</code>||{{Icon|SA}} {{Icon|4}}||Creates garages. | ||
|- | |- | ||
|< | |<code>[[ENEX|enex]]</code>||{{Icon|SA}} {{Icon|4}}||Creates entry-exit markers. | ||
|- | |- | ||
|< | |<code>[[CARS (IPL Section)|cars]]</code>||{{Icon|SA}} {{Icon|4}}||Creates car generators (parked cars). | ||
|- | |- | ||
|< | |<code>[[JUMP|jump]]</code>||{{Icon|SA}}||Creates stunt jumps. This section exists in GTA IV but is not functional. | ||
|- | |- | ||
|< | |<code>[[TCYC|tcyc]]</code>||{{Icon|SA}} {{Icon|4}}||Creates time cycles modifiers. | ||
|- | |- | ||
|< | |<code>[[AUZO|auzo]]</code>||{{Icon|SA}}||Creates [[Audio stream|audio]] zones. This section exists in GTA IV but is not functional. | ||
|- | |- | ||
|< | |<code>[[MZON|mzon]]</code>||{{Icon|4}}||– | ||
|- | |- | ||
|< | |<code>[[VNOD|vnod]]</code>||{{Icon|4}}||Extended format of ''PATH'' – apparently only used for [[Multiplayer#GTA_4|multiplayer]] mode. | ||
|- | |- | ||
|< | |<code>[[LINK|link]]</code>||{{Icon|4}}||– | ||
|- | |- | ||
|< | |<code>[[BLOK|blok]]</code>||||This section exists in GTA IV but is apparently ignored by the game – appears to be used to allocate responsibilities during the development stage of ''GTA IV'', but also could be used to place [[Ped_Event|decision makers]]. | ||
|- | |- | ||
|< | |<code>[[MLO+|mlo+]]</code>||{{Icon|4}}||MLO placement – Used to place offsets for ''GTA IV's'' [[interior]]s. The ''interiors'' themselfes get placed inside the [[IDE]] file section <code>[[MLO|mlo]]</code>. | ||
|- | |- | ||
|< | |<code>[[2DFX (IPL Section)|2dfx]]</code>||{{Icon|4}}||Used to make many game effects, for example - Particle. | ||
|} | |||
|- | |- | ||
|< | |<code>[[LODM|lodm]]</code>||{{Icon|4}}||– | ||
|- | |- | ||
|< | |<code>[[SLOW|slow]]</code>||{{Icon|4}}||Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box. | ||
<!--|[[RTFX]]||{{Icon|4}}||–--> | |||
|} | |} | ||
=== | == Tools == | ||
=== | * [[KEd]], by JernejL | ||
* [[MEd]], by Tonywob | |||
* [http://www.gtaforums.com/index.php?showtopic=315944 IPL Helper], by Xmen | |||
* [http://www.gta.ocram-net.de/index_all.php?downloadsa=11 Binary (De-)Compiler], by ocram88 | |||
* [http://www.gtaforums.com/index.php?showtopic=429526 SA Binary IPL Exporter for 3DS Max], by Gforce | |||
== | == See also == | ||
* [[Item Definition|Item definition]] | |||
* [ | * [[WPL]] – Major ''GTA IV'' item placement file. | ||
== External links == | |||
[ | * [http://www.gtaforums.com/index.php?showtopic=118193 GTA3/VC Map File Documentation and Troubleshooting] - Topic by Opius covering general features of IPL files in GTA3 and GTA VC. | ||
[[ | * [http://www.gtaforums.com/index.php?showtopic=202532 GTA SA IPL Documentation] - Topic by [[User:spaceeinstein|spaceeinstein]] covering details of the IPL format in GTA SA. | ||
{{ | {{fdl}} | ||
{{3-navi}} | |||
{{VC-navi}} | |||
[[Category:Map Formats]] |
Latest revision as of 22:09, 22 July 2018
IPL Sections:
|
Item placement files, usually identified by the file extension .ipl
, are a part of the map system and used to create and place (for example) different objects, zones of special behaviour or paths in the world. All games support standard item placement files which are mostly stored in plain text format that can be opened and edited using any text-editing program (like Notepad), but there are tools to simplify editing. San Andreas is the first game to introduce a binary format for item placement files. Most of the placement information in Grand Theft Auto IV is stored inside of binary files (see WPL).
Overview
- See also: Item Definition § Overview
The structure and format of the plain text item placement files are similar to that of the item definition files.
Binary format
San Andreas introduced an simple binary format of item placement files. They are stored as "streaming files" inside the archive files. Editing them requires an special editor (see below). The format is pretty simple and their possibilities are not completely used by Rockstar. By default they do only support inst
and cars
sections. It is unconfirmed if other sections also can be used or if they are just stubs which are not implemented. Anyway their binary format is completely unknown.
Header
Each binary placement information file starts with an 4-Byte identifier followed by a header containing information about the files content.
4b - CHAR[4] - Always "bnry" 4b - INT32 - Number of item instances 4b - INT32 - Number of unknown 1 (CULL ?) 4b - INT32 - Number of unknown 2 (GRGE ?) 4b - INT32 - Number of unknown 3 (ENEX ?) 4b - INT32 - Number of parked cars 4b - INT32 - Number of unknown 4 (PICK ?) 4b - INT32 - Offset of item instances (0x4C by default) 4b - INT32 - Size of item instances (unused - always 0) 4b - INT32 - Offset of unknown 1 4b - INT32 - Size of unknown 1 (unused - always 0) 4b - INT32 - Offset of unknown 2 4b - INT32 - Size of unknown 2 (unused - always 0) 4b - INT32 - Offset of unknown 3 4b - INT32 - Size of unknown 3 (unused - always 0) 4b - INT32 - Offset of parked cars 4b - INT32 - Size of parked cars (unused - always 0) 4b - INT32 - Offset of unknown 4 4b - INT32 - Size of unknown 4 (unused - always 0)
The header is followed by the arrays of the entries. For more information about their format see the articles about the sections.
Format
The following table contains all known sections in the item placement. The supported games column lists games that support the sections but it doesn't necessarily means they're functional in the games. Mouse over the game icons to see if the games are supported.
Section | Supported games | Description |
---|---|---|
inst |
Places objects defined in objs , tobj , anim or tanm into the world.
| |
zone |
Creates map, navigation, and info zones. | |
cull |
Creates zones with special attributes. | |
pick |
Creates pickups. This section exists in GTA III, GTA Vice City, and GTA IV, but is only functional in GTA San Andreas. | |
path |
Creates waypoints for random NPC spawns. Note: this section is also present in San Andreas and GTA IV. It is used as a base for Rockstar's paths compiler, but gets ignored by the games. For more information see: Paths. | |
occl |
Creates occlusion zones. | |
mult |
This section exists in GTA San Andreas and GTA IV but is not functional. | |
grge |
Creates garages. | |
enex |
Creates entry-exit markers. | |
cars |
Creates car generators (parked cars). | |
jump |
Creates stunt jumps. This section exists in GTA IV but is not functional. | |
tcyc |
Creates time cycles modifiers. | |
auzo |
Creates audio zones. This section exists in GTA IV but is not functional. | |
mzon |
– | |
vnod |
Extended format of PATH – apparently only used for multiplayer mode. | |
link |
– | |
blok |
This section exists in GTA IV but is apparently ignored by the game – appears to be used to allocate responsibilities during the development stage of GTA IV, but also could be used to place decision makers. | |
mlo+ |
MLO placement – Used to place offsets for GTA IV's interiors. The interiors themselfes get placed inside the IDE file section mlo .
| |
2dfx |
Used to make many game effects, for example - Particle. | |
lodm |
– | |
slow |
Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box. |
Tools
- KEd, by JernejL
- MEd, by Tonywob
- IPL Helper, by Xmen
- Binary (De-)Compiler, by ocram88
- SA Binary IPL Exporter for 3DS Max, by Gforce
See also
- Item definition
- WPL – Major GTA IV item placement file.
External links
- GTA3/VC Map File Documentation and Troubleshooting - Topic by Opius covering general features of IPL files in GTA3 and GTA VC.
- GTA SA IPL Documentation - Topic by spaceeinstein covering details of the IPL format in GTA SA.
This page is licensed under the GNU Free Documentation Licence. This page has a separate license to the CC-BY-SA that applies to most of Grand Theft Wiki.
The full text of the GNU FDL v1.2 is here. Click the "History" button to see the full list of authors. See Grand Theft Wiki:Copyright for more detail on our copyright policy.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. See Grand Theft Wiki:Copyright for more information. |
|
|