Difference between revisions of "Gta.dat"

From GTAMods Wiki
Jump to navigation Jump to search
m (still testing)
(Added link to Collision File)
 
(28 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{lcfirst:PAGENAME}}}}
+
{{lowercase}} {{TocRight}}
 +
The '''gta*.dat''' file lists which files define the game map. It can be found in the game's <code>data</code> directory, and is known as <code>'''gta3.dat'''</code> in [[GTA III]], <code>'''gta_vc.dat'''</code> in [[Vice City]], and simply <code>'''gta.dat'''</code> in [[San Andreas]]. The same file format is also used for the <code>'''default.dat'''</code> file in the same directory.
  
This file lists which files define the game map. It can be found in the game's <code>data</code> directory, and is known as '''gta3.dat''' in GTA III, '''gta-vc.dat''' in GTA VC, and simply '''gta.dat''' in GTA SA. The same file format is also used for '''default.dat'''.
+
== Format ==
 
+
The files are in plain text format so they can be opened with any text editor (like [[wikipedia:Microsoft Notepad|Notepad]]). Line comments are indicated by the character <code>#</code> (number sign) and empty lines are allowed. They can be placed anywhere in the file. Since there are different types of files, a keyword is needed for each entry. Most entries use the following format, where the path is relative to the game's base directory:
==Format==
 
Each line links to a map file, unless it's empty or starts with a <code>#</code> (denoting a comment, which are ignored by the game). Since there are different types of files, a keyword is needed for each entry. Most entries use the following format, where the path is relative to the game's base directory:
 
 
  &lt;keyword&gt; &lt;path&gt;
 
  &lt;keyword&gt; &lt;path&gt;
  
 
Although the file itself is not split up into sections, entries are usually grouped by type and arranged in a special order according to the game's loading sequence:
 
Although the file itself is not split up into sections, entries are usually grouped by type and arranged in a special order according to the game's loading sequence:
# Archives (<code>IMG</code>)
+
{|class="wikitable center-col-2"
# Item Definitions (<code>IDE</code>)
+
!Keyword ||Games ||Description
# Collision Files (<code>COLLISION</code>)
+
|-
# Map Areas (<code>MAPZONE</code>, <code>IPL</code>)
+
|CDIMAGE ||{{Icon|3}} {{Icon|VC}} ||rowspan="2" |[[IMG archive]]
# Item Placements (<code>IPL</code>)
+
|-
 +
|IMG ||{{Icon|SA}} {{Icon|4}}
 +
|-
 +
|IMGLIST ||{{Icon|SA}} {{Icon|4}} ||[[Images.txt|Image list]]
 +
|-
 +
|WATER ||{{Icon|4}} ||[[Water_(GTA_4)|Water]]
 +
|-
 +
|IDE ||{{Icon|t}} {{Icon|4}} ||[[IDE]] item definitions
 +
|-
 +
|COLFILE ||{{Icon|t}} ||[[Collision File|Collisions]]
 +
|-
 +
|MAPZONE ||{{Icon|3}} ||rowspan="2" |[[Zone]] map areas and [[IPL]] item placements
 +
|-
 +
|IPL ||{{Icon|t}}
 +
|-
 +
|TEXDICTION ||{{Icon|t}} ||[[TXD|Texture dictionaries]]
 +
|-
 +
|MODELFILE ||{{Icon|t}} ||DFF [[Model file]]s
 +
|-
 +
|SPLASH ||{{Icon|t}} ||
 +
|-
 +
|HIERFILE ||{{Icon|t}} ||
 +
|}
  
==Keywords==
+
Since [[GTA IV]] has various subdirectories which need to be identified there are new identifiers at the start of the path. They identify the exact location relative to the executable file. Those are:
===IMG===
 
''GTA SA only''
 
  
These entries define additionally used [[archive]]s (other than the hardcoded ones).
+
platform:
 +
common:
  
 +
Internally they will be replaced with the internal directory description and appended to the installation directory of the game.
 
Example:
 
Example:
 +
platform:/DATA/MAPS/MANHAT/MANHAT12.IPL
 +
gets
 +
PC/DATA/MAPS/MANHAT/MANHAT12.IPL
 +
which finally is transformed to (e.g.)
 +
C:\Program Files\Rockstar Games\Grand Theft Auto 4\PC\DATA\MAPS\MANHAT\MANHAT12.IPL
 +
 +
== Keywords ==
 +
=== IMG and CDIMAGE ===
 +
''IMG: GTA SA only, CDIMAGE: GTA III and VC''
 +
 +
These entries define additionally used [[IMG archive]]s (other than the [[hardcoded]] ones). In SA, you can only define a maximum of five entries. Any more will crash the game. <code>CDIMAGE</code> is supported in GTA III and VC, though unused in the default data files.
 +
 +
Example (GTA SA):
 
  IMG DATA\PATHS\CARREC.IMG
 
  IMG DATA\PATHS\CARREC.IMG
 
  IMG DATA\SCRIPT\SCRIPT.IMG
 
  IMG DATA\SCRIPT\SCRIPT.IMG
 
  IMG MODELS\CUTSCENE.IMG
 
  IMG MODELS\CUTSCENE.IMG
  
===IDE===
+
=== IMGLIST ===
 +
''GTA 4''
 +
 
 +
These link to external [[Images.txt|image list]] files.
 +
 
 +
Example:
 +
IMGLIST common:/data/images.txt
 +
 
 +
''GTA SA''
 +
 
 +
This keyword can be added in GTA SA by using [https://gtaforums.com/topic/733982-fastman92-limit-adjuster/ fastman92-limit-adjuster].
 +
For that, you must configure <code>fastman92limitAdjuster_GTASA.ini</code> as below,
 +
 
 +
; Enable handling of IMGLIST keyword
 +
Enable handling of IMGLIST keyword = 1
 +
 
 +
Example:(gta.dat)
 +
IMGLIST DATA\IMAGES.TXT
 +
 
 +
Example:(IMAGES.TXT)
 +
anim\anim.img
 +
models\paths.img
 +
models\pedprops.img
 +
 
 +
Note: Works with GTA San Andreas v1.0 [US] HOODLUM No-CD Fixed EXE
 +
 
 +
=== WATER ===
 +
''GTA 4 only''
 +
 
 +
These link to external [[Water (GTA 4)|water]] plane placement files.
 +
 
 +
Example:
 +
WATER common:/DATA/WATER.DAT
 +
 
 +
The WATER identifier can hold more than one parameter. It is unconfirmed either this also works for other identifiers.
 +
 
 +
Example:
 +
WATER common:/DATA/WATER.DAT common:/DATA/WATERLOW.DAT
 +
 
 +
=== IDE ===
 
''GTA III, VC and SA''
 
''GTA III, VC and SA''
  
Line 33: Line 106:
 
  IDE DATA\MAPS\generic.IDE
 
  IDE DATA\MAPS\generic.IDE
  
===COLLISION===
+
=== HIERFILE ===
''GTA III and VC''
+
{{Incomplete}}
  
With these entries [[collision file]]s are defined. An additional parameter between keyword and path defines the map part they belong to. If this is 0, the col file is used by the whole map; a higher number (1 to 3) assigns it to one of GTA3's islands.
+
=== COLLISION ===
 +
''GTA III, VC and SA''
 +
 
 +
With these entries [[collision file]]s are defined. An additional parameter between keyword and path defines the map part they belong to. If this is 0, the col file is used by the whole map; a higher number (1 to 3) assigns it to one of the [[Zone|map zones]].
  
 
Example:
 
Example:
 
  COLFILE 0 MODELS\COLL\GENERIC.COL
 
  COLFILE 0 MODELS\COLL\GENERIC.COL
  
===IPL and MAPZONE===
+
=== IPL and MAPZONE ===
 
''GTA III, VC and SA''
 
''GTA III, VC and SA''
  
These keywords are used to link to [[IPL]]-style item placement and [[zone]] files. <code>MAPZONE</code> is only used in GTA3 and ''might'' be synonymous with <code>IPL</code>.
+
These keywords are used to link to [[IPL]]-style item placement and [[zone]] files. <code>MAPZONE</code> is only used in GTA3 and can only contain map zone data.
  
 
Example (GTA3):
 
Example (GTA3):
Line 57: Line 133:
 
  IPL DATA\MAPS\LA\LAn2.IPL
 
  IPL DATA\MAPS\LA\LAn2.IPL
  
===SPLASH===
+
=== TEXDICTION ===
 
''GTA III, VC and SA''
 
''GTA III, VC and SA''
  
These define the splash screens that appear while loading the map. The argument for these is '''not''' a path, but just the name (without extension) of a [[texture dictionary]] in the <code>txd</code> directory. Might be ignored, though.
+
These link to external, mostly generic [[texture dictionary|texture dictionaries]].
  
 
Example:
 
Example:
  SPLASH loadsc2
+
  TEXDICTION MODELS\GENERIC.TXD
  
===TEXDICTION===
+
=== MODELFILE ===
''GTA III and VC''
+
''GTA III, VC and SA''
  
These link to external, mostly generic [[texture dictionary|texture dictionaries]].
+
These link to external, mostly generic [[model file]]s.
  
 
Example:
 
Example:
  TEXDICTION MODELS\GENERIC.TXD
+
  MODELFILE MODELS\GENERIC\WHEELS.DFF
  
===MODELFILE===
+
=== SPLASH ===
''GTA III and VC''
+
''GTA III, VC and SA''
  
These link to external, mostly generic [[model file]]s.
+
These define the splash screens that appear while loading the map. The argument for these is '''not''' a path, but just the name (without extension) of a [[texture dictionary]] in the <code>models/txd</code> directory. Might be ignored, though.
  
 
Example:
 
Example:
  MODELFILE MODELS\GENERIC\WHEELS.DFF
+
  SPLASH loadsc2
 +
 
 +
=== EXIT ===
 +
''GTA III, VC and SA''
 +
 
 +
This command stops any further processing of the gta.dat file.
  
[[Category:Map Formats]][[Category:GTA 3]][[Category:GTA VC]][[Category:GTA SA]]
+
{{N|4|SA|VC|3}}
 +
[[Category:Map Formats]]

Latest revision as of 09:31, 5 October 2019

The gta*.dat file lists which files define the game map. It can be found in the game's data directory, and is known as gta3.dat in GTA III, gta_vc.dat in Vice City, and simply gta.dat in San Andreas. The same file format is also used for the default.dat file in the same directory.

Format

The files are in plain text format so they can be opened with any text editor (like Notepad). Line comments are indicated by the character # (number sign) and empty lines are allowed. They can be placed anywhere in the file. Since there are different types of files, a keyword is needed for each entry. Most entries use the following format, where the path is relative to the game's base directory:

<keyword> <path>

Although the file itself is not split up into sections, entries are usually grouped by type and arranged in a special order according to the game's loading sequence:

Keyword Games Description
CDIMAGE GTA III Vice City IMG archive
IMG San Andreas GTA IV
IMGLIST San Andreas GTA IV Image list
WATER GTA IV Water
IDE GTA III Vice City San Andreas GTA IV IDE item definitions
COLFILE GTA III Vice City San Andreas Collisions
MAPZONE GTA III Zone map areas and IPL item placements
IPL GTA III Vice City San Andreas
TEXDICTION GTA III Vice City San Andreas Texture dictionaries
MODELFILE GTA III Vice City San Andreas DFF Model files
SPLASH GTA III Vice City San Andreas
HIERFILE GTA III Vice City San Andreas

Since GTA IV has various subdirectories which need to be identified there are new identifiers at the start of the path. They identify the exact location relative to the executable file. Those are:

platform:
common:

Internally they will be replaced with the internal directory description and appended to the installation directory of the game. Example:

platform:/DATA/MAPS/MANHAT/MANHAT12.IPL 

gets

PC/DATA/MAPS/MANHAT/MANHAT12.IPL 

which finally is transformed to (e.g.)

C:\Program Files\Rockstar Games\Grand Theft Auto 4\PC\DATA\MAPS\MANHAT\MANHAT12.IPL

Keywords

IMG and CDIMAGE

IMG: GTA SA only, CDIMAGE: GTA III and VC

These entries define additionally used IMG archives (other than the hardcoded ones). In SA, you can only define a maximum of five entries. Any more will crash the game. CDIMAGE is supported in GTA III and VC, though unused in the default data files.

Example (GTA SA):

IMG DATA\PATHS\CARREC.IMG
IMG DATA\SCRIPT\SCRIPT.IMG
IMG MODELS\CUTSCENE.IMG

IMGLIST

GTA 4

These link to external image list files.

Example:

IMGLIST common:/data/images.txt

GTA SA

This keyword can be added in GTA SA by using fastman92-limit-adjuster. For that, you must configure fastman92limitAdjuster_GTASA.ini as below,

; Enable handling of IMGLIST keyword
Enable handling of IMGLIST keyword = 1

Example:(gta.dat)

IMGLIST DATA\IMAGES.TXT

Example:(IMAGES.TXT)

anim\anim.img
models\paths.img
models\pedprops.img

Note: Works with GTA San Andreas v1.0 [US] HOODLUM No-CD Fixed EXE

WATER

GTA 4 only

These link to external water plane placement files.

Example:

WATER common:/DATA/WATER.DAT

The WATER identifier can hold more than one parameter. It is unconfirmed either this also works for other identifiers.

Example:

WATER common:/DATA/WATER.DAT common:/DATA/WATERLOW.DAT

IDE

GTA III, VC and SA

These entries link to item definition files.

Example:

IDE DATA\MAPS\generic.IDE

HIERFILE

This section is incomplete. You can help by fixing and expanding it.

COLLISION

GTA III, VC and SA

With these entries collision files are defined. An additional parameter between keyword and path defines the map part they belong to. If this is 0, the col file is used by the whole map; a higher number (1 to 3) assigns it to one of the map zones.

Example:

COLFILE 0 MODELS\COLL\GENERIC.COL

IPL and MAPZONE

GTA III, VC and SA

These keywords are used to link to IPL-style item placement and zone files. MAPZONE is only used in GTA3 and can only contain map zone data.

Example (GTA3):

MAPZONE DATA\MAP.ZON
IPL DATA\GTA3.ZON

Example (GTA SA):

IPL DATA\MAP.ZON
IPL DATA\INFO.ZON

IPL DATA\MAPS\LA\LAn.IPL
IPL DATA\MAPS\LA\LAn2.IPL

TEXDICTION

GTA III, VC and SA

These link to external, mostly generic texture dictionaries.

Example:

TEXDICTION MODELS\GENERIC.TXD

MODELFILE

GTA III, VC and SA

These link to external, mostly generic model files.

Example:

MODELFILE MODELS\GENERIC\WHEELS.DFF

SPLASH

GTA III, VC and SA

These define the splash screens that appear while loading the map. The argument for these is not a path, but just the name (without extension) of a texture dictionary in the models/txd directory. Might be ignored, though.

Example:

SPLASH loadsc2

EXIT

GTA III, VC and SA

This command stops any further processing of the gta.dat file.