OniSplit: Difference between revisions

m
improved wording on command line apps
m (.NET 2.0 links died; let's just link to the main download page)
m (improved wording on command line apps)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{update|This article contains links to the now defunct Oni Central Forum. Sections: Commands -> Levels}}
{{TOCfloat|side=right}}
{{TOCfloat|side=right}}
:''Before reading this page, it's a good idea to be familiar with basic Oni [[game data terminology]].''
{{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.


'''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)


==Getting it==
==Getting it==
===Download links===
===Download links===
* Latest release of OniSplit: [http://mods.oni2.net/node/38 v0.9.99.2] ([http://websvn.illy.bz/dl.php?repname=Oni2&path=%2FOniSplit%2F&isdir=1 source code])
* Latest release of OniSplit: [http://mods.oni2.net/node/38 v0.9.99.2] ([https://websvn.illy.bz/browse/Oni2/OniSplit/ source code])
* The current GUI for OniSplit is [[Vago (tool)|Vago]]. '''You should try the GUI to see if it does what you need before working with OniSplit on the command line.'''
* The current GUI for OniSplit is [[Vago (tool)|Vago]]. '''You should try the GUI to see if it does what you need before working with OniSplit on the command line.'''


===Requirements===
===Requirements===
*Windows: [https://dotnet.microsoft.com/download/dotnet-framework .NET framework]
*Windows: [https://dotnet.microsoft.com/en-us/download/dotnet-framework .NET framework]
*macOS: [https://www.mono-project.com/download/stable/ Mono framework]
*macOS: [https://www.mono-project.com/download/stable/ Mono framework]


Line 31: Line 33:
==Beginner's tips==
==Beginner's tips==
{{Divhide|show=yes|For users new to the command line or to OniSplit}}
{{Divhide|show=yes|For users new to the command line or to OniSplit}}
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, 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 found in the Terminal app (/Applications/Utilities) (press Command-Spacebar and type "Terminal" to get there faster).
On Macs, the command line is accessed through /Applications/Utilities/Terminal.app (press Command-Space and type "terminal" to get there faster).


===OniSplit syntax===
===OniSplit syntax===
Line 96: Line 101:
! style="width:430px"|
! style="width:430px"|
|-
|-
|<code>-list <file name></code>||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/Naming|HERE]] for info on unnamed resources)
|-
|-
|<code>-export <destination directory> <dat file></code>||Breaks .dat file into .oni files
|<code>-export <destination directory> <dat file></code>||Breaks .dat file into .oni files
Line 163: Line 168:




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 [http://oni.bungie.org/forum/viewtopic.php?id=1515 HERE] for details.
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.
{|
{|
|- valign="top"
|- valign="top"
Line 195: Line 200:
|<code>-create <destination directory> <XML file></code>||Creates an .oni file from an XML file
|<code>-create <destination directory> <XML file></code>||Creates an .oni file from an XML file
|}
|}
====Blender support====
[[Blender]] by default has a number of issues with most of Oni's assets, however, OniSplit allows exporting them to Blender-readable files with the <tt>-blender</tt> flag.
For more detailed information on how to use the <tt>-blender</tt> flag, please check [[Importing_character_models#Blender-specific_OniSplit_information|Blender specific OniSplit information]].


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