XML:File types

From OniGalore
Jump to: navigation, search
See Modding Oni for an introduction to modding.
Click to return to the main XML page.

Following is an overview of each of the 65 significant data types (43 basic, 16 OBJC, and 4 BINA) and 43 sub-types that they rely on.

Legend
Documentation status:
Aqua Dot-Green.png Available
Aqua Dot-Yellow.png Incomplete
Aqua Dot-Red.png Unavailable, see OBD docs
if you wish to mod the file type
Location:
vanilla: An un-modded retail copy of Oni
AE: The AE reorganizes some data
global: File(s) found in level0_Final
local: File(s) may be in level[1-19]_Final
both: File(s) may be in either place
Jump Table

A-BABNA, AGQC, AGQG,
AGQR, AISA, AKAA, AKBA,
AKBP, AKEV, AKOT, AKVA,
BINA

C-ECBPI, CBPM, CHAR,
CMBT, CONS, CONS (OBJC),
CRSA, DOOR, DOOR (OBJC),
DPge, ENVP

F-KFILM, FLAG, FURN,
HPge, IDXA, IGHH, IGPA,
IGPG, IGSA, IGSt, Impt,
IPge, KeyI

M-NM3GA, M3GM, MELE,
Mtrl, NEUT

OOBAN, OBJC, OBOA,
OFGA, ONCC, ONCP, ONCV,
ONGS, ONIA, ONIE, ONLD,
ONLV, ONOA, ONSK, ONVL,
ONWC, OPge, OSBD, OTIT,
OTLF

P-SPAR3, PART, PATR,
PLEA, PNTA, PSpc, PSpL,
PSUI, PWRU, QTNA, SABD,
SNDD, SNDG, StNA, SUBT

TTMBD, TRAC, TRAM,
TRAS, TRBS, TRCM, TRGA,
TRGE, TRGV, TRIA, TRIG,
TRIG (OBJC), TRMA, TRSC,
TRTA, TSFF, TSFL, TSFT,
TSGA, TURR, TURR (OBJC),
TXAN, TXCA, TXMA, TXMB,
TXMP, TxtC

V-WVCRA, WEAP, WMCL,
WMDD, WMM, WMMB, WPge

Tag Aqua Dot-Grey.png Name File name(s) Location (vanilla) Location (AE)
AISA Aqua Dot-Green.png AI Character Setup Array

AISAlevel##_scripts local local
This file type was probably in the process of being replaced by CHAR when Oni shipped, but it is still used for a few cutscene characters.
AKEV Aqua Dot-Yellow.png Akira Environment

AKEV... local local
It's the 3D level model. Many subtypes are used for the actual 3D data -- ABNA, AGDB, AGQG, AGQC, AGQR, AKAA, AKBA, AKBP, AKDA, AKOT (which in turn uses OTIT, OTLF, and QTNA), AKVA, IDXA, PLEA, PNTA, TXCA, and TXMA; these types do not have separate XML documentation because they export as a part of AKEV. Some of these types are also used by M3GM. This type exports as a Collada (.dae) file, meant to be edited in a 3D modeler like Mod Tool.
CONS Aqua Dot-Yellow.png Console

CONSconsole... global global
There are only three of these models for the consoles used in all of Oni, as documented in Console, though the picture (TXMP) displayed on a specific console varies.
DOOR Aqua Dot-Green.png Door

DOOR... global global
There are 48 types of doors, defined globally for use in the levels.
DPge Aqua Dot-Green.png Diary Page

DPgelev_##_pg_## global global
As seen in the Diary tab of the Pause screen. The actual text is in a linked IGPG (see OPge for more info; also used by HPge, IPge, and WPge). The diary page is used for both diary-style entries and move pages, which are both unlocked when reaching the level number contained in this data. When being used as a move page, the sequence of actions that produce the move can be conveyed with the use of icons (TXMPs provided by KeyI), however, this functionality is unused in Oni's existing data.
FILM Aqua Dot-Green.png Film

FILM... local local
A record of a character's movements, created by a developer recording his gameplay and played back in cutscenes to make an AI perform complex actions. During playback, AIs have no AI. ^_^
HPge Aqua Dot-Green.png Help Page

HPgehelp_pg_01 global global
The Help tab of the Pause screen labels the in-game UI and reminds the player of the controls (but only the default bindings, regardless of what the player is actually using...). The actual text is in a linked IGPG (also used by DPge, OPge, IPge, and WPge).
IGHH Aqua Dot-Green.png IGUI (In-Game User Interface) HUD Help

IGHHhud_help_info global global
The Help tab of the Pause screen labels the in-game UI using the text found here and the overlay textures it links to.
Impt Aqua Dot-Green.png Impact

Impt... global global
This file is used to build up the hierarchy of impacts. See BINA/ONIE for more information.
IPge Aqua Dot-Green.png Item Page

IPge... local local
As items are picked up, their Item Pages are displayed on the Items tab of the Pause screen. The actual text and image is found in a linked IGPG (see OPge for more info; also used by DPge, HPge, and WPge).
M3GM Aqua Dot-Green.png Geometry

M3GM... both both (more are global)
A basic unit of 3D geometry, used by anything that can have a physical shape, such as characters (TRBS), consoles (CONS), animated objects (OBAN) and particles (PAR3). The building blocks of the geometry are the types IDXA, PNTA, TXCA, VCRA (these are all exported under M3GM so do not have separate XML documentation), and the texture is provided by TXMP.
Mtrl Aqua Dot-Green.png Material

Mtrl... global global
These files is used to build up the hierarchy of materials. See BINA/ONIE for more information.
OBAN Aqua Dot-Green.png Object Animation

OBAN... both both
Yes, this is used to animate objects, but also characters and cutscene cameras. Uses OBOA (also used by ONLV) to store the physics settings, and the OBOA in turn uses an M3GA, which is an array of M3GMs, to store the actual geometry.
OFGA Aqua Dot-Green.png Object Furniture Geometry Array

OFGA... N/A N/A
Used to import objects with no functions. (Door, consoles, etc. get imported as object lists. See XML:ONLV for more information.)
ONCC Aqua Dot-Yellow.png Oni Character Class

ONCC... local global
Here a type of character (Konoko, Striker, etc.) is assigned its weapon skill, behavior ID, vision radius, jumping height, sounds, 3D model (TRBS), animation collection (TRAC), textures (TRMA), and much more. The XML file contains also the character's body part material (CBPM), body part impacts (CBPI), and particles for animations (ONCP and ONIA).)
ONCV Aqua Dot-Green.png Oni Character Variant

ONCV... global global
Used to create a pool of characters from which an AI can be randomly spawned, in order to create a natural variation in appearance. A flag in a CHAR determines which variant the character falls under. It can be also used to upgrade characters on the Hard difficulty level, also determined by a flag in the CHAR.)
ONGS Aqua Dot-Green.png Oni Game Settings

ONGSgame_settings global global
Here you can modify the game's health bar, hypo spray strength, game difficulty, autoprompts (text messages when picking up a new kind of item), etc.
ONLD Aqua Dot-Yellow.png Oni Game Level Descriptor

ONLDlevel_## global global
Contains the level's number, the number of the next level, and the level's name as it appears on the Load Game screen.
ONLV Aqua Dot-Yellow.png Oni Game Level

ONLV... local local
The top of the hierarchy when it comes to level data. Holds, among other things, the name of the BSL folder with the scripts for this level, and links to the environmental model (AKEV), animated objects (OBOA), the skybox (ONSK), and the AIs to spawn (well, the ones in AISA; the ones in CHAR need no link from here). These type links as well as the corpse array (CRSA), environmental particles (ENVP), and gunk data (ONOA) will be exported together in XML. ONLV also links to six obsolete types which will not be exported: AITR, OBDC, ONFA, ONMA, ONSA, and ONTA.
ONSK Aqua Dot-Green.png Oni Sky Class

ONSK... local global
It's essentially a box of textures that surrounds the level, so you will need five images for the top, north, east, south and west. The bottom has no image.
ONVL Aqua Dot-Green.png Oni Variant List

ONVLvariant_list global global
It's used to randomize characters' appearances in conjunction with ONCV.
ONWC Aqua Dot-Green.png Oni Weapon Class

ONWCw... global global
Describes the primary and secondary fire mode and more, and links to its particles (PAR3), a 3D model (M3GM), and textures (TXMP).
OPge Aqua Dot-Green.png Objective Page

OPgelevel_## local local
This is the wrapping type for the text that appears in the Objective tab of the Pause screen. The actual text is found by following the objective page's link to an IGPA (also used by TxtC), which is an array of IGPGs (also used by DPge, HPge, IPge, and WPge) which contain links to arrays of text strings (IGSA, which point to the individual strings, IGSt, which link to the font family, TSFF) and links to TXMPs for illustrations.
OSBD Aqua Dot-Yellow.png Oni Sound Binary Data

OSBD... global (but SNDDs are local) global (including SNDDs)
They determine how sounds (SNDD) get played.
PSpc Aqua Dot-Green.png Part Specification

PSpc... both both
Specifies coordinates in a certain TXMP which contains a collection of UI elements. The coordinates are used to cut out specific elements for use in drawing the windows in the game.
PSpL Aqua Dot-Red.png Part Specification List

PSpLpartspec_list global global
Links to the PSpc used for the plain-color background of a particular UI (the in-game UI uses black and the out-game UI uses transparency).
PSUI Aqua Dot-Red.png Part Specification UI

PSUIpsui_... global global
Specifies the PSpcs used to paint a certain style of UI. There are only two of these files in Oni, and only PSUIpsui_oniUI is actually used.
StNA Aqua Dot-Green.png String Array

StNA... global global
StNA files are obsolete. However, in the XML docs for it, you'll find collections of flags used by TRAM.
SUBT Aqua Dot-Green.png Subtitle Array

SUBT... global global
This is just here for informational purposes, because subtitle files are extracted to TXT files, not XML.
TRAC Aqua Dot-Green.png (Totoro) Animation Collection

TRAC... both global
Used to build a hierarchy of moves (TRAMs) which form a weighted moveset, based on which parent TRAC(s) a character's TRAC inherits from.
TRAM Aqua Dot-Yellow.png Totoro Animation Sequence

TRAM... both global
The core animation data for character moves. Exports to Collada (.dae) + XML. The XML file contains the animation's Oni-specific flags, links to particles, and so on.
TRAS Aqua Dot-Red.png Totoro Animation Sequence

TRAS... both global
The pose keyframes defined here are interpolated and overlaid on characters when they aim with weapons.
TRBS Aqua Dot-Green.png Totoro Body Set

TRBS... local global
The wrapping data for the 3D model of a character. Character classes (ONCCs) link to these. The 3D data can be imported/exported as Collada (.dae) files, but using the ONCC for this might be preferable so you get all related character data in XML on the side. The structure of the body at each individual detail level is found in the linked TRCM, which links to TRGA for the geometry of each body part, to TRTA for the relative location of each body part, and to TRIA for the hierarchical relationship of the body parts.
TRGE Aqua Dot-Green.png Trigger Emitter

TRGEtrigger_emitter_0 global global
This file links to the one 3D model (M3GM) used for all laser triggers. Used by TRIG.
TRIG Aqua Dot-Yellow.png Trigger

TRIG... global global
A laser trigger class.
TRMA Aqua Dot-Green.png Texture Map Array

TRMA... local global
The list of textures used for each body part of a certain character.
TRSC Aqua Dot-Red.png Screen (Aiming) Collection

TRSC... both global
Essentially just links to the TRAS of a character.
TURR Aqua Dot-Green.png Turret

TURR... global global
A class of turret. The actual geometry is in a linked M3GM.
TXMB Aqua Dot-Green.png Texture Map Big

TXMB... both both
A series of concatenated TXMPs, used for creating splash screens, like the Main Menu background and level intro/win/loss screens.
TXMP Aqua Dot-Green.png Texture Map

TXMP... both global except for textures used by specific levels
This type covers all images in Oni (except the ones larger than 256x256, which are built with TXMB). When a texture is animated, it will have a link to TXAN, which simply contains information about the animation; the actual image data is still in the TXMP.
TxtC Aqua Dot-Green.png Text Console

TxtClevel_... local local
The source of the text for a given console. The actual text is found by following the link to an IGPA (also used by OPge), which is an array of IGPG (also used by DPge, HPge, IPge, and WPge) that contains the actual text.
WMCL Aqua Dot-Red.png WM (Window Manager) Cursor List

WMCLcursor_list global global
Simply links to the PSpc which links to the image used for the mouse pointer that appears in Oni.
WMDD Aqua Dot-Green.png WM (Window Manager) Dialog Data

WMDD... global global
Describes the structure of screens like the Main Menu. Uses WMM for pop-up menus, and links to the desired font family (TSFF, also used by IGPG), which in turn links to the font language (TSFL) and the font itself (TSFT, which links to TSGA for the coordinates of each letter in the TSFT data); there is only one font to choose from, Tahoma. Because Oni's UI is partially hardcoded, adding new buttons would require engine modding.
WMM Aqua Dot-Green.png WM (Window Manager) Menu

WMM... global global
Drop-down menus used in WMDDs. This type is actually "WMM_", using the underscore in lieu of a fourth letter, but the wiki won't let us end a page in an underscore, so here we call it "WMM". Most of the WMMs, and the sole WMMB in Oni (a menu bar that uses WMM for its menus), are development relics.
WPge Aqua Dot-Green.png Weapon Page

WPgew... global global
This is the source for the text and images that appear in the Weapons tab of the Pause screen. The actual text and image is found in a linked IGPG (see OPge for more info; also used by DPge, HPge, and WPge).

BINA

Tag Aqua Dot-Grey.png Name File name(s) Location (vanilla) Location (AE)
BINA/ONIE Aqua Dot-Yellow.png Oni Impact Effects

BINAEINOimpact_effects global global
A list of all impact effects which can happen in the game. That includes weapon particles, hand-to-hand combat, and footsteps. The impact effect is selected according the type of impact (Impt) and the material (Mtrl) which is hit.
BINA/PAR3 Aqua Dot-Yellow.png Particle

BINA3RAP... global global
A type of particle which can be spawned in the game, used by weapons to deal damage, for lighting effects, etc. The list of the specific particles spawned in a certain level is a PART.
BINA/SABD Aqua Dot-Yellow.png Sound Animation

BINADBAS... global global
A list of the sounds to be played for an animation type. There is one of these for each character variant (ONCV).
BINA/TMBD Aqua Dot-Green.png Texture Materials

BINADBMTTextureMaterials global global
A list of the materials (Mtrl) assigned to each texture map (TXMP). Used by ONIE.

BINA/OBJC

Tag Aqua Dot-Grey.png Name File name(s) Location (vanilla) Location (AE)
BINA/OBJC/CHAR Aqua Dot-Yellow.png Characters

BINACJBOCharacter local local
List of characters in a specific level, containing their position, script function names, weapon, ammunition, items, team, combat, melee ID, etc.
BINA/OBJC/CMBT Aqua Dot-Yellow.png Combat

BINACJBOCombat global global
List of combat profiles for global use, containing conditions that govern the AI's melee, weapon combat, and retreat behavior, based on factors like distance and the enemy's reactions.
BINA/OBJC/CONS Aqua Dot-Green.png Consoles

BINACJBOConsole local local
List of consoles in a specific level, containing their position, script name (ID), screen images, and script function names. Consoles are used to open doors, trigger alarms, or provide information.
BINA/OBJC/DOOR Aqua Dot-Green.png Doors

BINACJBODoor local local
List of doors in a specific level, containing their conditions for when a door opens (e.g., is the action key required?), and what events are triggered by a character who opens the door.
BINA/OBJC/FLAG Aqua Dot-Green.png Flags

BINACJBOFlag local local
List of flags in a specific level, containing their position. Flags are used by level scripts and patrol paths.
BINA/OBJC/FURN Aqua Dot-Green.png Furniture

BINACJBOFurniture local local
List of pieces of furniture in a specific level. This file type can be used to import level objects.
BINA/OBJC/MELE Aqua Dot-Yellow.png Melee

BINACJBOMelee Profile global global
List of melee profiles for global use. A melee profile contains a simple program that determines how the AI uses its combat moves.
BINA/OBJC/NEUT Aqua Dot-Green.png Neutral

BINACJBONeutral local local
List of neutral character behaviors in a specific level. Every character has a melee, combat and neutral behavior ID. It determines whether a non-player character (NPC) talks to you and whether they give you a power-up.
BINA/OBJC/PART Aqua Dot-Green.png Particles

BINACJBOParticle local local
List of particles in a specific level, containing their position, script name and scaling.
BINA/OBJC/PATR Aqua Dot-Green.png Patrol Paths

BINACJBOPatrol Path local local
List of patrol paths in a specific level, containing an ID which is used by CHAR and the scripting command "ai2_dopath".
BINA/OBJC/PWRU Aqua Dot-Green.png PowerUps

BINACJBOPowerUp local local
List of power-ups (items, e.g. hypo sprays) in a specific level which are spawned at level load, containing their position.
BINA/OBJC/SNDG Aqua Dot-Green.png Sound Groups

BINACJBOSound local local
List of sound groups in a specific level. Sound groups are the invisible spheres which contain ambient sounds. If you come near a machine and you hear a sound, that's because of a sound group.
BINA/OBJC/TRGV Aqua Dot-Green.png Trigger Volumes

BINACJBOTrigger Volume local local
List of trigger volumes in a specific level. They are invisible areas which trigger functions in a script when entered.
BINA/OBJC/TRIG Aqua Dot-Green.png Triggers

BINAJCBOTrigger local local
List of laser triggers in a specific level. There are several forms of triggers, and they can trigger not only turrets (TURR), but also script functions in the level.
BINA/OBJC/TURR Aqua Dot-Green.png Turrets

BINACJBOTurret local local
List of turrets in a specific level. Note that their pods are part of the level geometry. Spawn one manually and it might be located somewhere in the air. Determines their head's position, the weapon inside the turret head, and the team ID to target.
BINA/OBJC/WEAP Aqua Dot-Green.png Weapons

BINACJBOWeapon local local
List of weapons in a specific level, determining their spawn location at level load.