Jump to content

OniSplit: Difference between revisions

112 bytes added ,  27 May 2013
using code tag instead of tt for command list to help the eye break out the commands from the surrounding text
m (formatting)
(using code tag instead of tt for command list to help the eye break out the commands from the surrounding text)
Line 33: Line 33:
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.
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).
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===
===OniSplit syntax===
Line 96: Line 96:
! style="width:430px"|
! style="width:430px"|
|-
|-
|<tt>-list <file name></tt>||Lists the named resources contained in a .dat (see [[OBD:File_types/Named|HERE]] for info on unnamed resources)
|<code>-list <file name></code>||Lists the named resources contained in a .dat (see [[OBD:File_types/Named|HERE]] for info on unnamed resources)
|-
|-
|<tt>-export <destination directory> <dat file></tt>||Breaks .dat file into .oni files
|<code>-export <destination directory> <dat file></code>||Breaks .dat file into .oni files
|-
|-
|<tt>-export:<pattern> <destination directory> <dat file></tt>||Exports named resource (wildcards also allowed) from .dat file
|<code>-export:<pattern> <destination directory> <dat file></code>||Exports named resource (wildcards also allowed) from .dat file
|- valign="top"
|- valign="top"
|<tt>-import <source directory> <new dat file></tt>||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
|<code>-import <source directory> <new dat file></code>||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
|-
|-
|colspan="2"|<span style="padding-left:20px">To create level5_Final.dat/.raw[/.sep] from the files in MyNewLevel\: <code>OniSplit.exe -import C:\Oni\MyNewLevel\ C:\Oni\GameDataFolder\level5_Final.dat</code><span>
|colspan="2"|<span style="padding-left:20px">To create level5_Final.dat/.raw[/.sep] from the files in MyNewLevel\: <code>OniSplit.exe -import C:\Oni\MyNewLevel\ C:\Oni\GameDataFolder\level5_Final.dat</code><span>
|-
|-
|<tt>-import:sep <source directory> <new dat file></tt>||Imports target file (.dat) from source directory; uses .dat/.raw/.sep format (Mac and PC Demo)
|<code>-import:sep <source directory> <new dat file></code>||Imports target file (.dat) from source directory; uses .dat/.raw/.sep format (Mac and PC Demo)
|-
|-
|<tt>-import:nosep <source directory> <new dat file></tt>||Imports target file (.dat) from source directory; uses .dat/.raw format (PC retail)
|<code>-import:nosep <source directory> <new dat file></code>||Imports target file (.dat) from source directory; uses .dat/.raw format (PC retail)
|}
|}
:Note that <tt>-import</tt> 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.
:Note that <tt>-import</tt> 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.
Line 115: Line 115:
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.
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.
{|
{|
|<tt>-deps <oni file></tt>||Displays a list of .oni files that the specified .oni file depends on
|<code>-deps <oni file></code>||Displays a list of .oni files that the specified .oni file depends on
|-
|-
|<tt>-copy <destination directory> <oni file></tt>||Copies .oni file and its dependencies; skips file if it already exists at destination
|<code>-copy <destination directory> <oni file></code>||Copies .oni file and its dependencies; skips file if it already exists at destination
|-
|-
|<tt>-move <destination directory> <oni file></tt>||Moves an .oni file and its dependencies; skips file if it already exists at destination
|<code>-move <destination directory> <oni file></code>||Moves an .oni file and its dependencies; skips file if it already exists at destination
|-
|-
|<tt>-move:overwrite <destination directory> <oni file></tt>||Moves an .oni file and its dependencies; overwrites any existing .oni files
|<code>-move:overwrite <destination directory> <oni file></code>||Moves an .oni file and its dependencies; overwrites any existing .oni files
|-
|-
|<tt>-move:delete <destination directory> <oni file></tt>||Moves an .oni file and its dependencies; doesn't overwrite; deletes source files
|<code>-move:delete <destination directory> <oni file></code>||Moves an .oni file and its dependencies; doesn't overwrite; deletes source files
|}
|}


Line 130: Line 130:
Unless mentioned otherwise, source filenames support wildcards. See [[AE:Modifying textures|HERE]] for a detailed tutorial. The <tt>-extract</tt> 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.
Unless mentioned otherwise, source filenames support wildcards. See [[AE:Modifying textures|HERE]] for a detailed tutorial. The <tt>-extract</tt> 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.
{|
{|
|<tt>-extract:dds <destination directory> <dat/oni file></tt>||Extracts all textures (TXMP) from a Oni .dat/.oni file into DDS files
|<code>-extract:dds <destination directory> <dat/oni file></code>||Extracts all textures (TXMP) from a Oni .dat/.oni file into DDS files
|-
|-
|<tt>-extract:tga <destination directory> <dat/oni file></tt>||Extracts all textures (TXMP) from a Oni .dat/.oni file into TGA files
|<code>-extract:tga <destination directory> <dat/oni file></code>||Extracts all textures (TXMP) from a Oni .dat/.oni file into TGA files
|-
|-
|<tt>-extract:png <destination directory> <dat/oni file></tt>||Extracts all textures (TXMP) from a Oni .dat/.oni file into PNG files
|<code>-extract:png <destination directory> <dat/oni file></code>||Extracts all textures (TXMP) from a Oni .dat/.oni file into PNG files
|-
|-
|<tt>-create:txmp <destination directory><br>[-genmipmaps] [-nouwrap] [-novwrap]<br><nowiki>[-format:bgr32|bgra32|bgr555|bgra5551|bgra4444|dxt1]</nowiki><br>[-envmap:texture_name] <image file></tt>
|<code>-create:txmp <destination directory><br>[-genmipmaps] [-nouwrap] [-novwrap]<br><nowiki>[-format:bgr32|bgra32|bgr555|bgra5551|bgra4444|dxt1]</nowiki><br>[-envmap:texture_name] <image file></code>
|valign=top|Creates .oni file from image file (PNG, TGA, or DDS)
|valign=top|Creates .oni file from image file (PNG, TGA, or DDS)
|}
|}
Line 145: Line 145:
! style="width:540px"|
! style="width:540px"|
|- valign="top"
|- valign="top"
|<tt>-extract:obj <destination directory> <dat/oni file></tt>||Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Wavefront OBJ files
|<code>-extract:obj <destination directory> <dat/oni file></code>||Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Wavefront OBJ files
|- valign="top"
|- valign="top"
|<tt>-extract:dae <destination directory> <dat/oni file></tt>||Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Collada DAE files
|<code>-extract:dae <destination directory> <dat/oni file></code>||Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Collada DAE files
|-
|-
|<tt>-create:m3gm <destination directory> [-tex:texture_name] <OBJ file></tt>||Creates a M3GM .oni from an .obj file
|<code>-create:m3gm <destination directory> [-tex:texture_name] <OBJ file></code>||Creates a M3GM .oni from an .obj file
|-
|-
|<tt>-create:trbs <destination directory> [-cel] [-normals] <DAE file></tt>||Creates a TRBS .oni from a .dae file
|<code>-create:trbs <destination directory> [-cel] [-normals] <DAE file></code>||Creates a TRBS .oni from a .dae file
|}
|}


Line 157: Line 157:
OniSplit can convert AKEV files (level geometry) and the associated file types to and from DAE format:
OniSplit can convert AKEV files (level geometry) and the associated file types to and from DAE format:
{|
{|
|<tt>-extract:dae <destination directory> <AKEV.oni file></tt>||Extracts 3D data in AKEV and related resources from dependencies into Collada file
|<code>-extract:dae <destination directory> <AKEV.oni file></code>||Extracts 3D data in AKEV and related resources from dependencies into Collada file
|}
|}


Line 164: Line 164:
{|
{|
|- valign="top"
|- valign="top"
|<tt>-create <destination directory><br>[-genmipmaps] [-format:dxt1]<br><source directory></tt>||Converts all AKEV and related instances to .oni files
|<code>-create <destination directory><br>[-genmipmaps] [-format:dxt1]<br><source directory></code>||Converts all AKEV and related instances to .oni files
|- valign="top"
|- valign="top"
|<tt>-import:nosep <source directory><br><target file name>.dat</tt>||The standard command for creating .dat/.raw files from .oni files (remember to use the import:sep option on Mac!)
|<code>-import:nosep <source directory><br><target file name>.dat</code>||The standard command for creating .dat/.raw files from .oni files (remember to use the import:sep option on Mac!)
|}
|}


Line 172: Line 172:
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.
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.
{|
{|
|<tt>-extract:wav <destination directory> <dat/oni file></tt>||Rips sound data from an SNDD .oni file (or all SNDDs from a .dat) as .wav files
|<code>-extract:wav <destination directory> <dat/oni file></code>||Rips sound data from an SNDD .oni file (or all SNDDs from a .dat) as .wav files
|-
|-
|<tt>-extract:aif <destination directory> <dat/oni file></tt>||Rips sound data from an SNDD .oni file (or all SNDDs from a .dat) as .aif files
|<code>-extract:aif <destination directory> <dat/oni file></code>||Rips sound data from an SNDD .oni file (or all SNDDs from a .dat) as .aif files
|}
|}


====Text====
====Text====
{|
{|
|<tt>-extract:txt <destination directory> <dat/oni file></tt>||Rips text data from a SUBT .oni file (or all SUBTs from a .dat) as .txt files
|<code>-extract:txt <destination directory> <dat/oni file></code>||Rips text data from a SUBT .oni file (or all SUBTs from a .dat) as .txt files
|-
|-
|<tt>-create:subt <destination directory> <TXT file></tt>||Creates a SUBT .oni file from a .txt file
|<code>-create:subt <destination directory> <TXT file></code>||Creates a SUBT .oni file from a .txt file
|}
|}


Line 189: Line 189:
:::For detailed examples and tutorials, see [[XML|HERE]]
:::For detailed examples and tutorials, see [[XML|HERE]]
{|
{|
|<tt>-extract:xml <destination directory> <oni file></tt>||Extracts .oni file and all related resources to XML files and 3rd-party formats
|<code>-extract:xml <destination directory> <oni file></code>||Extracts .oni file and all related resources to XML files and 3rd-party formats
|-
|-
|<tt>-create <destination directory> <XML file></tt>||Creates an .oni file from an XML file
|<code>-create <destination directory> <XML file></code>||Creates an .oni file from an XML file
|}
|}


[[Category:Completed modding tools]][[Category:Bi-platform modding tools]]
[[Category:Completed modding tools]][[Category:Bi-platform modding tools]]