Customizing: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(→‎Controls: adding slightly sarcastic image)
(fixed link to Oni.exe; rewrote launch arg instructions because they needed a major overhaul)
Line 12: Line 12:
==Controls==
==Controls==
[[Image:Classic_Oni_startup_options.jpg|thumb|Wouldn't it be nice if Oni had something like this? Oh well...]]
[[Image:Classic_Oni_startup_options.jpg|thumb|Wouldn't it be nice if Oni had something like this? Oh well...]]
Oni for Mac OS 9 had a simple control-settings dialog which would appear if launching Oni with Shift held down. Nowadays, no version of Oni has any kind of GUI for setting key bindings. Here's how you customize your controls:
The Classic Mac build of Oni had a simple control-setting dialog which would appear if launching Oni with Shift held down. No other version of Oni has any kind of GUI for setting key bindings. Here's how you customize your controls:
*Edit the '''key_config.txt''' file manually -- [[/Binding|Binding syntax and instructions]]
*Edit the '''key_config.txt''' file manually; see [[/Binding|Binding syntax and instructions]]
*Use the [http://mods.oni2.net/node/129 Oni Key Editor] Java tool for a GUI experience
*Use the [http://mods.oni2.net/node/129 Oni Key Editor] Java tool for a GUI experience
*Set custom keybindings at runtime using [[scripts]]
*Set custom keybindings at runtime using a global BSL script that employs the "bind" command


==CD check==
==CD check==
Some versions of Oni for Windows have been known to require the game CD-ROM in the drive (or at least some CD named "ONI" ;-), but the app distributed with the standard U.S. release does not perform that CD check. The app is found [http://mods.oni2.net/node/243 here].
Some versions of Oni for Windows have been known to require the game CD-ROM in the drive (or at least some CD named "ONI" ;-), but the app distributed with the standard U.S. release does not perform that CD check. The app is found [http://mods.oni2.net/node/231 here].


==Save-game editing==
==Save-game editing==
*[[OSGE|OniSavegameEditor]] (Cross-platform)
*[[OSGE|OniSavegameEditor]] (Windows)
*[http://mods.oni2.net/node/155 OniLib] (Mac-only)
*[http://mods.oni2.net/node/155 OniLib] (Mac)


==Command-line arguments==
==Command-line arguments==
You can run Oni from your system's command prompt rather than clicking on the automatically generated shortcut. This enables you to use a number of options that are otherwise unavailable. Only the ones in bold seem to be useful.
You can run Oni from your system's command prompt rather than clicking on the automatically generated shortcut. This enables you to use a number of options that are otherwise unavailable. Here is how you pass Oni a command-line argument (multiple arguments can be supplied, as long as they are separated by a space character):


''(Historical note: In Oni for Mac OS 9, users could access these options ''via'' a special dialog that popped up if you pressed SHIFT during Oni's startup, but the OS X apps lack this feature.)''
*In Windows, you can make a shortcut to Oni and then add the argument on the shortcut's Properties window, or create a .bat file with contents like "start oni -noswitch".
*With the Mac OS 9 PPC Mac build of Oni, you can manually enter arguments ''via'' a special dialog that pops up if you hold down Shift during Oni's startup.
*With the Mac OS X PPC build of Oni, you must use the Terminal to directly invoke the actual binary by typing "Oni.app/Contents/MacOS/Oni -noswitch".
*With the Intel Mac build of Oni, you can supply arguments using a file called launch_args.txt. Simply list the arguments on one line. Additional arguments accepted by the Intel build are listed in the [[AE:FERAL|documentation]]. You can also visually choose many arguments in a GUI launch panel by holding down Command while opening Oni, which also allows you to manually type in any arguments that are not represented in the GUI.


*-combos : unused
Here are all the arguments Oni accepts, but only the ones in bold seem to be useful:
*-combos: unused
*-debug
*-debug
*'''-debugfiles''' : Additional debug files are dumped, e.g. low-level script debugging.
*'''-debugfiles''': Additional debug files are dumped, e.g. low-level script debugging.
*-ehalt : unused
*-ehalt: unused
*-findsoundbinaries : unused
*-findsoundbinaries: unused
*-findsounds
*-findsounds
*-glide : unused
*-glide: unused
*-ignore_config : unused
*-ignore_config: unused
*-ignore_private_data : Disables the loading of "private data" in level0.
*-ignore_private_data: Disables the loading of "private data" in level0.
*-nodialog
*-nodialog
*'''-nosound''' : Sounds and music are disabled. The "Overall volume" control in [[#Options menu|Options]] has no effect.
*'''-nosound''': Sounds and music are disabled. The "Overall volume" control in [[#Options menu|Options]] thus has no effect.
*[[#noswitch|'''-noswitch''']] : Windowed mode.
*[[#noswitch|'''-noswitch''']]: Windowed mode (see below).
*-opengl : unused
*-opengl: unused
You can combine those options on a single command line so that they apply simultaneously.
 
For example, here's a batch file I've been using lately (a Win32/DOS script called, say, '''oni.bat''', and located in Oni's [[Installation#Installation folder|installation folder]]):
rm saved_film*.dat
start OniTrainer\oni_trainer.exe
start oni -noswitch -debugfiles
What does it do? It cleans up the saved movie files (if any).
Then it starts Alloc's OniTrainer and Oni. Oni runs in a window.
 
The output generated by '''-debugfiles''' sometimes helps when debugging scripts (though not very often, not to say never).


===noswitch===
===noswitch===
'''-noswitch''' is probably the most useful of the command-line arguments. When launched with this argument, Oni stays in a window in the top-left corner (the Daodan DLL and Mac Intel builds center the window). The window size is the resolution specified in Oni's Options menu. Thus, if Oni is set to run in a low resolution like 640x480, the game will take only a portion of your screen, leaving the taskbar/Dock accessible, as well as other applications you may be running alongside Oni (very useful when modding).
'''-noswitch''' is probably the most useful of the command-line arguments. When launched with this argument, Oni stays in a window matching the resolution specified in Oni's Options menu instead of changing your screen resolution and going full-screen. Thus, if Oni is set to run in a low resolution like 640x480, the game will take only a portion of your screen, leaving you access to other applications that you may be running alongside Oni (very useful when modding).
 
The parameter is easy to pass to the Windows executable from the command line (see script above); with the Mac OS X app, you have to pass the parameters to the actual binary, which confuses some users. In the Terminal, instead of "Oni.exe -noswitch", you would type "Oni.app/Contents/MacOS/Oni -noswitch".


==Modding==
==Modding==
{{:Installation}}<!--Why type the same thing again?-->
See [[Installation#Mods|Installation]] page.


[[Category:Oni Support]]
[[Category:Oni Support]]

Revision as of 00:26, 11 October 2016

Options menu

When Oni launches, Options is the third button on the Main Menu. But after you load a game, this button is replaced with Resume when you return to the Main Menu by hitting Esc. However, the Daodan DLL and Mac Intel build make the Options button accessible while the game is paused. This is where you change or toggle:

  • Amount of graphical detail
  • Resolution and color depth
  • Gamma correction
  • Overall volume (sound FX and music can't be adjusted separately)
  • Subtitles
  • Difficulty setting
  • Inversion of the vertical mouse axis
Fun trivia: mouse inversion was implemented backwards. If the box is checked, moving the mouse up makes you look up... that's non-inverted aiming. This is fixed by the AE.

Controls

Wouldn't it be nice if Oni had something like this? Oh well...

The Classic Mac build of Oni had a simple control-setting dialog which would appear if launching Oni with Shift held down. No other version of Oni has any kind of GUI for setting key bindings. Here's how you customize your controls:

CD check

Some versions of Oni for Windows have been known to require the game CD-ROM in the drive (or at least some CD named "ONI" ;-), but the app distributed with the standard U.S. release does not perform that CD check. The app is found here.

Save-game editing

Command-line arguments

You can run Oni from your system's command prompt rather than clicking on the automatically generated shortcut. This enables you to use a number of options that are otherwise unavailable. Here is how you pass Oni a command-line argument (multiple arguments can be supplied, as long as they are separated by a space character):

  • In Windows, you can make a shortcut to Oni and then add the argument on the shortcut's Properties window, or create a .bat file with contents like "start oni -noswitch".
  • With the Mac OS 9 PPC Mac build of Oni, you can manually enter arguments via a special dialog that pops up if you hold down Shift during Oni's startup.
  • With the Mac OS X PPC build of Oni, you must use the Terminal to directly invoke the actual binary by typing "Oni.app/Contents/MacOS/Oni -noswitch".
  • With the Intel Mac build of Oni, you can supply arguments using a file called launch_args.txt. Simply list the arguments on one line. Additional arguments accepted by the Intel build are listed in the documentation. You can also visually choose many arguments in a GUI launch panel by holding down Command while opening Oni, which also allows you to manually type in any arguments that are not represented in the GUI.

Here are all the arguments Oni accepts, but only the ones in bold seem to be useful:

  • -combos: unused
  • -debug
  • -debugfiles: Additional debug files are dumped, e.g. low-level script debugging.
  • -ehalt: unused
  • -findsoundbinaries: unused
  • -findsounds
  • -glide: unused
  • -ignore_config: unused
  • -ignore_private_data: Disables the loading of "private data" in level0.
  • -nodialog
  • -nosound: Sounds and music are disabled. The "Overall volume" control in Options thus has no effect.
  • -noswitch: Windowed mode (see below).
  • -opengl: unused

noswitch

-noswitch is probably the most useful of the command-line arguments. When launched with this argument, Oni stays in a window matching the resolution specified in Oni's Options menu instead of changing your screen resolution and going full-screen. Thus, if Oni is set to run in a low resolution like 640x480, the game will take only a portion of your screen, leaving you access to other applications that you may be running alongside Oni (very useful when modding).

Modding

See Installation page.