Installation: Difference between revisions

added important note about location of files for non-admin users; we should have stated this years ago
m (→‎Patches: don't link to a page in the table header)
(added important note about location of files for non-admin users; we should have stated this years ago)
 
(5 intermediate revisions by the same user not shown)
Line 12: Line 12:
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 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|Patches]]" section, then check out the [[Troubleshooting]] page if you still encounter problems.
After following the instructions below to install a retail copy of the game, see {{SectionLink||Patches}}, then check out the [[Troubleshooting]] page if you still encounter problems.


===Windows===
===Windows===
:''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.''
:''Note that the installer on the CD may no longer work as of Windows 10; see {{SectionLink|Troubleshooting|Installer}} for how to install Oni manually.''
When the Oni CD is inserted, the installation will automatically start with the following steps:
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.
*Language selection (maybe): If you have a multilingual version of Oni, you'll be asked to choose the language first.
Line 24: Line 24:


===Mac===
===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|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]].
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 {{SectionLink||Patches}} to get the right version of the Oni game application for your system. If Oni still does not run properly, see [[Troubleshooting]].


===Linux===
===Linux===
Line 30: Line 30:


==Post-installation notes==
==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 [[Oni_(folder)|this page]] for a listing of the files you should have and a description of what they do.
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.


===Windows===
===Windows===
#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.
#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.
#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).
#The save-game file persist.dat, as well as key_config.txt and Oni's log files, will <u>not</u> be saved next to Oni.exe if you are not running the game as an administrator. See {{SectionLink|Oni (folder)|Warning for non-admins}} to learn more.
#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.
#Retail versions of Oni sometimes check for the installation CD, but the original U.S. distribution did not. If you run into a CD check, you can get rid of it by using the Oni.exe that is installed automatically by the [[AE]] (directly downloadable [[Customizing#CD check|here]]) or by using [[OniX]]. Otherwise you need to have either the Oni CD-ROM in the drive or any mounted volume with the same as the CD-ROM.
#OniX.exe does not look for an OniEngine folder.
#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 behaves the same except that it never looks for OniEngine.


===Mac===
===Mac===
#The Mac app never checks for the Oni disc in the CD-ROM drive.
#The Mac app never checks for the Oni disc in the CD-ROM drive.
#When opened, the app first looks for the GameDataFolder ("GDF") 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 OniEngine.
#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==
==Patches==
Retail Oni will not run on any 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.
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.


{|class="wikitable" style="margin-left:auto; margin-right:auto; width:800px"
{|class="wikitable" style="margin-left:auto; margin-right:auto;"
|+Windows
|+Windows
!Version
!Version
!width=300px|Vanilla Oni.exe
!width=300px|Oni.exe
!width=300px|OniX.exe
!width=300px|OniX.exe
|-
|-
|Windows 98, 2000, ME
|Windows 95, 98, 2000, ME
|The original version of Oni.exe should work out of the box.
|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.
|The ''legacy'' build of [[OniX|OniX.exe]] will also work (however the game data conversion script requires Win98+).
|-
|-
|Windows XP, Vista, 7
|Windows XP, Vista, 7
Line 60: Line 60:
|-
|-
|Windows 8
|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. See the Troubleshooting page if you don't know how to do that.
|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.
|The ''legacy'' build of OniX.exe will work without issue.
|-
|-
Line 92: Line 92:
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 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 [[Modding Oni|HERE]].
The central introduction to making your own mods is found [[Introduction to modding|HERE]].


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