OniSplit: Difference between revisions

2,279 bytes added ,  26 May 2013
explaining syntax a bit better, more changes coming; updating links for .NET and Mono downloads
m (link fixes)
(explaining syntax a bit better, more changes coming; updating links for .NET and Mono downloads)
Line 9: Line 9:
OniSplit requires .NET 2.0 for Windows and the Mono framework for Mac OS X.
OniSplit requires .NET 2.0 for Windows and the Mono framework for Mac OS X.


* [http://www.microsoft.com/downloads/details.aspx?familyid=0856eacb-4362-4b0d-8edd-aab15c5e04f5&displaylang=en .NET 2.0]
* [http://download.microsoft.com/download/c/6/e/c6e88215-0178-4c6c-b5f3-158ff77b1f38/NetFx20SP2_x86.exe .NET 2.0 (x86)]; [http://download.microsoft.com/download/c/6/e/c6e88215-0178-4c6c-b5f3-158ff77b1f38/NetFx20SP2_x64.exe .NET 2.0 (x64)]
* [http://www.go-mono.com/mono-downloads/download.html Latest version of mono (requires OS X 10.4+)]
* [http://www.go-mono.com/mono-downloads/download.html Latest version of mono (requires OS X 10.5+)]
* [http://edt.oni2.net/AE/MonoFramework10.3.dmg Mono for OS X 10.3]


==Using it==
OniSplit is used in up to four different stages when modding:
# Exporting - using the -export command, a [[Dat|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.
The basic syntax is:
{|
|-
|'''Windows'''||<tt><span style="background:rgb(235,235,235); border-radius:0.33em;">OniSplit.exe</span> <span style="background:rgb(175,175,255); border-radius:0.33em;">-create</span> <span style="background:rgb(255,156,156); border-radius:0.33em;">C:\Games\Oni\SomeFolder</span> <span style="background:rgb(175,175,255); border-radius:0.33em;">-genmipmaps</span> <span style="background:rgb(156,255,156); border-radius:0.33em;">C:\Games\Oni\GameDataFolder\level1_Final.dat</span></tt>
|-
|'''Mac'''||<tt><span style="background:rgb(235,235,235); border-radius:0.33em;">mono OniSplit.exe</span> <span style="background:rgb(175,175,255); border-radius:0.33em;">-create</span> <span style="background:rgb(255,156,156); border-radius:0.33em;">/Games/Oni/SomeFolder</span> <span style="background:rgb(175,175,255); border-radius:0.33em;">-genmipmaps</span> <span style="background:rgb(156,255,156); border-radius:0.33em;">/Games/Oni/GameDataFolder/level1_Final.dat</span></tt>
|}
Here's how it breaks down:
{|
! style="width:130px"|
|-
|<span style="background:rgb(235,235,235); border-radius:0.33em;">'''Invocation'''</span>||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 Console/Terminal's current directory, you must provide the full path to it or set the path variable.
|-
|<span style="background:rgb(175,175,255); border-radius:0.33em;">'''Option'''</span>||The command.
|-
|<span style="background:rgb(255,156,156); border-radius:0.33em;">'''Full path to folder'''</span>||Whether destination or source, the folder path comes first.
|-
|<span style="background:rgb(175,175,255); border-radius:0.33em;">'''Option flags'''</span>||The flags that can optionally go with this command.
|-
|<span style="background:rgb(156,255,156); border-radius:0.33em;">'''Full path to file'''</span>||Whether destination or source, the file path comes second.
|}


----
The following commands should be complete, but the current list can be obtained by calling OniSplit with the <tt>-help</tt> option (you should also use <tt>-version</tt> to make sure you're using the same version that's documented here).


==Using it==
The following actions are listed when calling OniSplit with the <tt>-help</tt> option (another informative option is <tt>-version</tt>)
:The command line must be preceded by either <tt>OniSplit.exe</tt> (Windows) or <tt>mono OniSplit.exe</tt> (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====
====Conversion between .dat and .oni====
{|
{|