OniSplit: Difference between revisions

{{Hatnote|Before reading this page, it's a good idea to be familiar with basic Oni [[game data terminology]].}}

'''OniSplit''', written by [[User_talk:Neo|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 [[OBD|knowledge about Oni's game data]], and it is currently the community's main modding tool.

:''Subpages:'' [[/Change_log|Change log]] (past versions), [[/WIP|WIP notes]] (upcoming versions)

* Latest release of OniSplit: [http://mods.oni2.net/node/38 v0.9.99.2] ([https://websvn.illy.bz/browse/Oni2/OniSplit/ source code])

*Windows: [https://dotnet.microsoft.com/en-us/download/dotnet-framework .NET framework]

*macOS: [https://www.mono-project.com/download/stable/ Mono framework]

In Windows, there are several options through which you can use OniSplit - out of which it is recommended to get Vago and CMDer:

* [[Vago (tool)|Vago]] is a GUI for OniSplit which allows you to handle all general conversions, save your sessions as project files, input manual commands if needed, and more. The two downsides of it is that it doesn't support Blender yet, forcing the users input commands manually, which in turn are not stored upon ending the session.

* Command Prompt (cmd.exe). Windows' default command line interpreter; it's a very simple application that does not preserve a history of your commands from session to session.

* [https://cmder.app/ CMDer] is an excellent alternative to cmd.exe. It adds a context menu option to open the command line with the current directory set to the folder you right-click in, and it also stores your recently used commands after ending the session.

On Macs, the command line is accessed through /Applications/Utilities/Terminal.app (press Command-Space and type "terminal" to get there faster).

|'''Windows'''||<tt><span style="background:rgb(235,235,235); border-radius:0.33em; padding:0.15em">OniSplit.exe</span> <span style="background:rgb(175,175,255); border-radius:0.33em; padding:0.15em">-create:trbs</span> <span style="background:rgb(255,156,156); border-radius:0.33em; padding:0.15em">C:\Games\Oni\SomeFolder</span> <span style="background:rgb(175,175,255); border-radius:0.33em; padding:0.15em">-normals</span> <span style="background:rgb(156,255,156); border-radius:0.33em; padding:0.15em">C:\Games\Oni\Modding\TRBSMyNewChar.dae</span></tt>

|'''Mac'''||<tt><span style="background:rgb(235,235,235); border-radius:0.33em; padding:0.15em">mono OniSplit.exe</span> <span style="background:rgb(175,175,255); border-radius:0.33em; padding:0.15em">-create:trbs</span> <span style="background:rgb(255,156,156); border-radius:0.33em; padding:0.15em">/Games/Oni/SomeFolder</span> <span style="background:rgb(175,175,255); border-radius:0.33em; padding:0.15em">-normals</span> <span style="background:rgb(156,255,156); border-radius:0.33em; padding:0.15em">/Games/Oni/Modding/TRBSMyNewChar.dae</span></tt>

|<span style="background:rgb(235,235,235); border-radius:0.33em; padding:0.15em">'''Invocation'''</span>

|<span style="background:rgb(175,175,255); border-radius:0.33em; padding:0.15em">'''Option'''</span>||The command.

|<span style="background:rgb(255,156,156); border-radius:0.33em; padding:0.15em">'''Path to folder'''</span>||Whether destination or source, the path which is a folder comes first. <u>Use the full path to the folder (starting from "C:\", or "/" on Macs).</u>

|<span style="background:rgb(175,175,255); border-radius:0.33em; padding:0.15em">'''Option flags'''</span>||The flags that can optionally go with this command, separated by spaces.

|<span style="background:rgb(156,255,156); border-radius:0.33em; padding:0.15em">'''Path to file'''</span>||Whether destination or source, the path of the file comes second. <u>Use the full path to the file (starting from "C:\", or "/" on Macs).</u> One exception to this parameter being a file is when using <tt>-create</tt> to make a level, in which case this is where you supply the source folder.

  '''MyMac%''' mono OniSplit.exe -list My\ Mods\ \(In\ Progress\)/level5_Final.dat

|<code>-list <file name></code>||Lists the named resources contained in a .dat (see [[OBD:File types/Naming|HERE]] for info on unnamed resources)

Unless mentioned otherwise, source filenames support wildcards. See [[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.

|<code>-extract:dae <destination directory> [-noanim] <dat/oni file></code>||Extracts 3D data in .oni file (or all M3GM, ONWC and ONCC instances in a .dat) into Collada DAE 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. See [https://web.archive.org/web/20201127180431/http://oni.bungie.org/forum/viewtopic.php?id=1515 HERE] for details.