OniSplit: Difference between revisions

# 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.

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

|-

|<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(255,156,156); border-radius:0.33em;">'''Path to folder'''</span>||Whether destination or source, the folder path comes first. <u>Use the full path to the folder (starting from C:\, or "/" on Macs).</u> For most commands, OniSplit wants a destination folder name, not a file name; the files that OniSplit creates will be named automatically when they are placed in the destination folder. A rare exception is the -import command, where you need to supply the name of the level files to be created.

|-

|<span style="background:rgb(156,255,156); border-radius:0.33em;">'''Path to file/folder'''</span>||Whether destination or source, the file path comes second. Sometimes the second parameter is also a folder, as with '''-create'''. <u>Use the full path to the folder (starting from C:\, or "/" on Macs).</u>

Command-line interfaces (CLI) usually supply an auto-complete feature to save on typing. If you've typed enough of a file/folder name to identify it, press the Tab key and the rest should fill in. In Windows, you may not get the right path name autocompleted on the first try if there are multiple possible autocompletions based on the names in that directory, so keep pressing Tab to cycle through all possibilities. On Macs, if you have not typed enough of the name to narrow it down to a single autocompletion, you will hear an error sound.  Double-tap Tab to see a list of possible autocompletions, then keep typing until you have narrowed it down to one of those and then hit Tab to fill in the rest of its name.

Wildcards can be used to supply patterns to CLI programs. The wildcard is simply the '*' character. For instance:

This works in the Mac Terminal too, but you can also use the escape character, '\'. Also, other characters like '(' need to be escaped as well if you do not use quotes:

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

Occasional sample usages are given after certain commands. These are in DOS style, so simply flip the '\'s to '/'s for Macs and make "C:\" into a leading "/" to indicate "root-level".

Optional flags are listed in square brackets simply to indicate that they're optional; don't enter the brackets when typing a command.

|-

: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 any way you like. The only exception is that a subdirectory named "noimport" or "_noimport" is always ignored.

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.

Unless mentioned otherwise, source filenames support wildcards. See [[AE:Modifying textures|HERE]] for a detailed tutorial. The -extract 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.

[[M3GM]]s, [[ONWC]]s, [[ONCC]]s can be exported to the Wavefront .obj and COLLADA .dae formats. For details see [[Importing character models]] and [[Importing weapon models]]. The generic -extract commands can work with .oni files (a single file, or several files if you use the '*' wildcard), or rip all the TXMP from a .dat file. TRBS and ONCC support additional -noanim and -anim options for -extract:dae; see [[Importing character models]] for details. Imported geometry must only contain triangles.

|-

|-