OniSplit
- Before reading this page, it's a good idea to be familiar with basic Oni game data terminology.
OniSplit, written by Neo, is an integral part of the Anniversary Edition and an essential modding tool on its own. It is a command line tool which can import and export almost all kinds of Oni game data, including textures, sound, 3D models, level geometry and combat animations. Its name comes from its original purpose, which was breaking Oni's level data files into individual resources. Later, the ability to convert those resources' data between Oni's format and standard file formats was added. OniSplit incorporates the latest knowledge about Oni's game data, and it is currently the community's main modding tool.
Getting it
Download links
- Latest release of OniSplit: v0.9.99.0 (source code)
- The current GUI for OniSplit is Vago. You should try the GUI to see if it does what you need before working with OniSplit on the command line.
Requirements
OniSplit requires .NET 2.0 in Windows and the Mono framework in macOS.
Workflow
OniSplit is used in up to four different stages when modding:
| OUT | Exporting - using the -export command, a level data file is broken into its component resources, .oni files. |
| Extracting - using the -extract commands, .oni files are converted to standard-format files that can be edited in various third-party programs. | |
| Creating - using the -create commands, standard-format files are converted into .oni files. | |
| Importing - using the -import command, a folder of .oni files is combined into a level data file. |
Note that "extracting" refers to a conversion from one format to another, but "exporting" only refers to the creation of .oni files from a .dat file. When exporting, no conversion or re-formatting is taking place; the data is simply being copied out of a .dat (any connected binary data in .raw/.sep files will be concatenated to the data from the .dat when making the .oni).
Beginner's tips
In Windows, you want to find the Command Prompt. The fastest way to get there is to bring up the "Run..." dialog with Windows+R, then type "cmd" and hit Enter.
On Macs, the command line is found in the Terminal app (/Applications/Utilities) (press Command-Spacebar and type "Terminal" to get there faster).
OniSplit syntax
The basic syntax is:
| Windows | OniSplit.exe -create:trbs C:\Games\Oni\SomeFolder -normals C:\Games\Oni\Modding\TRBSMyNewChar.dae |
| Mac | mono OniSplit.exe -create:trbs /Games/Oni/SomeFolder -normals /Games/Oni/Modding/TRBSMyNewChar.dae |
Here's how it breaks down:
| Invocation | Windows can refer to the program directly, but Macs use Mono to run the .NET app; note also that if OniSplit.exe is not in the Command Prompt/Terminal's current directory, you must provide the full path to it or set the path variable. |
| Option | The command. |
| Path to folder | Whether destination or source, the path which is a folder comes first. Use the full path to the folder (starting from "C:\", or "/" on Macs). |
| Option flags | The flags that can optionally go with this command, separated by spaces. |
| Path to file | Whether destination or source, the path of the file comes second. Use the full path to the file (starting from "C:\", or "/" on Macs). One exception to this parameter being a file is when using -create to make a level, in which case this is where you supply the source folder. |
CLI tips
- Command line interfaces (CLI) usually supply an auto-complete feature to save on typing. If you've typed enough of a file/folder name to identify it, press the Tab key and the rest should fill in. In Windows, you may not get the right path name autocompleted on the first try if there are multiple possible autocompletions based on the names in that directory, so keep pressing Tab to cycle through all possibilities. On Macs, if you have not typed enough of the name to narrow it down to a single autocompletion, you will hear an error sound. Double-tap Tab to see a list of possible autocompletions, then keep typing until you have narrowed it down to one of those and then hit Tab to fill in the rest of its name.
- Note that you can also drag files/folders into the window and the path will magically appear; in cases where you don't need to use a wildcard, this is the fastest way to build an OniSplit command.
Wildcards
Wildcards can be used to supply patterns to CLI programs. The wildcard is simply the * character. For instance:
OniSplit.exe -export:TRAM* <destination> <source .dat>
will export all the TRAMs in the source .dat into the destination folder. Using "TRAMKON*" would export all of Konoko's animations.
Spaces in paths
Command line interfaces (CLI) do not recognize spaces as a possible part of a path name because spaces are what separate the terms in your commands. The best course of action is to not use paths with spaces in their names! But if you must, you can use quotes to tell the CLI that a certain string is a single path:
C:\Games\Oni\>OniSplit.exe -list "My Mod Folder\level5_Final.dat"
This works in the Mac Terminal too, but you can also use the escape character, \. Also, other characters like ( need to be escaped as well if you do not use quotes:
MyMac:Oni username$ mono OniSplit.exe -list My\ Mods\ \(In\ Progress\)/level5_Final.dat
But as mentioned, the best practice is to not use any characters besides the alphabet and numbers. It makes your life simpler, and if you ask for help on the forum with a command, no one wants to have to read your long path with lots of spaces or escaped characters in it ;-)
Reading the commands below
- The following commands should be complete, but the current list can be obtained by calling OniSplit with the -help option. You should also use -version to make sure you're using the latest version, the number of which is given in the "Download links" section above.
- Sample usages are given after certain commands. These are in DOS style, so if you are on a Mac, simply flip the \s to /s and make "C:\" into a leading "/".
- Optional flags are listed in square brackets simply to indicate that they're optional; don't enter the brackets when typing a command.
Note that only the .dat file from a level's data files is mentioned. The .raw and .sep files will be accessed by OniSplit as necessary when working with the .dat file that you gave the name of.
Commands
Conversion between .dat and .oni
-list <file name> |
Lists the named resources contained in a .dat (see HERE for info on unnamed resources) |
-export <destination directory> <dat file> |
Breaks .dat file into .oni files |
-export:<pattern> <destination directory> <dat file> |
Exports named resource (wildcards also allowed) from .dat file |
-import <source directory> <new dat file> |
Compiles level files from source directory using the name you supply for the .dat file; tries to get target file format from source SNDD, but it's better to use the :sep or :nosep variants below |
To create level5_Final.dat/.raw[/.sep] from the files in MyNewLevel\: OniSplit.exe -import C:\Oni\MyNewLevel\ C:\Oni\GameDataFolder\level5_Final.dat
| |
-import:sep <source directory> <new dat file> |
Imports target file (.dat) from source directory; uses .dat/.raw/.sep format (Mac and PC Demo) |
-import:nosep <source directory> <new dat file> |
Imports target file (.dat) from source directory; uses .dat/.raw format (PC retail) |
- Note that -import will search subdirectories too. If you find having hundreds or thousand of files .oni in one directory to be unmanageable you can always group them in subdirectories any way you like. The only exception is that a subdirectory named "noimport" or "_noimport" is always ignored.
Management of .oni files
Sometimes you want to move some .oni files out of a larger folder of .onis. You could do this manually, but OniSpit knows which files depend on others. It will also look for those dependencies in subfolders beneath the level of the file you supply the name of. The filename field supports wildcards. This is mostly used by the AE Installer rather than modders themselves.
-deps <oni file> |
Displays a list of .oni files that the specified .oni file depends on |
-copy <destination directory> <oni file> |
Copies .oni file and its dependencies; skips file if it already exists at destination |
-move <destination directory> <oni file> |
Moves an .oni file and its dependencies; skips file if it already exists at destination |
-move:overwrite <destination directory> <oni file> |
Moves an .oni file and its dependencies; overwrites any existing .oni files |
-move:delete <destination directory> <oni file> |
Moves an .oni file and its dependencies; doesn't overwrite; deletes source files |
Conversion between .oni/.dat and 3rd party formats
Textures
Unless mentioned otherwise, source filenames support wildcards. See HERE for a detailed tutorial. The -extract commands can work with .oni files (a single file or several files if you use the wildcard), or rip all the TXMPs from a .dat file.
-extract:dds <destination directory> <dat/oni file> |
Extracts all textures (TXMP) from a Oni .dat/.oni file into DDS files |
-extract:tga <destination directory> <dat/oni file> |
Extracts all textures (TXMP) from a Oni .dat/.oni file into TGA files |
-extract:png <destination directory> <dat/oni file> |
Extracts all textures (TXMP) from a Oni .dat/.oni file into PNG files |
-create:txmp <destination directory>
|
Creates .oni file from image file (PNG, TGA, or DDS) |
Models
M3GMs, ONWCs, ONCCs can be exported to the Wavefront .obj and COLLADA .dae formats. For details see Importing character models and Importing weapon models. The generic -extract commands can work with .oni files (a single file, or several files if you use the wildcard), or rip all the TXMP from a .dat file. TRBS and ONCC support additional -noanim and -anim options for -extract:dae; see Importing character models for details. Imported geometry must only contain triangles.
-extract:obj <destination directory> <dat/oni file> |
Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Wavefront OBJ files |
-extract:dae <destination directory> [-noanim] <dat/oni file> |
Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Collada DAE files |
-create:m3gm <destination directory> [-tex:texture_name] <OBJ file> |
Creates a M3GM .oni from an .obj file |
-create:trbs <destination directory> [-cel] [-normals] <DAE file> |
Creates a TRBS .oni from a .dae file |
Note on -noanim parameter: Normally OniSplit exports the character with an idle animation. If you use -noanim the character is exported in "I" pose, also the pelvis has the coordinates x=0, y=0, z=0.
Levels
OniSplit can convert AKEV files (level geometry) and the associated file types to and from DAE format:
-extract:dae <destination directory> <AKEV.oni file> |
Extracts 3D data in AKEV and related resources from dependencies into Collada file |
The next two steps are used on a folder in which you have placed the DAE and XML-formatted instances of the required files, as well as textures in TGA format. See HERE for details.
-create <destination directory> |
Converts all AKEV and related instances to .oni files |
-import:nosep <source directory> |
The standard command for creating .dat/.raw files from .oni files (remember to use the import:sep option on Mac!) |
Sounds
The sounds in Windows Oni are stored in WAV format, and on Macs are stored in AIFF format. This also means creating each of your SNDD files in both formats in order to work on both platforms.
-extract:wav <destination directory> <dat/oni file> |
Rips sound data from an SNDD .oni file (or all SNDDs from a .dat) as .wav files |
-extract:aif <destination directory> <dat/oni file> |
Rips sound data from an SNDD .oni file (or all SNDDs from a .dat) as .aif files |
Text
-extract:txt <destination directory> <dat/oni file> |
Rips text data from a SUBT .oni file (or all SUBTs from a .dat) as .txt files |
-create:subt <destination directory> <TXT file> |
Creates a SUBT .oni file from a .txt file |
XML
One of the latest features is conversion of .oni files to and from an XML file, or an XML metafile and related 3rd-party format files. XML files are easier to read and edit.
- Currently XML export/import is limited to files that do not have raw/sep parts. 2-way conversion is known to work for BINA, CONS, DOOR, DPge, FILM, HPge, IGHH, IPge, M3GM, OBAN, ONCC, ONCV, ONLD, ONLV, ONGS, ONSK, ONVL, ONWC, OPge, OSBD, PSpc, PSpL, PSUI, TRAC, TRAM, TRIG, TRGE, TRMA, TRSC, TXMB, TXMP, WMCL, WMDD, WMM_, WPge.
- For detailed examples and tutorials, see HERE
- Currently XML export/import is limited to files that do not have raw/sep parts. 2-way conversion is known to work for BINA, CONS, DOOR, DPge, FILM, HPge, IGHH, IPge, M3GM, OBAN, ONCC, ONCV, ONLD, ONLV, ONGS, ONSK, ONVL, ONWC, OPge, OSBD, PSpc, PSpL, PSUI, TRAC, TRAM, TRIG, TRGE, TRMA, TRSC, TXMB, TXMP, WMCL, WMDD, WMM_, WPge.
-extract:xml <destination directory> <oni file> |
Extracts .oni file and all related resources to XML files and 3rd-party formats |
-create <destination directory> <XML file> |
Creates an .oni file from an XML file |