Installation: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(→‎Mac note: fixed plural in section header)
m (converted use of H template to Hover template)
 
(55 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Available versions==
{{UpdatedForOniX|1.0.0}}
===Demo (PC & Mac)===
This page will guide you in obtaining, installing and running Oni on practically any computer.
You can still get the PC demo [http://www.download.com/Oni-demo/3000-2095_4-4201532.html HERE],
{{TOCfloat}}
the Mac demo [http://www.feralinteractive.com/?game=oni&language=english&section=demo HERE],
==Obtaining==
and both demos [http://3ddownloads.com/Action/Oni/Demos HERE]
===Demo===
(the demos will be backed up on oni2.net if other sources are discontinued)
You can get the Windows demo [http://mods.oni2.net/node/335 HERE] and the Mac demo [http://mods.oni2.net/node/334 HERE]. They have been repackaged for modern computers, and include all three demo levels.
===Retail (PC, Mac & PS2)===
Mac version available from [http://www.feralinteractive.com/?game=oni&language=english&section=buy Feral]. PS2 version available from [http://take2store.stores.yahoo.net/oniplay.html Take 2]. PC version no longer available from Take 2. Consider eBay and Amazon.
===Beta===
;Beta 5 (Mac OS 9)
:Released as part of the [http://www.macelite.de/product_info.php?language=en&info=p107_Big-Blue-Box--Mac-.html Big Blue Box]. No [[thedayismine|developer mode]], but a level0_Tools [[dat|instance file]] and a few extra [[IGMD|level logic folders]].
;Beta 4 (Mac OS 9)
:Has a developer mode and uncrippled [[BSL]], but is not available publicly.


===Retail===
The game is no longer available to purchase new, but is often for sale secondhand on sites like eBay and Amazon. Make sure you know which platform you're purchasing the game for, as sometimes the game is not carefully labeled by the seller. Unless you're specifically looking for the PlayStation 2 port for some reason, make sure you're buying Oni for Windows or Oni for Mac OS, as those are considered the best versions of the game, and only Windows/Mac Oni is supported by the community and can be modded (note: Mac Oni does not run in macOS 10.15 Catalina or newer due to the loss of 32-bit support, though a 64-bit port is expected eventually).


----
==Installing==
==Installation process (PC & Mac)==
After installing retail Oni on a modern OS, you will need to install a patch of some kind to run it. The repackaged demos (linked above) come with the needed patches (but note again that Oni currently will not run on Macs in macOS 10.15+).
===Windows===
When the Oni CD is inserted, the installation will automatically start with the following steps :
*Language selection : for example, if you happen to have the European TakeAdvantage edition of Oni, you can choose between English/German/French
*Installation process itself : usual stuff (software licence agreement, installation folder selection...)
*Installation of DirectX/OpenGL : skip this, as the versions of DirectX or OpenGL provided with Oni are ''very'' old.
A shortcut is automatically generated and placed on your desktop.


===Windows demo===
After following the instructions below to install a retail copy of the game, see the "[[#Patches|Patches]]" section, then check out the [[Troubleshooting]] page if you still encounter problems.
:The installation process does not start automatically, as there's no CD. The demo's installer extracts the engine and game content to a temporary folder and deletes everything when you exit the game. If you want a persistent demo, try [http://geyser.oni2.net/demoni/demoni.exe THIS].


===Mac OSX===
===Windows===
:The installer requires OS9 to function. If you do not have Classic, open the CD and drag the "Oni ƒ" folder to the desired place on your hard-drive. You can play from this. See note below on engine upgrade.
:''Note that the installer on the CD may no longer work as of Windows 10; see [[Troubleshooting#Installer|HERE]] for how to install Oni manually.''
When the Oni CD is inserted, the installation will automatically start with the following steps:
*Language selection (maybe): If you have a multilingual version of Oni, you'll be asked to choose the language first.
*Installation process itself: The usual stuff (software license agreement, installation folder selection...).
*Prompt to install DirectX/OpenGL: '''Skip this''', as the version of DirectX or OpenGL provided with Oni is ''very'' old.


A shortcut to Oni is automatically generated and placed on your desktop.


----
===Mac===
==Upgrades and troubleshooting==
The installer requires Mac OS 9 to run, but you can simply open the CD and drag the "Oni ƒ" folder to the desired place on your hard drive. It's recommended that you then rename the folder to simply "Oni". See the "[[#Patches|Patches]]" section below to get the right version of the Oni game application for your system. If Oni still does not run properly, see [[Troubleshooting]].
===Blam, Oni crashed?===
:Damn! Go straight to the [[Troubleshooting]] page.
:You can also try your luck with the updates below.


===PC engine upgrades===
===Linux===
:There never was any official support for the English PC engine (minor fix for [http://www.buka.ru/cgi-bin/show.pl?id=92 Russian version] [http://www.buka.ru/cgi-bin/show.pl?option=Show_patch&id=92 HERE])
Oni was not developed for Linux, but for unofficial support with installing and patching Oni, see [[Playing in Linux]].
:Fixed bugs and unlocked/new features are listed [[Oni engine patches (Win)|HERE]]. The [[Daodan DLL]] applies these patches at runtime.
:The patched engine or DLL must be placed in Oni's installation folder (see below).


===Mac engine upgrades===
==Post-installation notes==
:In order to run Oni on OS X, you'll need [http://www.omnigroup.com Omni Group]'s engine port.
All of Oni's files will be found in '''C:\Program Files\Oni''' on Windows, and '''wherever you dragged the folder to''' on the Mac. The name of the folder does not have to be "Oni" and the Oni application can be renamed, too, but it is not recommended (some community tools expect the app to be called by its original name). Look at [[Oni_(folder)|this page]] for a listing of the files you should have and a description of what they do.
:The latest version from Omni is [http://www.insidemacgames.com/news/story.php?ArticleID=7003 1.0 v1.36] [http://www.omnigroup.com/ftp/pub/software/MacOSX/10.1/Oni-1.0v1.36.dmg  (1.8 MB)] and dates back to February 2003.
:The first time you run that engine, it will ask you where your game content is (see below).
:Updates made to 1.0 v1.36 by the community can be found [[Oni engine patches (Mac)|HERE]]
:These include bug fixes, as well as unlocked or reimplemented features.


===Game content upgrades===
===Windows===
:Check out the [[Anniversary Edition]] for an augmented Oni.
#Oni does not create any important registry entries (just [[Talk:Installation#Registry_redux|this one]] for uninstallation purposes). An installation of Oni consists entirely of the "Oni" folder; this makes it easy to back up Oni before experimenting with it.
:If you're new to Oni, maybe beat it once before though...
#Retail versions of Oni sometimes check for the installation CD. You can get rid of the CD check using the Oni.exe that gets installed automatically by the [[AE]] (found [[Customizing#CD_check|here]]) or by using [[OniX]]. Otherwise you need to have an Oni CD in the drive in order to play (any mounted volume will do as long as its name is the same as Oni's CD).
#If Oni.exe is opened by double-clicking it or its shortcut, it first looks for GameDataFolder (which we call "the GDF") in the same directory as itself. If Oni.exe is launched from the command line, it first looks for the GDF in the current command line directory, and if it's called by a .bat it looks in the location of the .bat that called it. Wherever it starts looking, Oni will also look for a folder in that directory called "OniEngine" and look inside there too for a GameDataFolder. If neither location contains the GDF, Oni progressively checks the parent directories, all the way up to C:\ if necessary, looking for the GDF (or an OniEngine folder with the GDF inside) at each level.
#OniX.exe does not look for an OniEngine folder.


===Mac===
#The Mac app never checks for the Oni disc in the CD-ROM drive.
#When opened, the app first looks for the GameDataFolder in the same directory as itself. If the GDF is not found there, it continues to look in each parent directory up to the root of the hard drive. Unlike in Windows, the app never looks for an OniEngine folder.


----
==Patches==
==Installation folder==
Retail Oni will not usually run on modern computers without a patched game application. For the sake of historical completeness, below is a table of Oni's compatibility with every version of Windows and the Mac OS going back to the minimum required OS that was listed for Oni when it launched in 2001. If you still encounter problems after following these directions, see the [[Troubleshooting]] page.
All of Oni's files will be found in a folder called [[Oni (folder)|Oni]] (default is C:\Program Files\Oni on Windows /Applications/Oni on the Mac). The name does not have to be Oni, however: you can rename it to anything you want (see below for customization notes).


===Windows notes===
{|class="wikitable" style="margin-left:auto; margin-right:auto;"
#Oni does not create any registry entries, so an installation of Oni is essentially a copy of the Oni folder: this is useful for backups, troubleshooting, reinstallation and experimentation. For example, the [[Anniversary Edition]] creates a copy of the [[GameDataFolder]] with the upgraded content and runs Oni from another folder, leaving the original installation intact.
|+Windows
#Retail versions of Oni typically check for the installation CD. You can get rid of the CD check [[Customizing#CD_check|with a custom patch]] or, better, by using the [[Daodan DLL]]. Otherwise, you need to have an Oni CD in the drive to play (any CD will do as long as its volume name is "ONI").
!Version
#The engine (Oni.exe) doesn't have to be present in the folder where it is launched from. The Edition takes advantage of this and runs the original engine remotely, without copying it around. This feature is a bit technical, but it can make life easier sometimes.
!width=300px|Oni.exe
!width=300px|OniX.exe
|-
|Windows 95, 98, 2000, ME
|The {{Hover|vanilla|text=The original unmodded game}} version of Oni.exe should work out of the box.
|The ''legacy'' build of [[OniX|OniX.exe]] will also work (however the game data conversion script requires Win98+).
|-
|Windows XP, Vista, 7
|A crashing bug began to manifest in Oni.exe around the time of XP. It is fixed by installing the [[Daodan DLL]] or by installing the [[Anniversary Edition]] modding framework, which includes the DLL.
|The ''legacy'' build of OniX.exe will work without issue.
|-
|Windows 8
|As above, install the Daodan DLL or the AE. Starting with Win8, however, you may experience mouse-pointing issues, which requires turning off display scaling for Oni (instructions [[Mouse control issues#Camera|HERE]]).
|The ''legacy'' build of OniX.exe will work without issue.
|-
|Windows 10, 11
|As above, install the Daodan DLL or the AE, and turn off display scaling if you have mouse issues.
|The ''modern'' build of OniX.exe is designed to work on Windows 10 and 11.
|}


{|class="wikitable" style="margin-left:auto; margin-right:auto;"
|+Macintosh
!Version
!width=530px|Notes
|-
|Mac OS 8.6–9.x
|The original version of Oni should work out of the box.
|-
|Mac OS X 10.0–10.6
|Use the community-patched version of The Omni Group's Mac OS X port found [[OMNI|HERE]].
|-
|Mac OS X 10.7–macOS 10.14
|Use Feral Interactive's Intel Mac port found [[FERAL|HERE]].
|-
|macOS 10.15+
|32-bit apps are no longer supported, so you must boot in macOS 10.14 or below to play Oni.
|}


===Mac notes===
==Customization==
#Omni's port remembers the absolute location of the Oni folder between runs. This means you can move the Oni application to another location and it will still find the GameDataFolder. If you move your GameDataFolder somewhere else, the Oni application will ask for the folder's location on its next launch, and then remember the new location of the GDF after that point.
For information on customizing the controls and making other changes to Oni's settings, see [[Customizing]].
#Omni's port (and the community-patched versions thereof) doesn't check for the Oni disc in the CD-ROM drive.


==Mods==
The community has produced a number of mods. You can browse the mods on the [http://mods.oni2.net Mod Depot], but you might just want to start at the [[Anniversary Edition]] page since mods are generally installed through the Anniversary Edition's Installer.


----
The central introduction to making your own mods is found [[Introduction to modding|HERE]].


==Savegames, keyconfigs, startup options==
[[Category:Oni Support]]
===persist.dat===
This binary file is dumped into your Oni folder when Oni exits, and keeps track of your progress in the game (savepoints stored at predefined places in the levels). If you want to edit your savegames, check out [[OSGE]].
===key_config===
This is a plain text file, also located in your Oni folder, and storing the custom control settings. Oni doesn't overwrite it, but it will generate a default one if there is none. See [[Customizing/Binding|HERE]] for instructions on how to bind keyboard and mouse events to Oni actions.
===Startup===
On the Mac pressing Shift at startup lets you specify controls (see above) and command-line parameters (see below). On Windows, this Shift feature is broken, so you have to: 1) modify key_config.txt with a text editor or with [[KeyConfig]]; 2) provide command-line parameters (if any) in a shortcut, at the command line, or in a shell script.
===Command-line parameters===
All versions of the engine accept a certain number of [[Customizing#Command-line_arguments|command-line arguments]], which modify the way it runs. These are mostly intended for developers (like turning off sound or generating advanced debug output). A useful is -noswitch (makes Oni run in a "window"), but it is flawed on Macs, and has been made redundant by the latest [[Daodan DLL]] on Windows.

Latest revision as of 23:58, 2 December 2023

This page will guide you in obtaining, installing and running Oni on practically any computer.

Obtaining

Demo

You can get the Windows demo HERE and the Mac demo HERE. They have been repackaged for modern computers, and include all three demo levels.

Retail

The game is no longer available to purchase new, but is often for sale secondhand on sites like eBay and Amazon. Make sure you know which platform you're purchasing the game for, as sometimes the game is not carefully labeled by the seller. Unless you're specifically looking for the PlayStation 2 port for some reason, make sure you're buying Oni for Windows or Oni for Mac OS, as those are considered the best versions of the game, and only Windows/Mac Oni is supported by the community and can be modded (note: Mac Oni does not run in macOS 10.15 Catalina or newer due to the loss of 32-bit support, though a 64-bit port is expected eventually).

Installing

After installing retail Oni on a modern OS, you will need to install a patch of some kind to run it. The repackaged demos (linked above) come with the needed patches (but note again that Oni currently will not run on Macs in macOS 10.15+).

After following the instructions below to install a retail copy of the game, see the "Patches" section, then check out the Troubleshooting page if you still encounter problems.

Windows

Note that the installer on the CD may no longer work as of Windows 10; see HERE for how to install Oni manually.

When the Oni CD is inserted, the installation will automatically start with the following steps:

  • Language selection (maybe): If you have a multilingual version of Oni, you'll be asked to choose the language first.
  • Installation process itself: The usual stuff (software license agreement, installation folder selection...).
  • Prompt to install DirectX/OpenGL: Skip this, as the version of DirectX or OpenGL provided with Oni is very old.

A shortcut to Oni is automatically generated and placed on your desktop.

Mac

The installer requires Mac OS 9 to run, but you can simply open the CD and drag the "Oni ƒ" folder to the desired place on your hard drive. It's recommended that you then rename the folder to simply "Oni". See the "Patches" section below to get the right version of the Oni game application for your system. If Oni still does not run properly, see Troubleshooting.

Linux

Oni was not developed for Linux, but for unofficial support with installing and patching Oni, see Playing in Linux.

Post-installation notes

All of Oni's files will be found in C:\Program Files\Oni on Windows, and wherever you dragged the folder to on the Mac. The name of the folder does not have to be "Oni" and the Oni application can be renamed, too, but it is not recommended (some community tools expect the app to be called by its original name). Look at this page for a listing of the files you should have and a description of what they do.

Windows

  1. Oni does not create any important registry entries (just this one for uninstallation purposes). An installation of Oni consists entirely of the "Oni" folder; this makes it easy to back up Oni before experimenting with it.
  2. Retail versions of Oni sometimes check for the installation CD. You can get rid of the CD check using the Oni.exe that gets installed automatically by the AE (found here) or by using OniX. Otherwise you need to have an Oni CD in the drive in order to play (any mounted volume will do as long as its name is the same as Oni's CD).
  3. If Oni.exe is opened by double-clicking it or its shortcut, it first looks for GameDataFolder (which we call "the GDF") in the same directory as itself. If Oni.exe is launched from the command line, it first looks for the GDF in the current command line directory, and if it's called by a .bat it looks in the location of the .bat that called it. Wherever it starts looking, Oni will also look for a folder in that directory called "OniEngine" and look inside there too for a GameDataFolder. If neither location contains the GDF, Oni progressively checks the parent directories, all the way up to C:\ if necessary, looking for the GDF (or an OniEngine folder with the GDF inside) at each level.
  4. OniX.exe does not look for an OniEngine folder.

Mac

  1. The Mac app never checks for the Oni disc in the CD-ROM drive.
  2. When opened, the app first looks for the GameDataFolder in the same directory as itself. If the GDF is not found there, it continues to look in each parent directory up to the root of the hard drive. Unlike in Windows, the app never looks for an OniEngine folder.

Patches

Retail Oni will not usually run on modern computers without a patched game application. For the sake of historical completeness, below is a table of Oni's compatibility with every version of Windows and the Mac OS going back to the minimum required OS that was listed for Oni when it launched in 2001. If you still encounter problems after following these directions, see the Troubleshooting page.

Windows
Version Oni.exe OniX.exe
Windows 95, 98, 2000, ME The vanillaThe original unmodded game version of Oni.exe should work out of the box. The legacy build of OniX.exe will also work (however the game data conversion script requires Win98+).
Windows XP, Vista, 7 A crashing bug began to manifest in Oni.exe around the time of XP. It is fixed by installing the Daodan DLL or by installing the Anniversary Edition modding framework, which includes the DLL. The legacy build of OniX.exe will work without issue.
Windows 8 As above, install the Daodan DLL or the AE. Starting with Win8, however, you may experience mouse-pointing issues, which requires turning off display scaling for Oni (instructions HERE). The legacy build of OniX.exe will work without issue.
Windows 10, 11 As above, install the Daodan DLL or the AE, and turn off display scaling if you have mouse issues. The modern build of OniX.exe is designed to work on Windows 10 and 11.
Macintosh
Version Notes
Mac OS 8.6–9.x The original version of Oni should work out of the box.
Mac OS X 10.0–10.6 Use the community-patched version of The Omni Group's Mac OS X port found HERE.
Mac OS X 10.7–macOS 10.14 Use Feral Interactive's Intel Mac port found HERE.
macOS 10.15+ 32-bit apps are no longer supported, so you must boot in macOS 10.14 or below to play Oni.

Customization

For information on customizing the controls and making other changes to Oni's settings, see Customizing.

Mods

The community has produced a number of mods. You can browse the mods on the Mod Depot, but you might just want to start at the Anniversary Edition page since mods are generally installed through the Anniversary Edition's Installer.

The central introduction to making your own mods is found HERE.

Retrieved from "https://wiki.oni2.net/w/index.php?title=Installation&oldid=41641"