View source for Developer Mode

[[Image:TheDayIsMine_crate.png|frame|Found on a crate in<br>Syndicate Warehouse]]
{{TOCfloat|limit=3}}
Developer Mode is a bundle of features created by [[Bungie West]] to help them develop [[Oni]]: a console line for entering scripting commands, manual camera controls, and various debugging features. It is enabled by the [[Cheats|cheat code]] '''thedayismine''' (see "Download it..." below before trying the code).

Despite being hinted at by a crate texture (right) and leaked as part of a list of cheat codes during beta testing, this cheat code did not work upon Oni's release, and it was long believed that Developer Mode had been cut from retail versions of Oni. However, Dev Mode is actually present in ''all'' available versions of Oni (except PS2). It just needed to be unlocked, as the community learned [[History_of_Oni_modding/The_tale_of_Dev_Mode|back in 2006]].

Below you will find download links, unlocking instructions, and finally an overview of the Developer Mode's features.
<br clear="all" />
==Getting it to work==
===Download it...===
In Windows, you can install the [[Daodan DLL]] to unlock Developer Mode; note that the [[Anniversary Edition]] installs the Daodan DLL automatically.<br>
On the Mac, the [[AE:FERAL|Intel build]] of Oni already has Dev Mode unlocked; note that the Anniversary Edition installs the Intel build automatically.

{{Divhide|...or do it yourself}}
===...or do it yourself===
You may want to read this if your Windows version of Oni is not covered by the above DLL (e.g. if you have an odd language version) or if your Mac is not running the Intel build (though a Dev Mode-enabled version of the last PPC build is [[AE:OMNI|HERE]]).

First, get a good hex editor. Ideally, it should allow you to search for sequences containing joker characters (that is, wildcards or bit masks). One such editor for PC is [http://www.chmaas.handshake.de/delphi/freeware/xvi32/xvi32.htm XVI32]. On Macs, [http://www.ufsexplorer.com/cihex.php CI Hex Viewer] is free, powerful, and can perform the search you need, but [http://ridiculousfish.com/hexfiend/ Hex Fiend] has a better comparison function so you can check your work afterward (open original and edited binaries and choose File>Compare "Oni" and "Oni").

====Cheat code lookup tables====
{|style="float:right"
|+Cheat codes and IDs
|
{|border=1 cellspacing=0
|-
|shapeshifter
|0x00
|-
|liveforever
|0x01
|-
|touchofdeath
|0x02
|-
|canttouchthis
|0x03
|-
|''fatloot''
|0x04
|-
|glassworld
|0x05
|-
|''winlevel''
|0x06
|-
|''loselevel''
|0x07
|-
|bighead
|0x08
|-
|minime
|0x09
|-
|superammo
|0x0A
|}
|
{|border=1 cellspacing=0
|-
|'''thedayismine'''
|0x0B
|-
|reservoirdogs
|0x0C
|-
|roughjustice
|0x0D
|-
|chenille
|0x0E
|-
|behemoth
|0x0F
|-
|elderrune
|0x10
|-
|moonshadow
|0x11
|-
|''munitionfrenzy''
|0x12
|-
|fistsoflegend
|0x13
|-
|killmequick
|0x14
|-
|carousel
|0x15
|}
|}

;Cheat overview
:There are 22 cheat events in every version of Oni, indexed from 0 to 21 (or 0x00 to 0x15 in hexadecimal). See table on right; the cheat code omitted by Bungie, thedayismine, is in bold. The four italicized cheat codes are "one-way" cheats that do not have on/off states, which affects the table described below.
:The order is the same in every version, so we can refer to the cheats by their ID, or by the cheat code used to activate them.

;Cheat lookup table
:When you type characters in the "pause screen", the text you enter is progressively compared with all the strings in the cheat table.
:When and if there is a match, the corresponding confirmation message is displayed for enablement/confirmation or for disablement if the cheat was already on, and the corresponding cheat event takes effect when the Pause screen is closed.
:In full, each row of the cheat table consists of:
:*a pointer to the cheat code string
:*a pointer to the "enabled"/recognition message
:*a pointer to the "disabled" message (if any)
:*the internal ID of the cheat event to launch
There is a row for every cheat, and they appear by order of increasing ID. In most Oni builds, the developer mode cheat (ID 0x0B) is simply skipped over; '''reservoirdogs''' (0x0C) comes right after '''superammo''' (0x0A).

;Data size on different platforms
:In the PC, PC demo and Mac OS X (PPC) builds, every row of the lookup table takes up 16 bytes; the 3 pointers and the ID are 4-byte data words (Little Endian on PC, Big Endian on PPC Macs); if a cheat has no "disabled" message, the row's third pointer is null.
<!--This does not appear to be true, not sure what version geyser was looking at. The item below this claimed to be for the Mac beta, but it's actually true of the Mac retail app. --Iritscen
:In the Mac OS 9 retail and demo, every row of the lookup table takes up 8 bytes; the 3 pointers and the ID are 3-byte data words (Big Endian); if a cheat has no "disabled" message, the last byte of the third element is taken up by the ID (the remaining 2 bytes are garbage, as well as the ID field).-->
:In the Mac OS 9 builds, the pointers and the ID are 2-byte words (Big Endian); regular rows take up 8 bytes; for one-way cheats with no "disabled" message, weird stuff happens to the third pointer and to the ID, and the row takes up 10 bytes... the ID can be found in what would be the first byte of the ID field instead of the second, and the remaining 3 bytes are garbage. An additional garbage byte is added between consecutive one-way cheats (0x06 and 0x07).

====Let's kill killmequick====
In the PC, PC demo and Mac OS X (PPC) builds, there's extra space at the end of the lookup table and where the cheat codes/messages are stored, so one can add '''thedayismine''' as an extra cheat. On Mac OS 9, the data is packed tighter (and the text strings are stored together with their size), so the only easy way is to replace an existing cheat. Since replacing an existing cheat is the only solution that works on all platforms, the following mini-tutorial will explain how to bind the Developer Mode cheat event to the Ultra Mode cheat code '''killmequick''' (since hardly anyone uses that cheat).

====Finding the lookup table====
Open the executable (or the data fork of the executable in the Mac OS 9 build), after backing it up of course.... We shall look for the last three elements of the table, corresponding to '''fistsoflegend''', '''killmequick''' and '''carousel'''.
;In the PC retail and PC demo builds, look for '''13 00 00 00 ## ## ## ## ## ## ## ## ## ## ## ## 14 00 00 00 ## ## ## ## ## ## ## ## ## ## ## ## 15 00 00 00'''
;In the Mac OS X (PPC) build, look for '''00 00 00 13 ## ## ## ## ## ## ## ## ## ## ## ## 00 00 00 14 ## ## ## ## ## ## ## ## ## ## ## ## 00 00 00 15''' ([[:File:Finding killmequick - Omni build.jpg|sample pic]])
;In the Mac OS 9 builds, look for '''00 13 ## ## ## ## ## ## 00 14 ## ## ## ## ## ## 00 15''' ([[:File:Finding killmequick - Mac OS 9 build.jpg|sample pic]])
;
where the ## are joker characters (wildcard bytes). Once you've found that data (make sure it occurs only once in the file), replace the '''14''' with a '''0B'''.

Developer Mode will now be enabled/disabled every time you type '''killmequick''' at the Pause screen; you'll get "Ultra Mode Enabled" and "Ultra Mode Disabled" as confirmation messages.
{{Divhide|end}}

==Using it==
===First check===
Cheats are normally unavailable until you finish the full version of the game, and Developer Mode can only be activated through a cheat code. For unlocking cheats "manually" (especially necessary with the demos), see [[Cheats|HERE]]. However, cheats are enabled all the time when the Daodan DLL is installed in Windows or when using the Mac Intel build.

Enter the Pause screen (default key F1) and look for a confirmation message after typing the Developer Mode cheat ('''thedayismine''', or '''killmequick''' if you followed the DIY tutorial, or just '''x''' -- the DLL and Intel build provide that shortcut). However, you may not notice anything special when you get back to the game (although there should be occasional console messages appearing at the bottom-left). 

The quickest way to tell whether Dev Mode definitely works, right after you get the confirmation message, is to exit the Diary screen and to press '''End'''. That should teleport you to where the camera is (usually back and up, possibly through walls and ceilings).

Here's another quick test, meant to see if the Control and Alt keys work fine (on Mac, use the Option key instead of Alt): Ctrl+Shift+U and Ctrl+Alt+U should both perform the "unstick" action; Konoko will shift forward by a small amount.

===Console output===
In Developer Mode, Oni prints debug messages about in-game events along the bottom-left of the screen. Past messages scroll up across the screen and fade. In some situations, messages don't fade (e.g. if character debugging is enabled or you are currently using the console line).

The easiest way to check whether that output works at all is to press '''F8''': the character class change is acknowledged with a console message.

If you don't see anything, that means console output is unfortunately disabled in your version of Oni. If you're on PC retail, you may have applied [[Troubleshooting/Blam|Ian's patch]] (aka XP patch), which disables console output. On PC demo, both console output and console input are invisible (i.e. you can enter script commands, but you're "blindfolded").

===Console input===
U.S. QWERTY: By default, Oni auto-binds the "console" toggle to the key which on U.S. keyboards has a grave accent, <span style="font-size:200%; top:0.3em; position:relative">`</span>, in the lowercase position and a tilde, <span style="font-size:175%">~</span>, in the uppercase position. It is usually called the "tilde key" by users, and perhaps even elsewhere on this wiki; however, you would have to hold Shift to type a tilde, and the console is activated by just pressing the key without Shift, thus it is actually the "grave accent key" which activates the console. On non-U.S. keyboards, that key may not be recognized. Just add a line like "bind leftalt to console" to '''key_config.txt''' in your Oni folder and you'll be able to open the console with that key. In some cases, this bound key will not ''close'' the console; however, pressing the grave accent key, oddly enough, may work.

German QWERTZ: By default, Oni uses the circumflex accent key, <span style="font-size:150%">^</span>, for console access. On Windows, when playing Oni in windowed mode, you should use "rightalt" as your alternative console binding because "leftalt" activates the window's menu, stealing Oni's controls.


===Features===
Many of the features listed below no longer work as intended, or work at all, either due to changes to the code made at the end of development or the absence in retail Oni of resources that the features were intended to call upon, such as [[level0_Tools]]. Nevertheless, some of these features are helpful for modders, most notably the camera controls and dev console.

====Hotkeys====
Below are Oni's hardcoded mappings for Developer Mode functions. The Alt key (Option key on Macs) can be used in placed of Ctrl. Alternate mappings are welcome if you have another version of Oni that you would like to have listed below.

The QWERTY column is for the English release of Oni, for U.S. QWERTY keyboards. The QWERTZ column is for German Oni and only lists the hotkeys that are different from QWERTY on German QWERTZ keyboards; note that on German keyboards, the "Ctrl" key is named "Strg".

{|class="wikitable" style="margin-left:auto; margin-right:auto;"
!Hotkey (QWERTY)
!Hotkey (QWERTZ)
!Description
!width=75|Windows
!width=75|Mac
|-
|Ctrl+Shift+o
|
|Draw no-occlusion quads (only makes console screens disappear)
|
|
|-
|Ctrl+Shift+i
|
|Draw invisible quads
|
|
|-
|Ctrl+Shift+y
|Ctrl+Shift+z
|Performance display (includes FPS)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+t
|
|Draw character collision
|
|
|-
|Ctrl+Shift+r
|
|Draw object collision
|
|
|-
|Ctrl+Shift+f
|
|Fast Mode (runs Oni at up to 24x)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+g
|
|Draw Every Frame Mode
|<center>{{ckblue}}</center>
|<center>'''(1)'''</center>
|-
|Ctrl+Shift+x
|
|Secret X / (Mac only) Show trigger volumes
|
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+y
|
|Secret Y
|
|
|-
|Ctrl+Shift+z
|
|Secret Z
|
|
|-
|Ctrl+Shift+Ins
|
|Add flag
|<center>{{ckblue}}</center>
|<center>'''(2)'''</center>
|-
|Ctrl+Shift+Del
|
|Delete flag
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+u
|
|Unstick player
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+n
|
|Camera recording start
|
|
|-
|Ctrl+Shift+m
|
|Camera recording stop
|
|
|-
|Ctrl+Shift+,
|
|Camera recording playback
|
|
|-
|?
|
|Place quad
|<center>?</center>
|<center>?</center>
|-
|?
|
|Place quad mode
|<center>?</center>
|<center>?</center>
|-
|Ctrl+Shift+\
|Ctrl+Shift+#
|Profile toggle (doesn't seem to have any effect)
|<center>{{ckblue}}</center>
|
|-
|Ctrl+Shift+l
|
|Dumps a screenshot every frame
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+1
|
|Test One
|
|
|-
|Ctrl+Shift+2
|
|Test Two
|
|
|-
|Ctrl+Shift+3
|
|Test Three
|
|
|-
|Ctrl+Shift+4
|
|Test Four
|
|
|-
|. (period)
|
|Single Step Mode
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|/
| -
|Advance one step (when in Single Step Mode)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|.+/
|.+-
|Exit Single Step Mode (press keys simultaneously)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+Home
|
|Cycle active camera
|
|<center>{{ckblue}}</center>
|-
|End
|
|Warp to camera
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+k
|
|Kill particles
|
|
|-
|Backspace
|
|Enter AI debugger
|
|
|-
|7
|
|Explode One
|
|
|-
|8
|
|Explode Two
|
|
|-
|9
|
|Explode Three
|
|
|-
|0
|
|Explode Four
|
|
|-
|Ctrl+Shift+j
|
|Reset particles
|
|
|-
|Ctrl+Shift+w
|
|Drop flag and add waypoint
|
|
|-
|Ctrl+Shift+b
|
|Shows current opponent's logic
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|]
|~
|Freeze (now causes camera drift while on;<br>stopping Freeze mode teleports to camera location)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|[
|
|Frame Advance (now renders Konoko at camera location)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+s
|
|Highlight furniture (turns their textures red)
|<center>{{ckblue}}</center>
|
|-
|F8, Shift+F8
|
|Cycle characters
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+Shift+p
|
|Display particle performance
|
|
|-
|Ctrl+Shift+;
|
|Lock particle performance display
|
|
|-
|F2
|
|Cutscene Animation 1
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|F3
|
|Cutscene Animation 2
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|F6
|
|Kill all AIs
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Ctrl+F7
|
|Play dead
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|F7, Shift+F7
|
|Cycle weapons (holster to get second weapon)
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|F9
|
|Start recording
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|F10
|
|Stop recording
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|F11
|
|Playback recording
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|` (grave accent)
|^
|Displays console
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|-
|Return/Enter
|
|Cycle camera modes (see table below for camera controls):<br>1. Normal<br>2. Detached A - mouse still controls character aim<br>3. Detached B - mouse aims camera
|<center>{{ckblue}}</center>
|<center>{{ckblue}}</center>
|}

'''(1)''' On Macs, Draw Every Frame Mode speeds up the game almost to the extent of Fast Mode, but with glitchy animations.

'''(2)''' Please see talk page section "Insert key on Macs".

====Camera controls====
Note that the camera controls have default mappings, given below, but unlike the developer hotkeys, they are '''custom-bindable'''. In fact, on Macs, the default numpad bindings ''need'' to be customized or they won't work at all. See note [[Customizing/Binding#Detached camera controls|HERE]] about how to bind these keys and fix the Mac numpad controls. Also, the definitions of panning left and right seem to be reversed, as NumPad4 will simulate the act of turning your head to the left, but its action is called "man_cam_pan_right", and vice versa for NumPad6....
{|class="wikitable" style="margin-left:auto; margin-right:auto;"
|align="center"|'''Windows'''
{|class="wikitable" style="margin-left:auto; margin-right:auto;"
!Key
!Result
|-
|NumPad 1/3
|Move camera left/right
|-
|NumPad 8/5
|Move camera forward/backward
|-
|NumPad -/+
|Move camera up/down
|-
|NumPad 6/4
|Pan camera left/right
|-
|Up/Down Arrow
|Pan camera up/down
|}
|align="center"|'''Mac'''
{|class="wikitable" style="margin-left:auto; margin-right:auto;"
!Key
!Result
|-
|Left/Right Arrow
|Move camera left/right
|-
|Up/Down Arrow
|Move camera forward/backward
|-
|Page Up/Down
|Move camera up/down
|-
|NumPad 6/4
|Pan camera left/right
|-
|NumPad 8/2
|Pan camera up/down
|}
|}

===Runtime scripting===
====Basic idea====
(Almost) anything you write in scripts you can enter at runtime with the console. The only thing you can't do is register new variables and functions.

You can call existing functions, check on the values of existing variables. "Existing" means either built-in ones, or part of the original level logic, or part of your own scripts for the given level.

If a function/variable was succesfully registered by Oni during level load, you will be able to refer to them from the console.

You will even be able to browse the registered variables/functions with the '''Tab''' key, while typing at the console. '''Tab''' autocompletes the command being typed, then cycles through all available commands in (hex)alphabetical order (A...Z come before a...z). '''Shift+Tab''' lets you go back.

Previous commands can be navigated with up and down arrows. You can't insert/delete text in the middle of a command : you have to use '''Backspace'''.

The only keys that have an effect while the console is active are : '''Escape''', '''Enter''', '''Backspace''', '''(Shift+)Tab''', ASCII character keys and the arrow keys.

If you press an illegal key during console input (such as F1), the input display will freeze : hit '''Tab''' a few times to fix.

====Limitations====
Obviously, if you have no console output, it's a bit frustrating. Even more so if console ''input'' is invisible -- you're in for some ''blindfolded'' scripting then. Still, there are a few commands which you can type in as complements to regular cheats:
:'''chr_nocollision 0 1''' and '''chr_nocollision 0 0''' enable/disable no-clipping. When in no-clipping mode, you can't fall down; thus, jumping makes you flail in midair, and eventually you die (so be careful about that)
:'''give_powerup shield''' gives you a force shield (which you can't have with '''fatloot''')
:'''dump_docs''' prints all the registered commands/variables to a file in your Oni folder (so you know just what you can type)

[[Category:Modding information]]