# Welcome To Oni

## This Read Me file accompanies version 1.2.1

Developed by Bungie
Ported to Mac OS X by Feral Interactive Limited and The Omni Group
Published for Mac by Feral Interactive Limited

## Contents

1. Getting Started
2. Launch Arguments
3. Cheats
4. Version History
5. Known Bugs

1. ### Getting Started

   This Intel-native build of Oni for Macs provides updated support for OS X through El Capitan 10.11 (minimum of Lion 10.7 is required), and many small improvements not present in the original game application.

   To install, simply place the application in your Oni installation folder (the folder which contains GameDataFolder), replacing the older Oni application in the same location.

   The Intel build would not be possible without the help of Ken Case at The Omni Group, who kindly donated the work he had done on an Intel build, and more recently Dirk Gently, EdT and Iritscen from the Oni Central Forum for their help and support in getting the build ready for public release.

   IMPORTANT: The persist.dat (save-game file) produced by Intel Mac Oni is not compatible with the old PowerPC Mac Oni save-game format. Please make a copy of your persist.dat file before playing Intel Mac Oni for the first time. You can use a save-game editor to recreate your progress in the new persist.dat that Intel Mac Oni creates.

   Back To Top

2. ### Launch Arguments

   Oni has always supported command-line launch arguments to set certain options in the game. With all the new features controlled by launch arguments, you will find it more convenient to place your chosen arguments in a text file so that these settings can persist from session to session like preferences. Create a plain-text file called launch_args.txt next to the Oni application, and add the desired arguments to it in any order, including the leading hyphens and with each argument separated by a space. An example of the contents of the file would be "-fsaa4x -af4x -noswitch".

   For a more user-friendly approach, call up the launch panel (hold Option or Command when launching Oni) and make your choices from the GUI. Arguments that are not represented in the GUI can be entered manually under the Advanced tab. The panel will save your GUI choices and manually-typed arguments in launch_args.txt. Below are the most useful of Oni's original arguments, and all of the new arguments added to the Intel Mac build. All of Oni's original arguments are documented on OniGalore.

   - -noswitch

     Oni will run in windowed mode rather than full-screen.

   - -vsync

     Vertical synchronization caps the game's frame rate at 60fps. This prevents the "tearing" effect seen when a game is drawing faster to a screen than the screen itself is refreshing. Since OS X now tends to apply vsync ("beam sync") to applications automatically, this argument might be unnecessary.

   - -fsaa2x, -fsaa4x, -fsaamax

     Turns on full-screen anti-aliasing (FSAA), which smooths the edges of 3D models. The "max" option uses the maximum FSAA your computer can provide and is likely to harm Oni's frame rate, so 2x or 4x is recommended.

   - -tri, -af2x, -af4x, -afmax

     The "af" commands turn on anisotropic filtering (AF), which makes textures look better as they recede into the distance. "-tri" turns it off, which is already the default setting for AF. As with FSAA, 2x or 4x is recommended.

   - -display1 ... -display9

     Tells Oni to run on a certain monitor, supporting any number from 1 to 9. If this monitor is not connected, Oni will fall back to monitor 1.

   - -wintop, -winbottom, -winleft, -winright

     In combination with -noswitch, these arguments place the Oni window up against one side of the display. It may be more convenient than having Oni in the center of the screen if you need to see another program at the same time.

   - -novideos

     Do not play the intro and outro movies.

   - -nosparkle

     Do not load the auto-update framework Sparkle. Launching may be faster with this option but you will not be informed of available updates issued through Sparkle, so it is not recommended for general use.

   - -wsafety

     Allows you to bind a key to the action "weapon_safety" (ex. "bind mousebutton3 to weapon_safety"). Engaging the weapon safety switch allows you to punch and kick with "fire1" and "fire2" (usually bound to the left and right mouse buttons) even when you are holding a loaded gun. The AIs can use this feature as well.

   - -parkour

     Allows AI to jump up on obstacles while attacking you. This is turned off by default because the behavior is not optimal yet and causes minor animation glitches.

   - -scrollrun

     Allows you to use the mouse scroll wheel to lock your movement speed. Scroll down or left to move slower, and up or right to move faster.

   - -debugdisplay

     Prints various messages to OS X's Console that concern windowing, for troubleshooting purposes.

   Back To Top

3. ### Cheats

   Oni no longer requires you to have beaten it once in order to use cheats. Some new cheats have been added to Oni and are documented below. The original cheats are documented on OniGalore. Type these strings on the Pause screen (F1).

   - bigbadboss

     Player has boss shield (invisibly, as opposed to "chenille" cheat), granting 50% immunity to weapons.

   - bulletproof

     Player has permanent invisible force field, granting immunity to weapons.

   - kangaroo

     Player can jump super-high.

   - marypoppins

     "Jet pack mode" (hold down "jump" key).

   - shinobi

     Stealth is easier (AI is deaf, vision is 25% of normal range).

   Back To Top

4. ### Version History

   1.2.1 (December 2015)

   Added features
   - The launch argument "-scrollrun" enables the scroll wheel run speed control.
   - The launch argument "-debugdisplay" prints various messages to OS X's Console that concern windowing, for troubleshooting purposes.
   - The BSL commands "p3_show_env_collision", "sound_show_occlusions", and "env_highlight_gq" now work. Existing command "sound_show_debug" now also displays sound spheres. See OniGalore for details.
   - New Developer Mode hotkeys: Ctrl-Shift-I (Draw invisible quads), Ctrl-Shift-O (Hide non-visually-occluding quads), Ctrl-Shift-S (Hide non-sound-occluding quads), Ctrl-Shift-R (Draw only object-colliding geometry), and Ctrl-Shift-T (Draw only character-colliding geometry). See OniGalore for details.
   Changes
   - Ensured support for Mac OS X El Capitan (10.11).
   - Scroll wheel run speed control which was added in v1.2 is no longer on by default; you must activate it using the -scrollrun argument.
   - Improved handling of scroll wheel for both run speed control and Load Game dialog.
   - Sparkle updated from 1.5b to 1.6.1.

   1.2 (October 2014)

   Added features
   - New higher-quality movies are bundled in the application and will be automatically installed when Oni launches (movie playback requires OS X 10.9+). Press Esc key to skip a movie. Use launch argument "-novideos" to disable video playback.
   - Launch settings panel - Hold down the Option or Command key while opening Oni to choose settings. You can enter launch arguments manually, but many of them can also be set using the panel's GUI.
   - Optional anti-aliasing (FSAA) has new setting "maximum" (launch argument "-fsaamax"), in addition to 2x ("-fsaa2x") and 4x ("-fsaa4x").
   - Optional anisotropic filtering (AF) for sharper textures (launch arguments "-af2x", "-af4x", "-afmax").
   - Optional vertical sync to prevent screen-tearing (launch argument "-vsync").
   - Custom mouse speed - Use BSL command "mouse_acceleration x", where 'x' is a number between 0.1 and 1.0 (you can have Oni run this command automatically using bsl_config.txt, described below).
   - Mouse scroll wheel can now control the player's running speed.
   - Oni's guns now have safety switches (you must supply the launch argument "-wsafety" in order for this feature to be available). Bind a key or button to "weapon_safety" in key_config.txt (ex. "bind mousebutton3 to weapon_safety"), and you can toggle the safety switch, allowing you to punch or kick while still holding your loaded weapon. The AI will know how to use this feature too (experimental).
   - All cheat codes are now bindable in key_config.txt (ex. "bind z to marypoppins").
   - Use the launch argument "-parkour" to try out the AI's experimental ability to jump over obstacles while pursuing Konoko.
   - Further BSL parity with Windows - The variables "show_sound_all", "show_sound_rectangles", and "show_sound_spheres" now work as in Windows.
   - Use launch argument "-nosparkle" to disable automatic update checks by Sparkle (not recommended).
   - Choose Oni's monitor using the argument "-display[1-9]", e.g. "-display2".
   - When running Oni in windowed mode, place Oni up against one side of a screen with launch arguments "-wintop", "-winbottom", "-winleft", and "-winright".
   - Launch argument "-nosound" now works as in Windows.
   - Mouse scroll wheel now works in Load Game dialog.
   Changes
   - New minimum OS requirement: Mac OS X Lion (10.7). Now supports Mac OS X Yosemite (10.10).
   - Oni behaves more properly as a Mac app when in windowed mode.
   - Options screen can now be accessed from Main Menu while game is in progress. Warning is given before restarting to change resolution. Only resolutions supported by current monitor are offered.
   - Oni now allows same number of active characters as in Windows.
   - Increased collision limit from 255 to 1024.
   - Increased object sorting limits from 4K to 10K to prevent overflows.
   - When on the Main Menu, Oni can be quit with Command-Q.
   - When running in windowed mode, window will use highest resolution which fits on screen if chosen resolution is too large to fit.
   - When running in full-screen mode, a supported resolution will automatically be chosen if an unsupported resolution was set in Oni's preferences.
   Bug fixes (fixed bug is from 1.1 PPC unless otherwise stated)
   - (from 1.0 v1.36) Oni's gamma setting is no longer lost when running Oni in full-screen resolution different from desktop resolution.
   - (from 1.1 Intel) Sparkle no longer sometimes stalls, preventing Oni from launching.
   - Sprites and character fly-in portraits no longer stretch out of proportion in wide-screen resolutions.
   - Right HUD no longer glitches when using "moonshadow" cheat.
   - Pursuing AIs will no longer tend to forget about player as soon as their vision of player is obscured.
   - Corrected limit on number of particle classes so that large amounts of particles no longer cause glitched particle behavior.
   - Splashscreens no longer fail to draw when they are larger than Oni's window size.
   - Missing textures should no longer crash Oni.
   - Missing .dat companion files (.raw/.sep) no longer crash Oni.
   - Lens flares in background no longer shine through objects in foreground.
   - (from 1.0 v1.36) In-game music and looping gunfire no longer play over top of Main Menu music when player escapes to Main Menu.

   1.1 Intel (April 2011) - First release of Feral's Intel build

   Added features
   - Intel-native build, resulting in improved performance.
   - Sparkle added for automatic application updates.
   - launch_args.txt - Place a file with this name next to Oni; in it, you can list arguments to be passed to Oni at launch time (complete list found in "Launch Arguments" section above).
   - Developer Mode can be enabled by typing "thedayismine" or simply "x" on the Pause screen (F1).
   - Optional anti-aliasing (FSAA) for smoother edges on shapes ("-fsaa2x", "-fsaa4x").
   - New cheats: bigbadboss (boss shield), bulletproof (force field), kangaroo (high jumps), marypoppins (jet pack jumps) and shinobi (easier stealth).
   - You can now bind a key to a cheat code in key_config.txt (ex. "bind z to munitionfrenzy"). Only Oni's original cheats are bindable at this time.
   - BSL near-parity with Windows - Almost any command used in a Windows script should work on Macs now.
   - RGBA8888 texture support - Enables 32-bit textures to use an alpha channel. There is a bug with the color conversion and the red and blue channels are swapped. This bug was not corrected since Oni for Windows has the same bug. In order for the RGBA8888 texture to appear correctly in Oni, the red and blue channels of the image have to be swapped before importing to Oni.
   - The "global" BSL folder now works as in Windows; create this folder inside the IGMD folder, and any scripts placed in it will be accessible from all levels.
   - bsl_config.txt - Place a file with this name next to Oni; in it, you can list on separate lines the BSL commands that should run every time a level loads.
   - New Mac-only BSL commands "am_show_texturename", "chr_show_weaponid", and "show_triggervolumes" (also activated by Ctrl-Shift-X).
   Changes
   - Now supports Mac OS X Lion (10.7).
   - Unlike in 1.0 v1.36, Oni no longer remembers the location of the GameDataFolder. Oni will simply use the GDF next to the game application. This matches the behavior in Windows Oni and in Mac Oni 1.1 PPC, and allows multiple Oni installations to co-exist on a hard drive.
   - Cheats can be entered on the Pause screen (F1) even when Oni has not been beaten once already.
   - Maximum texture size increased from 256x256 to 1024x1024.
   - BSL command "chr_location" takes an AI index number as in Windows, but now will also accept an AI name instead.
   - Maximum number of permitted level files in GDF raised from 16 to 64 to match Windows.
   - Limit on weapon pages in Diary raised from 15 to 30 for weapon modding support.
   Bug fixes (fixed bug is from 1.1 PPC unless otherwise stated)
   - Oni no longer crashes on startup due to overflow in buffer while listing GL extensions.
   - AIs are now able to properly dodge gunfire. Previously, they preferred to run straight toward the player when under fire. Also, AIs can now evade a ticking Mad Bomber (also requires a fix for the Mad Bomber particle, made in the fan project Anniversary Edition Oni).
   - (from 1.0 v1.36) More display resolutions to choose from on Options screen. Only 32-bit depth modes offered now.
   - A player can no longer drop and quickly pick up a weapon to avoid the delay before firing/reloading it.
   - Developer Mode console no longer invisible in higher resolutions.
   - (from 1.0 v1.36) Developer Mode console now accepts upper-case letters again.
   - Increased pathfinding grid cache to avoid crashes in large third-party levels.
   - BSL command "wp_fadetime" now works.

   1.0 v1.36 (2003) - Last release of The Omni Group's PPC build for OS X

   See read-me distributed with The Omni Group's build of Oni.

   1.1 PPC (2001) - Original release of Bungie's Oni for PPC Macs

   See read-me distributed with Oni.

   Back To Top

5. ### Known Bugs

   - Input is sometimes briefly interrupted; Oni will ignore new input or think that a key/button that is being pressed has been let up.
   - Intro/outro movies will not play in Mac OS X 10.7 and 10.8.
   - After quitting Oni, sometimes the mouse cursor is frozen in the middle of the screen until you click once.

   Back To Top