Oni (folder)/GameDataFolder: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (→‎Overview: typo)
m (did TOCtest even have a "side" parameter?)
(14 intermediate revisions by one other user not shown)
Line 1: Line 1:
{|
{{TOCtest}}
|valign=top|__TOC__
'''GameDataFolder''' (commonly called "GDF") is a subfolder of the main Oni folder. It holds the following:
|valign=top|GameDataFolder (commonly called GDF to save on typing) is a subfolder of the main Oni folder.<br>It holds the following:
*Oni's game data (see [[OBD]] for more info)
*Oni's game content (in the form of [[dat|instance files]], see [[OBD]] for more info)
*the level logic (as scripts in the IGMD subfolder; see [[BSL]] for more info)
*the level logic of the [[Chapters]] (as [[scripts]] in the [[IGMD]] subfolder, see [[BSL]] for more info)
*the intro and outro animated sequences, in the Bink video format
*the [[intro]] and [[outro]] animated sequences, in the BINK video format
 
|}
==Overview==
==Overview==
Below we list the instance files in parallel with the folders (subfolders of [[IGMD]]) which hold the corresponding level logic. SPOILER WARNING: the Chapter column links to summaries and analyses of Oni's storyline. The BINK movies are listed separately.
You should have all the files in bold in your GameDataFolder, but the movie files, marked with the blue dot, are optional. Beside each set of level files, we list the subfolders of IGMD which hold the corresponding level logic. '''SPOILER WARNING''': The "Chapter" column links to summaries and analyses of Oni's storyline.


{|align="center"
{| border="1" cellpadding="5" cellspacing="0" style="margin-left:auto; margin-right:auto;"
|
!Legend
{|{{table}}
|+BINK videos
|[[:Category:Intro sequence|intro.bik]]
|opening animated sequence
|-
|-
|[[:Category:Outro sequence|outro.bik]]
|<center>[[Image:Aqua Dot-Red.png]] = needed to run Oni; [[Image:Aqua Dot-Blue.png]] = unneeded files</center>
|closing animated sequence
|}
|}
|}


{|align="center"
{| class="wikitable" style="margin-left:auto; margin-right:auto;" align=center
|
|+
{|{{table}}
!
|+subfolders
!Windows
|[[IGMD]]
!Mac
|level logic folder
|}
|}
 
{|align="center"
|
{|{{table}}
|+[[dat|instance files]]
{{th}}
!Instance file (PC)
!Instance file (Mac)
!Level logic folder
!Level logic folder
![[Chapters|Chapter]]
![[Chapters|Chapter]]
!Location (as in Load Game dialog)
!Location (as in Load Game dialog)
|-
|-
|valign=top|level0_Final.dat<br>level0_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level0_Final.dat<br>level0_Final.raw<br>level0_Final.sep
|colspan="2"|<center>'''[[IGMD|IGMD/]]'''</center>
|[[IGMD|IGMD]]\[[IGMD/global|global]]
| <center>--</center>
|colspan=2 align=center|"global": used in all Chapters (see note)
|colspan=2 align=center|Contains all level logic
|-
|-
|valign=top|level1_Final.dat<br>level1_Final.raw
|[[Image:Aqua Dot-Blue.png]]
|level1_Final.dat<br>level1_Final.raw<br>level1_Final.sep
|colspan="2"|<center>'''[[:Category:Intro sequence|intro.bik]]'''</center>
|[[IGMD|IGMD]]\[[IGMD/EnvWarehouse|EnvWarehouse]]
| <center>--</center>
|colspan=2 align=center|Movie plays when Oni is launched (see note below)
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level0_Final.dat<br>level0_Final.raw'''
|'''level0_Final.dat<br>level0_Final.raw<br>level0_Final.sep'''
|[[IGMD/global]]
|colspan=2 align=center|Used in all Chapters (see notes below on "level0_Final" and "IGMD/global")
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level1_Final.dat<br>level1_Final.raw'''
|'''level1_Final.dat<br>level1_Final.raw<br>level1_Final.sep'''
|[[IGMD/EnvWarehouse]]
|{{C|0|0: COMBAT TRAINING}}<br>{{C|1|1: TRIAL RUN}}
|{{C|0|0: COMBAT TRAINING}}<br>{{C|1|1: TRIAL RUN}}
|TCTF Training<br>Syndicate Warehouse
|TCTF Training<br>Syndicate Warehouse
|-
|-
|valign=top|level2_Final.dat<br>level2_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level2_Final.dat<br>level2_Final.raw<br>level2_Final.sep
|valign=top|'''level2_Final.dat<br>level2_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/manplant|manplant]]
|'''level2_Final.dat<br>level2_Final.raw<br>level2_Final.sep'''
|[[IGMD/manplant]]
|{{C|2|2: ENGINES OF EVIL}}
|{{C|2|2: ENGINES OF EVIL}}
|Manufacturing Plant
|Manufacturing Plant
|-
|-
|valign=top|level3_Final.dat<br>level3_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level3_Final.dat<br>level3_Final.raw<br>level3_Final.sep
|valign=top|'''level3_Final.dat<br>level3_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/lab|lab]]
|'''level3_Final.dat<br>level3_Final.raw<br>level3_Final.sep'''
|[[IGMD/lab]]
|{{C|3|3: PUZZLE PIECES}}
|{{C|3|3: PUZZLE PIECES}}
|Bio-Research Lab
|Bio-Research Lab
|-
|-
|valign=top|level4_Final.dat<br>level4_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level4_Final.dat<br>level4_Final.raw<br>level4_Final.sep
|valign=top|'''level4_Final.dat<br>level4_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/Airport|Airport]]
|'''level4_Final.dat<br>level4_Final.raw<br>level4_Final.sep'''
|[[IGMD/Airport]]
|{{C|4|4: TIGER BY THE TAIL}}
|{{C|4|4: TIGER BY THE TAIL}}
|Airport Assault
|Airport Assault
|-
|-
|valign=top|level6_Final.dat<br>level6_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level6_Final.dat<br>level6_Final.raw<br>level6_Final.sep
|valign=top|'''level6_Final.dat<br>level6_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/Airport_III|Airport_III]]
|'''level6_Final.dat<br>level6_Final.raw<br>level6_Final.sep'''
|[[IGMD/Airport_III]]
|{{C|5|5: HOT PURSUIT}}
|{{C|5|5: HOT PURSUIT}}
|Airport Cargo Hangars
|Airport Cargo Hangars
|-
|-
|valign=top|level8_Final.dat<br>level8_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level8_Final.dat<br>level8_Final.raw<br>level8_Final.sep
|valign=top|'''level8_Final.dat<br>level8_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/tctf|tctf]]
|'''level8_Final.dat<br>level8_Final.raw<br>level8_Final.sep'''
|[[IGMD/tctf]]
|{{C|6|6: COUNTERATTACK}}
|{{C|6|6: COUNTERATTACK}}
|TCTF Regional HQ
|TCTF Regional HQ
|-
|-
|valign=top|level9_Final.dat<br>level9_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level9_Final.dat<br>level9_Final.raw<br>level9_Final.sep
|valign=top|'''level9_Final.dat<br>level9_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/power|power]]
|'''level9_Final.dat<br>level9_Final.raw<br>level9_Final.sep'''
|[[IGMD/power]]
|{{C|7|7: A FRIEND IN NEED}}
|{{C|7|7: A FRIEND IN NEED}}
|Atmospheric Conversion Center (exterior)
|Atmospheric Conversion Center (exterior)
|-
|-
|valign=top|level10_Final.dat<br>level10_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level10_Final.dat<br>level10_Final.raw<br>level10_Final.sep
|valign=top|'''level10_Final.dat<br>level10_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/power_II|power_II]]
|'''level10_Final.dat<br>level10_Final.raw<br>level10_Final.sep'''
|[[IGMD/power_II]]
|{{C|8|8: AN INNOCENT LIFE}}
|{{C|8|8: AN INNOCENT LIFE}}
|Atmospheric Conversion Center (interior)
|Atmospheric Conversion Center (interior)
|-
|-
|valign=top|level11_Final.dat<br>level11_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level11_Final.dat<br>level11_Final.raw<br>level11_Final.sep
|valign=top|'''level11_Final.dat<br>level11_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/state|state]]
|'''level11_Final.dat<br>level11_Final.raw<br>level11_Final.sep'''
|[[IGMD/state]]
|{{C|9|9: TRUTH AND CONSEQUENCES}}
|{{C|9|9: TRUTH AND CONSEQUENCES}}
|Regional State Building
|Regional State Building
|-
|-
|valign=top|level12_Final.dat<br>level12_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level12_Final.dat<br>level12_Final.raw<br>level12_Final.sep
|valign=top|'''level12_Final.dat<br>level12_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/roof|roof]]
|'''level12_Final.dat<br>level12_Final.raw<br>level12_Final.sep'''
|[[IGMD/roof]]
|{{C|10|10: CAT AND MOUSE}}
|{{C|10|10: CAT AND MOUSE}}
|Rooftops
|Rooftops
|-
|-
|valign=top|level13_Final.dat<br>level13_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level13_Final.dat<br>level13_Final.raw<br>level13_Final.sep
|valign=top|'''level13_Final.dat<br>level13_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/dream_lab|dream_lab]]
|'''level13_Final.dat<br>level13_Final.raw<br>level13_Final.sep'''
|[[IGMD/dream_lab]]
|{{C|11|11: DREAM DIVER}}
|{{C|11|11: DREAM DIVER}}
|Doctor Hasegawa's Lab
|Doctor Hasegawa's Lab
|-
|-
|valign=top|level14_Final.dat<br>level14_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level14_Final.dat<br>level14_Final.raw<br>level14_Final.sep
|valign=top|'''level14_Final.dat<br>level14_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/neuro|neuro]]
|'''level14_Final.dat<br>level14_Final.raw<br>level14_Final.sep'''
|[[IGMD/neuro]]
|{{C|12|12: SINS OF THE FATHER}}
|{{C|12|12: SINS OF THE FATHER}}
|TCTF Science Prison
|TCTF Science Prison
|-
|-
|valign=top|level18_Final.dat<br>level18_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level18_Final.dat<br>level18_Final.raw<br>level18_Final.sep
|valign=top|'''level18_Final.dat<br>level18_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/tctf_ii|tctf_ii]]
|'''level18_Final.dat<br>level18_Final.raw<br>level18_Final.sep'''
|[[IGMD/tctf_ii]]
|{{C|13|13: PHOENIX RISING}}
|{{C|13|13: PHOENIX RISING}}
|TCTF Regional HQ (redux)
|TCTF Regional HQ (redux)
|-
|-
|valign=top|level19_Final.dat<br>level19_Final.raw
|[[Image:Aqua Dot-Red.png]]
|level19_Final.dat<br>level19_Final.raw<br>level19_Final.sep
|valign=top|'''level19_Final.dat<br>level19_Final.raw'''
|[[IGMD|IGMD]]\[[IGMD/compound|compound]]
|'''level19_Final.dat<br>level19_Final.raw<br>level19_Final.sep'''
|[[IGMD/compound]]
|{{C|14|14: DAWN OF THE CHRYSALIS}}
|{{C|14|14: DAWN OF THE CHRYSALIS}}
|Syndicate Mountain Compound
|Syndicate Mountain Compound
|}
|-
|[[Image:Aqua Dot-Blue.png]]
|colspan="2"|<center>'''[[:Category:Outro sequence|outro.bik]]'''</center>
| <center>--</center>
|colspan=2 align=center|Movie plays when Oni is beaten (see note below)
|}
|}


==Notes==
==Notes==
===level0_Final and IGMD\global===
===level0_Final===
IGMD\global\ is not present by default, but if it is created, any scripts placed in it will load for all levels; this works only with the PC retail engine: the Mac engines and the PC demo always ignore the global folder. The level0_Final instance file is only loaded once, when Oni starts.
The level 0 data is only loaded once, when Oni starts.
 
===IGMD/global===
IGMD/global/ is not present by default, but if it is created, the functions in any scripts placed inside it will be accessible from all levels; however, the Windows demo engine ignores the global/ folder.


===Movie files===
===Movie files===
The movie files are not needed for Oni to run. You can thus rename or move intro.bik out of GameDataFolder so Oni starts faster. You can also delete both files permanently and gain over 100 MB of hard disk space.
RAD Game Tools, the makers of the Bink video format, offer [http://www.radgametools.com/bnkdown.htm standalone apps] for all platforms if you want to watch the .bik files on their own. The movie files are not needed for Oni to run. You can thus rename or move intro.bik out of GameDataFolder so Oni starts faster.
 
===How Oni finds its GameDataFolder===
In Windows, Oni's engine first looks up GDF in the [[wikipedia:working directory|working directory]] (a.k.a. "."). If ".\GameDataFolder" is missing, Oni tries parent folders all the way up to the root (e.g., it looks for "C:\Program Files\Oni\GameDataFolder", then "C:\Program Files\GameDataFolder", then "C:\GameDataFolder"). As a last resort, it looks for ".\OniEngine\GameDataFolder" the same way.
 
The Mac Oni app follows the same search pattern for GameDataFolder/, but does not look for OniEngine/GameDataFolder/.


===Relative lookup paths of GameDataFolder===
[[Category:Game directory map]]
In Windows, Oni's engine first looks up GDF in the [[wikipedia:working directory|working directory]] (a.k.a. "."). If ".\GameDataFolder" is missing, Oni tries parent folders all the way up to ther root (i.e., it looks for "..\GameDataFolder", "..\..\GameDataFolder", etc). As a last resort, it looks for ".\OniEngine\GameDataFolder". Here are two examples.
*If Oni was installed into C:\Program Files\Oni and is called from that folder (e.g. by double-clicking the executable or the shortcut generated during installation), Oni will first look for "C:\Program Files\Oni\GameDataFolder". If it's missing, it will try "C:\Program Files\GameDataFolder", then "C:\GameDataFolder", and finally "C:\Program Files\Oni\OniEngine\GameDataFolder".
*Same as above, but with the [[AE|Edition]] installed. There is a folder called "C:\Program Files\Oni\edition", which holds  a working copy of GameDataFolder and scripts that "remotely" run Oni (the engine is still in "C:\Program Files\Oni"). If you double-click the scripts, the working directory is "C:\Program Files\Oni\edition", so Oni will first look for "C:\Program Files\Oni\edition\GameDataFolder", and if it's missing it will try "C:\Program Files\Oni\GameDataFolder", "C:\Program Files\GameDataFolder", "C:\GameDataFolder", and finally "C:\Program Files\Oni\edition\OniEngine\GameDataFolder"
Early versions of the [[Daodan DLL|C-Daodan]] discarded the notion of working directory and used the engine's directory instead; the feature will probably be brought back, for backwards compatibility.

Revision as of 21:40, 9 September 2020

Template:TOCtest GameDataFolder (commonly called "GDF") is a subfolder of the main Oni folder. It holds the following:

  • Oni's game data (see OBD for more info)
  • the level logic (as scripts in the IGMD subfolder; see BSL for more info)
  • the intro and outro animated sequences, in the Bink video format

Overview

You should have all the files in bold in your GameDataFolder, but the movie files, marked with the blue dot, are optional. Beside each set of level files, we list the subfolders of IGMD which hold the corresponding level logic. SPOILER WARNING: The "Chapter" column links to summaries and analyses of Oni's storyline.

Legend
Aqua Dot-Red.png = needed to run Oni; Aqua Dot-Blue.png = unneeded files
Windows Mac Level logic folder Chapter Location (as in Load Game dialog)
Aqua Dot-Red.png
IGMD/
--
Contains all level logic
Aqua Dot-Blue.png
intro.bik
--
Movie plays when Oni is launched (see note below)
Aqua Dot-Red.png level0_Final.dat
level0_Final.raw
level0_Final.dat
level0_Final.raw
level0_Final.sep
IGMD/global Used in all Chapters (see notes below on "level0_Final" and "IGMD/global")
Aqua Dot-Red.png level1_Final.dat
level1_Final.raw
level1_Final.dat
level1_Final.raw
level1_Final.sep
IGMD/EnvWarehouse 0: COMBAT TRAINING
1: TRIAL RUN
TCTF Training
Syndicate Warehouse
Aqua Dot-Red.png level2_Final.dat
level2_Final.raw
level2_Final.dat
level2_Final.raw
level2_Final.sep
IGMD/manplant 2: ENGINES OF EVIL Manufacturing Plant
Aqua Dot-Red.png level3_Final.dat
level3_Final.raw
level3_Final.dat
level3_Final.raw
level3_Final.sep
IGMD/lab 3: PUZZLE PIECES Bio-Research Lab
Aqua Dot-Red.png level4_Final.dat
level4_Final.raw
level4_Final.dat
level4_Final.raw
level4_Final.sep
IGMD/Airport 4: TIGER BY THE TAIL Airport Assault
Aqua Dot-Red.png level6_Final.dat
level6_Final.raw
level6_Final.dat
level6_Final.raw
level6_Final.sep
IGMD/Airport_III 5: HOT PURSUIT Airport Cargo Hangars
Aqua Dot-Red.png level8_Final.dat
level8_Final.raw
level8_Final.dat
level8_Final.raw
level8_Final.sep
IGMD/tctf 6: COUNTERATTACK TCTF Regional HQ
Aqua Dot-Red.png level9_Final.dat
level9_Final.raw
level9_Final.dat
level9_Final.raw
level9_Final.sep
IGMD/power 7: A FRIEND IN NEED Atmospheric Conversion Center (exterior)
Aqua Dot-Red.png level10_Final.dat
level10_Final.raw
level10_Final.dat
level10_Final.raw
level10_Final.sep
IGMD/power_II 8: AN INNOCENT LIFE Atmospheric Conversion Center (interior)
Aqua Dot-Red.png level11_Final.dat
level11_Final.raw
level11_Final.dat
level11_Final.raw
level11_Final.sep
IGMD/state 9: TRUTH AND CONSEQUENCES Regional State Building
Aqua Dot-Red.png level12_Final.dat
level12_Final.raw
level12_Final.dat
level12_Final.raw
level12_Final.sep
IGMD/roof 10: CAT AND MOUSE Rooftops
Aqua Dot-Red.png level13_Final.dat
level13_Final.raw
level13_Final.dat
level13_Final.raw
level13_Final.sep
IGMD/dream_lab 11: DREAM DIVER Doctor Hasegawa's Lab
Aqua Dot-Red.png level14_Final.dat
level14_Final.raw
level14_Final.dat
level14_Final.raw
level14_Final.sep
IGMD/neuro 12: SINS OF THE FATHER TCTF Science Prison
Aqua Dot-Red.png level18_Final.dat
level18_Final.raw
level18_Final.dat
level18_Final.raw
level18_Final.sep
IGMD/tctf_ii 13: PHOENIX RISING TCTF Regional HQ (redux)
Aqua Dot-Red.png level19_Final.dat
level19_Final.raw
level19_Final.dat
level19_Final.raw
level19_Final.sep
IGMD/compound 14: DAWN OF THE CHRYSALIS Syndicate Mountain Compound
Aqua Dot-Blue.png
outro.bik
--
Movie plays when Oni is beaten (see note below)

Notes

level0_Final

The level 0 data is only loaded once, when Oni starts.

IGMD/global

IGMD/global/ is not present by default, but if it is created, the functions in any scripts placed inside it will be accessible from all levels; however, the Windows demo engine ignores the global/ folder.

Movie files

RAD Game Tools, the makers of the Bink video format, offer standalone apps for all platforms if you want to watch the .bik files on their own. The movie files are not needed for Oni to run. You can thus rename or move intro.bik out of GameDataFolder so Oni starts faster.

How Oni finds its GameDataFolder

In Windows, Oni's engine first looks up GDF in the working directory (a.k.a. "."). If ".\GameDataFolder" is missing, Oni tries parent folders all the way up to the root (e.g., it looks for "C:\Program Files\Oni\GameDataFolder", then "C:\Program Files\GameDataFolder", then "C:\GameDataFolder"). As a last resort, it looks for ".\OniEngine\GameDataFolder" the same way.

The Mac Oni app follows the same search pattern for GameDataFolder/, but does not look for OniEngine/GameDataFolder/.