Daodan DLL: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (corrected a section name that changed and added more SectionLinks for convenience)
 
(76 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The Daodan DLL is a modification for Oni that hooks into the game engine and applies bug fixes and patches. It also replaces parts of the engine with its own code. Daodan fixes many issues, including the famous "[[Blam|Blam!]]" error that occurs on many Windows XP machines. It also adds new features such as support for extra screen resolutions (including many widescreen resolutions) and bonus cheat codes.
{{Hatnote|This is about a Windows-only patch for the game engine. For the entity within the game's story, see [[Daodan]]. For information on the patches to Mac versions of Oni and historical patching of Windows Oni, see the [[:Category:Patches|Patches category]]. Also see [[OniX]], a rebuild of the Oni application for modern Windows systems.}}
The '''Daodan DLL''' is a patch for Oni for Windows that hooks into the game engine to fix bugs and add features. It does this by posing as '''binkw32.dll''', the library that Oni loads so that it can play the game's opening and ending videos. The Daodan fixes issues such as the famous "[[Blam|Blam!]]" error that occurs on modern machines. It also adds new features such as support for widescreen resolutions and bonus cheat codes. The Daodan DLL was created by [[User:SFeLi|SFeLi]] and then developed further by [[User:RossyMiles|RossyMiles]], [[User:Gumby|Gumby]] and [[User:Admin|Alloc]].
:''Subpages:'' [[/Change log|Change log]]
{{TOCfloat}}


==Installation Instructions==
Note that you '''already have the Daodan DLL installed''' if you installed the [[Anniversary Edition]].
#Before installation, it is important to know where your copy of Oni has been installed to. For most people, it is stored in "C:\Program Files\Oni" (My Computer -> Local Disk (C:) -> Program Files -> Oni). This folder should contain a "GameDataFolder" and "Oni" or "Oni.exe".
#It is important that you use an "Oni.exe" that is compatible with Daodan. If you are using the FASM-Daodan, Oni will not start unless you have the correct EXE. If you are using the recommended version of C-Daodan, Oni will start, but most of the features of Daodan will not be present.
#Back up your Oni.exe and binkw32.dll files by renaming them (e.g. "Oni-original.exe").
#Place the newly-downloaded Oni.exe, binkw32.dll (and realbink.dll, if provided) in the folder with Oni.exe.


==Testing==
===Manual installation instructions===
To test if you have done everything correctly, run "Oni.exe". Enter the pause (Diary) screen (F1 by default) and type "tellmetheversion"; if you get a result like "Daodan v.3.0", the DLL is working.
:'''''(For non-AE users)'''''
1. You'll have to extract the Daodan DLL files yourself from the AE package [http://mods.oni2.net/node/233 here]. The files you need are in the plain\win_only\ directory.<br />
2. Extract the Oni.exe meant to go with the Daodan DLL from the AE package [http://mods.oni2.net/node/231 here].<br />
3. Find where your copy of Oni has been installed on your hard drive; usually it's "C:\Program Files\Oni\". This folder should contain GameDataFolder and Oni.exe (just called "Oni" if you have file extensions hidden). Back up this Oni.exe by renaming it (e.g. "Oni-original.exe").<br />
4. Place the newly-downloaded Oni.exe, binkw32.dll, realbink.dll, and assorted files into the Oni\ folder.<br />
5. To confirm that you have done everything correctly, run Oni.exe. Enter the game, bring up the Data Comlink (F1 by default), and type "tellmetheversion"; if you get a result like "Daodan v.''x.y''", the DLL is working.


==C-Daodan==
===Troubleshooting===
This is the recommended version of the Daodan DLL. This is also the only version that supports windowed mode.
If the game does not display correctly (for instance, a black window), try the following in any order:


[http://mods.oni2.net/node/233 Download C-Daodan (binkw32.dll)] <big>—></big> [http://mods.oni2.net/node/231 Use with this version of the game app] (you probably already have it)
1. Disable the intro movie by renaming GameDataFolder\intro.bik. This often fixes the game window.<br />
2. Open the daodan.ini in Notepad and set either "daodangl" or "windowhack" to true. "windowhack" should at least center the window on the screen.<br />
3. Try [http://www.google.com/search?q=windows+run+as+administrator launching Oni as Administrator].<br />
4. Make the Oni folder writable by un-checking "Read-only" in the Properties window for the folder.<br />
5. Try both the run_full and run_wind scripts.
 
You can report problems with the Daodan DLL on [{{Discord}} our Discord server].


===Feature summary===
===Feature summary===
*Windows XP patch - Fixed Oni crashing at startup on modern computers.
*Buffer overflow patch – Fixes Oni crashing at startup on modern computers.
*Windowed mode - Oni runs inside a window.
*Windowed mode Oni can run inside a window properly.
*Custom screen resolutions - Includes many more default screen resolutions and the ability to add custom resolutions (see below).
*Custom screen resolutions Includes many more possible screen resolutions.
*BGRA32 (ARGB8888) support.
*BGRA32 (ARGB8888) texture support.
*Extra cheats - '''bigbadboss''' (player takes less weapon damage), '''bulletproof''' (player takes no weapon damage), '''kangaroo''' (high jumps), '''marypoppins''' (flight).
*Extra cheats – See {{SectionLink||Added cheat codes}}.
*Cheats always enabled; no need to beat game first.
*Cheats always enabled – No need to beat game first.
*Extra command line options (for advanced users) - For a list, type "Oni -help".
*Extra command-line options (for advanced users) For a list, type "Oni -help".
*DirectInput is used on NT, XP and Vista - Better support for keyboard layouts.
*A new input system based on Raw Input, which should fix mouse lag and judder, as well as disabling mouse acceleration.
*AIs have ability to properly dodge projectiles.
*AIs have ability to properly dodge projectiles.
*Stops fly-in character portraits from being stretched when playing in widescreen.
*Stops fly-in character portraits from being stretched when playing in widescreen resolutions.
*Enables [[Developer Mode]] – Enter the [[Data Comlink]] and type "thedayismine" or simply 'x' to activate it.
 
===Languages===
The Daodan DLL offers support for the Chinese version of the game as well as multibyte languages in general (see "multibyte" under {{SectionLink||All configuration settings}}). It also adds some basic localization support by allowing cheat code names and two hardcoded strings in Oni to be translated.
 
To enable Chinese support, type:
[language]
Chinese = True
This will load a DLL called xfhsm_oni.dll (provided with a Chinese copy of Oni in order to load the Chinese font that also comes with it).
 
Here are the strings that you can replace using the .ini file:
{| class="wikitable"
!INI name
!Description
|-
|blam
|Replaces body text of the [[:Image:Blam!.png|Blam window]].
|-
|damn
|Replaces title of the Blam window.
|-
|savepoint
|Replaces string "Save Point" in Load Game menu (see "Locales" below).
|-
|syndicatewarehouse
|Replaces string "Syndicate Warehouse" in Load Game menu (see "Locales" below).
|-
|''nameofcheat''_on/_off
|Replaces name of the built-in cheat code as it appears on the Data Comlink screen when code is entered. E.g., "behemoth_on=Gojira Desu!".
|}


===Settings===
====Locales====
====Patches====
In order to use the "savepoint" and "syndicatewarehouse" settings above, you must create a locale:
Creating a file called Daodan.[[wikipedia:INI_file|ini]] in the same directory as the Daodan DLL will allow you to enable/disable the patches inside Daodan. It can also be used to store configuration settings and language items. Each setting is stored inside a section as a name and value pair.
:1. Add a setting called "language" under the daodan.ini's [language] section with the name of your locale, e.g.:
[language]
language = xx
:You can call the locale whatever you want and it need not be an official ISO locale code such as "en" or "pt", but [[wp:List of ISO 639 language codes|here's the list of language codes]] if you want it.
:2. Create a folder alongside the Daodan DLL called "daodan_locales".
:3. Create an INI file inside called xx.ini (or whatever you called your locale in step 1).
:4. The contents of the INI should be:
savepoint = ''translation''
syndicatewarehouse = ''translation''
The next time Oni runs, you should see your translated strings in the Load Game screen. This approach allows you to create/download as many locale INIs as you want, place them in daodan_locales, and switch between them by changing the "language" setting in daodan.ini.


To enable a patch, look for the patches section in your Daodan.ini. If the patches section doesn't exist, create it by typing
===Configuration===
[Patch]
Creating a plain-text file called "daodan.[[wp:INI file|ini]]" in the same directory as the Daodan DLL will allow you to configure which patches are enabled, as well as to store configuration settings and language items. This file is typically created by the Daodan DLL the first time it loads.
at the end of your file.
You can now enable or disable patches by typing the patch name followed by '''=True''' or '''=False''' (caps and spacing don't matter). For example, let's say you want to turn off the cooldown timer patch (so you can drop and pick up the Mercury Bow after firing to fire again immediately) and the new windowed mode makes your game crash or makes it run slowly:
[Patch]
CooldownTimer = False
WindowHack = False
All patch names are found in the "All patches" section below.


====Options====
On modern versions of Windows (starting with Windows Vista), Oni does not properly request write access to the directory containing Oni.exe (i.e. C:\Program Files (x86)\Oni in typical installs). Windows detects this, and creates a dedicated directory for Oni.exe (and thus the Daodan DLL) to write its files to, located in C:\Users\<Your Username>\AppData\Local\VirtualStore. The directory for Oni will mirror its relative path on disk, so in a typical install it will be at VirtualStore\Program Files (x86)\Oni. This is where all files output by the program (startup.txt, persist.dat, key_config.txt, etc.) will be located when Oni is not run as an administrator. '''This is the location where daodan.ini must be placed if Oni is to be run as a non-administrator.''' Note that you can create your own folder for Oni, e.g. C:\Games\, to avoid this permissions issue.
With an unpatched Oni, the only way to change settings such as windowed mode was to create a batch file (.bat) and type command line options into it. In the beta Daodan, options can be added to the Daodan.ini. To add an option, look for the options section or type
[Options]
at the end of your Daodan.ini.
To enable windowed mode by default, type:
[Options]
Switch = False
Similarly, to disable sound, add the line:
[Options]
Switch = False
Sound = False
A list of options can be found in the "All options" section below.


====Command-line arguments====
Inside of the daodan.ini file, each configuration setting is stored inside a section as a name-value pair. To temporarily disable a setting in the INI, add a '#' to the beginning of the line and the Daodan will ignore it. Any settings not listed in the INI will use their default values which are listed in {{SectionLink||All configuration settings}}. To change a setting away from its default, add the setting to the relevant section. If the section does not yet exist, add it to the end of the file and add relevant entries under it.  Entries are case-<u>in</u>sensitive and spacing does not matter.
[[Customizing#Command-line_arguments|Command line options]] are still present in the beta Daodan although the syntax is a little different (and a bit more powerful.) The basic syntax for a command line option is this:
 
  -<ini section>.<name> <value>
Here is a simple example of a daodan.ini file:
Where <ini section> is the Daodan.ini section (usually '''Patch''' or '''Options''',) <name> is the option and <value> is the value to set it to (usually '''True''' or '''False'''.) Therefore, to disable sound, start Oni with this:
[devmode]
highres_console = True
showtriggervolumes = True
[gameplay]
cooldowntimer = False
 
daodan.ini may contain the following sections:
* devmode ''(Developer Mode Configuration)''
* gameplay ''(Gameplay Configuration)''
* graphics ''(Graphics Configuration)''
* language ''(Language Configuration)''
* modding ''(Modding Configuration)''
* oni ''(Original Oni Options Configuration)''
* windows ''(OS Interaction Options)''
 
For information on all possible settings, see {{SectionLink||All configuration settings}}.
 
===Command-line arguments===
[[Customizing#Command-line arguments|Command line options]] for the Daodan DLL can also be used when launching Oni, although the syntax is a little different (and a bit more powerful). The basic syntax for a command line option is this:
  -<ini section>.<option> <value>
For example, to disable sound start Oni with this:
  oni -options.sound false
  oni -options.sound false
When <ini section> is omitted, it is assumed to be '''options'''. When <value> is omitted, it is assumed to be '''true''' unless <name> starts with '''no''' (eg. '''nosound''') in which case it is assumed to be '''false'''. So an easier way to write the above command would be:
When <ini section> is omitted, it is assumed to be '''options'''. When <value> is omitted, it is assumed to be '''true''' unless <option> starts with '''no''' (eg. '''nosound''') in which case it is assumed to be '''false'''. So an easier way to write the above command would be:
  oni -nosound
  oni -nosound
Options or patches specified on the command line take precedence over options specified in Daodan.ini. Currently Oni's command line parser isn't powerful enough to parse language elements (no support for quoting arguments); this will be fixed in a later release.
Options or patches specified on the command line take precedence over options specified in daodan.ini so that you can temporarily override the usual settings. Currently Oni's command line parser isn't powerful enough to parse Language settings (no support for quoting arguments); this will be fixed in a later release.


===All patches===
===All configuration settings===
Below are the names of the patches you can turn on and off in Daodan.ini (names are case-insensitive). Also noted is whether the DLL has this patch turned on or off by default.
Below are the names of the configuration settings you can turn on and off in daodan.ini (names and sections are case-insensitive). Also noted is whether the DLL has this patch turned on or off by default.
{| class="wikitable"
{| class="wikitable"
!INI name
!INI Section
!INI Name
!Default
!Default
!Description
!Description
|-
|-
|alttab
|[devmode]
|highres_console
|true
|true
|Allows user to switch applications while in Oni (Alt-Tab) and use Windows key, however it may enable the screensaver as well.
|Fixes bug where console line becomes invisible at higher resolutions.
|-
|-
|argb8888
|[devmode]
|showtriggervolumes
|true
|true
|Textures using ARGB8888 can be used.
|Allows BSL variable "show_triggervolumes" and Ctrl+Shift+X (in devmode) to work.
|-
|-
|bsl
|[gameplay]
|bindablecheats
|true
|true
|Enables d_regen (unfinished) and prevents fly-in portraits from being stretched when playing in widescreen resolutions.
|Enables cheats to be bound to keys using key_config.txt. Requires "customactions" and "cheattable" to be on.
|-
|-
|cheater
|[gameplay]
|characterawareness
|true
|true
|
|Prevents AIs from forgetting about you when they are pursuing you and lose sight of you.
|-
|-
|[gameplay]
|cheatsenabled
|cheatsenabled
|true
|true
|Enables cheats without having to beat the game first.
|Enables cheats without having to beat the game first. Required for using 'tellmetheversion'.
|-
|-
|[gameplay]
|cheattable
|cheattable
|true
|true
|
|Replaces Oni's cheat table with table that includes new cheats (see section below). Required for using 'tellmetheversion'.
|-
|-
|[gameplay]
|cooldowntimer
|cooldowntimer
|true
|true
|Disables weapon cooldown exploit.
|Disables weapon cooldown exploit, e.g. dropping the Mercury Bow and picking it back up right away to reset weapon cooldown.
|-
|[gameplay]
|customactions
|true
|Allows new bindable actions to be registered with the DLL, such as bindable cheats (if "bindablecheats" is on).
|-
|[gameplay]
|kickguns
|false
|EXPERIMENTAL! Unfinished, do not use.
|-
|[gameplay]
|pathfinding
|true
|Multiplies size of pathfinding grid cache by eight in order to prevent crashes in large levels.
|-
|[gameplay]
|projaware
|true
|Allows AI to dodge incoming gunfire properly.
|-
|[gameplay]
|throwtest
|false
|EXPERIMENTAL! Enables experimentation with allowing enemies to be thrown over railings.
|-
|[gameplay]
|wpfadetime
|true
|Adds working function for existing BSL command wp_fadetime, sets fade time to 4800.
|-
|[graphics]
|binkplay
|true
|Fixes binkplay calls to use GDI and outro same mode as intro.
|-
|[graphics]
|daodangl
|true
|Provides an improved windowed mode (-noswitch); this patch is known to break the hiding of the Windows taskbar in fullscreen mode.
|-
|[graphics]
|displayenum
|true
|Offers a more accurate list of available display modes in the Options menu.
|-
|-
|daodandisplayenum
|[graphics]
|gamma
|true
|true
|Offers more display modes in the Options menu.
|Enables gamma slider in fullscreen, disables it in windowed mode.
|-
|-
|daodaninit
|[graphics]
|newweap
|true
|true
|If option (not patch) "usedaodanbsl" is also set to true, adds new Daodan BSL functions (documented below).
|Enables weapon info, so that standing above a weapon displays a message containing the weapon name and amount of ammo.
|-
|-
|directinput
|[graphics]
|optionsvisible
|true
|Enables always showing the options button in main menu, even when pausing from a game.
|-
|[graphics]
|showalllasersights
|false
|Enables visibility of all (also enemies') weapon lasersights
|-
|[graphics]
|widescreenportraits
|true
|true
|Forces on DirectInput.
|Prevents fly-in portraits from being stretched when playing in widescreen resolutions.
|-
|-
|disablecmdline
|[language]
|chinese
|true
|true
|Replaces existing command line parser with Daodan's in order to add new commands. Meant to be used with getcmdline.
|Allows Chinese fonts to be shown if the required DLL is available.
|-
|-
|[language]
|fonttexturecache
|fonttexturecache
|true
|true
|Doubles size of font texture cache.
|Doubles size of font texture cache.
|-
|-
|getcmdline
|[language]
|language
|en
|Sets locale name for hardcoded strings (see {{SectionLink||Locales}}).
|-
|[language]
|nomultibyte
|true
|true
|Replaces existing command line parser with Daodan's in order to add new commands. Meant to be used with disablecmdline.
|Enables languages which use multibyte coding (such as Chinese).
|-
|-
|kickguns
|[modding]
|false
|argb8888
|Unfinished, do not use.
|true
|Enables the use of textures using ARGB8888.
|-
|[modding]
|d_regen
|true
|Enables script command d_regen (query/set regeneration for any character).
|-
|[modding]
|daodanbsl
|true
|Adds new BSL commands (see below).
|-
|-
|killvtune
|[modding]
|REMOVED
|hdscreens_lowres
|Would prevent loading of vtuneapi.dll.
|true
|Allows HD intro/ending screens on game resolutions smaller than 1024x768.
|-
|-
|[modding]
|largetextures
|largetextures
|true
|true
|Textures up to 512x512 can be used.
|Enables the use of textures up to 512x512.
|-
|-
|[modding]
|levelplugins
|levelplugins
|true
|true
|Allows level files to be loaded from the GDF which do not end in "_Final".
|Allows level files that do not end in "_Final" to be loaded from the GDF.
|-
|-
|multibyte
|[oni]
|debug
|false
|false
|Enables languages which use multibyte coding (such as Chinese).
|Not useful; probably does nothing.
|-
|[oni]
|debugfiles
|false
|Enables function logging; when active, BSL function calls are logged to script_debug.txt.
|-
|-
|newweap
|[oni]
|true
|findsounds
|Picking up a weapon displays a message containing the weapon name and amount of ammo.
|false
|Not useful, extends output of sound_list_broken_links.
|-
|-
|particledisablebit
|[oni]
|ignore_private_data
|false
|false
|Unlocks particle action disabling/enabling bits for all events.
|Disables the loading of 'private data' in level0. Probably has no effect.
|-
|-
|pathfinding
|[oni]
|sound
|true
|true
|Multiplies size of pathfinding grid cache by eight in order to prevent crashes in large levels.
|Enables sound.
|-
|-
|projaware
|[oni]
|switch
|true
|true
|Allows AI to dodge incoming gunfire properly.
|Enables always switching screen to resolution on Oni's Options screen, making the game fullscreen; opposite of Oni's built-in argument "noswitch".
|-
|-
|safeprintf
|[windows]
|alttab
|true
|true
|Replaces Oni's function that prints to startup.txt with a safer one.
|Allows user to switch applications while in Oni (Alt-Tab) and use the Windows key; however, it may enable the screensaver as well.
|-
|-
|throwtest
|[windows]
|false
|border
|
|true
|Adds a border in windowed mode if '[graphics] daodangl' is active.
|-
|-
|usedaodangl
|[windows]
|clipcursor
|true
|true
|Provides an improved windowed mode (-noswitch); this patch is known to break the hiding of the Windows taskbar in fullscreen mode.
|Limits cursor to Oni's window. This is always enabled if Daodan Input is enabled.
|-
|-
|usegettickcount
|[windows]
|daodaninput
|true
|true
|Replaces Oni's timing functions with more accurate ones.
|A new input system which reports input on every frame, which should fix issues with mouse lag/judder and high-FPS displays.
|-
|-
|windowhack
|[windows]
|false
|directinput
|Fallback to be used for simpler windowed mode hack instead of "usedaodangl".
|true
|Forces on DirectInput when Daodan Input is disabled.
|-
|-
|wpfadetime
|[windows]
|true
|mousesensitivity
|Adds working function for existing BSL command wp_fadetime, sets fade time to 4800.
|1.0
|}
|Multiplier for mouse movement values when Daodan Input is enabled. 1.0 is Oni's default.
 
===All options===
Below are the names of the options you can turn on and off in Daodan.ini (names are case-insensitive). Also noted is whether the DLL has this option turned on or off by default.
{| class="wikitable"
!INI name
!Default
!Description
|-
|-
|border
|[windows]
|disablecmdline
|true
|true
|If "windowhack" patch is active, make sure game window has border in windowed mode.
|Disables Oni's existing command line parser as Daodan has its own.
|-
|-
|multibyte
|[windows]
|killvtune
|false
|false
|Redirects to patch "multibyte"; see "Patches" section.
|Prevents loading of vtuneapi.dll.
|-
|-
|shadow
|[windows]
|false
|safeprintf
|If "windowhack" patch is active, make sure game window has shadow in windowed mode.
|-
|switch
|true
|true
|Always switch screen to resolution on Oni's Options screen, making the game fullscreen; opposite of Oni's built-in argument "noswitch".
|Replaces Oni's function that prints to startup.txt with a safer one.
|-
|-
|[windows]
|topmost
|topmost
|false
|false
|Keep game window on top in windowed mode, even when switching applications.
|Keeps game window on top in windowed mode, even when switching applications.
|-
|-
|usedaodanbsl
|[windows]
|usegettickcount
|true
|true
|Adds new BSL commands (see below) as long as patch "daodaninit" is true.
|Replaces Oni's timing functions with more accurate ones.
|-
|''various''
| --
|Oni's built-in arguments; see [[Customizing#Command-line_arguments]].
|}
|}
===Added cheat codes===
*'''bigbadboss'''
:Player takes less weapon damage.
*'''buddha'''
:Player is unkillable (will not go below 1HP).
*'''bulletproof'''
:Player takes no weapon damage.
*'''kangaroo'''
:Player can make super-high jumps.
*'''marypoppins'''
:Player can fly by holding down jump key.
*'''shinobi'''
:Extra difficulty mode; player always has 1HP, but also is immune to weapons, and the enemy AI cannot hear the player.


===Added BSL functions===
===Added BSL functions===
===BSL===
Any time a function can both get and set a value, and you set the value, the old value should be returned, barring any programming oversight by Gumby.
Any time a function can both get and set a value, and you set the value, the old value should be is returned, barring any programming oversight by Gumby.
 
====Math====
====Math====
* int '''int32div''' n1:int n2:int
:Divides two integers
* int '''int32mul''' n1:int n2:int
* int '''int32mul''' n1:int n2:int
:Multiplies two integers
:Multiplies two integers
* float '''div''' [int1:int|float1:float] [int2:int|float2:float]
:Divides two two numbers
* float '''mul''' [int1:int|float1:float] [int2:int|float2:float]
* float '''mul''' [int1:int|float1:float] [int2:int|float2:float]
:Multiplies two numbers
:Multiplies two numbers
* int '''int32div''' n1:int n2:int
:Divides two integers
* float '''div''' [int1:int|float1:float] [int2:int|float2:float]
:Divides two two numbers
* int '''int32rand''' start:int end:int
* int '''int32rand''' start:int end:int
:Returns a pseudo-random number between two numbers (inclusive).
:Returns a pseudo-random number between two numbers (inclusive).
====Characters====
====Characters====
* int '''d_getkills''' [ai_name:str | script_id:int]
* float '''d_distance''' [ai_name:string | script_id:int] [ai_name:string | script_id:int]
:Gets the number of kills a character has
:Gets the distance between two characters
* int '''d_getdamage''' [ai_name:str | script_id:int]
* int '''d_getdamage''' [ai_name:str | script_id:int]
:Gets the amount of damage a character has caused
:Gets the amount of damage a character has caused
* string '''d_name''' [ai_name:str | script_id:int] [newname:string]
:Gets or sets a character's name
* string '''d_regen''' [ai_name:str | script_id:int] on_off:bool
:Currently broken, won't do anything
* int '''d_getindex''' [ai_name:str]
* int '''d_getindex''' [ai_name:str]
:Gets a character's script_id from their name
:Gets a character's script_id from their name
* int '''d_powerup''' ai_name:str|script_id:int powerup:str [newcount:int]
* int '''d_getkills''' [ai_name:str | script_id:int]
:Gets or sets the amount of powerups a character has
:Gets the number of kills a character has
:Powerup list the same as with '''chr_givepowerup''' with the addition of "bossshield"
* int '''d_health''' [ai_name:str | script_id:int] [newhealth:int]
* int '''d_health''' [ai_name:str | script_id:int] [newhealth:int]
:Gets or sets a character's health
:Gets or sets a character's health
* int '''d_maxhealth''' [ai_name:str | script_id:int] [newmaxhealth:int]
:Gets or sets a character's maxhealth
* int '''d_holdkey''' [ai_name:string | script_id:int] keys frames:int
* int '''d_holdkey''' [ai_name:string | script_id:int] keys frames:int
:Makes a character hold a key
:Makes a character hold a key
Line 256: Line 410:
:Checks if player is holding a key
:Checks if player is holding a key
:Possibly broken
:Possibly broken
* int '''d_waitforkeypress''' keys
* float '''d_location''' [ai_name:string | script_id:int] axis:string anything:string
:Waits for a keypress from the player
:Gets the X, Y or Z coordinate of a character, as specified in "axis"; the "anything" parameter is unused but must be present
* int '''d_powerup''' [ai_name:string | script_id:int] powerup:string
:Gets or sets a character's powerups
* float '''d_location''' [ai_name:string | script_id:int] xyz:string
:Gets the X\Y\Z coordinate of a character
* float '''d_location''' [ai_name:string | script_id:int] x:float y:float z:float
* float '''d_location''' [ai_name:string | script_id:int] x:float y:float z:float
:Sets the XYZ coordinates of a character
:Sets the XYZ coordinates of a character
* int '''d_regen''' [ai_name:string | script_id:int] yesno:int
* int '''d_maxhealth''' [ai_name:str | script_id:int] [newmaxhealth:int]
:Gets or sets a character's regeneration abilities
:Gets or sets a character's maxhealth
* string '''d_name''' [ai_name:str | script_id:int] [newname:string]
:Gets or sets a character's name
* int '''d_powerup''' ai_name:str|script_id:int powerup:str [newcount:int]
:Gets or sets the amount of powerups a character has
:Powerup list is the same one used with '''chr_givepowerup''', with the addition of "bossshield"
* int '''d_regen''' [ai_name:str | script_id:int] on_off:bool
:Gets or sets a character's regeneration (like elderrune for the player)
* int '''d_waitforkey''' keys
:Waits for a keypress from the player


====Text====
====Text====
Line 272: Line 431:
:Colors are ints between 0 and 255. Other numbers will be reduced to 255.
:Colors are ints between 0 and 255. Other numbers will be reduced to 255.
:Any colors you do not supply will be replaced with the default values: 255, 255, 255 and 63, 63. 63
:Any colors you do not supply will be replaced with the default values: 255, 255, 255 and 63, 63. 63
* string '''sprintf''' str1:format ...
* string '''sprintf''' str1:format ...
:Does a C-style sprintf operation on a string
:Does a C-style sprintf operation on a string


===Developer Mode===
===Added input bindings===
The DLL enables [[Developer Mode]]; go to the pause screen (F1) and type "thedayismine" or simply 'x' to activate it.
When Daodan Input is enabled, the following inputs can be bound in key_config.txt in addition to the [[Customizing/Binding#Bindable key names|usual ones]].
 
===Custom screen resolutions===
If you wish to run in a screen resolution that is not available and you are running the recommended version of C-Daodan, create a text file (Notepad document) called "res.txt" in your Oni folder (C:\Program Files\Oni) containing a list of custom resolutions in this format (one resolution per line):
 
800x600<br />
1024x600<br />
1024x768
 
==FASM-Daodan (old)==
There is also a much older release of Daodan, referred to as FASM-Daodan. This is the original version by SFeLi. Unlike the C-Daodan, FASM-Daodan requires a different DLL to be downloaded depending on which Oni.exe is used. It does not support the newer Daodan features, such as windowed mode and custom resolutions, however it still contains the basic patches such as the Windows XP patch and the custom cheats.
 
[http://sfeli.oni2.net/daodan/basic-0.6.6.zip Download a ZIP containing the DLLs for each version.]


[http://sfeli.oni2.net/daodan/current.zip Download a ZIP containing the DLLs for an experimental (unstable) FASM-Daodan] This includes the projectile awareness patch and support for any language (except Chinese and Japanese).
*'''mousebutton5'''
:The "forward" button on most 5-button mice.
*'''scrollup'''
:Scrolling up one notch on a mouse scroll wheel or touchpad.
*'''scrolldown'''
:Scrolling down one notch on a mouse scroll wheel or touchpad.
*'''scrollleft'''
:Scrolling left on a mouse with an omnidirectional scroll wheel or a touchpad.
*'''scrollright'''
:Scrolling right on a mouse with an omnidirectional scroll wheel or a touchpad.
*'''pagedown'''
:This was broken in DirectInput mode in vanilla Oni.


[[Category:Patches]]
[[Category:Patches]]

Latest revision as of 18:10, 27 March 2024

This is about a Windows-only patch for the game engine. For the entity within the game's story, see Daodan. For information on the patches to Mac versions of Oni and historical patching of Windows Oni, see the Patches category. Also see OniX, a rebuild of the Oni application for modern Windows systems.

The Daodan DLL is a patch for Oni for Windows that hooks into the game engine to fix bugs and add features. It does this by posing as binkw32.dll, the library that Oni loads so that it can play the game's opening and ending videos. The Daodan fixes issues such as the famous "Blam!" error that occurs on modern machines. It also adds new features such as support for widescreen resolutions and bonus cheat codes. The Daodan DLL was created by SFeLi and then developed further by RossyMiles, Gumby and Alloc.

Subpages: Change log

Note that you already have the Daodan DLL installed if you installed the Anniversary Edition.

Manual installation instructions

(For non-AE users)

1. You'll have to extract the Daodan DLL files yourself from the AE package here. The files you need are in the plain\win_only\ directory.
2. Extract the Oni.exe meant to go with the Daodan DLL from the AE package here.
3. Find where your copy of Oni has been installed on your hard drive; usually it's "C:\Program Files\Oni\". This folder should contain GameDataFolder and Oni.exe (just called "Oni" if you have file extensions hidden). Back up this Oni.exe by renaming it (e.g. "Oni-original.exe").
4. Place the newly-downloaded Oni.exe, binkw32.dll, realbink.dll, and assorted files into the Oni\ folder.
5. To confirm that you have done everything correctly, run Oni.exe. Enter the game, bring up the Data Comlink (F1 by default), and type "tellmetheversion"; if you get a result like "Daodan v.x.y", the DLL is working.

Troubleshooting

If the game does not display correctly (for instance, a black window), try the following in any order:

1. Disable the intro movie by renaming GameDataFolder\intro.bik. This often fixes the game window.
2. Open the daodan.ini in Notepad and set either "daodangl" or "windowhack" to true. "windowhack" should at least center the window on the screen.
3. Try launching Oni as Administrator.
4. Make the Oni folder writable by un-checking "Read-only" in the Properties window for the folder.
5. Try both the run_full and run_wind scripts.

You can report problems with the Daodan DLL on our Discord server.

Feature summary

  • Buffer overflow patch – Fixes Oni crashing at startup on modern computers.
  • Windowed mode – Oni can run inside a window properly.
  • Custom screen resolutions – Includes many more possible screen resolutions.
  • BGRA32 (ARGB8888) texture support.
  • Extra cheats – See § Added cheat codes.
  • Cheats always enabled – No need to beat game first.
  • Extra command-line options (for advanced users) – For a list, type "Oni -help".
  • A new input system based on Raw Input, which should fix mouse lag and judder, as well as disabling mouse acceleration.
  • AIs have ability to properly dodge projectiles.
  • Stops fly-in character portraits from being stretched when playing in widescreen resolutions.
  • Enables Developer Mode – Enter the Data Comlink and type "thedayismine" or simply 'x' to activate it.

Languages

The Daodan DLL offers support for the Chinese version of the game as well as multibyte languages in general (see "multibyte" under § All configuration settings). It also adds some basic localization support by allowing cheat code names and two hardcoded strings in Oni to be translated.

To enable Chinese support, type:

[language]
Chinese = True

This will load a DLL called xfhsm_oni.dll (provided with a Chinese copy of Oni in order to load the Chinese font that also comes with it).

Here are the strings that you can replace using the .ini file:

INI name Description
blam Replaces body text of the Blam window.
damn Replaces title of the Blam window.
savepoint Replaces string "Save Point" in Load Game menu (see "Locales" below).
syndicatewarehouse Replaces string "Syndicate Warehouse" in Load Game menu (see "Locales" below).
nameofcheat_on/_off Replaces name of the built-in cheat code as it appears on the Data Comlink screen when code is entered. E.g., "behemoth_on=Gojira Desu!".

Locales

In order to use the "savepoint" and "syndicatewarehouse" settings above, you must create a locale:

1. Add a setting called "language" under the daodan.ini's [language] section with the name of your locale, e.g.:
[language]
language = xx
You can call the locale whatever you want and it need not be an official ISO locale code such as "en" or "pt", but here's the list of language codes if you want it.
2. Create a folder alongside the Daodan DLL called "daodan_locales".
3. Create an INI file inside called xx.ini (or whatever you called your locale in step 1).
4. The contents of the INI should be:
savepoint = translation
syndicatewarehouse = translation

The next time Oni runs, you should see your translated strings in the Load Game screen. This approach allows you to create/download as many locale INIs as you want, place them in daodan_locales, and switch between them by changing the "language" setting in daodan.ini.

Configuration

Creating a plain-text file called "daodan.ini" in the same directory as the Daodan DLL will allow you to configure which patches are enabled, as well as to store configuration settings and language items. This file is typically created by the Daodan DLL the first time it loads.

On modern versions of Windows (starting with Windows Vista), Oni does not properly request write access to the directory containing Oni.exe (i.e. C:\Program Files (x86)\Oni in typical installs). Windows detects this, and creates a dedicated directory for Oni.exe (and thus the Daodan DLL) to write its files to, located in C:\Users\<Your Username>\AppData\Local\VirtualStore. The directory for Oni will mirror its relative path on disk, so in a typical install it will be at VirtualStore\Program Files (x86)\Oni. This is where all files output by the program (startup.txt, persist.dat, key_config.txt, etc.) will be located when Oni is not run as an administrator. This is the location where daodan.ini must be placed if Oni is to be run as a non-administrator. Note that you can create your own folder for Oni, e.g. C:\Games\, to avoid this permissions issue.

Inside of the daodan.ini file, each configuration setting is stored inside a section as a name-value pair. To temporarily disable a setting in the INI, add a '#' to the beginning of the line and the Daodan will ignore it. Any settings not listed in the INI will use their default values which are listed in § All configuration settings. To change a setting away from its default, add the setting to the relevant section. If the section does not yet exist, add it to the end of the file and add relevant entries under it. Entries are case-insensitive and spacing does not matter.

Here is a simple example of a daodan.ini file:

[devmode]
highres_console = True
showtriggervolumes = True

[gameplay]
cooldowntimer = False

daodan.ini may contain the following sections:

  • devmode (Developer Mode Configuration)
  • gameplay (Gameplay Configuration)
  • graphics (Graphics Configuration)
  • language (Language Configuration)
  • modding (Modding Configuration)
  • oni (Original Oni Options Configuration)
  • windows (OS Interaction Options)

For information on all possible settings, see § All configuration settings.

Command-line arguments

Command line options for the Daodan DLL can also be used when launching Oni, although the syntax is a little different (and a bit more powerful). The basic syntax for a command line option is this:

-<ini section>.<option> <value>

For example, to disable sound start Oni with this:

oni -options.sound false

When <ini section> is omitted, it is assumed to be options. When <value> is omitted, it is assumed to be true unless <option> starts with no (eg. nosound) in which case it is assumed to be false. So an easier way to write the above command would be:

oni -nosound

Options or patches specified on the command line take precedence over options specified in daodan.ini so that you can temporarily override the usual settings. Currently Oni's command line parser isn't powerful enough to parse Language settings (no support for quoting arguments); this will be fixed in a later release.

All configuration settings

Below are the names of the configuration settings you can turn on and off in daodan.ini (names and sections are case-insensitive). Also noted is whether the DLL has this patch turned on or off by default.

INI Section INI Name Default Description
[devmode] highres_console true Fixes bug where console line becomes invisible at higher resolutions.
[devmode] showtriggervolumes true Allows BSL variable "show_triggervolumes" and Ctrl+Shift+X (in devmode) to work.
[gameplay] bindablecheats true Enables cheats to be bound to keys using key_config.txt. Requires "customactions" and "cheattable" to be on.
[gameplay] characterawareness true Prevents AIs from forgetting about you when they are pursuing you and lose sight of you.
[gameplay] cheatsenabled true Enables cheats without having to beat the game first. Required for using 'tellmetheversion'.
[gameplay] cheattable true Replaces Oni's cheat table with table that includes new cheats (see section below). Required for using 'tellmetheversion'.
[gameplay] cooldowntimer true Disables weapon cooldown exploit, e.g. dropping the Mercury Bow and picking it back up right away to reset weapon cooldown.
[gameplay] customactions true Allows new bindable actions to be registered with the DLL, such as bindable cheats (if "bindablecheats" is on).
[gameplay] kickguns false EXPERIMENTAL! Unfinished, do not use.
[gameplay] pathfinding true Multiplies size of pathfinding grid cache by eight in order to prevent crashes in large levels.
[gameplay] projaware true Allows AI to dodge incoming gunfire properly.
[gameplay] throwtest false EXPERIMENTAL! Enables experimentation with allowing enemies to be thrown over railings.
[gameplay] wpfadetime true Adds working function for existing BSL command wp_fadetime, sets fade time to 4800.
[graphics] binkplay true Fixes binkplay calls to use GDI and outro same mode as intro.
[graphics] daodangl true Provides an improved windowed mode (-noswitch); this patch is known to break the hiding of the Windows taskbar in fullscreen mode.
[graphics] displayenum true Offers a more accurate list of available display modes in the Options menu.
[graphics] gamma true Enables gamma slider in fullscreen, disables it in windowed mode.
[graphics] newweap true Enables weapon info, so that standing above a weapon displays a message containing the weapon name and amount of ammo.
[graphics] optionsvisible true Enables always showing the options button in main menu, even when pausing from a game.
[graphics] showalllasersights false Enables visibility of all (also enemies') weapon lasersights
[graphics] widescreenportraits true Prevents fly-in portraits from being stretched when playing in widescreen resolutions.
[language] chinese true Allows Chinese fonts to be shown if the required DLL is available.
[language] fonttexturecache true Doubles size of font texture cache.
[language] language en Sets locale name for hardcoded strings (see § Locales).
[language] nomultibyte true Enables languages which use multibyte coding (such as Chinese).
[modding] argb8888 true Enables the use of textures using ARGB8888.
[modding] d_regen true Enables script command d_regen (query/set regeneration for any character).
[modding] daodanbsl true Adds new BSL commands (see below).
[modding] hdscreens_lowres true Allows HD intro/ending screens on game resolutions smaller than 1024x768.
[modding] largetextures true Enables the use of textures up to 512x512.
[modding] levelplugins true Allows level files that do not end in "_Final" to be loaded from the GDF.
[oni] debug false Not useful; probably does nothing.
[oni] debugfiles false Enables function logging; when active, BSL function calls are logged to script_debug.txt.
[oni] findsounds false Not useful, extends output of sound_list_broken_links.
[oni] ignore_private_data false Disables the loading of 'private data' in level0. Probably has no effect.
[oni] sound true Enables sound.
[oni] switch true Enables always switching screen to resolution on Oni's Options screen, making the game fullscreen; opposite of Oni's built-in argument "noswitch".
[windows] alttab true Allows user to switch applications while in Oni (Alt-Tab) and use the Windows key; however, it may enable the screensaver as well.
[windows] border true Adds a border in windowed mode if '[graphics] daodangl' is active.
[windows] clipcursor true Limits cursor to Oni's window. This is always enabled if Daodan Input is enabled.
[windows] daodaninput true A new input system which reports input on every frame, which should fix issues with mouse lag/judder and high-FPS displays.
[windows] directinput true Forces on DirectInput when Daodan Input is disabled.
[windows] mousesensitivity 1.0 Multiplier for mouse movement values when Daodan Input is enabled. 1.0 is Oni's default.
[windows] disablecmdline true Disables Oni's existing command line parser as Daodan has its own.
[windows] killvtune false Prevents loading of vtuneapi.dll.
[windows] safeprintf true Replaces Oni's function that prints to startup.txt with a safer one.
[windows] topmost false Keeps game window on top in windowed mode, even when switching applications.
[windows] usegettickcount true Replaces Oni's timing functions with more accurate ones.

Added cheat codes

  • bigbadboss
Player takes less weapon damage.
  • buddha
Player is unkillable (will not go below 1HP).
  • bulletproof
Player takes no weapon damage.
  • kangaroo
Player can make super-high jumps.
  • marypoppins
Player can fly by holding down jump key.
  • shinobi
Extra difficulty mode; player always has 1HP, but also is immune to weapons, and the enemy AI cannot hear the player.

Added BSL functions

Any time a function can both get and set a value, and you set the value, the old value should be returned, barring any programming oversight by Gumby.

Math

  • int int32div n1:int n2:int
Divides two integers
  • int int32mul n1:int n2:int
Multiplies two integers
  • float div [int1:int|float1:float] [int2:int|float2:float]
Divides two two numbers
  • float mul [int1:int|float1:float] [int2:int|float2:float]
Multiplies two numbers
  • int int32rand start:int end:int
Returns a pseudo-random number between two numbers (inclusive).

Characters

  • float d_distance [ai_name:string | script_id:int] [ai_name:string | script_id:int]
Gets the distance between two characters
  • int d_getdamage [ai_name:str | script_id:int]
Gets the amount of damage a character has caused
  • int d_getindex [ai_name:str]
Gets a character's script_id from their name
  • int d_getkills [ai_name:str | script_id:int]
Gets the number of kills a character has
  • int d_health [ai_name:str | script_id:int] [newhealth:int]
Gets or sets a character's health
  • int d_holdkey [ai_name:string | script_id:int] keys frames:int
Makes a character hold a key
Possibly broken
  • int d_isheld keys
Checks if player is holding a key
Possibly broken
  • float d_location [ai_name:string | script_id:int] axis:string anything:string
Gets the X, Y or Z coordinate of a character, as specified in "axis"; the "anything" parameter is unused but must be present
  • float d_location [ai_name:string | script_id:int] x:float y:float z:float
Sets the XYZ coordinates of a character
  • int d_maxhealth [ai_name:str | script_id:int] [newmaxhealth:int]
Gets or sets a character's maxhealth
  • string d_name [ai_name:str | script_id:int] [newname:string]
Gets or sets a character's name
  • int d_powerup ai_name:str|script_id:int powerup:str [newcount:int]
Gets or sets the amount of powerups a character has
Powerup list is the same one used with chr_givepowerup, with the addition of "bossshield"
  • int d_regen [ai_name:str | script_id:int] on_off:bool
Gets or sets a character's regeneration (like elderrune for the player)
  • int d_waitforkey keys
Waits for a keypress from the player

Text

  • void d_dprint text:string [textcolor: r b g] [shadowcolor: r b g]
Prints to console in color
Colors are ints between 0 and 255. Other numbers will be reduced to 255.
Any colors you do not supply will be replaced with the default values: 255, 255, 255 and 63, 63. 63
  • string sprintf str1:format ...
Does a C-style sprintf operation on a string

Added input bindings

When Daodan Input is enabled, the following inputs can be bound in key_config.txt in addition to the usual ones.

  • mousebutton5
The "forward" button on most 5-button mice.
  • scrollup
Scrolling up one notch on a mouse scroll wheel or touchpad.
  • scrolldown
Scrolling down one notch on a mouse scroll wheel or touchpad.
  • scrollleft
Scrolling left on a mouse with an omnidirectional scroll wheel or a touchpad.
  • scrollright
Scrolling right on a mouse with an omnidirectional scroll wheel or a touchpad.
  • pagedown
This was broken in DirectInput mode in vanilla Oni.