Oni (folder)/GameDataFolder: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (did TOCtest even have a "side" parameter?)
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==GameDataFolder==
{{TOCtest}}
(Default location on PC is '''C:\Program Files\Oni\GameDataFolder''')
'''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


This is where all of Oni's "game data" resources are stored.
==Overview==
===Movie files in BINK format===
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.
*'''intro.bik'''
*'''outro.bik'''
===Binary resources===
(This is for PC, Mac users please contribute)
*'''level0_Final.dat''' and '''level0_Final.raw''' - global binary resources
*'''level1_Final.dat''' and '''level1_Final.raw''' - binary resources for Chapters 0:COMBAT TRAINING and 1:TRIAL RUN
*'''level2_Final.dat''' and '''level2_Final.raw''' - binary resources for Chapter 2:ENGINES OF EVIL
*'''level3_Final.dat''' and '''level3_Final.raw''' - binary resources for Chapter 3:PUZZLE PIECES
*'''level4_Final.dat''' and '''level4_Final.raw''' - binary resources for Chapter 4:TIGER BY THE TAIL
*'''level6_Final.dat''' and '''level6_Final.raw''' - binary resources for Chapter 5:HOT PURSUIT
*'''level8_Final.dat''' and '''level8_Final.raw''' - binary resources for Chapter 6:COUNTERATTACK
*'''level9_Final.dat''' and '''level9_Final.raw''' - binary resources for Chapter 7:A FRIEND IN NEED
*'''level10_Final.dat''' and '''level10_Final.raw''' - binary resources for Chapter 8:AN INNOCENT LIFE
*'''level11_Final.dat''' and '''level11_Final.raw''' - binary resources for Chapter 9:TRUTH AND CONSEQUENCES
*'''level12_Final.dat''' and '''level12_Final.raw''' - binary resources for Chapter 10:CAT AND MOUSE
*'''level13_Final.dat''' and '''level13_Final.raw''' - binary resources for Chapter 11:DREAM DIVER
*'''level14_Final.dat''' and '''level14_Final.raw''' - binary resources for Chapter 12:SINS OF THE FATHER
*'''level18_Final.dat''' and '''level18_Final.raw''' - binary resources for Chapter 13:PHOENIX RISING
*'''level19_Final.dat''' and '''level19_Final.raw''' - binary resources for Chapter 14:DAWN OF THE CHRYSALIS
===Script folder===
A subfolder of '''GameDataFolder''' called '''IGMD'''.
The original contents is as follows :
====IGMD\EnvWarehouse====
Level logic for Chapters 0:COMBAT TRAINING and 1:TRIAL RUN
*warehouse_anim_scripts.bsl
*warehouse_cutscene.bsl
*warehouse_level_scripts.bsl
*warehouse_main.bsl
*warehouse_particles.bsl
*warehouse_train2.bsl
*warehouse_training_scripts.bsl
====IGMD\manplant====
Level logic for Chapter 2:ENGINES OF EVIL
*manplant_anim_scripts.bsl
*manplant_cutscene.bsl
*manplant_level_logic.bsl
*manplant_main.bsl
*particle_scripts.bsl
====IGMD\lab====
Level logic for Chapter 3:PUZZLE PIECES
*lab_cutscene.bsl
*lab_level_logic.bsl
*lab_main.bsl
*particle_scripts.bsl
====IGMD\Airport====
Level logic for Chapter 4:TIGER BY THE TAIL
*airport_cutscene.bsl
*airport_main.bsl
*airport1_level_logic.bsl
====IGMD\Airport_III====
Level logic for Chapter 5:HOT PURSUIT
*airport2_cutscene.bsl
*airport2_level_logic.bsl
*airport2_main.bsl
====IGMD\tctf====
Level logic for Chapter 6:COUNTERATTACK
*particle_scripts.bsl
*tctf_cutscene.bsl
*tctf_door_lock_lights.bsl
*tctf_main.bsl
*tctf_objectives.bsl
*tctf_spawn_syndicate.bsl
====IGMD\power====
Level logic for Chapter 7:A FRIEND IN NEED
*particle_scripts.bsl
*power_cutscene.bsl
*power_main.bsl
*power_objectives.bsl
*power_spawn.bsl
====IGMD\power_II====
Level logic for Chapter 8:AN INNOCENT LIFE
*particle_scripts.bsl
*power_II_main.bsl
*power2_spawn.bsl
*powerII_cutscene.bsl
====IGMD\state====
Level logic for Chapter 9:TRUTH AND CONSEQUENCES
*state_cutscene.bsl
*state_level_logic.bsl
*state_main.bsl
====IGMD\roof====
Level logic for Chapter 10:CAT AND MOUSE
*particle_scripts.bsl
*roof.bsl
*roof_cutscene.bsl
*roof_main.bsl
====IGMD\dream_lab====
Level logic for Chapter 11:DREAM DIVER
*dream_lab_cutscene.bsl
*dream_lab_logic.bsl
*dream_lab_main.bsl
*particle_scripts.bsl
====IGMD\neuro====
Level logic for Chapter 12:SINS OF THE FATHER
*neuro_cutscene.bsl
*neuro_level_logic.bsl
*neuro_main.bsl
*particle_scripts.bsl
====IGMD\tctf_ii====
Level logic for Chapter 13:PHOENIX RISING
*tctf_ii_cutscene.bsl
*roof_main.bsl
*tctf2.bsl
====IGMD\compound====
Level logic for Chapter 14:DAWN OF THE CHRYSALIS
*compound.bsl
*compound_cutscene.bsl
*compound_main.bsl
*particle_scripts.bsl


==Related links==
{| border="1" cellpadding="5" cellspacing="0" style="margin-left:auto; margin-right:auto;"
Check :
!Legend
*[[OBD:Oni_Binary_Data | Oni Binary Data]] for more info the .dat and .raw files
|-
*[[OSL:IGMD]] for more info on [[OSL:Scripts|scripts]] (.bsl files)
|<center>[[Image:Aqua Dot-Red.png]] = needed to run Oni; [[Image:Aqua Dot-Blue.png]] = unneeded files</center>
|}
 
{| class="wikitable" style="margin-left:auto; margin-right:auto;" align=center
|+
!
!Windows
!Mac
!Level logic folder
![[Chapters|Chapter]]
!Location (as in Load Game dialog)
|-
|[[Image:Aqua Dot-Red.png]]
|colspan="2"|<center>'''[[IGMD|IGMD/]]'''</center>
| <center>--</center>
|colspan=2 align=center|Contains all level logic
|-
|[[Image:Aqua Dot-Blue.png]]
|colspan="2"|<center>'''[[:Category:Intro sequence|intro.bik]]'''</center>
| <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}}
|TCTF Training<br>Syndicate Warehouse
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level2_Final.dat<br>level2_Final.raw'''
|'''level2_Final.dat<br>level2_Final.raw<br>level2_Final.sep'''
|[[IGMD/manplant]]
|{{C|2|2: ENGINES OF EVIL}}
|Manufacturing Plant
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level3_Final.dat<br>level3_Final.raw'''
|'''level3_Final.dat<br>level3_Final.raw<br>level3_Final.sep'''
|[[IGMD/lab]]
|{{C|3|3: PUZZLE PIECES}}
|Bio-Research Lab
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level4_Final.dat<br>level4_Final.raw'''
|'''level4_Final.dat<br>level4_Final.raw<br>level4_Final.sep'''
|[[IGMD/Airport]]
|{{C|4|4: TIGER BY THE TAIL}}
|Airport Assault
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level6_Final.dat<br>level6_Final.raw'''
|'''level6_Final.dat<br>level6_Final.raw<br>level6_Final.sep'''
|[[IGMD/Airport_III]]
|{{C|5|5: HOT PURSUIT}}
|Airport Cargo Hangars
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level8_Final.dat<br>level8_Final.raw'''
|'''level8_Final.dat<br>level8_Final.raw<br>level8_Final.sep'''
|[[IGMD/tctf]]
|{{C|6|6: COUNTERATTACK}}
|TCTF Regional HQ
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level9_Final.dat<br>level9_Final.raw'''
|'''level9_Final.dat<br>level9_Final.raw<br>level9_Final.sep'''
|[[IGMD/power]]
|{{C|7|7: A FRIEND IN NEED}}
|Atmospheric Conversion Center (exterior)
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level10_Final.dat<br>level10_Final.raw'''
|'''level10_Final.dat<br>level10_Final.raw<br>level10_Final.sep'''
|[[IGMD/power_II]]
|{{C|8|8: AN INNOCENT LIFE}}
|Atmospheric Conversion Center (interior)
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level11_Final.dat<br>level11_Final.raw'''
|'''level11_Final.dat<br>level11_Final.raw<br>level11_Final.sep'''
|[[IGMD/state]]
|{{C|9|9: TRUTH AND CONSEQUENCES}}
|Regional State Building
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level12_Final.dat<br>level12_Final.raw'''
|'''level12_Final.dat<br>level12_Final.raw<br>level12_Final.sep'''
|[[IGMD/roof]]
|{{C|10|10: CAT AND MOUSE}}
|Rooftops
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level13_Final.dat<br>level13_Final.raw'''
|'''level13_Final.dat<br>level13_Final.raw<br>level13_Final.sep'''
|[[IGMD/dream_lab]]
|{{C|11|11: DREAM DIVER}}
|Doctor Hasegawa's Lab
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level14_Final.dat<br>level14_Final.raw'''
|'''level14_Final.dat<br>level14_Final.raw<br>level14_Final.sep'''
|[[IGMD/neuro]]
|{{C|12|12: SINS OF THE FATHER}}
|TCTF Science Prison
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level18_Final.dat<br>level18_Final.raw'''
|'''level18_Final.dat<br>level18_Final.raw<br>level18_Final.sep'''
|[[IGMD/tctf_ii]]
|{{C|13|13: PHOENIX RISING}}
|TCTF Regional HQ (redux)
|-
|[[Image:Aqua Dot-Red.png]]
|valign=top|'''level19_Final.dat<br>level19_Final.raw'''
|'''level19_Final.dat<br>level19_Final.raw<br>level19_Final.sep'''
|[[IGMD/compound]]
|{{C|14|14: DAWN OF THE CHRYSALIS}}
|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==
===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 [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/.
 
[[Category:Game directory map]]

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/.