OniSplit: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (forgot, there's nothing there, changing link to his Talk page; also updating OS version num.)
m (updated version of OS on the MD)
Line 4: Line 4:
==Getting it==
==Getting it==
===Download links===
===Download links===
* Latest version of OniSplit: [http://mods.oni2.net/sites/default/files/OniSplit.exe_.zip v0.9.30]
* Latest version of OniSplit: [http://mods.oni2.net/sites/default/files/OniSplit.exe_.zip v0.9.34]


===Requirements===
===Requirements===

Revision as of 14:54, 19 December 2008

OniSplit, written by Neo, is an integral part of the Anniversary Edition and an essential modding tool on its own. It does the work of splitting and recombining Oni's data files. But it also does much more, such as extracting and creating textures, 3D and .xml files.

Getting it

Download links

  • Latest version of OniSplit: v0.9.34

Requirements

OniSplit requires .NET 2.0 for Windows and the Mono framework for Mac OS X.



Using it

The following actions are listed when calling OniSplit with the -help option (another informative option is -version)

The command line must be preceded by either OniSplit.exe (Windows) or mono OniSplit.exe (Mac OS)
If OniSplit.exe is not in the current folder, you can provide the full/relative path to it or set the path variable.
On the Mac, be sure to use / rather than \ in paths. The following instructions are for Windows by default.

Conversion between .dat and .oni

-export <target directory> <source file> Exports source file (.dat) to target directory
-import <source directory> <target file> Imports target file (.dat) from source directory; tries to get target file format from source SNDD
-import:sep <source directory> <target file> Imports target file (.dat) from source directory; uses .dat+.raw+.sep format (Mac and PC Demo)
-import:nosep <source directory> <target 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 anyway you like. The only exception is that a subdirectory named "noimport" or "_noimport" is always ignored.

Management of .oni files

Unless mentioned otherwise, the filename field supports wildcards ("*").

OniSplit consistently detects and manages "dependencies" of .oni files.
The dependencies of a file are looked up in its folder and subfolders.
-deps <filenames> Displays a list of .oni files that the specified .oni file depends on
-copy <target directory> <filenames> Copies .oni file and its dependencies to target; skips file if it already exists at destination
-move <target directory> <filenames> Moves an .oni file and its dependencies to target; skips file if it already exists at destination
-move:overwrite <target directory> <filenames> Moves an .oni file and its dependencies to target; overwrites any existing .oni files
-move:delete <target directory> <filenames> Moves an .oni file and its dependencies to target; 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 sorta tutorial.

-extract:dds <target directory> <filenames> Extracts all textures (TXMP) from a Oni .dat/.oni file in DDS format
-extract:tga <target directory> <filenames> Extracts all textures (TXMP) from a Oni .dat/.oni file in TGA format
-extract:png <target directory> <filenames> Extracts all textures (TXMP) from a Oni .dat/.oni file in PNG format
-create:txmp <targer directory> [-genmipmaps] [-nouwrap] [-novwrap]
[-format:bgr32|bgra32|bgr555|bgra5551|bgra4444|dxt1]
[-envmap:texture_name] <filename>
Creates .oni file in target directory from source image

The -extract commands can work with .oni files (a single file or several files, wildcards possible) or rip all the TXMP from a .dat file.

Models

M3GMs, ONWCs, ONCCs can be exported to the Wavefront .obj and COLLADA .dae formats. For details see HERE and HERE

-extract:obj <target directory> <filenames> Extracts all M3GM, ONWC and ONCC instances to Wavefront OBJ files
-extract:dae <target directory> <filenames> Extracts all M3GM, ONWC and ONCC instances to Collada files
-create:m3gm <target directory> [-tex:texture_name] <filename> Creates a TRBS .oni in target directory from an .obj file
-create:trbs <target directory> [-cel] [-normals] <filename> Creates a TRBS .oni in target directory from a .dae file

The generic -extract commands can work with .oni files (a single file or several files, wildcards possible) or rip all the TXMP from a .dat file.

TRBS and ONCC support additional -noanim and -anim options for -extract:dae, see HERE for details.
Imported geometry must only contain triangles. See HERE for additional options (e.g., cel-shading)

Levels

OniSplit can convert AKEV files (level geometry) and the associated file types to and from DAE format:

-extract:dae <target directory> <name of AKEV.oni source file> Extracts all AKEV and related instances to Collada files

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.

-create <target directory> -genmipmaps -format:dxt1 <source directory/>*.xml Converts all AKEV and related instances to .oni files

-import:nosep <source directory> <target file name>.dat The standard command for creating .dat/.raw files from .oni files (remember to use the import:sep option on Mac!)

Misc

Some more import/export functions, e.g., to rip sounds or rip/replace subtitles.

-extract:wav <target directory> <filenames> Rips all SNDD as .aif into target folder from source .dat or .oni
-extract:aif <target directory> <filenames> Rips all SNDD as .aif into target folder from source .dat or .oni
-extract:txt <target directory> <filenames> Rips all SUBT as .txt into target folder from source .dat or .oni
-create:subt <target directory> <filename> Creates a SUBT .oni file in target folder from a .txt file
XML

One of the latest features is conversion of an .oni file (binary) into an XML metafile and back. XML files are more explicit and more readily editable.

Currently xml export/import is limited to files that do not have raw/sep parts. 2-way conversion is known to work for CONS, DPge, HPge, IGHH, IPge, OBJC, ONCC, ONCV, ONLD, ONLV, ONGS, ONSK, ONVL, ONWC, OPge, PAR3, PSpc, PSpL, PSUI, TRAC, TRAM, TRIG, TRGE, TRMA, TXMB, TXMP, WMCL, WMDD, WMM_, WPge.
For detailed examples and tutorials, see HERE
-extract:xml <target directory> <filenames> Extracts all instances to XML files
-create <target directory> <filename> Creates an .oni file in the target directory from an XML file

BIG NOTE OF WARNING: some of the above instance types (most importantly ONWC) contain geometry data (M3GM) embedded in them. The geometry can round-trip through xml but versions of OniSplit up to and including 0.9.26 produce an invalid .oni file that may cause Oni to crash.