KeenWiki - User contributions [en-gb]

Patch:Levels (Vorticons)

2023-10-07T06:57:23Z

Levellass: Format tweak

This page deals with patches relating to level in Keen Vorticons. It does not cover all patches relating to the [[Patch:Map|map level.]] For patches relating to the cities that need to be saved in [[Keen 2]] see [[Patch:Cities]]. Other patches relating to levels can be found at [[Patch:Levels]]. See also [[Patch:Done markers]].

== Level format and editing ==

In Keen Vorticons levels are individual external files loaded by the game as needed. There are a number of editors available of which perhaps the most advanced is [[Mindbelt]]. Playing new levels does not require any patching.

== 32 levels ==

In Keen Vorticons it is possible to use levels between 30-100 on the map, though only some work and none will be done properly (They will be replayable after exit.) It is also possible that they may be unstable and\or overwrite important stuff. To properly set up levels there is a patch that fits 32 level into the space for the default 16. This affects the [[Patch:Item bytes|item bytes]] of these levels, each becomes 1 byte long. (So level 1 in Keen 1 is still $AAA6W, but level 2 is $AAA7W and so on.)

Changing the $01 to $00 will allow Keen to replay all the levels as many times as he wants. [[Patch:Levels#Infinite_replays| (See below.)]] The $20 is how many levels are available, the maximum using this patch is 32, but any number less than this can also be used.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#32 levels:
#Let Keen enter levels if these values are 0
%patch $7D3A $90 $90 $80 $BF {$AAA6W} $00
%patch $7FCA $90 $90 $80 $BF {$AAA5W} $00
#When starting a new game, make all 32 levels not done
%patch $9065 $90 $90 $C6 $87 {$AAA6W} $00 $90
%patch $9073 [$20]
#Change things when marking a level as done
%patch $8013 $90 $90 $C6 $87 {$AAA5W} [$01] $90
%patch $7E4B [$20]</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#32 levels:
#Let Keen enter levels if these values are 0
%patch $8146 $90 $90 $80 $BF {$9ABCW} $00
%patch $83C9 $90 $90 $80 $BF {$9ABBW} $00
#When starting a new game, make all 32 levels not done
%patch $8AF9 $90 $90 $C6 $87 {$9ABCW} $00 $90
%patch $8B07 [$20]
#Change things when marking a level as done
%patch $8412 $90 $90 $C6 $87 {$9ABBW} [$01] $90
%patch $8253 [$20]</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#32 levels:
#Let Keen enter levels if these values are 0
%patch $8AE2 $90 $90 $80 $BF {$9D26W} $00
%patch $8D9A $90 $90 $80 $BF {$9D25W} $00
#When starting a new game, make all 32 levels not done
%patch $9944 $90 $90 $C6 $87 {$9D26W} $00 $90
%patch $994F [$20]
#Change things when marking a level as done
%patch $8DE1 $90 $90 $C6 $87 {$9D25W} [$01] $90
%patch $8BF9 [$20]</syntaxhighlight>

== Infinite replays ==

This allows a player to play the level as many times as they want. The level is not marked as completed when Keen exits it. If the Vorticons 32 level patch is being used this must be after it. (It can be built into that patch, [[Patch:Levels_(Vorticons)#Extra_levels| see above.)]] Use only one of the possibilities given at a time, they are mutually exclusive.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Infinite replays of all levels:
%patch $8019 $00</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Infinite replays of all levels:
%patch $8DE7 $00

#Only levels [$04] and below get marked as done, others are infinite replay
%patch $8BF9 [$04]
%patch $8DA1 $90 $90</syntaxhighlight>

== Infinite replays of certain levels ==

This patch allows the player to replay any level that cannot produce a [[Patch:Done markers|DONE marker.]] This can be done in several ways. The first is to make its entrance out of 2 or 3 squares, the second is to place a single level entrance square in the top left of the map level. Both will prevent a DONE marker being produced when the level is completed so the player can replay it. This patch is completely compatible with the 32 level patch.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Can replay any level that doesn't make a DONE marker:
%patch $7FD1 $90 $90</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Can replay any level that doesn't make a DONE marker:
%patch $83D0 $90 $90</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Can replay any level that doesn't make a DONE marker:
%patch $8DA1 $90 $90</syntaxhighlight>

== Complete levels to win ==

These patches allow Keen to win the game only if he completes either a specific level or a specific number of levels. (For Keen 3 this is level 16.) For the Keen 1 'level 16 to win' patch you will need to see [[Patch:Item bytes|item bytes]]. See also [[Patch:Mangling Machine]].

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Complete [x+1] levels to win:
#SIDE EFFECT: Ship parts don't matter
%patch $8020 $83 $BF {$AAA6W} [$0x] $75 $1E $E8 $62 $01 $EB $29

#Complete the game when level 16 is done:
%patch $8022 {$AAC4W} $00 $74 #The byte C4 sets a win condition to level 16, level
%patch $8029 {$AAC4W} $00 $74 #15 is C2, etc. For the 32 levels patch use B5 with
%patch $8030 {$AAC4W} $00 $74 #level 15 as B4, etc. This patch means you can have
%patch $8037 {$AAC4W} $00 $74 #up to four levels as winning conditions</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Only win when exiting level [$0x]
%patch $8436 $83 $3E $3C $80 [$0x] $90 $90 $90 $90</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Only win when exiting level [$xx]
%patch $8DF2 [$00xxW] $75 #Win game
%patch $85D2 [$xx] $75 #MM text sequence</syntaxhighlight>

== Everything in levels is pulled sideways ==

This patch creates a 'breeze' in levels; a sort of sideways gravity that pulls everything sideways all the time. Note that this patch will be incompatible with any other patches that use the <tt>$55EF</tt> line to free up space, such as the [[Patch:Keen_shooting_(Vorticons)#Control_Keen.27s_shot_angle_with_up_and_down_arrow_keys|'shoot up\down patch']], so check your patchfile before adding this patch.

The value marked in blue is the 'breeze', set here to very low rightwards. Negative values will pull things left.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Levels have a breeze (Pull ALL sprites and Keen in one direction steadily)
%patch $55EF $EB $4A
%patch $4D1E $E9 $08D0W
%patch $55F1 $B8 $0000W $A3 $823EW $B8 [$0040W] $A3 $823CW $33 $C0 $E9 $F724W</syntaxhighlight>

== Screen automatically scrolls from left to right ==

This patch makes the screen scroll left or right, killing Keen when he touches the left edge. The speed of the scrolling can be changed. As a side effect levels 'loop'; there is not left or right level edge, instead going off the right level 'edge' will make Keen appear on the left 'edge' of the level. (However the player will not notice the transition, it is seamless.) The camera will also not follow the player.

Keen can also not pass the right edge of the screen, though he may fall or climb as much as he wants. The right edge is the first blue value in the patch below. (It is set here to the visible edge of the screen, but this is not necessary.)

The remaining blue variables control other aspects oft he game. The right side pushback is how much the right side of the screen pushes Keen back when he tries to leave the right side of the screen. This should be at ''least'' $10 more than the scrolling speed. The left side push forward is similar, but should be no more than given here ($40) and should be made smaller if it starts pushing Keen through solid tiles.

The scrolling speed controls how fast and in what direction the screen scrolls. (It is advised you stick with a right scrolling screen.) Finally the two breeze strengths do what they do in the above patch, move objects in the level in a certain direction. The first breeze is positive (right) and the second negative and ''equal'' (and left.) In this patch they are set to be equal to the scroll speed, but you can also make them zero.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Right screen boundary (22 tiles)
%patch $800 $B8 [$0016W]

#add boundary checking to pogo ground
%patch $40E7 $E8 $7B $F2

#update keen movement boundaries
%patch $3368 $66 $A1 $2C $82 $66 $3B $06 $4A
$56 $7F $21 $C7 $06 $3C $82 [$0210W] $C7 $06 $40 $82 $30 $00 $E8 #Right side pushback
$15 $F9 $A9 $04 $00 $74 $0D $33 $C0 $A3 $40 $82 $A3 $42 $82 $E8
$1A $0F $EB $31 $66 $A1 $34 $82 $66 $3B $06 $AC $5D $7C $26 $C7
$06 $3C $82 $A0 $FF $66 $A1 $AC $5D $66 $A3 $34 $82 $EB $16

#Auto screen scroll
%patch $3458 $66 $A1 $D0 $6E $66 [$0040W] $00 #Left push forward
$00 $7D $15 $66 $B8 [$0200W] $00 $00 $66 $01 $06 $D0 $6E $66 $01 #Scroll speed
$06 $4A $56 $66 $01 $06 $AC $5D $1E $68 $20 $82 $1E $68 $DA $6E
$B9 $36 $00 $E8 $15 $AE $C7 $06 $3C $82 [$0200W] $E8 $08 $F8 $A9 #Right breeze strength
$04 $00 $74 $06 $C7 $06 $3C $82 [$FE00W] $A1 $3C $82 $66 $98 $66 #Left breeze strength
$01 $06 $24 $82 $E8 $94 $F5 $66 $A1 $2C $82 $66 $05 $80 $00 $00
$00 $66 $3B $06 $D0 $6E $7D $0B $33 $C0 $A3 $40 $82 $A3 $42 $82
$E8 $E9 $0D $1E $68 $DA $6E $1E $68 $20 $82 $B9 $36 $00 $E8 $CA
$AD $EB $1F</syntaxhighlight>

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Levels|}}
{{PatchCategories|Gameplay|}}

Patch:Status Window (Vorticons)

2023-10-07T06:45:17Z

Levellass: COORECT an added patch. Must be rusty.

The status window in Keen Vorticons appears when the spacebar is pressed during normal gameplay. It displays what Keen has, keys, shots, score and suchlike. This page covers patches relating to this window, divided into two sections. The first section contains patches relating to the window's behavior, what causes it to appear and what it does. The second section contains patches that relate to what the window looks like, its construction and content.

Patches for other status windows can be found at [[Patch:Status_Window_(Galaxy)]] and [[Patch:Status_Window_(Dreams)]]. These patches also require some knowledge of [[Patch:Game stats]] and [[Patch:Text patches]]

= Disable status window =

This patch completely disables the status window, meaning it cannot be called during gameplay. The map is treated differently from levels, meaning it is possible to disable the status window in only one of these.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Disable status window
%patch $124F $5D $C3 #In-level
%patch $7FA3 $EB $08 #On map</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $1209 $5D $C3 #In-level
%patch $83A0 $EB $08 #On map</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $11AD $5D $C3 #In-level
%patch $8D6C $EB $08 #On map</syntaxhighlight>

= Status window behavior =

This section contains patches that alter how the status window behaves, what causes it to appear and what it does.

== Change controls ==

These patches change what key activates the status screen. By default this is the spacebar. in the example here it is changed to enter. Using these patches requires some knowledge of [[Patch:Scancodes]].

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $1251 [$5048W]
%patch $7FA3 [$5048W]</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $120B [$5024W]
%patch $83A2 [$5024W]</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $11AF [$5274W]
%patch $8D6E [$5274W]</syntaxhighlight>

=== Galaxy style status window controls ===

This changes the controls of the game to be more like Keen Galaxy. Spacebar shoots, enter brings up the status screen. See #http://andy.durdin.net/keen/modding/viewtopic.php?t=433 for the original topic. In essence this is a longer version of the above patches, with extra lines altering Keen's shot keys.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Change the controls to Space, shoot; Enter, status.
%patch $1251 [$5048W]
%patch $7FA3 [$5048W]
%patch $3B23 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3C4E $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3DB9 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3DCC $90 $90
%patch $3E6D $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3FFC $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $40AA $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change the controls to: Space, shoot; Enter, status.
%patch $120B [$5024W]
%patch $83A2 [$5024W]
%patch $6965 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6A90 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6BFB $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6C0E $90 $90
%patch $6CAF $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6E3E $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6EEC $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change the controls to: Space, shoot; Enter, status.
%patch $11AF [$5274W]
%patch $8D6E [$5274W]
%patch $71C9 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $72FA $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $7461 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $7474 $90 $90
%patch $7515 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $76A1 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $7750 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00</syntaxhighlight>

= Status window construction and appearance =

== Status screen appearance ==

The status screen is at heart a text window with 16x16 tiles drawn over it at certain positions, followed by variables like the score.

For text, a lot of 'short lines' (separators) little more than one character long are used, as well as some 'long lines' with actual labels on them. Short lines are often shifted across a few characters.

There is also a 'big versatile status screen patch' that allows total customization of the Keen 1 status window. It is the last entry in this section.

=== Keen 1 ===

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Status box size:
%patch $0E53 [$000CW] #Height (In lines of text)
%patch $0E57 [$001CW] #width (In letters)

#Text read from
%patch $0E6B [$1E02W] #First line (SCORE...EXTRA KEEN AT)
%patch $0E7C [$1E20W] #Second line - Score\EKA separator
%patch $0E85 [$1E23W] #Third line (KEENS...SHIP)
%patch $0E96 [$1E41W] #Fourth line - Lives\Parts separator 1
%patch $0EA7 [$1E44W] #Fifth line - Lives\Parts separator 2
%patch $0EB8 [$1E47W] #Sixth line - Lives\Parts separator 3
%patch $0EC1 [$1E4AW] #Seventh line (RAYGUN...KEYS)
%patch $0ED2 [$1E68W] #Eighth line - Raygun\Pogo separator 1
%patch $0EE0 [$1E6AW] #Eighth line - Pogo\Keycard separator 1
%patch $0EF1 [$1E6DW] #Ninth line -Raygun\Pogo separator 2
%patch $0EFF [$1E6FW] #Ninth line -Pogo\Keycard separator 2
%patch $0F10 [$1E72W] #Tenth line - Raygun\Pogo separator 3
%patch $0F1E [$1E74W] #Tenth line - Pogo\Keycard separator 3
%patch $0F27 [$1E77W] #Eleventh line (CHARGE)
%patch $0F35 [$1E81W] #Eleventh line - Pogo\Keycard separator 4
%patch $0F46 [$1E84W] #Twelfth line - Charge\Pogo separator
%patch $0F54 [$1E86W] #Twelfth line - Pogo\Keycard separator 5
%patch $0F5D [$1E89W] #Thirteenth line (PRESS A KEY)

#Text
%patch $14E52 " SCORE EXTRA KEEN AT " $0A $00
%patch $14E70 " " $0A $00
%patch $14E73 " KEENS SHIP PARTS " $0A $00
%patch $14E91 " " $0A $00
%patch $14E94 " " $0A $00
%patch $14E97 " " $0A $00
%patch $14E9A " RAYGUN POGO KEYCARDS " $0A $00
%patch $14EB8 " " $00
%patch $14EBA " " $0A $00
%patch $14EBD " " $00
%patch $14EBF " " $0A $00
%patch $14EC2 " " $00
%patch $14EC4 " " $0A $00
%patch $14EC7 " CHARGE " $00
%patch $14ED1 " " $0A $00
%patch $14ED4 " " $00
%patch $14ED6 " " $0A $00
%patch $14ED9 " PLEASE PRESS A KEY " $00

#Score
%patch $0F66 [$0A] #Base to show Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0F6F {$AACCW} #Variable (Low)
%patch $0F73 {$AACAW} #Variable (High)

#Extra Keen score
%patch $0FA0 [$0A] #Base to show Extra Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0FA8 {$6EC4W} #Variable (Low)
%patch $0FAC {$6EC2W} #Variable (High)
%patch $0FB0 {$4E20W} #Minimum EKA score

#Lives
%patch $1001 {$AAC6W} #Lives variable
%patch $0FE5 [$0003W] #Vertical position of lives
%patch $0FF0 $90 $90 #Lives spaced 8 pixels apart, not 16
%patch $1007 [$06] #Maximum number of lives to show
%patch $0FDE $EB $1E #Don't show Lives
%patch $1003 $90 $90 #Always show maximum number of Keens no matter how many lives Keen has

#Raygun tile
%patch $1166 [$019EW] #Tile
%patch $116D [$0007W] #V position, squares
%patch $1176 [$0004W] #V position, pixels
%patch $117C [$0003W] #H position

#Shots counter
%patch $1198 {$AAC8W} #Variable
%patch $1188 [$0003W] #H position
%patch $1191 [$000BW] #V position

#Pogo tile
%patch $11A7 [$019FW] #Tile
%patch $11AE [$0008W] #V position, squares
%patch $11B7 [$0004W] #V position, pixels
%patch $11BD [$000BW] #H position</syntaxhighlight>

==== Change the lives sprite ====

This patch allows the sprite used for lives to be changed. The first blue value is the sprite used * 4. (Here sprite 31 x 4 = 124 = $7B.) The second blue value is the vertical position of the sprites, originally this was 3 but because of he patch it must now be 9 larger (12 or $0C). This patch is incompatible with several of the patches in the above section that alter the lives counter.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Change the lives sprite
%patch $0FDE $B8 [$007BW] $50 $8B $46 $FE $05 [$000CW] $D1 $E0 $D1 $E0
$50 $8B $C7 $D1 $E0 $90</syntaxhighlight>

==== Don't show ship parts ====

This patch removes the ship parts from the status window, converting it into more space to show Keen's lives. The blue variable is how many lives can now be shown in the status window.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Don't display ship parts
%patch $100A $E9 $00B9W
%patch $14E90 $0A $0A $0A $00
%patch $0E8D $EB $31
%patch $1007 [$0D]</syntaxhighlight>

=== Keen 2 ===

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Status box size:
%patch $0E53 [$000CW] #Height (In lines of text)
%patch $0E57 [$001CW] #width (In letters)

#Text read from
%patch $0E69 [$219CW] #First line (SCORE...EXTRA KEEN AT)
%patch $0E7A [$21BAW] #Second line
%patch $0E83 [$21BDW] #Third line (KEENS...PISTOL)
%patch $0E94 [$21DBW] #Fourth line
%patch $0EA5 [$21DEW] #Fifth line
%patch $0EB6 [$21E1W] #Sixth line
%patch $0EBF [$21E1W] #Seventh line (TARGETS...KEYS)
%patch $0ED0 [$2202W] #Eighth line
%patch $0EE1 [$2205W] #Ninth line
%patch $0EF2 [$2208W] #Tenth line
%patch $0F03 [$220BW] #Eleventh line
%patch $0F0C [$220EW] #Twelfth line (PRESS A KEY)
%patch $10A4 [$222BW] #London
%patch $10C0 [$2232W] #Cairo
%patch $10DC [$2238W] #Sydney
%patch $10F8 [$223FW] #New York
%patch $1118 [$2248W] #Paris
%patch $1138 [$224EW] #Rome
%patch $1158 [$2253W] #Moscow
%patch $1178 [$225AW] #Washington

#Text
%patch $1991C " SCORE EXTRA KEEN AT " $0A $00
%patch $1993A " " $0A $00
%patch $1993D " KEENS PISTOL " $0A $00
%patch $1995B " " $0A $00
%patch $1995E " " $0A $00
%patch $19961 " " $0A $00
%patch $19964 " TARGETS SAVED KEYS " $0A $00
%patch $19982 " " $0A $00
%patch $19985 " " $0A $00
%patch $19988 " " $0A $00
%patch $1998B " " $0A $00
%patch $1998E " PLEASE PRESS A KEY " $0A $00
%patch $199AB "London" $00
%patch $199B2 "Cairo" $00
%patch $199B8 "Sydney" $00
%patch $199BF "New York" $00
%patch $199C8 "Paris" $00
%patch $199CE "Rome" $00
%patch $199D3 "Moscow" $00
%patch $199DA "Wash D.C." $00

#H position of separating lines (Short lines)
%patch $0E74 [$0A] #SCORE-EXTRA square
%patch $0E8E [$13] #KEENS-PISTOL separator 1
%patch $0E9F [$13] #KEENS-PISTOL separator 2
%patch $0EB0 [$13] #KEENS-PISTOL separator 3
%patch $0ECA [$13] #TARGETS-KEYS separator 1
%patch $0ED8 [$13] #TARGETS-KEYS separator 2
%patch $0EEC [$13] #TARGETS-KEYS separator 3
%patch $0EFD [$13] #TARGETS-KEYS separator 4

#Score
%patch $0F15 [$0A] #Base to show Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0F1E {$9AE2W} #Variable (Low)
%patch $0F22 {$9AE0W} #Variable (High)

#Extra Keen score
%patch $0F4E [$0A] #Base to show Extra Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0F56 {$6EA0W} #Variable (Low)
%patch $0F5A {$6E9EW} #Variable (High)
%patch $0F5E {$4E20W} #Minimum EKA score

#Lives
%patch $0FB7 {$9ADCW} #Lives variable
%patch $0FBC [$0009W] #Maximum number of lives to show
%patch $0F8B [$0000W] #Hide x lives from START of lives (None hidden by default)
%patch $0F95 [$0003W] #Vertical position of lives
%patch $0FA1 $90 $90 #Lives spaced 8 pixels apart, not 16
%patch $0F8F $EB $1E #Don't show Lives
%patch $0FB9 $90 $90 #Always show maximum number of Keens no matter how many lives Keen has

#Raygun tile
%patch $0FC1 [$019EW] #Tile
%patch $0FC7 [$0003W] #V position, squares
%patch $0FD0 [$0004W] #V position, pixels
%patch $0FD6 [$0015W] #H position

#Shots
%patch $0FE2 [$0018W] #H position
%patch $0FEA [$0004W] #V position

#Keycards
%patch $0FFB [$0015W] #Keycards horizontal position
%patch $1003 [$0007W] #Keycards vertical position
%patch $1010 [$01A8W] #Keycard A tile
%patch $102F [$01A9W] #Keycard B tile
%patch $1040 [$0003W] #Keycard B horizontal offset (3 squares left of Key A)
%patch $1051 [$01AAW] #Keycard C tile
%patch $105E [$0010W] #Keycard C vertical offset (two squares down from Key A)
%patch $1073 [$01ABW] #Keycard D tile
%patch $1080 [$0010W] #Keycard D vertical offset(two squares down from Key A)
%patch $1087 [$0003W] #Keycard D offset offset (3 squares left of Key A)
%patch $1032 $90 #Don't show keycard B
%patch $1054 $90 #Don't show keycard C
%patch $1076 $90 #Don't show keycard D</syntaxhighlight>

==== Change the lives sprite ====

This patch allows the sprite used for lives to be changed. The first blue value is the sprite used * 4. (Here sprite 31 x 4 = 124 = $7B.) The second blue value is the vertical position of the sprites, originally this was 3 but because of he patch it must now be 9 larger (12 or $0C). This patch is incompatible with several of the patches in the above section that alter the lives counter.

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change the lives sprite
%patch $0F8F $B8 [$007BW] $50 $8B $C7 $05 [$000CW] $D1 $E0 $D1 $E0
$50 $8B $46 $FE $D1 $E0 $90</syntaxhighlight>

=== Keen 3 ===

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Status box size:
%patch $0EC0 [$000BW] #Height (In lines of text)
%patch $0EC4 [$001CW] #width (In letters)

#Text read from:
%patch $0ED5 [$22D4W] #1st line
%patch $0EE5 [$22F2W]
%patch $0EED [$22F5W] #3rd
%patch $0EFD [$2313W]
%patch $0F0D [$2316W]
%patch $0F1D [$2319W]
%patch $0F25 [$231CW] #7th
%patch $0F35 [$233AW]
%patch $0F45 [$233DW]
%patch $0F55 [$2340W]
%patch $0F5D [$2343W] #11th

#Text
%patch $1BAF4 " SCORE EXTRA KEEN AT " $0A $00
%patch $1BB12 " " $0A $00
%patch $1BB15 " KEENS PISTOL " $0A $00
%patch $1BB33 " " $0A $00
%patch $1BB36 " " $0A $00
%patch $1BB39 " " $0A $00
%patch $1BB3C " ANKH TIME KEY CARDS " $0A $00
%patch $1BB5A " " $0A $00
%patch $1BB5D " " $0A $00
%patch $1BB60 " " $0A $00
%patch $1BB63 " PLEASE PRESS A KEY " $00

#Horizontal position of some text (In characters)
%patch $0EDF [$000CW] #2nd line
%patch $0EF7 [$0013W] #4th line
%patch $0F07 [$0013W] #5th line
%patch $0F17 [$0013W] #6th line
%patch $0F2F [$000BW] #8th
%patch $0F3F [$000BW] #9th
%patch $0F4F [$000BW] #10th

#Position of values (Score and suchlike)
%patch $0F65 [$0A] #Score base (0A = 10 = decimal, $10 =hex, $01 = binary, $00 don't show)
%patch $0F86 [$0A] #Score h position
%patch $102F [$18] #Ammo h position
%patch $1037 [$04] #Ammo v position
%patch $1066 [$07] #Ankh time h position
%patch $106E [$08] #Ankh time v position

#EKA structure
%patch $0F9C [$0A] #Extra Keen counter base (like above, $00, don't show)
%patch $0FC5 [$1A] #Extra Keen counter h position
%patch $0FA4 {$70F0W} #Variable (Low)
%patch $0FA8 {$70EEW} #Variable (High)
%patch $0FAC {$4E20W} #Minimum EKA score

#Keen's lives structure
%patch $100A [$09] #Maximum number of lives to show
%patch $0FD7 [$0000W] #Hide x lives from START of lives (None hidden by default)
%patch $0FD7 [$00] #Lives h position (Lives stop at $12, so $0A doesn't show lives)
%patch $0FE1 [$0003W] #Sprite vertical position
%patch $0FED $90 $90 #Sprites close together (Change spacing of sprites)

#Raygun
%patch $100E [$00D8W] #Raygun tile
%patch $1014 [$0003W] #Vertical position (lines)
%patch $101D [$0004W] #Plus xx pixels
%patch $1023 [$0015W] #H position
%patch $103E {$9D48W} #What counter tracks

#Ankh
%patch $1045 [$00D6W] #Ankh tile
%patch $104B [$0007W] #V position
%patch $1054 [$0004W] #Plus xx pixels
%patch $105A [$0003W] #H position
%patch $1074 {$9946W} #What counter tracks

#Don't show Ankh tile
%patch $105D $90 $90 $90

#Keycards
%patch $1084 [$000DW] #Keycards h position (4 keycards start here)
%patch $108C [$0008W] #Keycards v position (All 4 keycards this height)
%patch $1099 [$00D9W] #Yellow keycard tile
%patch $10BB [$00DAW] #Red keycard tile
%patch $10CF [$0004W] #Red keycard left of yellow by this much
%patch $10E0 [$00DBW] #Green keycard tile
%patch $10F4 [$0008W] #Green keycard left of yellow by this much
%patch $1105 [$00DCW] #Blue keycard tile
%patch $1119 [$000CW] #Blue keycard left of yellow by this much

%patch $1094 [$0001W] #Always show yellow keycard
%patch $10B6 [$0001W] #Always show red keycard
%patch $10DB [$0001W] #Always show green keycard
%patch $1100 [$0001W] #Always show blue keycard</syntaxhighlight>

==== Change the lives sprite ====

This patch allows the sprite used for lives to be changed. The first blue value is the sprite used * 4. (Here sprite 30 x 4 = 120 = $77.) The second blue value is the vertical position of the sprites, originally this was 3 but because of he patch it must now be 9 larger (12 or $0C). This patch is incompatible with several of the patches in the above section that alter the lives counter.

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change the lives sprite
%patch $0FDB $B8 [$0077W] $50 $8B $C7 $05 [$000CW] $D1 $E0 $D1 $E0
$50 $8B $46 $FE $D1 $E0 $90</syntaxhighlight>

== The big versatile Keen 1 status box patch ==

This patch fully customizes the status window, allowing the smart patcher to remove or rearrange things to their will. Along with the tiles and variables, it contains their positions and even allows entire blocks of code to be skipped. In addition to this, it frees up space for use with other patches.

The status file is just an external text file of 392 bytes in size. A default example can be found here: [https://files.shikadi.net/keenwiki/misc/STATUS.CK1 STATUS.CK1]

Values in brown are related to [[Patch:Item bytes]] which control *what* is shown, or [[Patch:Jump conditions|jumps]] which control whether or not something is shown. Values in blue are positions (In 8x8 tiles) or 16x16 tiles displayed

=== Keen 1 ===
<syntaxhighlight lang="asm">#Big versatile status window patch:
#Patch in the long-integer drawing function
%patch $11B4 $55 $89 $E5 $B8 $0A $00 $50 $B8 $90 $82 $50 $FF
$76 $06 $FF $76 $04 $E8 $03 $C2 $83 $C4 $08 $B8 $90 $82 $50 $E8
$A5 $C5 $44 $44 $8B $56 $08 $29 $C2 $89 $16 $82 $82 $8B $46 $0A
$A3 $F8 $82 $B8 $90 $82 $50 $E8 $E8 $50 $44 $44 $89 $EC $5D $C3

#Patch in the name of the status dialog text file, you'll need to create a file with this name and put your status
#text in it or Keen will crash.
%patch $14E52 "STATUS.CK1" $00

# Patch in the code to draw the status text (coordinates are measured in characters--8 pixel blocks)
%patch $0E6A $B8 $00 $3D $BA $1E02W # Show status window (0E6A)
$CD $21 $89 $C3 $BF $27 $00 $C6 $06 $9A $82 $00 $B9 $0A $00 $BA
$90 $82 $B4 $3F $CD $21 $53 $B8 $90 $82 $50 $E8 $2E $97 $44 $44
$5B $4F $75 $E8 $B4 $3E $CD $21

#Draw the status window, you can fiddle around with this code
#Draw extra Keen score at 01,0A
%patch $0E98 $8B $46 $FE $05 [$0001W] $50 $89
$F0 $05 [$000AW] $50 $FF $36 $CC $AA $FF $36 $CA $AA $E8 $04 $03
$83 $C4 $08

#Draw extra Keen score at 01,1A
%patch $0EB3 $8B $46 $FE $05 [$0001W] $50 $89 $F0 $05 [$001AW] $50
$A1 $C4 $6E $8B $16 $C2 $6E $81 $C2 $20 $4E $15 $00 $00 $50 $52
$E8 $E1 $02 $83 $C4 $08

#Draw Keen's lives, count $AAC6W, show sprite $007B \ 4 at 03,01
%patch $0ED6 $31 $FF $3B $3E {$AAC6W} $7D $29 $83 $FF
$06 $7D $24 $B8 [$007BW] $50 $8B $46 $FE $05 [$0003W] $B1 $03 $D3
$E0 $90 $90 $50 $89 $F8 $D1 $E0 $05 [$0001W] $01 $F0 $50 $E8 $2C
$AC $83 $C4 $06 $47 $EB $D1

#Draw joystick, check $AA94, if 0 show tile $0141 else show tile $013D at position 3.5 (3 + 4 pixels),10
%patch $0F07 $B8 [$0141W] $83 $3E {$AA94W} [$00] {$74}
$03 $B8 [$013DW] $50 $8B $46 $FE $05 [$0003W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0010W] $50 $E8 $0D $AA $83 $C4 $06

#Draw battery, check $AA9C, if 0 show tile $0142 else show tile $013E at position 3.5,13
$B8
[$0142W] $83 $3E {$AA9CW} [$00] {$74} $03 $B8 [$013EW] $50 $8B $46 $FE
$05 [$0003W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0013W]
$50 $E8 $E5 $A9 $83 $C4 $06

#Draw vacuum, check $AA96, if 0 show tile $0143 else show tile $013F at position 3.5,16
$B8 [$0143W] $83 $3E {$AA96W} [$00] {$74}
$03 $B8 [$013FW] $50 $8B $46 $FE $05 [$0003W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0016W] $50 $E8 $BD $A9 $83 $C4 $06

#Draw whiskey, check $AA98, if 0 show tile $0144 else show tile $0140 at position 3.5,19
$B8
[$0144W] $83 $3E {$AA98W} [$00] {$74} $03 $B8 [$0140W] $50 $8B $46 $FE
$05 [$0003W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0019W]
$50 $E8 $95 $A9 $83 $C4 $06

#Draw Key A, check $AA9E, if 0 show tile $022E else show tile $01A8 at position 7.5,13
%patch $0FA7 $B8 [$022EW] $83 $3E {$AA9EW} [$00] {$74}
$03 $B8 [$01A8W] $50 $8B $46 $FE $05 [$0007W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0013W] $50 $E8 $6D $A9 $83 $C4 $06

#Draw Key B, check $AAA0, if 0 show tile $022E else show tile $01A9 at position 7.5,17
$B8
[$022EW] $83 $3E {$AAA0W} [$00] {$74} $03 $B8 [$01A9W] $50 $8B $46 $FE
$05 [$0007W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0017W]
$50 $E8 $45 $A9 $83 $C4 $06

#Draw Key C, check $AAA2, if 0 show tile $022E else show tile $01AA at position 9.5,13
$B8 [$022EW] $83 $3E {$AAA2W} [$00] {$74}
$03 $B8 [$01AAW] $50 $8B $46 $FE $05 [$0009W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0013W] $50 $E8 $1D $A9 $83 $C4 $06

#Draw Key D, check $AAA4, if 0 show tile $022E else show tile $01AB at position 9.5,17
$B8
[$022EW] $83 $3E {$AAA4W} [$00] {$74} $03 $B8 [$01ABW] $50 $8B $46 $FE
$05 [$0009W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0017W]
$50 $E8 $F5 $A8 $83 $C4 $06

#Draw Pogo, check $AA9A, if 0 show tile $000B else show tile $019F at position 8.5,0B
%patch $1047 $B8 [$000BW] $83 $3E {$AA9AW} [$00] {$74}
$03 $B8 [$019FW] $50 $8B $46 $FE $05 [$0008W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$000BW] $50 $E8 $CD $A8 $83 $C4 $06

#Draw Ammo value, count $AAC8, at position 0B,06
$8B
$46 $FE $05 [$000BW] $50 $89 $F0 $05 [$0006W] $50 $31 $C0 $50 $FF
$36 [$AAC8W] $E8 $2E $01 $83 $C4 $08

#Draw Raygun at position 7.5,03 (Change first two bytes to $EB $1C to skip)
$B8 [$019EW] $50 $8B $46 $FE
$05 [$0007W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0003W]
$50 $E8 $95 $A8 $83 $C4 $06

#Wait for key and return
$E8 $90 $4B $31 $C0 $50 $E8 $1E $AD
$44 $44 $E8 $81 $A6 $E8 $D1 $F1 $E8 $CE $F1 $E8 $7C $4B $8B $46
$FC $8B $56 $FA $89 $16 $35 $51 $A3 $37 $51 $5F $5E $89 $EC $5D
$C3 </syntaxhighlight>

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Text|}}

Patch:Status Window (Vorticons)

2023-10-07T06:44:28Z

Levellass: Add patches for Keen 2 and 3 for disabling status window

The status window in Keen Vorticons appears when the spacebar is pressed during normal gameplay. It displays what Keen has, keys, shots, score and suchlike. This page covers patches relating to this window, divided into two sections. The first section contains patches relating to the window's behavior, what causes it to appear and what it does. The second section contains patches that relate to what the window looks like, its construction and content.

Patches for other status windows can be found at [[Patch:Status_Window_(Galaxy)]] and [[Patch:Status_Window_(Dreams)]]. These patches also require some knowledge of [[Patch:Game stats]] and [[Patch:Text patches]]

= Disable status window =

This patch completely disables the status window, meaning it cannot be called during gameplay. The map is treated differently from levels, meaning it is possible to disable the status window in only one of these.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Disable status window
%patch $124F $5D $C3 #In-level
%patch $7FA3 $EB $08 #On map</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $1209 $5D $C3 #In-level
%patch $83A0 $EB $08 #On map</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $11AF $5D $C3 #In-level
%patch $8D6E $EB $08 #On map</syntaxhighlight>

= Status window behavior =

This section contains patches that alter how the status window behaves, what causes it to appear and what it does.

== Change controls ==

These patches change what key activates the status screen. By default this is the spacebar. in the example here it is changed to enter. Using these patches requires some knowledge of [[Patch:Scancodes]].

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $1251 [$5048W]
%patch $7FA3 [$5048W]</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $120B [$5024W]
%patch $83A2 [$5024W]</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change status window key
%patch $11AF [$5274W]
%patch $8D6E [$5274W]</syntaxhighlight>

=== Galaxy style status window controls ===

This changes the controls of the game to be more like Keen Galaxy. Spacebar shoots, enter brings up the status screen. See #http://andy.durdin.net/keen/modding/viewtopic.php?t=433 for the original topic. In essence this is a longer version of the above patches, with extra lines altering Keen's shot keys.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Change the controls to Space, shoot; Enter, status.
%patch $1251 [$5048W]
%patch $7FA3 [$5048W]
%patch $3B23 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3C4E $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3DB9 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3DCC $90 $90
%patch $3E6D $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $3FFC $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00
%patch $40AA $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5065W] $00</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change the controls to: Space, shoot; Enter, status.
%patch $120B [$5024W]
%patch $83A2 [$5024W]
%patch $6965 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6A90 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6BFB $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6C0E $90 $90
%patch $6CAF $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6E3E $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00
%patch $6EEC $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5041W] $00</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change the controls to: Space, shoot; Enter, status.
%patch $11AF [$5274W]
%patch $8D6E [$5274W]
%patch $71C9 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $72FA $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $7461 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $7474 $90 $90
%patch $7515 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $76A1 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00
%patch $7750 $90 $90 $90 $90 $90 $90 $90 $80 $3E [$5291W] $00</syntaxhighlight>

= Status window construction and appearance =

== Status screen appearance ==

The status screen is at heart a text window with 16x16 tiles drawn over it at certain positions, followed by variables like the score.

For text, a lot of 'short lines' (separators) little more than one character long are used, as well as some 'long lines' with actual labels on them. Short lines are often shifted across a few characters.

There is also a 'big versatile status screen patch' that allows total customization of the Keen 1 status window. It is the last entry in this section.

=== Keen 1 ===

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Status box size:
%patch $0E53 [$000CW] #Height (In lines of text)
%patch $0E57 [$001CW] #width (In letters)

#Text read from
%patch $0E6B [$1E02W] #First line (SCORE...EXTRA KEEN AT)
%patch $0E7C [$1E20W] #Second line - Score\EKA separator
%patch $0E85 [$1E23W] #Third line (KEENS...SHIP)
%patch $0E96 [$1E41W] #Fourth line - Lives\Parts separator 1
%patch $0EA7 [$1E44W] #Fifth line - Lives\Parts separator 2
%patch $0EB8 [$1E47W] #Sixth line - Lives\Parts separator 3
%patch $0EC1 [$1E4AW] #Seventh line (RAYGUN...KEYS)
%patch $0ED2 [$1E68W] #Eighth line - Raygun\Pogo separator 1
%patch $0EE0 [$1E6AW] #Eighth line - Pogo\Keycard separator 1
%patch $0EF1 [$1E6DW] #Ninth line -Raygun\Pogo separator 2
%patch $0EFF [$1E6FW] #Ninth line -Pogo\Keycard separator 2
%patch $0F10 [$1E72W] #Tenth line - Raygun\Pogo separator 3
%patch $0F1E [$1E74W] #Tenth line - Pogo\Keycard separator 3
%patch $0F27 [$1E77W] #Eleventh line (CHARGE)
%patch $0F35 [$1E81W] #Eleventh line - Pogo\Keycard separator 4
%patch $0F46 [$1E84W] #Twelfth line - Charge\Pogo separator
%patch $0F54 [$1E86W] #Twelfth line - Pogo\Keycard separator 5
%patch $0F5D [$1E89W] #Thirteenth line (PRESS A KEY)

#Text
%patch $14E52 " SCORE EXTRA KEEN AT " $0A $00
%patch $14E70 " " $0A $00
%patch $14E73 " KEENS SHIP PARTS " $0A $00
%patch $14E91 " " $0A $00
%patch $14E94 " " $0A $00
%patch $14E97 " " $0A $00
%patch $14E9A " RAYGUN POGO KEYCARDS " $0A $00
%patch $14EB8 " " $00
%patch $14EBA " " $0A $00
%patch $14EBD " " $00
%patch $14EBF " " $0A $00
%patch $14EC2 " " $00
%patch $14EC4 " " $0A $00
%patch $14EC7 " CHARGE " $00
%patch $14ED1 " " $0A $00
%patch $14ED4 " " $00
%patch $14ED6 " " $0A $00
%patch $14ED9 " PLEASE PRESS A KEY " $00

#Score
%patch $0F66 [$0A] #Base to show Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0F6F {$AACCW} #Variable (Low)
%patch $0F73 {$AACAW} #Variable (High)

#Extra Keen score
%patch $0FA0 [$0A] #Base to show Extra Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0FA8 {$6EC4W} #Variable (Low)
%patch $0FAC {$6EC2W} #Variable (High)
%patch $0FB0 {$4E20W} #Minimum EKA score

#Lives
%patch $1001 {$AAC6W} #Lives variable
%patch $0FE5 [$0003W] #Vertical position of lives
%patch $0FF0 $90 $90 #Lives spaced 8 pixels apart, not 16
%patch $1007 [$06] #Maximum number of lives to show
%patch $0FDE $EB $1E #Don't show Lives
%patch $1003 $90 $90 #Always show maximum number of Keens no matter how many lives Keen has

#Raygun tile
%patch $1166 [$019EW] #Tile
%patch $116D [$0007W] #V position, squares
%patch $1176 [$0004W] #V position, pixels
%patch $117C [$0003W] #H position

#Shots counter
%patch $1198 {$AAC8W} #Variable
%patch $1188 [$0003W] #H position
%patch $1191 [$000BW] #V position

#Pogo tile
%patch $11A7 [$019FW] #Tile
%patch $11AE [$0008W] #V position, squares
%patch $11B7 [$0004W] #V position, pixels
%patch $11BD [$000BW] #H position</syntaxhighlight>

==== Change the lives sprite ====

This patch allows the sprite used for lives to be changed. The first blue value is the sprite used * 4. (Here sprite 31 x 4 = 124 = $7B.) The second blue value is the vertical position of the sprites, originally this was 3 but because of he patch it must now be 9 larger (12 or $0C). This patch is incompatible with several of the patches in the above section that alter the lives counter.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Change the lives sprite
%patch $0FDE $B8 [$007BW] $50 $8B $46 $FE $05 [$000CW] $D1 $E0 $D1 $E0
$50 $8B $C7 $D1 $E0 $90</syntaxhighlight>

==== Don't show ship parts ====

This patch removes the ship parts from the status window, converting it into more space to show Keen's lives. The blue variable is how many lives can now be shown in the status window.

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Don't display ship parts
%patch $100A $E9 $00B9W
%patch $14E90 $0A $0A $0A $00
%patch $0E8D $EB $31
%patch $1007 [$0D]</syntaxhighlight>

=== Keen 2 ===

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Status box size:
%patch $0E53 [$000CW] #Height (In lines of text)
%patch $0E57 [$001CW] #width (In letters)

#Text read from
%patch $0E69 [$219CW] #First line (SCORE...EXTRA KEEN AT)
%patch $0E7A [$21BAW] #Second line
%patch $0E83 [$21BDW] #Third line (KEENS...PISTOL)
%patch $0E94 [$21DBW] #Fourth line
%patch $0EA5 [$21DEW] #Fifth line
%patch $0EB6 [$21E1W] #Sixth line
%patch $0EBF [$21E1W] #Seventh line (TARGETS...KEYS)
%patch $0ED0 [$2202W] #Eighth line
%patch $0EE1 [$2205W] #Ninth line
%patch $0EF2 [$2208W] #Tenth line
%patch $0F03 [$220BW] #Eleventh line
%patch $0F0C [$220EW] #Twelfth line (PRESS A KEY)
%patch $10A4 [$222BW] #London
%patch $10C0 [$2232W] #Cairo
%patch $10DC [$2238W] #Sydney
%patch $10F8 [$223FW] #New York
%patch $1118 [$2248W] #Paris
%patch $1138 [$224EW] #Rome
%patch $1158 [$2253W] #Moscow
%patch $1178 [$225AW] #Washington

#Text
%patch $1991C " SCORE EXTRA KEEN AT " $0A $00
%patch $1993A " " $0A $00
%patch $1993D " KEENS PISTOL " $0A $00
%patch $1995B " " $0A $00
%patch $1995E " " $0A $00
%patch $19961 " " $0A $00
%patch $19964 " TARGETS SAVED KEYS " $0A $00
%patch $19982 " " $0A $00
%patch $19985 " " $0A $00
%patch $19988 " " $0A $00
%patch $1998B " " $0A $00
%patch $1998E " PLEASE PRESS A KEY " $0A $00
%patch $199AB "London" $00
%patch $199B2 "Cairo" $00
%patch $199B8 "Sydney" $00
%patch $199BF "New York" $00
%patch $199C8 "Paris" $00
%patch $199CE "Rome" $00
%patch $199D3 "Moscow" $00
%patch $199DA "Wash D.C." $00

#H position of separating lines (Short lines)
%patch $0E74 [$0A] #SCORE-EXTRA square
%patch $0E8E [$13] #KEENS-PISTOL separator 1
%patch $0E9F [$13] #KEENS-PISTOL separator 2
%patch $0EB0 [$13] #KEENS-PISTOL separator 3
%patch $0ECA [$13] #TARGETS-KEYS separator 1
%patch $0ED8 [$13] #TARGETS-KEYS separator 2
%patch $0EEC [$13] #TARGETS-KEYS separator 3
%patch $0EFD [$13] #TARGETS-KEYS separator 4

#Score
%patch $0F15 [$0A] #Base to show Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0F1E {$9AE2W} #Variable (Low)
%patch $0F22 {$9AE0W} #Variable (High)

#Extra Keen score
%patch $0F4E [$0A] #Base to show Extra Keens score in ($0A = 10, $01 = binary, $00 don't show)
%patch $0F56 {$6EA0W} #Variable (Low)
%patch $0F5A {$6E9EW} #Variable (High)
%patch $0F5E {$4E20W} #Minimum EKA score

#Lives
%patch $0FB7 {$9ADCW} #Lives variable
%patch $0FBC [$0009W] #Maximum number of lives to show
%patch $0F8B [$0000W] #Hide x lives from START of lives (None hidden by default)
%patch $0F95 [$0003W] #Vertical position of lives
%patch $0FA1 $90 $90 #Lives spaced 8 pixels apart, not 16
%patch $0F8F $EB $1E #Don't show Lives
%patch $0FB9 $90 $90 #Always show maximum number of Keens no matter how many lives Keen has

#Raygun tile
%patch $0FC1 [$019EW] #Tile
%patch $0FC7 [$0003W] #V position, squares
%patch $0FD0 [$0004W] #V position, pixels
%patch $0FD6 [$0015W] #H position

#Shots
%patch $0FE2 [$0018W] #H position
%patch $0FEA [$0004W] #V position

#Keycards
%patch $0FFB [$0015W] #Keycards horizontal position
%patch $1003 [$0007W] #Keycards vertical position
%patch $1010 [$01A8W] #Keycard A tile
%patch $102F [$01A9W] #Keycard B tile
%patch $1040 [$0003W] #Keycard B horizontal offset (3 squares left of Key A)
%patch $1051 [$01AAW] #Keycard C tile
%patch $105E [$0010W] #Keycard C vertical offset (two squares down from Key A)
%patch $1073 [$01ABW] #Keycard D tile
%patch $1080 [$0010W] #Keycard D vertical offset(two squares down from Key A)
%patch $1087 [$0003W] #Keycard D offset offset (3 squares left of Key A)
%patch $1032 $90 #Don't show keycard B
%patch $1054 $90 #Don't show keycard C
%patch $1076 $90 #Don't show keycard D</syntaxhighlight>

==== Change the lives sprite ====

This patch allows the sprite used for lives to be changed. The first blue value is the sprite used * 4. (Here sprite 31 x 4 = 124 = $7B.) The second blue value is the vertical position of the sprites, originally this was 3 but because of he patch it must now be 9 larger (12 or $0C). This patch is incompatible with several of the patches in the above section that alter the lives counter.

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Change the lives sprite
%patch $0F8F $B8 [$007BW] $50 $8B $C7 $05 [$000CW] $D1 $E0 $D1 $E0
$50 $8B $46 $FE $D1 $E0 $90</syntaxhighlight>

=== Keen 3 ===

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Status box size:
%patch $0EC0 [$000BW] #Height (In lines of text)
%patch $0EC4 [$001CW] #width (In letters)

#Text read from:
%patch $0ED5 [$22D4W] #1st line
%patch $0EE5 [$22F2W]
%patch $0EED [$22F5W] #3rd
%patch $0EFD [$2313W]
%patch $0F0D [$2316W]
%patch $0F1D [$2319W]
%patch $0F25 [$231CW] #7th
%patch $0F35 [$233AW]
%patch $0F45 [$233DW]
%patch $0F55 [$2340W]
%patch $0F5D [$2343W] #11th

#Text
%patch $1BAF4 " SCORE EXTRA KEEN AT " $0A $00
%patch $1BB12 " " $0A $00
%patch $1BB15 " KEENS PISTOL " $0A $00
%patch $1BB33 " " $0A $00
%patch $1BB36 " " $0A $00
%patch $1BB39 " " $0A $00
%patch $1BB3C " ANKH TIME KEY CARDS " $0A $00
%patch $1BB5A " " $0A $00
%patch $1BB5D " " $0A $00
%patch $1BB60 " " $0A $00
%patch $1BB63 " PLEASE PRESS A KEY " $00

#Horizontal position of some text (In characters)
%patch $0EDF [$000CW] #2nd line
%patch $0EF7 [$0013W] #4th line
%patch $0F07 [$0013W] #5th line
%patch $0F17 [$0013W] #6th line
%patch $0F2F [$000BW] #8th
%patch $0F3F [$000BW] #9th
%patch $0F4F [$000BW] #10th

#Position of values (Score and suchlike)
%patch $0F65 [$0A] #Score base (0A = 10 = decimal, $10 =hex, $01 = binary, $00 don't show)
%patch $0F86 [$0A] #Score h position
%patch $102F [$18] #Ammo h position
%patch $1037 [$04] #Ammo v position
%patch $1066 [$07] #Ankh time h position
%patch $106E [$08] #Ankh time v position

#EKA structure
%patch $0F9C [$0A] #Extra Keen counter base (like above, $00, don't show)
%patch $0FC5 [$1A] #Extra Keen counter h position
%patch $0FA4 {$70F0W} #Variable (Low)
%patch $0FA8 {$70EEW} #Variable (High)
%patch $0FAC {$4E20W} #Minimum EKA score

#Keen's lives structure
%patch $100A [$09] #Maximum number of lives to show
%patch $0FD7 [$0000W] #Hide x lives from START of lives (None hidden by default)
%patch $0FD7 [$00] #Lives h position (Lives stop at $12, so $0A doesn't show lives)
%patch $0FE1 [$0003W] #Sprite vertical position
%patch $0FED $90 $90 #Sprites close together (Change spacing of sprites)

#Raygun
%patch $100E [$00D8W] #Raygun tile
%patch $1014 [$0003W] #Vertical position (lines)
%patch $101D [$0004W] #Plus xx pixels
%patch $1023 [$0015W] #H position
%patch $103E {$9D48W} #What counter tracks

#Ankh
%patch $1045 [$00D6W] #Ankh tile
%patch $104B [$0007W] #V position
%patch $1054 [$0004W] #Plus xx pixels
%patch $105A [$0003W] #H position
%patch $1074 {$9946W} #What counter tracks

#Don't show Ankh tile
%patch $105D $90 $90 $90

#Keycards
%patch $1084 [$000DW] #Keycards h position (4 keycards start here)
%patch $108C [$0008W] #Keycards v position (All 4 keycards this height)
%patch $1099 [$00D9W] #Yellow keycard tile
%patch $10BB [$00DAW] #Red keycard tile
%patch $10CF [$0004W] #Red keycard left of yellow by this much
%patch $10E0 [$00DBW] #Green keycard tile
%patch $10F4 [$0008W] #Green keycard left of yellow by this much
%patch $1105 [$00DCW] #Blue keycard tile
%patch $1119 [$000CW] #Blue keycard left of yellow by this much

%patch $1094 [$0001W] #Always show yellow keycard
%patch $10B6 [$0001W] #Always show red keycard
%patch $10DB [$0001W] #Always show green keycard
%patch $1100 [$0001W] #Always show blue keycard</syntaxhighlight>

==== Change the lives sprite ====

This patch allows the sprite used for lives to be changed. The first blue value is the sprite used * 4. (Here sprite 30 x 4 = 120 = $77.) The second blue value is the vertical position of the sprites, originally this was 3 but because of he patch it must now be 9 larger (12 or $0C). This patch is incompatible with several of the patches in the above section that alter the lives counter.

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Change the lives sprite
%patch $0FDB $B8 [$0077W] $50 $8B $C7 $05 [$000CW] $D1 $E0 $D1 $E0
$50 $8B $46 $FE $D1 $E0 $90</syntaxhighlight>

== The big versatile Keen 1 status box patch ==

This patch fully customizes the status window, allowing the smart patcher to remove or rearrange things to their will. Along with the tiles and variables, it contains their positions and even allows entire blocks of code to be skipped. In addition to this, it frees up space for use with other patches.

The status file is just an external text file of 392 bytes in size. A default example can be found here: [https://files.shikadi.net/keenwiki/misc/STATUS.CK1 STATUS.CK1]

Values in brown are related to [[Patch:Item bytes]] which control *what* is shown, or [[Patch:Jump conditions|jumps]] which control whether or not something is shown. Values in blue are positions (In 8x8 tiles) or 16x16 tiles displayed

=== Keen 1 ===
<syntaxhighlight lang="asm">#Big versatile status window patch:
#Patch in the long-integer drawing function
%patch $11B4 $55 $89 $E5 $B8 $0A $00 $50 $B8 $90 $82 $50 $FF
$76 $06 $FF $76 $04 $E8 $03 $C2 $83 $C4 $08 $B8 $90 $82 $50 $E8
$A5 $C5 $44 $44 $8B $56 $08 $29 $C2 $89 $16 $82 $82 $8B $46 $0A
$A3 $F8 $82 $B8 $90 $82 $50 $E8 $E8 $50 $44 $44 $89 $EC $5D $C3

#Patch in the name of the status dialog text file, you'll need to create a file with this name and put your status
#text in it or Keen will crash.
%patch $14E52 "STATUS.CK1" $00

# Patch in the code to draw the status text (coordinates are measured in characters--8 pixel blocks)
%patch $0E6A $B8 $00 $3D $BA $1E02W # Show status window (0E6A)
$CD $21 $89 $C3 $BF $27 $00 $C6 $06 $9A $82 $00 $B9 $0A $00 $BA
$90 $82 $B4 $3F $CD $21 $53 $B8 $90 $82 $50 $E8 $2E $97 $44 $44
$5B $4F $75 $E8 $B4 $3E $CD $21

#Draw the status window, you can fiddle around with this code
#Draw extra Keen score at 01,0A
%patch $0E98 $8B $46 $FE $05 [$0001W] $50 $89
$F0 $05 [$000AW] $50 $FF $36 $CC $AA $FF $36 $CA $AA $E8 $04 $03
$83 $C4 $08

#Draw extra Keen score at 01,1A
%patch $0EB3 $8B $46 $FE $05 [$0001W] $50 $89 $F0 $05 [$001AW] $50
$A1 $C4 $6E $8B $16 $C2 $6E $81 $C2 $20 $4E $15 $00 $00 $50 $52
$E8 $E1 $02 $83 $C4 $08

#Draw Keen's lives, count $AAC6W, show sprite $007B \ 4 at 03,01
%patch $0ED6 $31 $FF $3B $3E {$AAC6W} $7D $29 $83 $FF
$06 $7D $24 $B8 [$007BW] $50 $8B $46 $FE $05 [$0003W] $B1 $03 $D3
$E0 $90 $90 $50 $89 $F8 $D1 $E0 $05 [$0001W] $01 $F0 $50 $E8 $2C
$AC $83 $C4 $06 $47 $EB $D1

#Draw joystick, check $AA94, if 0 show tile $0141 else show tile $013D at position 3.5 (3 + 4 pixels),10
%patch $0F07 $B8 [$0141W] $83 $3E {$AA94W} [$00] {$74}
$03 $B8 [$013DW] $50 $8B $46 $FE $05 [$0003W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0010W] $50 $E8 $0D $AA $83 $C4 $06

#Draw battery, check $AA9C, if 0 show tile $0142 else show tile $013E at position 3.5,13
$B8
[$0142W] $83 $3E {$AA9CW} [$00] {$74} $03 $B8 [$013EW] $50 $8B $46 $FE
$05 [$0003W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0013W]
$50 $E8 $E5 $A9 $83 $C4 $06

#Draw vacuum, check $AA96, if 0 show tile $0143 else show tile $013F at position 3.5,16
$B8 [$0143W] $83 $3E {$AA96W} [$00] {$74}
$03 $B8 [$013FW] $50 $8B $46 $FE $05 [$0003W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0016W] $50 $E8 $BD $A9 $83 $C4 $06

#Draw whiskey, check $AA98, if 0 show tile $0144 else show tile $0140 at position 3.5,19
$B8
[$0144W] $83 $3E {$AA98W} [$00] {$74} $03 $B8 [$0140W] $50 $8B $46 $FE
$05 [$0003W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0019W]
$50 $E8 $95 $A9 $83 $C4 $06

#Draw Key A, check $AA9E, if 0 show tile $022E else show tile $01A8 at position 7.5,13
%patch $0FA7 $B8 [$022EW] $83 $3E {$AA9EW} [$00] {$74}
$03 $B8 [$01A8W] $50 $8B $46 $FE $05 [$0007W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0013W] $50 $E8 $6D $A9 $83 $C4 $06

#Draw Key B, check $AAA0, if 0 show tile $022E else show tile $01A9 at position 7.5,17
$B8
[$022EW] $83 $3E {$AAA0W} [$00] {$74} $03 $B8 [$01A9W] $50 $8B $46 $FE
$05 [$0007W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0017W]
$50 $E8 $45 $A9 $83 $C4 $06

#Draw Key C, check $AAA2, if 0 show tile $022E else show tile $01AA at position 9.5,13
$B8 [$022EW] $83 $3E {$AAA2W} [$00] {$74}
$03 $B8 [$01AAW] $50 $8B $46 $FE $05 [$0009W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$0013W] $50 $E8 $1D $A9 $83 $C4 $06

#Draw Key D, check $AAA4, if 0 show tile $022E else show tile $01AB at position 9.5,17
$B8
[$022EW] $83 $3E {$AAA4W} [$00] {$74} $03 $B8 [$01ABW] $50 $8B $46 $FE
$05 [$0009W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0017W]
$50 $E8 $F5 $A8 $83 $C4 $06

#Draw Pogo, check $AA9A, if 0 show tile $000B else show tile $019F at position 8.5,0B
%patch $1047 $B8 [$000BW] $83 $3E {$AA9AW} [$00] {$74}
$03 $B8 [$019FW] $50 $8B $46 $FE $05 [$0008W] $B1 $03 $D3 $E0 $05
[$0004W] $50 $89 $F0 $05 [$000BW] $50 $E8 $CD $A8 $83 $C4 $06

#Draw Ammo value, count $AAC8, at position 0B,06
$8B
$46 $FE $05 [$000BW] $50 $89 $F0 $05 [$0006W] $50 $31 $C0 $50 $FF
$36 [$AAC8W] $E8 $2E $01 $83 $C4 $08

#Draw Raygun at position 7.5,03 (Change first two bytes to $EB $1C to skip)
$B8 [$019EW] $50 $8B $46 $FE
$05 [$0007W] $B1 $03 $D3 $E0 $05 [$0004W] $50 $89 $F0 $05 [$0003W]
$50 $E8 $95 $A8 $83 $C4 $06

#Wait for key and return
$E8 $90 $4B $31 $C0 $50 $E8 $1E $AD
$44 $44 $E8 $81 $A6 $E8 $D1 $F1 $E8 $CE $F1 $E8 $7C $4B $8B $46
$FC $8B $56 $FA $89 $16 $35 $51 $A3 $37 $51 $5F $5E $89 $EC $5D
$C3 </syntaxhighlight>

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Text|}}

User talk:Malvineous

2023-02-07T21:51:48Z

Levellass: Patch wiki

Been whined at by Lemm and assorted people, apparently the term 'sprite' applies to graphics only and the terms I should have been using for all the 'sprite' patch stuff is 'actor'; is there any way to systematically change the term 'sprite' in patch page titles (and maybe text) to 'actor'? If not, leave it, but if so, it might be something to think about. --[[User:Levellass|Levellass]] 02:41, 17 July 2011 (GMT)

: It is possible to do a bulk search and replace across pages, but the pages themselves will need to be renamed manually. [[User:DHeadshot]] has access to do this, perhaps you can ask him? If he renames pages when logged in as a bot, it's possible to avoid creating those redirect pages too. -- [[User:Malvineous|Malvineous]] 03:00, 17 July 2011 (GMT)

== ''More talk...'' ==

The older conversations on this page have been archived to keep the content current. To read the previous content on this page, please see:
* 2010-08: [http://www.shikadi.net/wiki/keen/index.php?title=User_talk:Malvineous&oldid=15924 revision 15924]
* 2008-04: [http://www.shikadi.net/wiki/keen/index.php?title=User_talk:Malvineous&oldid=9028 revision 9028]



== Needs pictures error ==

This page [[Keen 1 640x480 Redux]] has itself listed under 'needs pictures' despite having pictures. This appears to be because the pictures on the page are resized. Is there any way aside from using fullsized pictures (Which ruins the page) to fix this? -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 02:21, 29 August 2015 (UTC)

: Thanks for pointing that out! I don't want to automatically resize all images in the infobox, because that makes it too easy to upload 640x400 images by accident as screenshots. So as a compromise I added an ImageScale option to the infobox, which will scale the image and takes care of the 'Needs pictures' category. Hopefully people won't abuse this and upload 320x200 screenshots scaled up to 640x400! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 03:39, 19 September 2015 (UTC)

== Deletion for stupid redirect ==

The page http://www.shikadi.net/keenwiki/Patch:Keen_sstanding_(Vorticons) is obviously misspelled and needs to be deleted. The correct redirect link has already been created so nothing of value will be lost. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 07:55, 15 April 2015 (UTC)

: You're an admin so you should have no trouble deleting the page! The delete link might be hidden under the 'More' drop down, next to the Read/Edit/History tabs at the top of the page. Let me know if you can't find it or it doesn't work for some reason. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 08:12, 15 April 2015 (UTC)

== Jeez, have I been such an butt in the past? ==

Hey Malv. I've not been on in ages, and I was looking at some of my past edits. I have just realized I was acting a total ass, and you should have banned me for what I did. Your patience (and Shadow Master's) with me, legendary as it is, was stretched to the limit, and I'm sorry for what I did to this wiki, with that fiasco wih KeenRush, and me smarting off to you over the preview button and all. I was going through a rather hard period im my life then, and it shows--looking at the comments and such, it looks as if they were written by someone else. Again, I'd like to apologize for any discord I've caused this place. -[[User:Xterra1|Xt]][[User talk:Xterra1|er]][[Special:Contributions/Xterra1|r]][[Special:Random|a1]] 17:02, 19 November 2011 (GMT)

: Hey Xt - no worries, I figured it was something you would grow out of eventually ;-) -- [[User:Malvineous|Malvineous]] 23:50, 19 November 2011 (GMT)

:: And I was looking at the [[Talk: Viva|Viva talkpage]] yesterday. "Xterra-ism". :-) At least I've gotten SOMETHING besides a Nissan SUV named after me. Again, I must compliment you on your patience with me. -[[User:Xterra1|Xt]][[User talk:Xterra1|er]][[Special:Contributions/Xterra1|r]][[Special:Random|a1]] 18:07, 20 November 2011 (GMT)

== Abandoned mods / level packs ==

Hello Malvineous. As I mentioned on [[Talk:Vorticon Mods#Missing_Download_links|Talk:Vorticon Mods]], I still have a few abandoned mods/level packs by different people that are not available for download anymore (at least according to the wiki). Various mods and packs have been directly uploaded to shikadi.net/wiki/, thus I sent one mod to Tulip who contributed a lot to the Vorticons Mods page. He replied two weeks ago, but since then no download has been added for "Mars Kingdoms", so I assume he is just too busy for editing. As you run this wiki, I wonder if I can also send them to you? --[[User:Grandy02|Grandy02]] 09:48, 20 November 2011 (GMT)

: Sure, just e-mail them to malvineous@shikadi.net and I will upload them to shikadi.net/wiki/ if you'd be willing to add the necessary links to the article pages! -- [[User:Malvineous|Malvineous]] 10:27, 20 November 2011 (GMT)
::Great, I'll send them this day! :-) --[[User:Grandy02|Grandy02]] 11:46, 20 November 2011 (GMT)
:::Sent. The names of the zip files are those of the original downloads (if I remember correctly), rename them as you please. The mail includes demos of Redemption, Lord of the Rings (two demos), and Mars Kingdoms. There is also a beta of Bp's "mod" Marooned on Mars Forever, but I think it seems more like a level pack (no changed graphics, no patches and only minimal edits of the story text). What do you think? --[[User:Grandy02|Grandy02]] 16:01, 20 November 2011 (GMT)
::::Not really sure, whatever you think is best would be fine. And thanks, I've put them into http://www.shikadi.net/wiki/files/Mods/abandoned/ so you can link to them directly there. -- [[User:Malvineous|Malvineous]] 22:24, 20 November 2011 (GMT)
:::::Thanks a lot! I added Bp's work to level packs, as I think that changed titles in the story text do not really make it a mod. Anyway, I noticed that the various download links for dosclassics.com are not working anymore. I haven't been able to access the site for quite a while. Do you know anything? Does the site even exist anymore? --[[User:Grandy02|Grandy02]] 14:09, 21 November 2011 (GMT)
::::::I haven't heard anything but as of a year ago it seemed to be online only for "nostalgic reasons" so I guess it's finally offline now. You could try contacting Xtraverse (xtraverse@hotmail.com) and see if he still has a copy of the site... -- [[User:Malvineous|Malvineous]] 00:17, 22 November 2011 (GMT)
:::::::Okay, I sent him a mail. I wonder, if he doesn't want to put the site online anymore, would it be possible to archive the site at shikadi.net just like CC314? --[[User:Grandy02|Grandy02]] 17:35, 23 November 2011 (GMT)
::::::::Certainly I'm happy to do that, if Xtra is willing to send the files across or upload them to my server. -- [[User:Malvineous|Malvineous]] 22:56, 23 November 2011 (GMT)
:::::::::Yeah, it would be great to keep that fine piece of Keen community history. By the way, the hotmail account seems to be inactive (I got "mailbox unavailable" as a response), so now I'm hoping that he'll answer the mail I sent to his @spatang.com address... --[[User:Grandy02|Grandy02]] 14:41, 24 November 2011 (GMT)
::::::::::Hi again. I sent you another abandoned mod, "Trouble on Xion 2" (Keen 4 this time). On a side note, the zip file for [[Trapped Keen]] includes the KEEN3.EXE, which should probably be removed. Also, no answer from Xtraverse yet. --[[User:Grandy02|Grandy02]] 11:22, 26 November 2011 (GMT)
:::::::::::Thanks, uploaded. Thanks also for pointing out keen3.exe, I have removed it from the zip. -- [[User:Malvineous|Malvineous]] 01:50, 27 November 2011 (GMT)
::::::::::::Darn, I guess I should have been more vigilant in copying the levels and mods over to the keenwiki server... -- [[User:Flaose|Flaose]] 04:01, 30 November 2011 (GMT)
:::::::::::::Meh, you couldn't get the official Keen3 game out of it anyway thanks to the modifications, so it's more a courtesy to id than anything else :-) -- [[User:Malvineous|Malvineous]] 11:18, 30 November 2011 (GMT)

==PCKF Archive==
Thanks again! On a side note, could you delete Norp3 title.png, please? But now something completely different: Maybe you have noticed that the old PCKF (its ezBoard incarnation) is not available in the Wayback Archive anymore since the Archive's new version was introduced. Due to the attack on ezBoard back in 2005, this means that basically all pre-2005 topics of the PCKF are lost now. I have basically not followed the community this year, do you know if there have been any reactions on this incident? The thing is, I saved a bunch of topics before the old Archive was taken down, and I'd like to send them over to someone who wants to turn that mess into something more comfortable on the web. But maybe I'm just late to the party and there already have been efforts to save the old PCKF. Has anything been said? --[[User:Grandy02|Grandy02]] 15:55, 27 November 2011 (GMT)
: Done. And I'm not sure about the PCKF - after all those old topics were lost it seemed a bit hit and miss to save it. Plus it was all in HTML so it's difficult to convert - there was some discussion about importing all the topics into the current PCKF. I've also spent hardly any time at the PCKF for a long while, so I'm not sure what the mood is. I think many people who had topics then are no longer active, it seems to be quite a different group of people there now! -- [[User:Malvineous|Malvineous]] 07:16, 28 November 2011 (GMT)
::Okay, I see. I might create a topic on this issue in the PCKF this week (after a quick look, there still are quite a few of the "old ones", though). But if nobody has archived anything, would you mind to host certain topics I saved (of course, not every "W00t! 3000 Posts!!!111!1!" thing)? I might select interesting topics bit by bit - but first I have to know if that is even possible. --[[User:Grandy02|Grandy02]] 17:01, 28 November 2011 (GMT)
:::Sure, but in that case it'll be easier to give you some webspace so you can manage it all yourself, if you're prepared to do so! -- [[User:Malvineous|Malvineous]] 23:21, 28 November 2011 (GMT)
::::Thanks for your offer! I'll create a topic in the PCKF first this weekend and see what others did (if anything), then I'll get back to you. --[[User:Grandy02|Grandy02]] 14:27, 29 November 2011 (GMT)

I had talked with tulip per mail the last few days. According to him, there was nothing on the forum about archiving the ezBoard, and as he is one of the most active members, that has to be the truth. I created a thread nonetheless, but I don't expect much. So I'd greatly appreciate if you really gave me some webspace. :-) --[[User:Grandy02|Grandy02]] 18:27, 6 December 2011 (GMT)

Hello. I neither have mail nor FTP access right now, so could you write your answer on my last mail at this place (in case you already responded)? Also, could you do me a really big favour and make a little edit to the index.htm of the PCKF Archive? Actually, I finally wanted to post, but today I noticed that the page is incorretly displayed in certain browsers due to a little error on my side. Please change

<nowiki>PCKF Archive</a></nowiki>

to

<nowiki>PCKF Archive</nowiki>

and it should be fixed. Thanks in advance! :-) --[[User:Grandy02|Grandy02]] 20:05, 22 January 2012 (GMT)

: Done. There was a suspected intrusion on my web host, so my provider reset everyone's passwords as a precaution. Your new password is in your e-mail. -- [[User:Malvineous|Malvineous]] 22:39, 22 January 2012 (GMT)
:: Thank you! :-D --[[User:Grandy02|Grandy02]] 21:06, 29 January 2012 (GMT)

==DOS Classics is back!==
Good news: Xtraverse replied and put DOS Classics back online! Oh, and by the way, he already created a little PCKF [http://dosclassics.com/old/pckf/ archive] of sorts in the past - well, those topics can be quite... entertaining. ;-) --[[User:Grandy02|Grandy02]] 17:37, 30 November 2011 (GMT)
:Great news, good to have the site back. -- [[User:Malvineous|Malvineous]] 22:43, 30 November 2011 (GMT)
::In a second message, he thanks you for your offer to host DOS Classics, but he intends to keep up the site for "the long haul." DOS Classics was just offline due to a DNS error he forgot to fix. Anyway, yeah, it's great to have it back, I learned lots of Keen stuff at that place, and it got me into modding. --[[User:Grandy02|Grandy02]] 20:06, 1 December 2011 (GMT)

== Another apology ==

Hey Malv. Recently, I made a couple of unnecessary double-edits on accident. Sorry if this irks you.-[[User:Xterra1|Xt]][[User talk:Xterra1|er]][[Special:Contributions/Xterra1|r]][[Special:Random|a1]] 04:29, 24 November 2011 (GMT)

== Source of creatures' names ==

Hello. I'm new here but I hope to be a good contributor :) What I'd like to know is where the names of the creatures from Keen Dreams and Keen 6 were found because Keen Dreams doesn't seem to list them all while Keen 6 doesn't even contain a help section and some of the names mentioned in Keen 6 user manual are different from the names listed here. Can you help? Levellass hasn't answered yet. [[User:Saluton|Saluton]] 05:46, 4 February 2013 (GMT)

: Hi Saluton and welcome to the wiki! Things do move a little more slowly here so you might have to give people a week or two to respond :-) As far as I'm aware all the names are correct - if you can tell me which ones are wrong and let me know where the correct name is we will certainly fix it! Most of the names came from official sources like the manuals, while one or two were supplied by Tom Hall himself. I believe there are a few which have been named by fans lacking a more official source, but it should mention this on those creature pages. -- [[User:Malvineous|Malvineous]] 08:17, 4 February 2013 (GMT)
:: Sorry, I was wrong, the names in Keen 6 user manual and here do match, but I couldn't find a user manual for Keen Dreams. Where should I look? In any case, it's only better for all the wiki articles to refer to sources. :) [[User:Saluton|Saluton]] 09:22, 4 February 2013 (GMT)

::: The rule so far is that the creature names come from the help text for Keens 1-5+Dreams and from the manual for Keen 6. Anything different and it's mentioned in the article. If you have a look at [[Keen Dreams Creatures]] it will tell you that the names come from the help text in version 1.0 of the game. This information was removed from later versions. -- [[User:Malvineous|Malvineous]] 10:49, 4 February 2013 (GMT)
:::: OK, I was wrong here, too :( but citations would still be useful. On another point, wouldn't it be better to combine those articles on creatures so that there's only one article per game? There can hardly be any information on most of the creatures anyway, apart from what they look like, how they move, and what they do. Most articles will forever be two- or three-paragraph stubs. [[User:Saluton|Saluton]] 14:59, 5 February 2013 (GMT)

::::: I guess citations could be useful - they are already there on most if not all the Dreams pages, but there is a lot of more important work needed on all the mod pages so this is a fairly low priority for us. Combining the creatures onto a single page has already been done - each episode has a summary page for the creatures. But we decided long ago it was still worth having a dedicated page for each creature as that gives us more room for additional details, like which levels the creature appears in, bugs in its behaviour, tricks for avoiding it, and so on. It also makes it easier to link to creatures - otherwise we'd have dozens of redirect pages anyway. But likewise we also decided that mods should not have individual pages for each creature, as there would be thousands of unnecessary pages then. -- [[User:Malvineous|Malvineous]] 19:45, 5 February 2013 (GMT)

:::::: I see, thanks. Why is there no page on [[Bobby Prince]]? Was anything decided on that? [[User:Saluton|Saluton]] 06:11, 7 February 2013 (GMT)

::::::: No, there has been no decision there. If you have some information about Bobby Prince related to Commander Keen, by all means go ahead and create a page for him. But if you're looking for things to do, there are [[Vorticon Mods|lots of]] [[Galaxy Mods|mods]] that don't have pages created yet, and each page needs infoboxes, screenshots, level lists, etc. This is where most of the work is being done at the moment. Have a look at [[Episode Null]] for what we're aiming for on each mod's page. -- [[User:Malvineous|Malvineous]] 22:03, 8 February 2013 (GMT)

:::::::: I don't think pages on the creators of Keen should only contain information related to Keen. To my mind, a proper encyclopedic article about a person should give a complete view of their biography even if it's in a Keen encyclopedia, but anyway, we'll see about that when I have enough time to actually edit articles. Thanks for this discussion :) [[User:Saluton|Saluton]] 07:46, 11 February 2013 (GMT)

::::::::: Of course you can include non Keen-related information, but since it's a Commander Keen encyclopaedia it makes sense to give a greater focus on things related to Commander Keen. Otherwise you may as well just link to the Wikipedia article instead! -- [[User:Malvineous|Malvineous]] 23:01, 15 February 2013 (GMT)

:::::::::: I would suggest just linking to the Wikipedia article of Bobby Prince and other creators of Keen when needed. There's no reason to repeat something that is stated better elsewhere. -- [[User:Flaose|Flaose]] 15:48, 20 February 2013 (GMT)

== Goodbye, Galaxy! ==

Why is there no punctuation in the title [[Goodbye Galaxy]]? [[User:Saluton|Saluton]] 14:47, 11 February 2013 (GMT)

: Very good point. I've renamed the page - thanks! -- [[User:Malvineous|Malvineous]] 23:01, 15 February 2013 (GMT)

== Moving of pages and their location on alphabetical lists ==

I notice when a page is moved, it remains in the same place as the old page would when listed in a category. This could be confusing, is there any way to circumvent it? -[[User:Levellass|Always so much to do!]] 09:22, 16 February 2013 (GMT)

: It shouldn't - do you have any examples? Keep in mind the category pages are cached so it can take a few page views before they all get updated after a rename. Certainly by 24 hours later they should all be correct and up to date. -- [[User:Malvineous|Malvineous]] 21:27, 16 February 2013 (GMT)

== Delete some pages ==

[[:Category:Incompatible Patches]] is an invalid category, it seems that such pages should always have a small 'p' in patches due to the way the wiki works. This page is thus extra and should be deleted post haste. -[[User:Levellass|Always so much to do!]]
: The following pages can also be deleted, having no other pages linking to them and being the subject of double redirects; [[Moving Platform]], [[Patch:Keens Left]] and [[Patches:Game start]], results of poor syntax -[[User:Levellass|Always so much to do!]]

:: Done! -- [[User:Malvineous|Malvineous]] 14:48, 20 March 2013 (GMT)

::: Many thanks, that clears things up a bit, I dislike superfluous pages. -[[User:Levellass|Always so much to do!]] 19:28, 20 March 2013 (GMT)
:::: Bleah, found yet another duplicated page, (Mind the original was very old and in need of updating.) Could you please remove [[Patch:Light Switch]], it has stuff on it, but nothing that isn't on the original page now. (Also there's only one page that links directly to the light switch page, so it was easy to make sure there's no links to the duplicate page.)

::::: Done. I've also made you an administrator of the wiki so you should be able to delete pages yourself in future (there's a new tab at the top of each page you will see once you log out and back in again.) -- [[User:Malvineous|Malvineous]] 00:06, 2 April 2013 (GMT)

::::: Thanks, that should help, assuming I don;t make any more dumb mistakes like the mess you just fixed up. -[[User:Levellass|Always so much to do!]] 09:08, 8 April 2013 (GMT)

:::::: Hahaha no worries, everyone makes mistakes :-) -- [[User:Malvineous|Malvineous]] 11:56, 8 April 2013 (GMT)

== About my Cosmo Mod ==

Thanks for the heads-up. I didn't know there was a page at the Modding Wiki for Cosmo Mods. I'll make sure to put the mod article there next time.
[[User:T-Squared|T-Squared]] ([[User talk:T-Squared|talk]]) 22:32, 23 February 2015 (UTC)

== A bug ==
I tried to get my three mods in the Keen 1, Keen 2, and Keen 3 mods page. But I can't do it, because it won't do it. Sorry about the edits I've done. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 23:52, 15 March 2015 (UTC)
:Hello Quinton. You did everything right, but those pages are not always refreshed automatically. To purge a page's cached version, add "?action=purge" to the page title in the address bar and commit, e.g. <nowiki>http://www.shikadi.net/keenwiki/Keen_1_mods?action=purge</nowiki>. You can also read about this in the source code of the mod lists. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 07:59, 16 March 2015 (UTC)

== Mod title confusion ==

Hi Malv. I'm currently creating stubs for the remaining missing mods, but I'm confused about the wiki's handling of mod titles, especially those with subtitles. Sometimes the main (series) title(+episode number) is used (e.g. [[The Clones of Evil 1]], [[Death to the Vorticons 3]]), but for others the subtitle/episode name (e.g. [[Vanished To Venus]], [[Kidnapped Keen]], TUIT trilogy), while in some cases the full title is given to the article (e.g. [[Onward: Silcar 1: Nightmare Before Teatime]]). Are there any rules for this? And a unique case seems to be [[OrbKeen1]], which is given its production name rather than actual title. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 18:37, 21 March 2015 (UTC)

: I'm not sure - I don't think there's a specific rule at the moment, but if you want to come up with one then by all means. I guess what you want is something unique, so MyMod1, MyMod2, MyMod3, etc. aren't very good because they are too similar. Likewise the Onward: Silcar one is probably a bit too long. I'd be happy renaming that to [[Nightmare Before Teatime]] and then applying that rule to the others. There's probably no need to have the series name in the title, as the previous/next episodes in a series are listed in the infobox on each page. What do you think? -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 23:22, 21 March 2015 (UTC)

::I'm okay with both using the full title or only the episode's name. Sure, there would be quite a few lengthy page titles in case of the former option, so it might be better to choose the latter one. My only concern is that some mods could be more commonly known by the series name+number rather than the subtitles from what I've seen (e.g. Norp the Yorp, Shadow Keen, Marta). Do you think that would be still acceptable? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 11:03, 22 March 2015 (UTC)

::: I think so. Providing the common name(s) appear in the article itself then it will show up in a search for those names, so it shouldn't be a problem locating a mod. If it's really bad then we can always create a redirect, although personally I would try to manage without redirects first, as I'd rather not see every mod come with a dozen redirects attached as it will make it more difficult to maintain. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 11:49, 22 March 2015 (UTC)

::::Sounds good. Though I think there would generally have to be one redirect for the affected pages. For example, "Brain Damage" would have "Norp the Yorp 3" so that visitors can also find the mod when typing "Norp". --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 19:49, 25 March 2015 (UTC)

::::: That's fine, although if it's only searching you're worried about, on the mod page putting something like "Brain Damage (also known as Norp the Yorp 3)" should be enough. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 00:44, 29 March 2015 (UTC)

:::::: I think it would be more comfortable so that a visitor gets directly to the correct page when typing the title they are used to. So, could a rule for this be created? Also, would it affect the names of the zip files? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 08:10, 8 April 2015 (UTC)

::::::: Can you give me an example? When I type "Norp the Yorp 3" into the search bar the mod is the first result, and if I type "Brain Damage" it's the second result. Wouldn't that be enough for people to find it using whatever name they prefer? Or you just prefer if it goes straight to the page if there's an exact match? I don't mind just as long as there's a good reason for doing it one way over the other. One thing I want to avoid is having a dozen redirects for each mod, with only things like capitalisation being the difference between some of them. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 09:07, 8 April 2015 (UTC)

::::::::Yeah, I'm only referring to going straight to the pages. I personally don't mind if I have to do one more click, just thought that some visitors wouldn't like that when entering a mod's common name a list of search results appears first. I fully understand that the number of redirects has to be kept small, never intended to add different capitalisations and stuff. If anything, I only imagined one per mod if it is relevant at all (as in case of the Norp mods). If a rule is made, would the zip files also have to be renamed? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 17:54, 8 April 2015 (UTC)

::::::::: Fair enough if there aren't huge numbers of them. Remember that redirects aren't supposed to be categorised though, they're only supposed to be used for pages that used to exist on the wiki but were deleted/merged, so that any external sites linking to the old page still work. Up to you whether you want to rename the files, but I think we should stick to one title per filename though. Most people will only see the filenames temporarily while they download mods, so there should be no need to cram too much information into the filename! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 22:25, 8 April 2015 (UTC)

I'm almost done with with adding pages for the missing mods. However, I have a question related to the download links in the mod galleries. In most cases, only the download for the latest version is needed there. But what about downloads of remakes, e.g. those of Yorphius II, ShadowKeen and Crash on Gobo III? Maybe even a separate box (though not a separate article) that also includes the remake author's name? If there's one mod that definitely needs two download links, it is [[The Grand Intellect: Doomship Dilemma|Doomship Dilemma]], because the mods by Levellass and Szemigi are basically two different works based on the same beta. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 07:38, 23 May 2015 (UTC)

: Nice work! If the mods are that different then they probably deserve their own pages, like [[The Grand Intellect: Doomship Dilemma (Levellass version)]], [[Yorphius II (Deluxe)]] or [[Crash on Gobo III (remake)]]. However I think we need to come up with some criteria to make sure we don't get a different page for every revision of a mod. I think the criteria should be:
:* If the remake is by the same author as the original, then it should be considered the latest version and only that version included in the list (but the older versions of course listed on the article page.) This is to encourage mod authors to make new mods instead of endlessly tinkering with existing ones. It is fine to have screenshots of the different versions and to explain why they were released, but only one infobox can go on a page (otherwise it will break the categories and mod lists.)
:* If a mod builds on another one (by the same or a different author), then a new article for it should not be created, and the new mod should be listed as an alternate version on the original mod's page. This is to avoid having people change a couple of graphics and get their own mod listed. The way [[Yorphius II]] is written now is perfect.
:* An exception to the previous rule is allowed for substantial changes, such as a complete levelpack for an existing mod. If you are unsure whether a mod-mod counts or not, then it doesn't. It should be very obviously a whole new mod based on an existing one, and not just a few changes or a couple of new levels. This means [[Gridlock's Dead in the Desert Levelpack]] should have its article deleted, and the content moved onto [[Dead in the Desert]] where it should be listed as an alternate version by a different author.
: Using this criteria, Doomship Dilemma would get split into two mods/pages, Yorphius II would have an alternate version listed (unchanged to how it is now), and Crash on Gobo III would have the more recent change listed as the latest version.
: What do you think, does this seem fair? -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 09:06, 23 May 2015 (UTC)

::I agree with the most points, but regarding Gridlock's level pack, I'm not sure. I mean, level "packs" with just one level based on the original games also have their own articles, so I think a small level pack for a mod is as worthy. But any way, what to do with level packs in general? Most pages don't use any mod/level pack-specific templates yet (though several have the level template). Should they also use the mod infobox and thus appear in the mod lists? Or a slightly altered template and separate lists? I think there should be a way to differentiate between them. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 21:03, 13 June 2015 (UTC)

::: I'm not so keen on having an entirely different list for full mods vs level packs, but what if we modify the current mod lists so that under each mod (where it currently has a download link, the number of levels, and the mod status) we include a new item that says whether the mod includes new graphics? That way full mods would say yes here, and level packs say no, but everything could be in the same mod list. This item can pull from the existing mod infobox, so current pages wouldn't have to be updated to include the new info. Would that work? -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 23:30, 13 June 2015 (UTC)

::::Good idea. Okay, now the only remaining issue is the sheer number of level packs that don't have a page yet (more than 40). Of course I could do it all on my own again, but the progress would be very slow, and the outdated links would continue to be in the navigation. It would be a different case if just putting infoboxes on those pages would be enough for stubs, not sure about that. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 17:29, 21 June 2015 (UTC)

:::::The page only needs an infobox to appear in the list, and ideally a screenshot, but really, as much or as little as you can manage is fine. Maybe you can come up with a simple procedure explaining what to copy/paste and recruit some help from the PCKF? -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 10:43, 27 June 2015 (UTC)

::::::I'll ask the PCKF members to help with screenshots and red links once I'm done with the few missing "blue links". --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 18:50, 24 July 2015 (UTC)

:::::::Sounds good! Thanks for all your effort cleaning up the mod lists, it's great to have someone willing to put the time in to do this properly! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 22:37, 24 July 2015 (UTC)

==File name problems==
I moved [[Commander Keen & the Morticore]] to [[The Morticore]], and I have encountered a problem. The files are now broken, because the mod title has changed. I don't want to upload a duplicate of the file, so is there anything else I can do? [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 16:22, 23 May 2015 (UTC)
:I've "moved" the files. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 16:30, 23 May 2015 (UTC)

== Translation mods ==

Hi, I've two questions regarding mods that act as translations of the original games, more specifically the Hungarian translations by Szemigi. First, would each one of those mods have its own page just like other skin mods? Texts and text graphics are changed. And second, how to localise the downloads? The zip files contain installers for Windows. Should the zip archives include the actual game files or the installer executables? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 19:15, 26 July 2015 (UTC)

: Hmm, they're not really "mods" in the gameplay sense so they kind of belong on the main episode pages instead. Do you think we could put them somewhere there? Maybe we need to expand each episode's page to contain a bit more info as well as things like this. As for the download, technically we can't distribute modified versions of the game so it should be the usual patch files that sit on top of the original game. You don't need an installer for this so hopefully that can be removed, especially since it won't work for anyone running a Mac, Linux, or a real DOS PC. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 21:54, 26 July 2015 (UTC)
::Yeah, I was thinking the same, it would require an additional emulator for non-Windows users, so I'd zip the extracted files for the localised downloads. Maybe we could have a page named "Translations"? "Keen 1 Translations" and so on would have too little content each, so one page for all translations would be enough, and each episode page would have a link to it. What do you think? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 15:03, 13 August 2015 (UTC)

::: That sounds fine to me, feel free to go ahead and create it! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 11:27, 15 August 2015 (UTC)

The translations are essentially skin mods, too, aren't they? What about a collective page for skin mods (that could also include the translations then)? I've to agree that it's hard to draw the line, and things like "play in CGA" or "play as Vorticon (Keen's sprites simply replaced by Vorticon's)" probably don't need their own pages. But I wouldn't like a complete exclusion of them, either. Not to mention that the wiki provides the downloads for all of them since more than two years. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 10:41, 20 August 2015 (UTC)

:: I'm still not so keen on listing skin mods. To me they are not much different to changing the sounds or music and leaving the game otherwise unchanged. It's like an incomplete mod, and incomplete mods should not be listed here unless they are abandoned and enough progress has been made that playing them is significantly different to the original game. I guess it hinges on whether the KeenWiki is supposed to be a database of every single mod, no matter how insignificant, or whether it should be an index of the better more complete mods. I am of the opinion that you need to change more than one or two things in order for the mod to feature here. If a skin mod is good enough, then someone over at the PCKF will surely use it in a full mod and then there's no problem listing it here. For the completists, who want every single little change preserved, maybe other sites like moddb.com would be a better match? Translations are a special case as they make the original games accessible to a wider audience - in my opinion they aren't really mods, as the content is the same as the original game, just in another language. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 03:13, 19 September 2015 (UTC)

I've created [[User:Grandy02/Test|a list]] with all the skin mods + translations. Do you think the SGA mods would count as "translations", even though the language remains English? Regarding the skin mods, a few words have been exchanged in the [https://pckf.com/viewtopic.php?t=3206&start=15 PCKF topic]. Personally, I wouldn't mind if they had pages. Technically, the abandoned mods without changed levels are a similar case. But I wouldn't create pages for the "Military" mods, for example, as only some sprites have been changed and nothing else, but in those cases I'd keep download links somewhere due to their "historical" value (made during the early years of Keen modding). Not sure about Cybernetic Dreams, though, as quite a few graphics have been edited, while there is nothing else like patching or text edits. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 21:24, 20 December 2015 (UTC)

: Translation mods definitely deserve a place, but I think they should be separate to mods and listed close to the official games, since the idea is that they are the same as the official games but open them up to a wider audience. An SGA translation mod is interesting, but if it's changing the English parts to SGA then it's more of a curiosity than something I think anyone would choose to play.

: For skin mods, I think we need something similar to Wikipedia's notability guidelines. Skin mods may be worth listing if they are historically significant (such as one of the first ever mods) but beyond that I personally feel that unless there are new levels, the mod doesn't add anything new to the original games. Playing the original games is fun - but playing them with a different sprite here or there is boring - you aren't going to make any new discoveries. I see skin mods as being lazy, and when people complain about having to make even just one new level, that just reinforces the idea that they are being lazy and want a mod page with the least amount of effort possible.

: How about asking the people over at Keen:Modding what they think? If you can get the modders themselves to cast a vote about whether we should include skin mods or not, then I am willing to go with their decision. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 22:30, 20 December 2015 (UTC)

== Galaxy Mods - adding additional topic ==

Hey Malvineous, quick question to that [[Galaxy Mods|Galaxy Mod]] page: What about adding a new topic like ''Notable Demos''. This section would comprise round about 12 alpha-mods and it might give a bit more clarity.
I can take care of it, as soon as you give me your "OK" for doing so. -- [[User:Nisaba|Nisaba]] ([[User talk:Nisaba|talk]]) 21:21, 6 April 2016 (UTC)

: I'm not quite sure exactly what you are proposing, but you are welcome to make a start and then get some opinions about whether people like what you're doing or not. It's a community wiki so it's not up to me :-) However do bear in mind that per the note at the top of [[Galaxy Mods]], that page will be deleted once all the mods are moved off it. If you're going to start classifying mods as notable though, make sure the criteria you are using are very clear, otherwise everyone will want to add their own mods to the list! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 09:41, 25 April 2016 (UTC)

== What happened to the voting system? ==

I noticed that the voting system that is found inside the CK mod info boxes appears to be disabled. Is this because of some nasty bug happened or was this done on purpose? [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 05:45, 14 May 2016 (UTC)

:It seems that the extension was not updated and/or it's source is not longer available. @Malvineous: But there is an alternative extension available. The installation seems pretty straight forward. See: https://www.mediawiki.org/wiki/Extension:VoteNY -- [[User:Nisaba|Nisaba]] ([[User talk:Nisaba|talk]]) 20:10, 25 March 2017 (UTC)

== Possible username change? ==

Hey there, Malvineous. I was wondering if you admins have the power to rename user names or not. If so, then I would appreciate it if you could change my username into "Quillax", my current name in the PCKF and K:M. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 02:33, 26 March 2017 (UTC)
: I don't think we can do so easily, but if you are able to find some SQL that can do it for MediaWiki then I'm happy to run that. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 09:31, 1 October 2017 (UTC)

== Weird thing with adding new external links ==

I was updating the download link and adding a new one to my site in The Sunnylands. During the security thing, however, the images are only displayed as "V1 SHUTDOWN ON 2018-03-31" and no sounds are played when doing the audio challenge. I thought things broke at first, but I typed the text in the image and it was working fine. I feel like I should let you know about this, though, just in case. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 14:31, 7 April 2018 (UTC)
:Oh, it seems like anything will work in the security thing. I think it might be good to fix it if possible. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 14:52, 7 April 2018 (UTC)
::Thanks for the heads up! I'm glad it's not stopping people from adding links. I am (slowly) working towards moving the wiki onto a new server so I'll probably remove it when that happens. The requirement for people to fill out a biography when they register has so far kept out 100% of the spam, so hopefully that keeps up and we won't need the external link captcha any longer. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 01:42, 8 April 2018 (UTC)

== My Mortimer skin for Keen 5 and 6 got deleted ==

Hey, Nisaba from PCKF removed my Mortimer skin for Keen 5 and 6 and I cannot recover these anymore. These contained the EXE files, but this should have been updated, so these won't have the EXEs anymore. --[[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 13:45, 6 July 2018 (UTC)

: If it was a skin mod (only graphics changed) then it's against the [[KeenWiki:Guidelines|Guidelines]] so that might be why. You'll have to change more than just the graphics to justify including it here. Knowing how many popular mods you make though, I'm sure you'll have no trouble making some new levels for it! Then we can include it here. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 13:49, 6 July 2018 (UTC)

:: Strange, because Mortimer McMire Keen 5 and 6 skin changes has only sprite and some other graphic edits. What about Keen 1-3 skins then?--[[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 14:23, 6 July 2018 (UTC)

::: My personal preference is to delete them, but some in the community want to keep them, so we're still a bit undecided. If you have some good ideas let me know. I just want to avoid the KeenWiki becoming a dumping ground for fan art, when there are much better sites for that type of thing (e.g. DeviantArt) -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 22:54, 28 July 2018 (UTC)

== EXE files in Keen 2,3,5,6 mods ==

Hey, I saw that some of the Keen 2,3,5,6 mods contain the EXE files. What to do? Because I have mods as well that has EXE and I should update them sometimes. --[[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 14:36, 6 July 2018 (UTC)

: We are trying to update these mods to delete the .EXE files where we can. If you are updating your mods it is best to set it up so that the player unzips the mod over the top of a working copy of the game, so that the .EXE is not distributed on the wiki. That would be very helpful if you have mods like this that you can update! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 22:54, 28 July 2018 (UTC)

== Semantic questions ==

Hey there, Malvineous. I've been updating mod pages to fit in the latest style, but I thought I'd ask you a few questions. First, I'd like to mention the ending and title screen levels in the Vorticon mods. I've been including them since your adding a mod tutorial requested so, but what I'm wondering about is if they should be considered required or not. I've been setting them to "Yes", since I figured that one has to go through them to beat the game, but I just want to make sure. Also, should the items in the title screens be counted for points or no? That is something I'm not so sure about.

Another thing I want to bring up is hazards. In my mods, I put them into the actors list with their replacements stated. However though, I now feel like listing the tile hazards as replacing something is kinda dumb, as it's really easy for one to add more tile hazards and they don't have much differences between each other (especially in Vorticons mods). I think it's alright if it replaces a hazard that has something to do with a sprite, though, such as the Underwater Mine. I think it'd be nice to either have the ModActorImage template updated to have something for if it's a tile hazard or not or a new template (something like ModHazardImage?).

Finally, I want to bring up something that has to do with the regular Sqeeks and levels from therealdopefish's levelpacks. Both have been used in more than one mod, with the former replacing different creatures (although they act nearly identical) and the latter using different level numbers. I'm not sure how to explain it but if you were to look Flames on Earth and The Sqeek Battle for the former and therealdopefish's two levelpacks for the latter, I think you'll be able to see that there is a problem. It'd be nice if it can be fixed, although I think therealdopefish's levelpacks are a lot like each other, with one just having extra levels, so those two could probably just be merged. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 20:09, 11 November 2018 (UTC)

: Hey, very good questions! I'm a bit out of the loop at the moment so not sure which levelpacks you mean, but (although I haven't tested it), in theory you should be able to put multiple <nowiki>{{LevelImage}}</nowiki> templates on a level page to have the same level appear in multiple mods. If this doesn't work let me know and I'll fix it.

: With the hazards my opinion is that they are just tiles so they should not be listed (otherwise we'd be listing every single tile that's changed) however exceptions can be made if one of the hazard replacements is particularly notable for whatever reason. Otherwise I'd leave them out. The mod pages are after all just meant to be a summary of the important bits rather than a list of every single change. If you think it would be better to have a ModHazardImage then by all means go ahead and create one - just copy the existing one and modify as needed, that's perfectly fine.

: The 'required' attribute was meant to indicate whether the level must be *played* in order to finish the game so I guess by that logic the title and ending levels can be set to false for most mods, unless somehow the player ends up in them intentionally and cannot finish the game otherwise. Interesting point though, I had not considered the non-level levels! I would still count it for points though, just for curiosity's sake, but at the same time I wouldn't give it a high priority so it's fine if it's left blank. However I am now wondering whether these should be included at all, since if there's no way to play the level without cheating, isn't not really a level... -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 21:58, 11 November 2018 (UTC)

== ModActorImage request ==

Hi Malv, could you take a look at [[Template talk:ModActorImage]], please? I think the template needs a "Link" parameter just like the one used by ItemImage. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 17:57, 18 May 2019 (UTC)

: Sorry for the late reply, I didn't get a notification for some reason and I'm a bit behind on all this stuff at the moment! I replied on the [[Template talk:ModActorImage|Talk page]] but essentially to avoid the wiki becoming a dumping ground for all sorts of random fan art, there are some restrictions on what can be uploaded. Generally speaking it's one page per mod, and all the actor info, story, etc. should be on that single page. We found early on that having a separate article for each mod actor was too much work because they would never be completed fully, so by keeping everything on the one page it makes it easier to maintain. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 04:24, 13 July 2019 (UTC)

::No problem, thanks for your reply. I answered on the talk page. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 18:35, 13 July 2019 (UTC)

== New version of a file doesn't work ==

Some minutes ago, I uploaded a new version of The Ultra Omegamatic in-game image with new tiles, but it is the same as the first version of the image, how I can change it?--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 18:54, 8 September 2020 (UTC)

: You have to clear the cache of your browser in order to see the changes take effect.
: -- [[User:Nisaba|Nisaba]] ([[User talk:Nisaba|talk]]) 23:50, 8 September 2020 (UTC)

== All the fangames use the new infobox ==

Hi, I would like to tell you I checked all the fangames infobox and all of them use the new infobox, so there is a thing to remove in the list of "To do things". Soon I'll check the unused images--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 20:07, 8 October 2020 (UTC)
: Nice job! Feel free to remove it from the list if you're satisfied it's done! (And feel free to add anything else you think is important.) -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 01:34, 9 October 2020 (UTC)
I now finished to check the unused images: some of them are present in their articles but it says they're unused, the others have been hidden so an administrator can delete them except for the 1st level of The Prisoner's Dilemma. It can be utilised when it'll be released--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 10:59, 9 October 2020 (UTC)

I also uploaded some fangames images to fix the broken links, but I've done an error moving a file and uploading another image for [[Keen: Next (fangame)|Keen: Next]] because I didn't know both the files have the same name. The rest of the fangames that need pictures are unplayable on my PC so I can't do some screenshots of them--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 20:09, 9 October 2020 (UTC)

I just finished putting all the files into categories. The remaining are 12: An image of Bobby Prince, some images of my mod in development that need to be deleted, some levels of Keen 3 Part 2 which are the same as the originals and which I think should be deleted and some screenshots of some other Mod. Keen Aqua 3 I think--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 07:41, 11 October 2020 (UTC)

: That's great, thanks so much for all your effort! I've made you an administrator of the wiki so you should now have access to delete files if you want to tidy up that last little bit. Sometimes the wiki software can be a little slow to realise an image is in use if you have only just added it to a page, but if you use the [http://www.shikadi.net/wiki/keen/api.php?action=query&meta=siteinfo&siprop=statistics statistics API] and look at the "jobs" value then once it has reached zero everything should be up to date. If this is zero but you still have an image listed as unused when it's definitely in use, let me know and I'll investigate. Remember that filenames on the wiki are case sensitive so it's possible it's a duplicate if the case is different. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 00:19, 12 October 2020 (UTC)

Obviously I'll have to get used to it. Because I don't know how certain functions work so by mistake I reversed your edits but quiet I fixed everything--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 08:01, 12 October 2020 (UTC)

I also deleted all the unused images and the duplicates. The remaining images are from unreleased mods(They can be utilized when the mods will be finished) and levels that are present in their articles(even if it says they're unused) . So this work is finished

: I refreshed the wiki link database as it looked like the unused images shouldn't have been there, and sure enough now it has realised which ones were in use and most of them have gone from the list. There are still a few unused images so hopefully those can easily be sorted. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 09:57, 14 October 2020 (UTC)

Good. So I can sort the rest--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 10:40, 14 October 2020 (UTC)

== Creatures and Hazards ==

Hi Malv, since some years, the creatures and hazards of the original games appear on the main page of a game rather than on separate pages (though certain pages like [[Keen 1 Hazards]], [[Keen 6 Hazards]] and [[Keen GBC Creatures]] were not changed to redirects). While the template EpisodeInfo still contains separate links for creatures and hazards, both of them appear under the heading "Actors". Personally, I'd prefer to have separate sections for them (Nisaba agreed). What do you think? I guess that would not only require a new template, but also some new properties? Or would there be another way to split them on the game page? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 21:07, 11 November 2020 (UTC)

:I couldn't help but read. It would be a very nice idea to create separate pages for each hazard. It would help readers to know more about these--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 08:34, 12 November 2020 (UTC)

::Actually, I was referring to separate sections on a game's main page rather than separate pages for the various hazards. Most of them are just deadly tiles, though I wouldn't mind if pages were made for ice cannon, laser cannon, jack, underwater mine, etc., since these stand out. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 15:24, 12 November 2020 (UTC)

:::Both are cool ideas. So let's wait Malvineous's reply--[[User:DarkAle|DarkAle]] ([[User talk:DarkAle|talk]]) 18:00, 12 November 2020 (UTC)

:::: I just dropped by to let you guys know that I second Grandy02 suggestions.
:::: -- [[User:Nisaba|Nisaba]] ([[User talk:Nisaba|talk]]) 19:49, 27 November 2020 (UTC)

::::: Are you saying you just want the creatures under the "Actors" heading split into two headings, "Creatures" and "Hazards"? I'm fine with that (I think those pages could do with a revamp in general) but do we need to agree on the criteria for what goes where? e.g. if you say hazards are anything that is a tile then what about a [[Pat Pat]], isn't it a creature? Maybe hazards are things that are environmental, but then the Ice Cannon doesn't really qualify...
::::: There is an existing property for 'harms keen' that could be used to split the sections but it sounds like this isn't what you are after. If you need to add a new property then that's no problem, let's just agree on how to classify it first. Perhaps it's worth asking on the PCKF or K:M for opinions there? I don't think too many active community members keep an eye on these talk pages. Either way we'll need to create a page for each hazard so we can use the Semantic MediaWiki query tools to populate the lists. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 11:14, 28 July 2021 (GMT)

::::::Splitting into two headings (possibly as subheadings of "Actors") sounds good. What about an additional parameter for the "ActorImage" template that allows to distinguish between the two? The Pat Pat is indeed a tricky one, technically it's just a deadly tile, maybe an exception could be made for that one. I'd list everything as "hazards" what has been referred to as such on the "Hazards" pages (including Ice Cannon, Jack, Dart Gun, Laser Cannon etc.). Not sure about the "Stranded Fish" (or whatever it is), though. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 16:03, 7 November 2021 (GMT)

== HTTPS & New URL ==

I see the URL for the KeenWiki has changed and the site is now HTTPS - when did that change and, out of interest, were you contacted by a user called "mr_pants" requesting it? It's just that I was contacted via IRC this morning under the mistaken assumption that I had control of that part of the wiki. -- [[User:DHeadshot|DHeadshot]] ([[User talk:DHeadshot|talk]]) 16:39, 11 May 2021 (GMT)

:No, nobody has contacted me about it. It is something I have wanted to do for a long time, starting the process [https://pckf.com/viewtopic.php?f=3&t=4396 over two years ago] and only finishing [https://pckf.com/viewtopic.php?t=9247 a couple of months back]. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 23:30, 12 May 2021 (GMT)

== Camoto: Dangerous Dave - graphic problems ==

Hey! Today I translated (only hexadecimally unfortunately) Dangerous Dave 1 to Hungarian. I wanted to translate the graphic signs like "DAVES:" "GO THRU THE DOOR", etc. as well, but when I exported original VGA (!) graphic stuff and then I modificated it and re-imported it, the graphics were screwed up when I started new game. (Even the blazing Dangerous Dave sign had little glitch as well). Help me! [[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 20:48, 3 June 2021 (GMT)

: This is a known problem that was only very recently fixed. I'm not working on the old Camoto version any longer, but you can try the incomplete development version of the new Camoto version that runs in a web browser. It can't do as many things as the old Camoto yet but it can modify the Dave graphics without corrupting them. See https://camoto.shikadi.net -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 23:36, 3 June 2021 (GMT)

== Adding a Demo/Beta release date to infoboxes? ==

Right now, it seems half the time the first release date is the release of a demo/beta (such as with [[Atroxian Realm]]), and half the time it's the first full release (such as with [[Operation Ocflore]]). It's inconsistent.

In my opinion, the best way to fix this would be to add a Demo/Beta Release date to the info box and rename the Release date to Official Release Date. [[User:Pandakeen|Pandakeen]] ([[User talk:Pandakeen|talk]]) 18:43, 7 August 2021 (GMT)

: Fair point. I'm less keen on the demo/beta release date because mods shouldn't have pages made for them until they are finished (as this acts as motivation to finish the mod instead of abandoning it shortly after the demo has been done) so I'd be fine with only having the date of the full release and not worrying about any demos or betas. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 00:56, 9 August 2021 (GMT)

:: I'll go ahead and correct the dates, then. [[User:Pandakeen|Pandakeen]] ([[User talk:Pandakeen|talk]]) 13:27, 20 October 2021 (GMT)

== Thanks for the admin access! ==

Hey Malv, thanks for giving me access to administrator tools, including mass-editing! A few days ago, I fixed tons of download links to reflect the KeenWiki server change. It took me a while to figure out how to use the mass-editing tool, but once I got it down it was a breeze. The download links seem to be working now. I also upgraded them so that they use HTTPS instead of HTTP -- hope that doesn't do any harm!

When I first took care of the fan-game download links, I made a slight mistake. It messed up the "List of fan-games" page, but thankfully, I got that fixed. The individual fan-game pages seem to be alright, so I didn't bother with those, but I thought I'd point out the mistake just in case something else did get messed up. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 07:10, 8 November 2021 (GMT)

: All good, I wasn't sure if you got my e-mail or not! As long as you can fix any problems you create then it's no issue :) -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 12:23, 8 November 2021 (GMT)

== Is Keen 1 Randomiser a mod or a tool? ==

I've been thinking of making an article about Multimania's [https://davidgow.net/keen/randomiser.html Keen 1 Randomiser], but I can't decide if it's a mod or a tool. On one hand, the index page of Multimania's website describes it as a tool and it looks like it could be used with mods, or at least the simple ones. On the other hand, however, it seems to be made more for playing rather than creation. What do you think? [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 07:10, 8 November 2021 (GMT)

: In my opinion if it's a patch you run as part of the game then it's a mod, and if it's a program you run that produces a mod you then run as a second step (and can distribute independently), that's a tool. However if the difference is that slight then it won't hurt to list it in both categories. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 12:23, 8 November 2021 (GMT)

::Well, you can run a program (RANDKEEN.EXE) that will generate the randomized levels and patch file, which could be independently distributed. On the other hand, however, you can run a batch file (RNDKEEN1.BAT) that will run RANDKEEN.EXE and then runs the game with the produced levels and patch file. Since the [[Random Maze Generator]] is considered a tool, I'm slightly leaning towards the tool category. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 06:36, 16 November 2021 (GMT)

::: It certainly is a borderline one. Is its primary purpose for people to play (like a mod), or to make levels for other modders to incorporate into their own levels (like a tool)? How many mods have made use of it as a tool? If there aren't too many that suggests it's a mod first, but also listed in tools second. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 07:00, 16 November 2021 (GMT)

::::I just created an article about it, and it's classified as a tool. I saw your message after uploading the first image and while creating the article. I'm sure it's made for people to play, and I haven't seen any mods make use of it (at least not yet). I made it a tool, though, since I feel like it makes more sense and classifying it as a mod might make the article look awkward. Feel free to change it, though. [[User:Quinton|Quinton]] ([[User talk:Quinton|talk]]) 08:44, 16 November 2021 (GMT)

== Mirror Keen in Second Dome of Darkness ==

Hello. In the Second Dome of Darkness you can see a mirror Keen with the SGA sign "ICU". Is it really fake? [[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 13:45, 16 January 2022 (GMT)

: I think so. If you look at the [[Second Dome of Darkness|level map]] there's nothing there - you can open the game in a level editor to confirm it for yourself. You can also extract the Keen 6 sprites and look through them to see if you can find any of the sprites you can see in the video. You can use the F10+T cheat in the game to view all the sprites loaded for the level and look for a mirror Keen sprite there. If it was real, I'm sure there would be more than a single video of it. I suppose the question now is, will someone make a Keen 6 mod to turn it into reality :) It looks like the video was of a Keen mod. I suppose if there is a background tile that animates quickly with enough frames it would be easy enough to do. You are a very experienced modder, I'm sure you would be able to work out how it was done and solve the mystery! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 14:33, 16 January 2022 (GMT)

:: Well, I'm planning Keen 6 v2.0, which will be a Keen 6 mod based on v1.5, so I'll try everything. :) [[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 16:06, 16 January 2022 (GMT)

== Patch wiki issues ==

So I've just come back and noticed the patch wiki is broken. All the patches are an ugly red color, the [] and {} highlights are broken, the titles of patches that used to be present have been totally erased, the whole thing's a mess. What happened? What's this weird 'syntaxhighlight lang="asm"' stuff? If this is permanent it'll require a massive overhaul of all patch pages to remove the brackets and the descriptions that used the fact that brqackets highlighted stuff different colors. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 23:31, 30 January 2023 (GMT)

: I've had a look at a few pages (e.g. [[Patch:A 2 Enter]] and [[Patch:Deadly tiles]]) and they seem to be displaying fine. Which pages are you seeing that are broken? The version of MediaWiki that powers the KeenWiki had to be upgraded a year or so ago to get the latest security patches, and the new version wasn't compatible with the old syntax highlighting feature we were using for the patches. Instead there was a "syntaxhighlight" extension (used for highlighting code) and after investigating a few options, the assembly language (asm) option gave the least-worst highlighting for CKPatch code, so we went with that. We did a bulk replace across all wiki pages so all patches should be wrapped in asm syntaxhighlight tags now instead, and the old patch titles should now have been moved to headings shown above the patch instead. Unfortunately there wasn't a lot we could do but I'm open to suggestions if you have any better ideas! -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 00:32, 31 January 2023 (GMT)
:: Are you not seeing lines like '%patch $825D {$BCEBW}' with the curly brackets? Those can't be copied into a patch file and were previously used for highlighting. If there's no way to revert they should be cut out of all the patches, along with the square brackets. A lot of text mentions the old highlight colors, which are now complete nonsense. If you're NOT seeing those brackets I can get a screenshot, as this might be a browser issue. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 10:59, 3 February 2023 (GMT)

::: Ohh sorry you're right, I misunderstood and thought you meant you were seeing "syntaxhighlight asm" instead of the actual patch. I do see the curly braces and never noticed they weren't supposed to be there. Hmm. Not so keen on removing them especially if the text references them, but I'm not sure how easy it will be to correct. I guess the [https://github.com/Malvineous/ckpatch-highlight old CKPatch extension] will need to be updated to work with the latest Mediawiki release. Don't suppose anyone has any PHP skills and would be willing to update it? If it can be updated then we can go back to using it again like before. -- [[User:Malvineous|Malvineous]] ([[User talk:Malvineous|talk]]) 13:20, 3 February 2023 (GMT)
:::: Yeah and square brackets too. Boy I wish I had PHP skills. It sounds like some effort will be needed either to clean up the changed highlights or get the old system working to be compatible. Quite a pity. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 21:51, 7 February 2023 (GMT)

User talk:Malvineous

2023-02-03T10:59:41Z

Levellass: Patch wiki stuff

Patch:Music

2023-01-30T23:31:54Z

Levellass: Add menu music patches. The patch wiki is broken!

This page covers music related patches. As such, it relates mostly to Keen Galaxy. At present, about the only patches available are those that will change what song plays in a level.

There is a patch and program created by [[User:Lemm]] to allow IMF files of up to 32 KB in Keen Vorticons.

== Keen Vorticons music ==

The TSR [[TSMusic]] created by [[User:Lemm]] allows a modder to include as many IMF music files as they wish, one per level. To be used TSMusic requires the Keen engine to coomunicate with it, and thus a patch. The patches for Keen 1–3 (v1.31) are as follows:

=== Keen 1 ===
<syntaxhighlight lang="asm">
#Play music with TSMusic:
%patch $BE97 $65
%patch $BEE2 $65</syntaxhighlight>

=== Keen 2 ===
<syntaxhighlight lang="asm">
#Play music with TSMusic:
%patch $B5AF $65
%patch $B5FA $65</syntaxhighlight>

=== Keen 3 ===
<syntaxhighlight lang="asm">
#Play music with TSMusic:
%patch $C90D $65
%patch $C958 $65</syntaxhighlight>

== Keen Galaxy Level songs ==

These patches change what song is played in a given level. You are limited only to songs in the <tt>AUDIO.CKx</tt> file. For other music, the values used are not the song number, but the ''level'' number that plays the song you want, with some complications. (It is best to experiment with these later values, to see how things work.)

Additional songs can be added to the game by using a chunk designated for sound to hold an extra songs. In the executable, the audio chunk pointers are ordered so that the music chunk pointers are immediately after the sound chunk pointers. Thus, if you shift the boundary between sound and music backwards, you create more space for music chunk pointers at the expense of sound chunk pointers. This also shifts the existing song numbers correspondingly (e.g. if you shift by two chunks, a song that was originally song 3 becomes song 5, since the first music chunk is now two chunks earlier). To use the extra songs patch, lower the existing start index of the song chunks by however many new songs you are adding. Then lower the corresponding start of audio segment pointer by 2x however many songs you imported. For example, in keen 5, if you were to add two songs, %patch $8C61 $00C0W would be lowered to $00BE, and %patch $8BF1 $BF45W would be lowered to $BF41W (along with the two subsequent patches). Finally, you would have to change the total number of songs from 14 to 16.

In Keen 4 it is also possible to play music in the [[Patch:Main menu]] or [[Patch:Computer_Wrist#Play_music_in_help|computer wrist]], see the pages for details.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Where music list is read from:
%patch $8CCD $0396W #$2F206
%patch $8CA4 $14 #Total number of level entries

#Song values:
#0: Shadowlands 1: Eat your Veggies
#2: Too hot 3: Slug village
#4: Kick in the pants 5: Ancients

#This is the music played in each level:
# VALUE LEVEL MUSIC PLAYED LEVEL No
%patch $2F206 [$0000W] #Map (Shadowlands) 0
[$0004W] #Border Village (Kick in the Pants) 1
[$0003W] #Slug Village (Slug Village) 2
[$0003W] #Perilous Pit (Slug Village) 3
[$0002W] #Cave of Descendants (Too Hot) 4
[$0002W] #Chasm of Chills (Too Hot) 5
[$0004W] #Crystalus (Kick in the Pants) 6
[$0003W] #Hillville (Slug Village) 7
[$0001W] #Sand Yego (Eat your Veggies) 8
[$0001W] #Miragia (Eat your Veggies) 9
[$0001W] #Lifewater Oasis (Eat your Veggies) 10
[$0002W] #Pyramid of Moons (Too Hot) 11
[$0002W] #Pyramid of Shadows (Too Hot) 12
[$0002W] #Pyramid of Ancients (Too Hot) 13
[$0002W] #Pyramid of Forbidden (Too Hot) 14
[$0002W] #Isle of Tar (Too Hot) 15
[$0002W] #Isle of Fire (Too Hot) 16
[$0001W] #Well of Wishes (Eat your Veggies) 17
[$0003W] #Bwb Megarocket (Slug Village) 18
[$FFFFW] #High scores (No music, "Fanfare") 19

#Other music played: (Values here is number of LEVELS whose music is used)
%patch $5836 $000CW #Story demo (Too hot)
%patch $9CD7 $0007W #Ending Sequence (Slug Village)
%patch $F107 $FFFFW #Talking to Lindsey (Ancient)
%patch $F4CA $FFFFW #Talking to Ancient (Ancient)

#Add new music
#Index of first music chunk within audio chunks:
%patch $8CEF $009CW

#Start address of music chunks
#reduce start address by 2x that of "First Audio Entry"
%patch $8C75 $C895W #Clear_music()
%patch $8C83 $C895W #Clear_music()
%patch $8D83 $C895W #StartMusic()
%patch $8C91 $06 #Total Number of Songs</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Where music list is read from:
%patch $8C3F $033AW #$3067A
%patch $8C20 $14 #Total number of level entries

#Song values:
#00 = Came In 01 = Armageddon Machine
#02 = High Scores 03 = Snooping
#04 = Bagpipes 05 = Wednesday on the Beach
#06 = Unknown 07 = Security Center
#08 = Help 09 = Be Sphereful With My Diamonds
#0A = Make it Tighter 0B = Omegamatic
#0C = Fanfare 0D = Quantum Explosion Dynamo

#This is the music played in each level:
# VALUE LEVEL MUSIC PLAYED LEVEL No
%patch $3067A [$000BW] #Map (Omegamatic) 0
[$0005W] #Ion Ventilation System (Wednesday on the Beach) 1
[$0007W] #Security Center (Security Center) 2
[$0009W] #Defense Tunnel Vlook (Be Sphereful) 3
[$000AW] #Energy Flow Systems (Make it Tighter) 4
[$0009W] #Defense Tunnel Burrh (Be Sphereful) 5
[$000AW] #Regulation Control Center (Make it Tighter) 6
[$0009W] #Defense Tunnel Sorra (Be Sphereful) 7
[$000AW] #Neutrino Burst Injector (Make it Tighter) 8
[$0009W] #Defense Tunnel Teln (Be Sphereful) 9
[$000AW] #Brownian Motion Inducer (Make it Tighter) 10
[$0003W] #Gravitational Damping Hub (Snooping) 11
[$000DW] #Quantum Explosion Dynamo (QED) 12
[$0004W] #Korath III Base (Bagpipes) 13
[$000CW] #Ending (Fanfare)
[$0002W] #High Scores (High Scores) 15
%patch $3069C [$0001W] #Scrolling Story (Armageddon Machine)
[$0000W] #Game Over (Came In)
[$0008W] #Help (Help)

#Other music played: (Values here is number of LEVELS whose music is used)
%patch $5830 $0011W #Star Wars story
%patch $EABD $0013W #Help
%patch $EC67 $000EW #Ending sequence
%patch $F808 $0012W #Game over

#Add new music
#Index of first music chunk within audio chunks:
%patch $8C61 $00C0W

#Start address of music chunks
#reduce start address by 2x that of "First Audio Entry"
%patch $8BF1 $BF45W #Clear_music()
%patch $8BFF $BF45W #Clear_music()
%patch $8CF5 $BF45W #StartMusic()
%patch $8C0D $0E #Total Number of Songs</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Where music list is read from:
%patch $8AA7 $030EW #$3103E
%patch $8A88 $14 #Total number of level entries

#Song values:
#00 = A World of Wonderment 01 = Brer Tar
#02 = To the Future 03 = Faster
#04 = Space Funk 05 = Aliens Ate My Babysitter
#06 = Ominous 07 = Metal
#08 = Mamba Snake

#This is the music played in each level:
# VALUE LEVEL MUSIC PLAYED LEVEL No
%patch $3103E [$0005W] #Map (Aliens Ate My Babysitter) 0
[$0003W] #Bloogwaters Crossing (Faster) 1
[$0001W] #Guard Post One (Brer Tar) 2
[$0008W] #First Dome of Darkness (Mamba Snake) 3
[$0008W] #Second Dome of Darkness (Mamba Snake) 4
[$0008W] #Bloogdome (Mamba Snake) 5
[$0007W] #Bloogton Manufacturing (Metal) 6
[$0002W] #Bloogton Tower (To the Future) 7
[$0007W] #Bloogfoods, Inc. (Metal) 8
[$0001W] #Guard Post 2 (Brer Tar) 9
[$0003W] #Bloogville (Faster) 10
[$0002W] #BASA (To the Future) 11
[$0001W] #Guard Post 3 (Brer Tar) 12
[$0004W] #Bloogbase Recreational District(Space Funk) 13
[$0004W] #Bloogbase Management District (Space Funk) 14
[$0006W] #Bloog Control Center (Ominous) 15
[$0002W] #Blooglab Space Station (To the Future) 16
[$0000W] #Bean-with-Bacon Megarocket (A World of Wonderment) 17
[$0000W] #High Scores (A World of Wonderment) 18

#Other music played: (Values here is number of LEVELS whose music is used)
%patch $563F $000DW #Star wars text (Space funk)
%patch $E33C $0001W #Molly ending (Faster)

#Index of first music chunk within audio chunks:
%patch $8AC9 $00B4W

#Add new music
#Start address of music chunks
#reduce start address by 2x that of "First Audio Entry"
%patch $8A59 $CA53W #Clear_music()
%patch $8A67 $CA53W #Clear_music()
%patch $8B5D $CA53W #StartMusic()
%patch $8A75 $09 #Total number of songs</syntaxhighlight>

== Music and extra levels ==

[[Patch:Levels#Extra_levels|It is possible to have extra levels in Keen Vorticons and Galaxy.]] For Vorticons there is no issue, the TSR program will provide music for any level. With Keen Galaxy the music list must be extended, this is done by simply adding new entries to the end of it. (This will overwrite some of the [[Patch:F10 M Cheat]] text.) The extra level patch also has an entry for the number of level song entries in the list. This should match the number of levels.

== Create a secondary song list ==

This patch creates a secondary music subroutine that uses an alternate song list. What this means is that when called it will play a song from this list instead of the main level list. This is useful if music\level space is tight, or the modder wishes to play a song that does not appear in any possible level. It relies on using the [[Patch:EGAGRAPH|EGAGRAPH check skip]] and so is incompatible with any other patches that use this.

Following the main part of the patch is a series of optional patches that make various situations in the game use this alternate song list. Any or all of them can be used or removed as desired. Note that the song to be played in these uses is highlighted in blue.

As a note the [[Keen 6]] patch overwrites two 'Not enough memory to load levels' error texts and disables the [[Patch:F10 V Cheat|VBL cheat.]]

=== New song list -Keen 4 ===
<syntaxhighlight lang="asm">
#Disable EGAGRAPH check (Frees 389 bytes at $3CF6)
%patch $3CE5 $90 $90

#New music setting code = $037D0526RL
%patch $3CF6 $55 $8B $EC $83 $EC $02 $56 $57 $8B $76 $06 $83 $FE $14 $72 $11
$83 $FE $FF $74 $0C $B8 $06CCW $50 $9A $037D022FRL $83 $C4
$02 $9A $18740B15RL $83 $FE $FF $75 $05 $BF $05 $00 $EB $08
$8B $DE $D1 $E3 $8B $BF $018EW $E9 $4F9EW

#New music list (Max length 20 entries)
%patch $2EFFE $0000W
$0001W
$0002W
$0003W
$0004W
$0005W
$0006W
$0007W
$0008W
$0009W
$000AW
$000BW
$000CW
$000DW
$000EW
$000FW

#OPTIONAL USES OF NEW MUSIC LIST:
#Use new list in story demo
%patch $5835 $B8 [$0001W] $50 $9A $037D0526RL

#Use new list in ending sequence
%patch $9CD6 $B8 [$0001W] $50 $9A $037D0526RL

#Use new list talking to Lindsey
%patch $F106 $B8 [$0001W] $50 $9A $037D0526RL

#Use new list when talking to Oracle Member
%patch $F4C9 $B8 [$0001W] $50 $9A $037D0526RL

#Play music in the main menu
#SIDE EFFECT: Keen menu background color black, not cyan
%patch $1CC6A $B8 [$0015W] $50 $9A $06BD20C7RL

#Play music whenever help loaded (Overwrite cache graphic sub, thus can cause graphic glitch)
%patch $9924 $B8 [$0001W] $50 $9A $037D0526RL $83 $C4 $02</syntaxhighlight>

=== New song list -Keen 5 ===
<syntaxhighlight lang="asm">
#Disable EGAGRAPH check (Frees 389 bytes at $3CF0)
%patch $3CDF $90 $90

#New music setting code = $037D0520RL
%patch $3CF0 $55 $8B $EC $83 $EC $02 $56 $57 $8B $76 $06 $83 $FE $14 $72 $11
$83 $FE $FF $74 $0C $B8 $063EW $50 $9A $037D022FRL $83 $C4
$02 $9A $196E0B13RL $8B $DE $D1 $E3 $8B $BF $0147W $E9 $4F20W

#New music list (Max length 20 entries)
%patch $30487 $0000W
$0001W
$0002W
$0003W
$0004W
$0005W
$0006W
$0007W
$0008W
$0009W
$000AW
$000BW
$000CW
$000DW
$000EW
$000FW

#OPTIONAL USES OF NEW MUSIC LIST:
#Use new list in GAME OVER music
%patch $F807 $B8 [$0001W] $50 $9A $037D0520RL

#Use new list in music in help menu
%patch $EABC $B8 [$0001W] $50 $9A $037D0520RL

#Use new list in story demo
%patch $5830 $B8 [$0001W] $50 $9A $037D0520RL

#Use new list in ending sequence
%patch $EC66 $B8 [$0001W] $50 $9A $037D0520RL</syntaxhighlight>

=== New song list -Keen 6 ===
<syntaxhighlight lang="asm">
#Disable Add VBLs (Free $74B0-$7535)
%patch $74AD $E9 $0086W

#New music setting code = $069A0B10RL
%patch $74B0 $55 $8B $EC $83 $EC $02 $56 $57 $8B $76 $06 $83 $FE $14 $72 $11
$83 $FE $FF $74 $0C $B8 $0636W $50 $9A $037B0230RL $83 $C4
$02 $9A $183B0B15RL $8B $DE $D1 $E3 $8B $BF $027BW $E9 $15C8W

#New music list (Max length 24 entries)
%patch $30FAB $0000W
$0001W
$0002W
$0003W
$0004W
$0005W
$0006W
$0007W
$0008W
$0009W
$000AW
$000BW
$000CW
$000DW
$000EW
$000FW

#Use new list in story demo
%patch $563E $B8 [$0001W] $50 $9A $069A0B10RL

#Use new list in ending sequence
%patch $E33B $B8 [$0001W] $50 $9A $069A0B10RL</syntaxhighlight>

== Insufficient Memory to play music error ==

This error occurs when after all the level and graphics have been loaded, there does not remain enough free memory to load the IMF music file selected for that level. The solution is to either use a smaller music file for the level or free up memory.

This error is both easy to diagnose and remedy. The first step is to load the level with the error. Using the [[Patch:F10 M Cheat|memory test cheat]] (F10 + M) the amount of free memory ''without the music'' can be found. This can then be compared with the size of the IMF file needing to be played to give a good estimate of how much extra memory needs to be freed up. If a smaller music file is not desirable or cannot be found then more memory will have to be freed up. This can be constantly checked with the memory cheat.

There are three main ways to free up memory. The first is to physically shrink the level's size; each tile removed will free up six bytes of memory, so trimming a large level can save a lot. This however is often not preferable.

The second method is to lessen the number of different tiles in the level (This is why [[TED5]] has a function to tell you how many there are.) each background tile will save 128 bytes and each foreground tile 140 bytes of memory. Again this may not be preferable, but a large level often contains many tiles that do not really add anything to it.

Finally certain sprites may be removed. [[Patch:Sprite cache|Each sprite caches all its graphics into memory so it can display them]] A sprite can easily take up tens of kilobytes of space, the larger and showier it is, the more memory it needs. To remove a sprite cache, ''all'' instances of the sprite must be removed from the level, not one can remain.

A related solution is to edit the graphics, either making them smaller, or changing how many copies are placed into memory. (In theory this will make the sprite move less smoothy, but this is often hard to see.) This can halve or even quarter the amount of memory the sprite needs to run.

Other errors can be found at [[Patch:Game errors]].

=== Insufficient memory to play music ===
<syntaxhighlight lang="asm">
#Insufficient memory to play music window -Keen 4:
%patch $8D18 $EB #Never show (Free 8D1A-8D7F)
%patch $8D1B [$0008W] #Height
%patch $8D1F [$0014W] #Width
%patch $8D30 [$06ECW] #Text called from
%patch $2F55C "Insufficient memory" $0A
"for background music!" $00

#Insufficient memory to play music window -Keen 5:
%patch $8C8A $EB #Never show (Free 8C8C-8CEE)
%patch $8C8D [$0008W] #Height
%patch $8C91 [$0014W] #Width
%patch $8CA2 [$065EW] #Text called from
%patch $3099E "Insufficient memory" $0A
"for background music!" $00

#Insufficient memory to play music window -Keen 6:
%patch $8AF2 $EB #Never show (Free 8AF4-8B69)
%patch $8AF5 [$0008W] #Height
%patch $8AF9 [$0014W] #Width
%patch $8B0A [$0656W] #Text called from
%patch $31386 "Insufficient memory" $0A
"for background music!" $00</syntaxhighlight>

== Disable music ==

These patches disable music entirely. Even if the player attempts to enable music this will fail. The first patch simply disables music. (Changing the $0000W to $0001W will force the game to always play music.) The second forces 'PC mode' where there is no music and PC sounds only will play.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Disable music
%patch $18F54 $C7 $06 $C633W $0000W $90 $90

#Force PC-mode
%patch $19022 $EB</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Disable music
%patch $19EF2 $C7 $06 $BC9BW $0000W $90 $90

#Force PC-mode
%patch $19FC0 $EB</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Disable music
%patch $18BC4 $C7 $06 $C7C1W $0000W $90 $90

#Force PC-mode
%patch $18C92 $EB</syntaxhighlight>

== Don't play music in certain situations ==

These patches remove music from playing or changing in given situations. For disabling music in a level the best option is to create an 'empty' song with no sound and use that as the level music. (Though Keen 4 has the option of setting a song to -1 ($FFFFW) for silence.)

=== Keen 4 ===
<syntaxhighlight lang="asm">
#No music during Star Wars story:
%patch $5835 $EB $0A

#No music during ending sequence:
%patch $9CD6 $EB $0A

#No music during Lindsey talk
%patch $F106 $EB $0A

#No music during Oracle Member talk
%patch $F4C9 $EB $0A</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#No GAME OVER music
%patch $F807 $EB $0A

#No music in help menu:
%patch $EABC $EB $0A

#No music during Star Wars story:
%patch $5830 $EB $0A

#No music during ending sequence:
%patch $EC66 $EB $0A</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#No music during Star Wars story:
%patch $563E $EB $0A

#No music during ending sequence:
%patch $E33B $EB $0A</syntaxhighlight>

== Play a certain song while an item is got ==

This patch causes a certain level's song to be played in any normal level while some condition is met. Here the map (level 0's) music is played while Keen has the [[Patch:V Card|V card]]. Loading a saved game or going to the help\menu will result in the 'default' music restarting. By changing the <tt>$0000W</tt> a different level's music can be selected.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Play a certain song while an item is got
%patch $C551 $E9 $FEFDW
%patch $C53B $E9 $FF19W
%patch $C3FC $55 $8B $EC $83 $EC $0C $56 $57 $8B $76 $06 $83 $3E {$6F5AW} [$01]
{$75} $0C $B8 [$0000W] $50 $9A $06B92083RL $83 $C4 $02 $8B $5C $2E $D1 $E3 $8B $87 $87
$BF $D1 $E8 $E0D1W $8B $16 $51 $9E $8B $5C $2C $D1 $E3 $03 $C3
$89 $56 $FC $89 $46 $FA $8B $44 $30 $2B $44 $2C $40 $8B $16 $4C
$9E $2B $D0 $89 $56 $F8 $8B $44 $2E $89 $46 $FE $E9 $00FBW $8B
$7C $2C $E9 $00E2W $C4 $5E $FA $26 $8B $1F $8E $06 $61 $BF $26
$8A $87 $0A $47 $B4 $00 $25 $7F $00 $89 $46 $F6 $0B $C0 $74 $16
$8B $5E $F6 $83 $EB $03 $83 $FB $19 $77 $0B
%patch $8C7D $75 $08 $C7 $06 {$6F5AW} [$0000W] $EB $68 $FF $06 {$6F5AW} $83 $3E
{$6F5AW} [$01] {$76} $06 $C7 $06 {$6F5AW} [$0000W] $EB $18
%patch $8CC3 $5F $5E $8B $E5 $5D $CB</syntaxhighlight>

== Play music in Galaxy menu ==

This allows you to play music in the [[Patch:Main menu (Galaxy)|main menu.]] As a side effect the menu background color is black, not cyan. This only matters if your menu image is smaller than 320x200. The value used here is the level whose music is used. (For example a value of 0 will play the map level's music.) See [[Patch:Music]].

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Play music in the menu
%patch $1CC6F $06BD20C7RL
%patch $1CC6B [$0003W] #Play this level's song</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Play music in the menu
%patch $1DC0C $06B92083RL
%patch $1DC08 [$0003W] #Play this level's song</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Play music in the menu
%patch $1C8DE $069A20DBRL
%patch $1C8DA [$0003W] #Play this level's song</syntaxhighlight>

== Galaxy menu doesn't stop game music ==

This patch lets the game music keep playing when the menu is called. This means the music playing in the level or demo the player plays before calling the menu. When the game initially starts the menu will be silent.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Don't interrupt music when Main menu is called
%patch $7994 $90 $90 $90 $90
%patch $79A2 $EB $0A</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Don't interrupt music when Main menu is called
%patch $794F $90 $90 $90 $90
%patch $795D $EB $0A</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Don't interrupt music when Main menu is called
%patch $7728 $90 $90 $90 $90
%patch $7736 $EB $0A</syntaxhighlight>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}

User talk:Malvineous

2023-01-30T23:31:01Z

Levellass: The patch wiki is broken!

Patch:Main menu (Galaxy)

2023-01-30T23:25:25Z

Levellass: Add Keen 6 music patch, and is the patch wiki broken?

This page covers patches relating to the main menu, the first menu the player is confronted with on starting the game. Related pages are [[Patch:Title screen]]. For patches relating to the main menu in other games see [[Patch:Main menu (Vorticons)]] and [[Patch:Main menu (Dreams)]].

The Galaxy menu is more closely related to Keen Vorticons' menu, but is also like the Dreams menu in that it also uses bitmaps (it even has its own fullscreen graphic). It is also much more complex than the Vorticons menus.

This page is divided into several sections. The first two sections are minor and deal with disabling the entire menu and playing music when the menu is called. They are pretty self-explanatory. The third section deals with menu bitmaps in general and the range the menu can use. More useful is the fourth section which details 'menu segments'; these control how the various menus are laid out, their texts and bitmaps, a very broad and powerful set of tools. The fifth section pertains to menu 'bars', that is horizontal lines that divide up the menus. The sixth section involves 'colors' and deals with the colors of various texts and objects in the menus. The remaining two sections are minor and rather miscellaneous things.

== Disable ==

There are two parts to this patch, the first disables accessing the Main Menu during normal gameplay by pressing the F2-F6 keys or Esc. The second part skips going to the Main Menu when the game is first started, instead launching the [[Patch:Demo mode|demo mode]] game.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Disable Main Menu in-game
%patch $798E $E9 $00AAW

#Skip Main Menu, go straight to new game on startup
%patch $51F8 $EB $05</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Disable Main Menu in-game
%patch $7949 $E9 $00AAW</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Disable Main Menu in-game
%patch $7722 $E9 $00AAW</syntaxhighlight>

=== What blocks ingame menu ===

This patch shows what controls the blocking of the Main Menu ingame. Ordinarily this is [[Patch:Demo mode|'demo mode', a special gameplay mode activated by the <tt>-demo</tt> switch.]] This can be changed however so that the menu is permanently or temporarily disabled.

=== What blocks Main Menu ingame ===
<syntaxhighlight lang="asm">
#What blocks Main Menu ingame -Keen 4
%patch $796E {$7A72W} [$00] {$74}

#What blocks Main Menu ingame -Keen 5
%patch $7929 {$6F72W} [$00] {$74}

#What blocks Main Menu ingame -Keen 6
%patch $7702 {$75AEW} [$00] {$74}</syntaxhighlight>

=== Skip menu on startup ===

This patch changes things so that when the game is started there is no Main Menu, instead the player is sent straight to a new game. The second line controls the [[Patch:Difficulty Level|difficulty]] of that game; by default it is 2, or, normal.

Note that the player can still access the menu and quit the game\start a different difficulty if they wish.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Skip Main Menu, go straight to new game on startup
%patch $51F8 $EB $05

#Difficulty of new game
%patch $5209 [$0002W] </syntaxhighlight>

== Play music in menu ==

This allows you to play music in the main menu. As a side effect the menu background color is black, not cyan. This only matters if your menu image is smaller than 320x200. The value used here is the level whose music is used. (For example a value of 0 will play the map level's music.) See [[Patch:Music]].

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Play music in the menu
%patch $1CC6F $06BD20C7RL
%patch $1CC6B [$0003W] #Play this level's song</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Play music in the menu
%patch $1DC0C $06B92083RL
%patch $1DC08 [$0003W] #Play this level's song</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Play music in the menu
%patch $1C8DE $069A20DBRL
%patch $1C8DA [$0003W] #Play this level's song</syntaxhighlight>

== Menu doesn't stop game music ==

This patch lets the game music keep playing when the menu is called. This means the music playing in the level or demo the player plays before calling the menu. When the game initially starts the menu will be silent.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Don't interrupt music when Main menu is called
%patch $7994 $90 $90 $90 $90
%patch $79A2 $EB $0A</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Don't interrupt music when Main menu is called
%patch $794F $90 $90 $90 $90
%patch $795D $EB $0A</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Don't interrupt music when Main menu is called
%patch $7728 $90 $90 $90 $90
%patch $7736 $EB $0A</syntaxhighlight>

== Menu bitmaps ==

The Main Menu uses a variety of bitmaps. Primary among these is the 'background bitmap' that fills the entire screen and over which other bitmaps are displayed. These 'sub bitmaps' are called by various 'menu actions' (See below.)

As such all these bitmaps must be cached when the menu is first displayed. They are also displayed in the same location onscreen (despite being different sizes.)

=== Bitmap cache ===

The bitmap cache controls all the possible bitmaps the Main Menu can display. Note that while the first value is a word, the second is only a byte. At the same time it also caches the required sprites for the [[Patch:Paddle war|Paddle War]] minigame and the 'DEMO' sign for demo display. The ''sprite images'' used for Paddle War are cached at a different location when the minigame is loaded.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Main menu bitmaps cache
%patch $1CBEF [$0058W] #Start
%patch $1CC04 [$67] #End

#Paddle War sprites\DEMO cache
%patch $1CC08 [$007CW] #Start
%patch $1CC1D [$0080W] #End</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Main menu bitmaps cache
%patch $1DB8D [$0043W] #Start
%patch $1DBA2 [$52] #End

#Paddle War sprites\DEMO cache
%patch $1DBA6 [$0066W] #Start
%patch $1DBBB [$6A] #End</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Main menu bitmaps cache
%patch $1C85F [$000BW] #Start
%patch $1C874 [$1A] #End

#Paddle War sprites\DEMO cache
%patch $1C878 [$002EW] #Start
%patch $1C88D [$32] #End</syntaxhighlight>

==== Unused cache ====

Interestingly Keen Galaxy contains an unused bitmap cache possibly from an older version of the Main Menu.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Main menu bitmaps cache
%patch $306D0 [$0058W] #Start
%patch $3071A [$0067W] #End</syntaxhighlight>

=== Background bitmap ===

This is the 'background' bitmap used for the main menu, in short Keen's computerwrist. If this is not displayed the game will show the menu text and bitmaps over a blank screen. There are two separate uses of the bitmap, one for all menus except Paddle War, and one for Paddle War itself.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Main Menu background bitmap
%patch $1AC07 [$0067W] #Draw current menu
%patch $1C6D2 [$0067W] #Paddle War</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Main Menu background bitmap
%patch $1BBA5 [$0052W] #Draw current menu
%patch $1D670 [$0052W] #Paddle War</syntaxhighlight>

=== Menu name bitmap locations ===

As stated above, all the menu name bitmaps are displayed in the same location, no matter how wide they are. (They are the same height.) The actual bitmap displayed depends on what menu the player is currently in.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Location of menu name bitmaps
%patch $1AB34 [$0030W] #Vertical
%patch $1AB38 [$0050W] #Horizontal</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Location of menu name bitmaps
%patch $1BDA2 [$0030W] #Vertical
%patch $1BDA6 [$0050W] #Horizontal</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Location of menu name bitmaps
%patch $1A7A4 [$0030W] #Vertical
%patch $1A7A8 [$0050W] #Horizontal</syntaxhighlight>

== Menu actions ==

The structure of the Main menu's actions and options is discussed in detail [[Patch:Galaxy menu tutorial|in this tutorial page.]] Menu actions and options control most of the menu text, the number of options in menus and how they are laid out, the bitmaps that appear and more.

=== Debug menu ===

This is a 'hidden' menu not seen during normal gameplay used by the developers when debugging the game. By default it can be ignored. It contains only one option 'DEBUG' and it is not known how functional this is.

This menu uses the 'MAIN MENU' bitmap and its only option is type 1.

=== Keen 4 Debug menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F854 $0000W $0000W $0058W $0000W $0000W $1F83RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1F830 $0001W $0000W $0000W $477CW $0000W $00000000L $0000W $0000W

#Menu texts
%patch $335EC "DEBUG" $00</syntaxhighlight>

=== Keen 5 Debug menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $206E4 $0000W $0000W $0043W $0000W $0000W $206CRW $00000000L $0000W $0000W $0000W

#Menu options
%patch $206C0 $0001W $0000W $0000W $3D98W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $340D8 "DEBUG" $00</syntaxhighlight>

=== Keen 6 Debug menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F6B4 $0000W $0000W $000BW $0000W $0000W $1F69RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1F690 $0001W $0000W $0000W $41F6W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34F26 "DEBUG" $00</syntaxhighlight>

=== Sound effects menu ===

This menu allows the player to control how sounds are played in the game. It has four options, each of type 2. Each item uses its third value for a currently unknown function.

The menu itself uses the 'SOUND EFFECTS MENU' bitmap and positions all its options 8 pixels right of the Computerwrist's left side.

=== Keen 4 Sound menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F8CA $0008W $0000W $005DW $0000W $0000W $1F87RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1F870 $0002W $0000W $0031W $4782W $0000W $00000000L $0000W $0000W
%patch $1F882 $0002W $0000W $0019W $4793W $0000W $00000000L $0000W $0000W
%patch $1F894 $0002W $0000W $001EW $479EW $0000W $00000000L $0000W $0000W
%patch $1F8A6 $0002W $0000W $0010W $47B1W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $335F2 "NO SOUND EFFECTS" $00
%patch $33603 "PC SPEAKER" $00
%patch $3360E "ADLIB/SOUNDBLASTER" $00
%patch $33621 "QUIET ADLIB/SOUNDBLASTER" $00</syntaxhighlight>

=== Keen 5 Sound menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $2075A $0008W $0000W $0048W $0000W $0000W $2070RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $20700 $0002W $0000W $0031W $3D9EW $0000W $00000000L $0000W $0000W
%patch $20712 $0002W $0000W $0019W $3DAFW $0000W $00000000L $0000W $0000W
%patch $20724 $0002W $0000W $001EW $3DBAW $0000W $00000000L $0000W $0000W
%patch $20736 $0002W $0000W $0010W $3DCDW $0000W $00000000L $0000W $0000W

#Menu texts
%patch $340DE "NO SOUND EFFECTS" $00
%patch $340EF "PC SPEAKER" $00
%patch $340FA "ADLIB/SOUNDBLASTER" $00
%patch $3410D "QUIET ADLIB/SOUNDBLASTER" $00</syntaxhighlight>

=== Keen 6 Sound menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F72A $0008W $0000W $0010W $0000W $0000W $1F6DRW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1F6D0 $0002W $0000W $0031W $41FCW $0000W $00000000L $0000W $0000W
%patch $1F6E2 $0002W $0000W $0019W $420DW $0000W $00000000L $0000W $0000W
%patch $1F6F4 $0002W $0000W $001EW $4218W $0000W $00000000L $0000W $0000W
%patch $1F706 $0002W $0000W $0010W $422BW $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34F2C "NO SOUND EFFECTS" $00
%patch $34F3D "PC SPEAKER" $00
%patch $34F48 "ADLIB/SOUNDBLASTER" $00
%patch $34F5B "QUIET ADLIB/SOUNDBLASTER" $00</syntaxhighlight>

=== Music menu ===

This menu allows the player to control how music is played in the game. It has two options, each of type 2. Each option's third value, $1E and $31 are the [[Patch:Scancodes|scancodes]] for each option's shortcut key, 'A' and 'N' respectively.

The menu itself uses the 'MUSIC MENU' bitmap and positions all its options 8 pixels right of the Computerwrist's left side.

=== Keen 4 Music menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F916 $0008W $0000W $005EW $0000W $0000W $1F8ERW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1F8E0 $0002W $0000W $0031W $47CAW $0000W $00000000L $0000W $0000W
%patch $1F8F2 $0002W $0000W $001EW $47D3W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $3363A "NO MUSIC" $00
%patch $33643 "ADLIB/SOUNDBLASTER" $00</syntaxhighlight>

=== Keen 5 Music menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $207A6 $0008W $0000W $0049W $0000W $0000W $2077RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $20770 $0002W $0000W $0031W $3DE6W $0000W $00000000L $0000W $0000W
%patch $20782 $0002W $0000W $001EW $3DBAW $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34126 "NO MUSIC" $00
%patch $340FA "ADLIB/SOUNDBLASTER" $00</syntaxhighlight>

=== Keen 6 Music menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F776 $0008W $0000W $0011W $0000W $0000W $1F74RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1F740 $0002W $0000W $0031W $4244W $0000W $00000000L $0000W $0000W
%patch $1F752 $0002W $0000W $001EW $424DW $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34F74 "NO MUSIC" $00
%patch $34F7D "ADLIB/SOUNDBLASTER" $00</syntaxhighlight>

=== New game menu ===

This menu allows the player to select the difficulty of a new game from either Easy, Medium or Hard. It has three options, each of type 1. Each item uses its third value for a currently unknown function. The fifth value controls what kind of game is started; 5 starts an easy game, 6 normal and 7 hard.

The menu itself uses the 'NEW GAME MENU' bitmap and positions all its options 8 pixels right of the Computerwrist's left side. Its eighth value is 1 for unknown reasons. It is possible to [[Patch:Difficulty Level#Add_an_extra_difficulty_level_to_game|add a fourth difficulty option]] to this menu by using the (unused) debug menu.

=== Keen 4 New game menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F978 $0008W $0000W $0059W $0000W $0000W $1F93RW $00000000L $0001W $0000W $0000W

#Menu options
%patch $1F930 $0001W $0000W $0012W $47E6W $0005W $00000000L $0000W $0000W
%patch $1F942 $0001W $0000W $0031W $47F6W $0006W $00000000L $0000W $0000W
%patch $1F954 $0001W $0000W $0023W $4808W $0007W $00000000L $0000W $0000W

#Menu texts
%patch $33656 "BEGIN EASY GAME" $00
%patch $33666 "BEGIN NORMAL GAME" $00
%patch $33678 "BEGIN HARD GAME" $00</syntaxhighlight>

=== Keen 5 New game menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $20808 $0008W $0000W $0044W $0000W $0000W $207CRW $00000000L $0001W $0000W $0000W

#Menu options
%patch $207C0 $0001W $0000W $0012W $3DEFW $0005W $00000000L $0000W $0000W
%patch $207D2 $0001W $0000W $0031W $3DFFW $0006W $00000000L $0000W $0000W
%patch $207E4 $0001W $0000W $0023W $3E11W $0007W $00000000L $0000W $0000W

#Menu texts
%patch $3412F "BEGIN EASY GAME" $00
%patch $3413F "BEGIN NORMAL GAME" $00
%patch $34151 "BEGIN HARD GAME" $00</syntaxhighlight>

=== Keen 6 New game menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F7D8 $0008W $0000W $000CW $0000W $0000W $1F79RW $00000000L $0001W $0000W $0000W

#Menu options
%patch $1F790 $0001W $0000W $0012W $4260W $0005W $00000000L $0000W $0000W
%patch $1F7A2 $0001W $0000W $0031W $4270W $0006W $00000000L $0000W $0000W
%patch $1F7B4 $0001W $0000W $0023W $4282W $0007W $00000000L $0000W $0000W

#Menu texts
%patch $34F90 "BEGIN EASY GAME" $00
%patch $34FA0 "BEGIN NORMAL GAME" $00
%patch $34FB2 "BEGIN HARD GAME" $00</syntaxhighlight>

=== Load\save menu ===

This is one of the more complex menus. It has two menu setups as well as multiple 'blank' options filled in by saved game data. The first menu is the load menu used when loading games while the second is the 'save' menu used when saving games. Both menus offset their texts 4 pixels horizontally and 3 pixels vertically and use the same options. Each menu has its own unique code to run when in use.

Each option is type 1 and its third value controls what game is loaded. (2 loads game 1 and so on.) Each option has no text associated with it, this is supplied by the saved game entry for that option.

=== Keen 4 Load menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1FA0E $0004W $0003W $005AW $0000W $0000W $1F99RW $1A891581RL $0000W $0000W $0000W #Load
%patch $1FA24 $0004W $0003W $005BW $0000W $0000W $1F99RW $1A8918A6RL $0000W $0000W $0000W #Save

#Menu options
%patch $1F990 $0001W $0000W $0002W $0000W $0000W $00000000L $0000W $0000W
%patch $1F9A2 $0001W $0000W $0003W $0000W $0000W $00000000L $0000W $0000W
%patch $1F9B4 $0001W $0000W $0004W $0000W $0000W $00000000L $0000W $0000W
%patch $1F9C6 $0001W $0000W $0005W $0000W $0000W $00000000L $0000W $0000W
%patch $1F9D8 $0001W $0000W $0006W $0000W $0000W $00000000L $0000W $0000W
%patch $1F9EA $0001W $0000W $0007W $0000W $0000W $00000000L $0000W $0000W</syntaxhighlight>

=== Keen 5 Load menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $2089E $0004W $0003W $0045W $0000W $0000W $2082RW $1B83157FRL $0000W $0000W $0000W #Load
%patch $208B4 $0004W $0003W $0046W $0000W $0000W $2082RW $1B8318A4RL $0000W $0000W $0000W #Save

#Menu options
%patch $20820 $0001W $0000W $0002W $0000W $0000W $00000000L $0000W $0000W
%patch $20832 $0001W $0000W $0003W $0000W $0000W $00000000L $0000W $0000W
%patch $20844 $0001W $0000W $0004W $0000W $0000W $00000000L $0000W $0000W
%patch $20856 $0001W $0000W $0005W $0000W $0000W $00000000L $0000W $0000W
%patch $20868 $0001W $0000W $0006W $0000W $0000W $00000000L $0000W $0000W
%patch $2087A $0001W $0000W $0007W $0000W $0000W $00000000L $0000W $0000W</syntaxhighlight>

=== Keen 6 Load menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1F86E $0004W $0003W $000DW $0000W $0000W $1F7FW $1A501581RL $0000W $0000W $0000W #Load
%patch $1F884 $0004W $0003W $000EW $0000W $0000W $1F7FW $1A5018A6RL $0000W $0000W $0000W #Save

#Menu options
%patch $1F7F0 $0001W $0000W $0002W $0000W $0000W $00000000L $0000W $0000W
%patch $1F802 $0001W $0000W $0003W $0000W $0000W $00000000L $0000W $0000W
%patch $1F814 $0001W $0000W $0004W $0000W $0000W $00000000L $0000W $0000W
%patch $1F826 $0001W $0000W $0005W $0000W $0000W $00000000L $0000W $0000W
%patch $1F838 $0001W $0000W $0006W $0000W $0000W $00000000L $0000W $0000W
%patch $1F84A $0001W $0000W $0007W $0000W $0000W $00000000L $0000W $0000W</syntaxhighlight>

=== [[Patch:Configuration options|Options menu]] ===

This menu allows the player to modify several options in the game such as turning the scorebox off and on. It uses the 'OPTIONS MENU' bitmap and displays text 8 pixels right of the computerwrist's left side. There are also four 'option menus' run by each menu option when it is selected.

There are four menu options none of which has text since the text must change when the option is turned off or on. (The text must be patched another way.) It is not known what the text field does in these options, it appears to simply point to empty text strings to avoid displaying anything. The options are all type 3 and have their own unique codes to run when selected.

The last four menus have no text offsets or bitmaps to display. Their function is to run code when a menu option is changed, changing that option and the text displayed.

=== Keen 4 Options menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1FAFA $0008W $0000W $0063W $0000W $0000W $1FAARW $00000000L $0000W $0000W $0000W #Main
%patch $1FA3A $0000W $0000W $0000W $0000W $0000W $0000W $1A890926RL $0000W $0000W $0000W #Scorebox
%patch $1FA50 $0000W $0000W $0000W $0000W $0000W $0000W $1A8909D1RL $0000W $0000W $0000W #Two-button firing
%patch $1FA66 $0000W $0000W $0000W $0000W $0000W $0000W $1A89095FRL $0000W $0000W $0000W #Jerky motion fix
%patch $1FA7C $0000W $0000W $0000W $0000W $0000W $0000W $1A890998RL $0000W $0000W $0000W #SVGA compatibility

#Menu options
%patch $1FAA0 $0003W $0000W $001FW $4818W $0000W $1F9900AARL $0000W $0000W
%patch $1FAB2 $0003W $0000W $0014W $4819W $0000W $1F9900C0RL $0000W $0000W
%patch $1FAC4 $0003W $0000W $0032W $481AW $0000W $1F9900D6RL $0000W $0000W
%patch $1FAD6 $0003W $0000W $002EW $481BW $0000W $1F9900ECRL $0000W $0000W

#Menu texts called from
%patch $1B106 [$4A04W] #Score on
%patch $1B10B [$4A13W] #Score off
%patch $1B11E [$4A23W] #Two-button on
%patch $1B123 [$4A3AW] #Two-button off
%patch $1B136 [$4A52W] #Fix on
%patch $1B13B [$4A68W] #Fix off
%patch $1B14E [$4A7FW] #SVGA on
%patch $1B153 [$4A97W] #SVGA off

#Menu texts
%patch $33874 "SCORE BOX (ON)" $00
%patch $33883 "SCORE BOX (OFF)" $00
%patch $33893 "TWO-BUTTON FIRING (ON)" $00
%patch $338AA "TWO-BUTTON FIRING (OFF)" $00
%patch $338C2 "FIX JERKY MOTION (ON)" $00
%patch $338D8 "FIX JERKY MOTION (OFF)" $00
%patch $338EF "SVGA COMPATIBILITY (ON)" $00
%patch $33907 "SVGA COMPATIBILITY (OFF)" $00

#Change texts called from
%patch $1B1D7 [$4AE1W] #Score on
%patch $1B1DC [$4AF2W] #Score off
%patch $1B282 [$4B96W] #2-button on
%patch $1B287 [$4BAFW] #2-button off
%patch $1B1CC [$4B04W] #Press any- Scorebox change
%patch $1B205 [$4B45W] #Press any- jerk change
%patch $1B23E [$4B88W] #Press any- SVGA change
%patch $1B277 [$4BC9W] #Press any- 2-Button change

#Change texts
%patch $33951 "Score box now on" $00
%patch $33962 "Score box now off" $00
%patch $33A06 "Two-button firing now on" $00
%patch $33A1F "Two-button firing now off" $00
%patch $33974 "Press any key" $00
%patch $339B5 "Press any key" $00
%patch $339F8 "Press any key" $00
%patch $33A39 "Press any key" $00</syntaxhighlight>

=== Keen 5 Options menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $2098A $0008W $0000W $004EW $0000W $0000W $2093RW $00000000L $0000W $0000W $0000W #Main
%patch $208CA $0000W $0000W $0000W $0000W $0000W $0000W $1B830924RL $0000W $0000W $0000W #Scorebox
%patch $208E0 $0000W $0000W $0000W $0000W $0000W $0000W $1B8309CFRL $0000W $0000W $0000W #Two-button firing
%patch $208F6 $0000W $0000W $0000W $0000W $0000W $0000W $1B83095DRL $0000W $0000W $0000W #Jerky motion fix
%patch $2090C $0000W $0000W $0000W $0000W $0000W $0000W $1B830996RL $0000W $0000W $0000W #SVGA compatibility

#Menu options
%patch $20930 $0003W $0000W $001FW $3D9DW $0000W $208200AARL $0000W $0000W
%patch $20942 $0003W $0000W $0014W $3D9DW $0000W $208200C0RL $0000W $0000W
%patch $20954 $0003W $0000W $0032W $3D9DW $0000W $208200D6RL $0000W $0000W
%patch $20966 $0003W $0000W $002EW $3D9DW $0000W $208200ECRL $0000W $0000W

#Menu texts called from
%patch $1C0A4 [$3FE4W] #Score on
%patch $1C0A9 [$3FF3W] #Score off
%patch $1C0BC [$4003W] #Two button on
%patch $1C0C1 [$4014W] #Two button off
%patch $1C0D4 [$4032W] #Jerk on
%patch $1C0D9 [$4048W] #Jerk off
%patch $1C0EC [$405FW] #SVGA on
%patch $1C0F1 [$4077W] #SVGA off

#Menu texts
%patch $34324 "SCORE BOX (ON)" $00
%patch $34333 "SCORE BOX (OFF)" $00
%patch $34343 "TWO-BUTTON FIRING (ON)" $00
%patch $3435A "TWO-BUTTON FIRING (OFF)" $00
%patch $34372 "FIX JERKY MOTION (ON)" $00
%patch $34388 "FIX JERKY MOTION (OFF)" $00
%patch $3439F "SVGA COMPATIBILITY (ON)" $00
%patch $343B7 "SVGA COMPATIBILITY (OFF)" $00

#Change texts called from
%patch $1C175 [$40C1W] #Score on
%patch $1C17A [$40D2W] #Score off
%patch $1C220 [$415AW] #2-button on
%patch $1C225 [$4173W] #2-button off
%patch $1C16A [$40E4W] #Press any- Scorebox change

#Change texts
%patch $34401 "Score box now on" $00
%patch $34412 "Score box now off" $00
%patch $3449A "Two-button firing now on" $00
%patch $344B3 "Two-button firing now off" $00
%patch $34424 "Press any key" $00</syntaxhighlight>

=== Keen 6 Options menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1F95A $0008W $0000W $0016W $0000W $0000W $1F90RW $00000000L $0000W $0000W $0000W #Main
%patch $1F89A $0000W $0000W $0000W $0000W $0000W $0000W $1A500926RL $0000W $0000W $0000W #Scorebox
%patch $1F8B0 $0000W $0000W $0000W $0000W $0000W $0000W $1A5009D1RL $0000W $0000W $0000W #Two-button firing
%patch $1F8C6 $0000W $0000W $0000W $0000W $0000W $0000W $1A50095FRL $0000W $0000W $0000W #Jerky motion fix
%patch $1F8DC $0000W $0000W $0000W $0000W $0000W $0000W $1A500998RL $0000W $0000W $0000W #SVGA compatibility

#Menu options
%patch $1F900 $0003W $0000W $001FW $4292W $0000W $1F7F00AARL $0000W $0000W
%patch $1F912 $0003W $0000W $0014W $4293W $0000W $1F7F00C0RL $0000W $0000W
%patch $1F924 $0003W $0000W $0032W $4294W $0000W $1F7F00D6RL $0000W $0000W
%patch $1F936 $0003W $0000W $002EW $4295W $0000W $1F7F00ECRL $0000W $0000W

#Menu texts
%patch $351AE "SCORE BOX (ON)" $00
%patch $351BD "SCORE BOX (OFF)" $00
%patch $351CD "TWO-BUTTON FIRING (ON)" $00
%patch $351E4 "TWO-BUTTON FIRING (OFF)" $00
%patch $351FC "FIX JERKY MOTION (ON)" $00
%patch $35212 "FIX JERKY MOTION (OFF)" $00
%patch $35229 "SVGA COMPATIBILITY (ON)" $00
%patch $35241 "SVGA COMPATIBILITY (OFF)" $00

#Change texts called from
%patch $1AE47 [$455BW] #Score on
%patch $1AE4C [$456CW] #Score off
%patch $1AEF2 [$4610W] #2-button on
%patch $1AEF7 [$4629W] #2-button off
%patch $1AE3C [$457EW] #Press any- Scorebox change
%patch $1AE75 [$45BFW] #Press any- jerk change
%patch $1AEAE [$4602W] #Press any- SVGA change
%patch $1AEE7 [$4643W] #Press any- 2-Button change

#Change texts
%patch $3528B "Score box now on" $00
%patch $3529C "Score box now off" $00
%patch $35340 "Two-button firing now on" $00
%patch $35359 "Two-button firing now off" $00
%patch $352AE "Press any key" $00
%patch $352EF "Press any key" $00
%patch $35332 "Press any key" $00
%patch $35373 "Press any key" $00</syntaxhighlight>

=== Movement setup menu ===

This menu allows the player to change which keyboard keys move Keen in various directions. It has eight options all of type 1, one for each movement direction. Each option has its own text. The menu itself uses the 'MOVEMENT SETUP' bitmap.

=== Keen 4 Movement setup menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FBB2 $0000W $0000W $0060W $0000W $0000W $1FB1RW $1A890C0ERL $0000W $0000W $0000W

#Menu options
%patch $1FB10 $0001W $0000W $0000W $481CW $0000W $00000000L $0000W $0000W
%patch $1FB22 $0001W $0000W $0000W $4826W $0000W $00000000L $0000W $0000W
%patch $1FB34 $0001W $0000W $0000W $4829W $0000W $00000000L $0000W $0000W
%patch $1FB46 $0001W $0000W $0000W $4834W $0000W $00000000L $0000W $0000W
%patch $1FB58 $0001W $0000W $0000W $483AW $0000W $00000000L $0000W $0000W
%patch $1FB6A $0001W $0000W $0000W $4847W $0000W $00000000L $0000W $0000W
%patch $1FB7C $0001W $0000W $0000W $484CW $0000W $00000000L $0000W $0000W
%patch $1FB8E $0001W $0000W $0000W $4858W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $3368C "UP & LEFT" $00
%patch $33696 "UP" $00
%patch $33699 "UP & RIGHT" $00
%patch $336A4 "RIGHT" $00
%patch $336AA "DOWN & RIGHT" $00
%patch $336B7 "DOWN" $00
%patch $336BC "DOWN & LEFT" $00
%patch $336C8 "LEFT" $00</syntaxhighlight>

=== Keen 5 Movement setup menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $20A42 $0000W $0000W $004BW $0000W $0000W $209ARW $1B830C0CRL $0000W $0000W $0000W

#Menu options
%patch $209A0 $0001W $0000W $0000W $3E21W $0000W $00000000L $0000W $0000W
%patch $209B2 $0001W $0000W $0000W $3E2BW $0000W $00000000L $0000W $0000W
%patch $209C4 $0001W $0000W $0000W $3E2EW $0000W $00000000L $0000W $0000W
%patch $209D6 $0001W $0000W $0000W $3E33W $0000W $00000000L $0000W $0000W
%patch $209E8 $0001W $0000W $0000W $3E39W $0000W $00000000L $0000W $0000W
%patch $209FA $0001W $0000W $0000W $3E46W $0000W $00000000L $0000W $0000W
%patch $20A0C $0001W $0000W $0000W $3E4BW $0000W $00000000L $0000W $0000W
%patch $20A1E $0001W $0000W $0000W $3E26W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34161 "UP & LEFT" $00
%patch $3416B "UP" $00
%patch $3416E "UP & RIGHT" $00
%patch $34173 "RIGHT" $00
%patch $34179 "DOWN & RIGHT" $00
%patch $34186 "DOWN" $00
%patch $3418B "DOWN & LEFT" $00
%patch $34166 "LEFT" $00</syntaxhighlight>

=== Keen 6 Movement setup menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FA12 $0000W $0000W $0013W $0000W $0000W $1F97RW $1A500C0ERL $0000W $0000W $0000W

#Menu options
%patch $1F970 $0001W $0000W $0000W $4296W $0000W $00000000L $0000W $0000W
%patch $1F982 $0001W $0000W $0000W $42A0W $0000W $00000000L $0000W $0000W
%patch $1F994 $0001W $0000W $0000W $42A3W $0000W $00000000L $0000W $0000W
%patch $1F9A6 $0001W $0000W $0000W $42AEW $0000W $00000000L $0000W $0000W
%patch $1F9B8 $0001W $0000W $0000W $42B4W $0000W $00000000L $0000W $0000W
%patch $1F9CA $0001W $0000W $0000W $42C1W $0000W $00000000L $0000W $0000W
%patch $1F9DC $0001W $0000W $0000W $42C6W $0000W $00000000L $0000W $0000W
%patch $1F9EE $0001W $0000W $0000W $42D2W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34FC6 "UP & LEFT" $00
%patch $34FD0 "UP" $00
%patch $34FD3 "UP & RIGHT" $00
%patch $34FDE "RIGHT" $00
%patch $34FE4 "DOWN & RIGHT" $00
%patch $34FF1 "DOWN" $00
%patch $34FF6 "DOWN & LEFT" $00
%patch $35002 "LEFT" $00</syntaxhighlight>

=== Button setup menu ===

This menu allows the player to change which keyboard keys make Keen jump, pogo and shoot. It has three options all of type 1, one for each action. Each option has its own text. The menu itself uses the 'BUTTON SETUP' bitmap and uses the same code as the movement setup menu.

=== Keen 4 Button setup menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FC18 $0000W $0000W $0061W $0000W $0000W $1FBDRW $1A890C0ERL $0000W $0000W $0000W

#Menu options
%patch $1FBD0 $0001W $0000W $0024W $485DW $0000W $00000000L $0000W $0000W
%patch $1FBE2 $0001W $0000W $0019W $4862W $0000W $00000000L $0000W $0000W
%patch $1FBF4 $0001W $0000W $0021W $4867W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $336CD "JUMP" $00
%patch $336D2 "POGO" $00
%patch $336D7 "FIRE" $00</syntaxhighlight>

=== Keen 5 Button setup menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $20AA8 $0000W $0000W $004CW $0000W $0000W $20A6RW $1B830C0CRL $0000W $0000W $0000W

#Menu options
%patch $20A60 $0001W $0000W $0024W $3E57W $0000W $00000000L $0000W $0000W
%patch $20A72 $0001W $0000W $0019W $3E5CW $0000W $00000000L $0000W $0000W
%patch $20A84 $0001W $0000W $0021W $3E61W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $34197 "JUMP" $00
%patch $3419C "POGO" $00
%patch $341A1 "FIRE" $00</syntaxhighlight>

=== Keen 6 Button setup menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FA78 $0000W $0000W $0014W $0000W $0000W $1FA3RW $1A500C0ERL $0000W $0000W $0000W

#Menu options
%patch $1FA30 $0001W $0000W $0024W $42D7W $0000W $00000000L $0000W $0000W
%patch $1FA42 $0001W $0000W $0019W $42DCW $0000W $00000000L $0000W $0000W
%patch $1FA54 $0001W $0000W $0021W $42E1W $0000W $00000000L $0000W $0000W

#Menu texts
%patch $35007 "JUMP" $00
%patch $3500C "POGO" $00
%patch $35011 "FIRE" $00</syntaxhighlight>

=== Keyboard\Joystick\Gravis menus ===

This menu consists of two different parts. The first menu lets the player pick between the movement and button setup menus. It has two type 3options each with their own text and code to run when selected. The menu itself uses the 'KEYBOARD MENU' bitmap.

The second, third and fourth menus switch control to Joystick 1, Joystick 2 and the Gravis Gamepad respectively. They do not change the screen or menu and instead are called by the Configure menu, run some code then return control to the Configure menu. As such they are not quite separate menus. It can be seen that they have no options but do have their own bitmap to display.

The two options themselves call two menus the movement and button configuration menus.

=== Keen 4 Keyboard\Joystick\Gravis menus ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1FC66 $0008W $0000W $005FW $0000W $0000W $1FC3RW $1A890BF1RL $0000W $0000W $0000W #Keyboard
%patch $1FC7C $0000W $0000W $0062W $0000W $0000W $0000W $1A891075RL $0000W $0000W $0000W #Joystick 1
%patch $1FC92 $0000W $0000W $0062W $0000W $0000W $0000W $1A8910B1RL $0000W $0000W $0000W #Joystick 2
%patch $1FCA8 $0000W $0000W $0062W $0000W $0000W $0000W $1A8912C8RL $0000W $0000W $0000W #Gravis Gamepad

#Menu options
%patch $1FC30 $0003W $0000W $0032W $486CW $0000W $1FB100A2RL $0000W $0000W #Movement (Calls movement menu)
%patch $1FC42 $0003W $0000W $0030W $4875W $0000W $1FBD0048RL $0000W $0000W #Buttons (Calls button menu)

#Menu texts
%patch $336DC "MOVEMENT" $00
%patch $336E5 "BUTTONS" $00</syntaxhighlight>

=== Keen 5 Keyboard\Joystick\Gravis menus ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $20AF6 $0008W $0000W $004AW $0000W $0000W $20ACRW $1B830BEFRL $0000W $0000W $0000W #Keyboard
%patch $20B0C $0000W $0000W $004DW $0000W $0000W $0000W $1B831073RL $0000W $0000W $0000W #Joystick 1
%patch $20B22 $0000W $0000W $004DW $0000W $0000W $0000W $1B8310AFRL $0000W $0000W $0000W #Joystick 2
%patch $20B38 $0000W $0000W $004DW $0000W $0000W $0000W $1B8312C6RL $0000W $0000W $0000W #Gravis Gamepad

#Menu options
%patch $20AC0 $0003W $0000W $0032W $3E66W $0000W $209A00A2RL $0000W $0000W #Movement (Calls movement menu)
%patch $20AD2 $0003W $0000W $0030W $3E6FW $0000W $20A60048RL $0000W $0000W #Buttons (Calls button menu)

#Menu texts
%patch $341A6 "MOVEMENT" $00
%patch $341AF "BUTTONS" $00</syntaxhighlight>

=== Keen 6 Keyboard\Joystick\Gravis menus ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1FAC6 $0008W $0000W $0012W $0000W $0000W $1FA9RW $1A500BF1RL $0000W $0000W $0000W #Keyboard
%patch $1FADC $0000W $0000W $0015W $0000W $0000W $0000W $1A501075RL $0000W $0000W $0000W #Joystick 1
%patch $1FAF2 $0000W $0000W $0015W $0000W $0000W $0000W $1A5010B1RL $0000W $0000W $0000W #Joystick 2
%patch $1FB08 $0000W $0000W $0015W $0000W $0000W $0000W $1A5012C8RL $0000W $0000W $0000W #Gravis Gamepad

#Menu options
%patch $1FA90 $0003W $0000W $0032W $42E6W $0000W $1F9700A2RL $0000W $0000W #Movement (Calls movement menu)
%patch $1FAA2 $0003W $0000W $0030W $42EFW $0000W $1FA30048RL $0000W $0000W #Buttons (Calls button menu)

#Menu texts
%patch $35016 "MOVEMENT" $00
%patch $3501F "BUTTONS" $00</syntaxhighlight>

=== [[Patch:Configuration options|Configure menu]] ===

This menu lets the player pick between the configuration menus. It is as such the most central menu. It has seven type 3 options, each with its own text. (Except that last which points to blank text.) The menu itself uses the 'CONFIGURATION MENU' bitmap.

Each option calls its own code, usually another menu. The last three options call a menu that doesn't change the screen and keeps the player in the options menu.

Notice the last option has no text. This is because its text must change depending on whether or not the Gravis Gamepad is active. The fourth option ('keyboard') has a second variable value of 8, which moves the next line down 8 pixels, creating a space between the first four and last three options.

Patches relating to how the menu's code works (What variables it can alter, how it behaves when an option is selected.) are covered under [[Patch:Configuration options]].

=== Keen 4 Configure menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1FD50 $0000W $0000W $005CW $0000W $0000W $1FCCRW $1A890A0ARL $0000W $0000W $0000W

#Menu options
%patch $1FCC0 $0003W $0000W $001FW $487DW $0000W $1F87005ARL $0000W $0000W #Sound (Call Sound menu)
%patch $1FCD2 $0003W $0000W $0032W $4883W $0000W $1F8E0036RL $0000W $0000W #Music (Call music menu)
%patch $1FCE4 $0003W $0000W $0018W $4889W $0000W $1FAA005ARL $0000W $0000W #Options (Call main options menu)
%patch $1FCF6 $0003W $0008W $0025W $4891W $0000W $1FC30036RL $0000W $0000W #Keyboard (Call keyboard menu)
%patch $1FD08 $0003W $0000W $0002W $489EW $0000W $1FC3004CRL $0000W $0000W #Joystick 1 (Call Joy 1 menu)
%patch $1FD1A $0003W $0000W $0003W $48AEW $0000W $1FC30062RL $0000W $0000W #Joystick 2 (Call Joy 2 menu)
%patch $1FD2C $0003W $0000W $0022W $48BEW $0000W $1FC30078RL $0000W $0000W #Gravis (Call Gravis menu)

#Menu texts
%patch $336ED "SOUND" $00
%patch $336F3 "MUSIC" $00
%patch $336F9 "OPTIONS" $00
%patch $33701 "USE KEYBOARD" $00
%patch $3370E "USE JOYSTICK #1" $00
%patch $3371E "USE JOYSTICK #2" $00

#Other texts
%patch $33920 "USE GRAVIS GAMEPAD (ON)" $00
"USE GRAVIS GAMEPAD (OFF)" $00</syntaxhighlight>

=== Keen 5 Configure menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $20BE0 $0000W $0000W $0047W $0000W $0000W $20B5RW $1B830A08RL $0000W $0000W $0000W

#Menu options
%patch $20B50 $0003W $0000W $001FW $3E77W $0000W $2070005ARL $0000W $0000W #Sound (Call Sound menu)
%patch $20B62 $0003W $0000W $0032W $3DE9W $0000W $20770036RL $0000W $0000W #Music (Call music menu)
%patch $20B74 $0003W $0000W $0018W $3E7DW $0000W $2093005ARL $0000W $0000W #Options (Call main options menu)
%patch $20B86 $0003W $0008W $0025W $3E85W $0000W $20AC0036RL $0000W $0000W #Keyboard (Call keyboard menu)
%patch $20B98 $0003W $0000W $0002W $3E92W $0000W $20AC004CRL $0000W $0000W #Joystick 1 (Call Joy 1 menu)
%patch $20BAA $0003W $0000W $0003W $3EA2W $0000W $20AC0062RL $0000W $0000W #Joystick 2 (Call Joy 2 menu)
%patch $20BBC $0003W $0000W $0022W $3D9DW $0000W $20AC0078RL $0000W $0000W #Gravis (Call Gravis menu)

#Menu texts
%patch $341B7 "SOUND" $00
%patch $34129 "MUSIC" $00
%patch $341BD "OPTIONS" $00
%patch $341C5 "USE KEYBOARD" $00
%patch $341D2 "USE JOYSTICK #1" $00
%patch $341E2 "USE JOYSTICK #2" $00

#Other texts called from
%patch $1C142 $4090W #Gravis on
%patch $1C147 $40A8W #Gravis off

#Other texts
%patch $343D0 "USE GRAVIS GAMEPAD (ON)" $00
%patch $343E8 "USE GRAVIS GAMEPAD (OFF)" $00</syntaxhighlight>

=== Keen 6 Configure menu ===
<syntaxhighlight lang="asm">
#Menu setups
%patch $1FBB0 $0000W $0000W $000FW $0000W $0000W $1FB2RW $1A500A0ARL $0000W $0000W $0000W

#Menu options
%patch $1FB20 $0003W $0000W $001FW $42F7W $0000W $1F6D005ARL $0000W $0000W #Sound (Call Sound menu)
%patch $1FB32 $0003W $0000W $0032W $42FDW $0000W $1F740036RL $0000W $0000W #Music (Call music menu)
%patch $1FB44 $0003W $0000W $0018W $4303W $0000W $1F90005ARL $0000W $0000W #Options (Call main options menu)
%patch $1FB56 $0003W $0008W $0025W $430BW $0000W $1FA90036RL $0000W $0000W #Keyboard (Call keyboard menu)
%patch $1FB68 $0003W $0000W $0002W $4318W $0000W $1FA9004CRL $0000W $0000W #Joystick 1 (Call Joy 1 menu)
%patch $1FB7A $0003W $0000W $0003W $4328W $0000W $1FA90062RL $0000W $0000W #Joystick 2 (Call Joy 2 menu)
%patch $1FB8C $0003W $0000W $0022W $4338W $0000W $1FA90078RL $0000W $0000W #Gravis (Call Gravis menu)

#Menu texts
%patch $35027 "SOUND" $00
%patch $3502D "MUSIC" $00
%patch $35033 "OPTIONS" $00
%patch $3503B "USE KEYBOARD" $00
%patch $35048 "USE JOYSTICK #1" $00
%patch $35058 "USE JOYSTICK #2" $00

#Other texts
%patch $3525A "USE GRAVIS GAMEPAD (ON)" $00
"USE GRAVIS GAMEPAD (OFF)" $00</syntaxhighlight>

=== Main menu ===

This menu is the most central menu of the game, the one that first appears when the player leaves the title screen or presses 'Esc' during gameplay. It leads to all other menus.

It has only one menu setup using the 'MAIN MENU' bitmap. Text is 20 pixels right and 4 pixels down from the top left of the Computerwrist screen.

=== Keen 4 Main menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FE22 $0020W $0004W $0058W $0000W $0000W $1FD8RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1FD80 $0003W $0000W $0031W $48BFW $0000W $1F930048RL $0000W $0000W #New game (Call New game menu)
%patch $1FD92 $0003W $0000W $0026W $48C8W $0000W $1F99007ERL $0000W $0000W #Load game (Call load game menu)
%patch $1FDA4 $0003W $0000W $001FW $48D2W $0000W $1F990094RL $0000W $0000W #Save game (Call save game menu)
%patch $1FDB6 $0003W $0000W $002EW $48DCW $0000W $1FCC0090RL $0000W $0000W #Configure (Call configure menu)
%patch $1FDC8 $0001W $0000W $0013W $0000W $0001W $00000000L $0000W $0000W #Return
%patch $1FDDA $0001W $0000W $0012W $48E6W $0002W $00000000L $0000W $0000W #End game
%patch $1FDEC $0003W $0000W $0019W $48EFW $0000W $1FCC00A6RL $0000W $0000W #Paddle war (Call Paddle menu)
%patch $1FDFE $0001W $0000W $0010W $48FAW $0003W $00000000L $0000W $0000W #Quit

#Menu texts
%patch $3372F "NEW GAME" $00
%patch $33738 "LOAD GAME" $00
%patch $33742 "SAVE GAME" $00
%patch $3374C "CONFIGURE" $00
%patch $33CCA "RETURN TO GAME" $00
%patch $33CD9 "RETURN TO DEMO" $00
%patch $33756 "END GAME" $00
%patch $3375F "PADDLE WAR" $00
%patch $3376A "QUIT" $00</syntaxhighlight>

=== Keen 5 Main menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $20CB2 $0020W $0004W $0043W $0000W $0000W $20C1RW $00000000L $0000W $0000W $0000W

#Menu options
%patch $20C10 $0003W $0000W $0031W $3EB2W $0000W $207C0048RL $0000W $0000W #New game (Call New game menu)
%patch $20C22 $0003W $0000W $0026W $3EBBW $0000W $2082007ERL $0000W $0000W #Load game (Call load game menu)
%patch $20C34 $0003W $0000W $001FW $3EC5W $0000W $20820094RL $0000W $0000W #Save game (Call save game menu)
%patch $20C46 $0003W $0000W $002EW $3ECFW $0000W $20B50090RL $0000W $0000W #Configure (Call configure menu)
%patch $20C58 $0001W $0000W $0013W $0000W $0001W $00000000L $0000W $0000W #Return
%patch $20C6A $0001W $0000W $0012W $3ED9W $0002W $00000000L $0000W $0000W #End game
%patch $20C7C $0003W $0000W $0019W $3EE2W $0000W $20B500A6RL $0000W $0000W #Paddle war (Call Paddle menu)
%patch $20C8E $0001W $0000W $0010W $3EEDW $0003W $00000000L $0000W $0000W #Quit

#Menu texts
%patch $341F2 "NEW GAME" $00
%patch $341FB "LOAD GAME" $00
%patch $34205 "SAVE GAME" $00
%patch $3420F "CONFIGURE" $00
%patch $3469A "RETURN TO GAME" $00
%patch $346A9 "RETURN TO DEMO" $00
%patch $34219 "END GAME" $00
%patch $34222 "PADDLE WAR" $00
%patch $3422D "QUIT" $00</syntaxhighlight>

=== Keen 6 Main menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FC82 $0020W $0004W $000BW $0000W $0000W $1FBERW $00000000L $0000W $0000W $0000W

#Menu options
%patch $1FBE0 $0003W $0000W $0031W $4339W $0000W $1F790048RL $0000W $0000W #New game (Call New game menu)
%patch $1FBF2 $0003W $0000W $0026W $4342W $0000W $1F7F007ERL $0000W $0000W #Load game (Call load game menu)
%patch $1FC04 $0003W $0000W $001FW $434CW $0000W $1F7F0094RL $0000W $0000W #Save game (Call save game menu)
%patch $1FC16 $0003W $0000W $002EW $4356W $0000W $1FB20090RL $0000W $0000W #Configure (Call configure menu)
%patch $1FC28 $0001W $0000W $0013W $0000W $0001W $00000000L $0000W $0000W #Return
%patch $1FC3A $0001W $0000W $0012W $4360W $0002W $00000000L $0000W $0000W #End game
%patch $1FC4C $0003W $0000W $0019W $4369W $0000W $1FB200A6RL $0000W $0000W #Paddle war (Call Paddle menu)
%patch $1FC5E $0001W $0000W $0010W $4374W $0003W $00000000L $0000W $0000W #Quit

#Menu texts
%patch $35069 "NEW GAME" $00
%patch $35072 "LOAD GAME" $00
%patch $3507C "SAVE GAME" $00
%patch $35086 "CONFIGURE" $00
%patch $35604 "RETURN TO GAME" $00
%patch $35613 "RETURN TO DEMO" $00
%patch $35090 "END GAME" $00
%patch $35099 "PADDLE WAR" $00
%patch $350A4 "QUIT" $00

#Other texts
%patch $35604 "RETURN TO GAME" $00
"RETURN TO DEMO" $00</syntaxhighlight>

=== Paddle war menu ===

This menu is called by the Main menu when the player selects the 'Paddle war' option. It runs the Paddle war code. It has no options or text or bitmaps to display as that is handled by the Paddle war code.

=== Keen 4 Paddle War menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FD66 $0000W $0000W $0000W $0000W $0000W $0000W $1A891E34RL $0000W $0000W $0000W</syntaxhighlight>

=== Keen 5 Paddle War menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $20BF6 $0000W $0000W $0000W $0000W $0000W $0000W $1B831E32RL $0000W $0000W $0000W</syntaxhighlight>

=== Keen 6 Paddle War menu ===
<syntaxhighlight lang="asm">
#Menu setup
%patch $1FBC6 $0000W $0000W $0000W $0000W $0000W $0000W $1A501E34RL $0000W $0000W $0000W</syntaxhighlight>

=== Menu loading text ===

This text appears when the menu is loading; either after a demo loop entry or when the player loads the menu from a current game. The text is replaced by the menu once it loads.

=== Menu loading text ===
<syntaxhighlight lang="asm">
#Keen 4 :
%patch $1CC37 [$4E78W] #Text called from
%patch $33CE8 "Control Panel" $00

#Keen 5 :
%patch $1DBD4 [$4378W] #Text called from
%patch $346B8 "Control Panel" $00

#Keen 6 :
%patch $1C8A6 [$48F2W] #Text called from
%patch $35622 "Control Panel" $00</syntaxhighlight>

=== Other menu related texts ===

These are strings of text used in the various menus that are not currently patchable using the above listed menu patches. More complete patches can be found on other pages such as [[Patch:Quit Windows]].

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Text
%patch $33792 "ESC TO BACK OUT" $00
%patch $337A2 "REALLY END CURRENT GAME?" $00
"PRESS Y TO END IT" $00
%patch $337CD "REALLY QUIT?" $00
"PRESS Y TO QUIT" $00
%patch $337EA "YOU'RE IN A GAME" $00
"PRESS Y TO LOAD GAME" $00
%patch $33810 "YOU'RE IN A GAME" $00
"PRESS Y FOR NEW GAME" $00

#Options menu
%patch $33951 "Score box now on" $00
"Score box now off" $00
"Press any key" $00
%patch $33CCA "RETURN TO GAME" $00
"RETURN TO DEMO" $00
%patch $33D11 "Quitting..." $00</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Text
%patch $34253 "ESC TO BACK OUT" $00
%patch $34263 "REALLY END CURRENT GAME?" $00
"PRESS Y TO END IT" $00
%patch $3428E "REALLY QUIT?" $00
"PRESS Y TO QUIT" $00
%patch $342AB "YOU'RE IN A GAME" $00
"PRESS Y TO LOAD GAME" $00
%patch $342D1 "PRESS Y FOR NEW GAME" $00
%patch $3469A "RETURN TO GAME" $00
"RETURN TO DEMO" $00
%patch $346E1 "Quitting..." $00

#Options menu text:
%patch $34401 "Score box now on" $00
"Score box now off" $00
"Press any key" $00</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Text
%patch $350CC "ESC TO BACK OUT" $00
%patch $350DC "REALLY END CURRENT GAME?" $00
"PRESS Y TO END IT" $00
%patch $35107 "REALLY QUIT?" $00
"PRESS Y TO QUIT" $00
%patch $35124 "YOU'RE IN A GAME" $00
"PRESS Y TO LOAD GAME" $00
%patch $3514A "YOU'RE IN A GAME" $00
"PRESS Y FOR NEW GAME" $00
%patch $3564B "Quitting..." $00

#Options menu
%patch $3528B "Score box now on" $00
"Score box now off" $00
"Press any key" $00</syntaxhighlight>

== Bars ==

The bars are horizontal lines of color that separate various sections of the menu. The Main menu has two, a top and bottom bar. All bars have four variables of interest. The first is the bar's color, the second how far down the screen it appears and the last two are the left and right ends of the bar. There is also a patch to remove the bars entirely. (Or their vertical position can be set to 0.)

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Top menu bar
%patch $1AB14 [$000AW] #Color
%patch $1AB18 [$0085W] #Vertical position
%patch $1AB1C [$00E7W] #Right end
%patch $1AB20 [$004DW] #Left start

#Don't show top bar
%patch $1AB13 $EB $16

#Bottom menu bar
%patch $1AAC1 [$000AW] #Color
%patch $1AAC5 [$0085W] #Vertical position
%patch $1AAC9 [$00E7W] #Right end
%patch $1AACD [$004DW] #Left start

#Don't show bottom bar
%patch $1AAC0 $8B $E5 $5D $CB</syntaxhighlight>

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Top menu bar
%patch $1BAB2 [$000AW] #Color
%patch $1BAB6 [$0085W] #Vertical position
%patch $1BABA [$00E7W] #Right end
%patch $1BABE [$004DW] #Left start

#Don't show top bar
%patch $1BAB1 $EB $16

#Bottom menu bar
%patch $1BA5F [$000AW] #Color
%patch $1BA63 [$0085W] #Vertical position
%patch $1BA67 [$00E7W] #Right end
%patch $1BA6B [$004DW] #Left start

#Don't show bottom bar
%patch $1BA5E $8B $E5 $5D $CB</syntaxhighlight>

=== Keen 6 ===
<syntaxhighlight lang="asm">
#Top menu bar
%patch $1A784 [$000AW] #Color
%patch $1A788 [$0085W] #Vertical position
%patch $1A78C [$00E7W] #Right end
%patch $1A790 [$004DW] #Left start

#Don't show top bar
%patch $1A783 $EB $16

#Bottom menu bar
%patch $1A731 [$000AW] #Color
%patch $1A735 [$0085W] #Vertical position
%patch $1A739 [$00E7W] #Right end
%patch $1A73D [$004DW] #Left start

#Don't show bottom bar
%patch $1A730 $8B $E5 $5D $CB</syntaxhighlight>

== Colors ==

There are numerous functions that set watch text and background colors, allowing you to have different colors in different parts of the watch. The following patch is appended with numerous notes which are invaluable for understanding what each section of the patch does.

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Main Menu
%patch $1A9C6 $B0 [$08] $50 #Background 1 (Dark grey)
$B0 [$08] $50 #Background 2 (Should match back 1)
$B0 [$9F] $50 #Width of background box
%patch $1AA06 [$02] #Selected text color (Light green)*
%patch $1AA0D [$0A] #Unselected text color (Dark green)*
%patch $1AA33 [$0F] #Unknown text color (Light grey)*
%patch $1AB14 [$0A] #Top line color (Light green)
%patch $1AAC1 [$0A] #Bottom line color (Light green)
%patch $1AA40 [$0A] #Menu bottom text color (Dark green)*
%patch $1AABF [$00] #Unknown menu bottom text color (Black)*

#Menu message box
%patch $1AC75 [$0A] #Top of box (Light green)
%patch $1AC90 [$0A] #Bottom of box (Light green)
%patch $1ACAE [$0A] #Left side of box (Light green)
%patch $1ACC9 [$0A] #Right side of box (Light green)
%patch $1AC5B [$08] #Background color (Dark grey)
%patch $1AE6C [$02] #Top text (Light green)*
%patch $1AEA3 [$0A] #Bar in the middle (Light green)
%patch $1AEC8 [$0A] #Bottom text (Dark green)*

#Configure menu
%patch $1B2F6 [$0A] #Control text

#Change keyboard keys menu
%patch $1B50E $B0 [$08] $50 #Background 1 (Dark grey)
$B0 [$08] $50 #Background 2 (Should match back 1)
$B0 [$9F] $50 #Width of background (Should match main menu width above)
%patch $1B543 [$02] #Selected text (Light green)*
%patch $1B547 [$0A] #Unselected text (Dark green)*
%patch $1B572 [$08] #Normal box color (XOR)
%patch $1B595 [$08] #Normal box background
%patch $1B33B [$02] #Changing key box color 1 (Dark green)
%patch $1B35E [$08] #Changing key box color 2 (Dark grey, XOR)
%patch $1B381 [$08] #Changing key box background

#Change joystick buttons menu
%patch $1B64F [$08] #Background color
%patch $1B670 [$02] #Text color (Light green)*

#Change gamepad button menu
%patch $1B987 [$08] #Background color
%patch $1BB9C [$02] #Text color (Light green)*

#Save\load game menu
%patch $1BC73 [$02] #Selected text and box
%patch $1BC77 [$0A] #Unselected text and box
%patch $1BC7E [$08] #Text color modifier
%patch $1BEA7 [$08] #Box background color
%patch $1BFAF [$02] #Saving game text color
%patch $1BFB1 [$08] #Saving game background color

#Load menu
%patch $1CC69 [$0F] #Unknown text color (Black)
%patch $1CD8E [$0F] #Loading menu text (Black)</syntaxhighlight>

=== NOTES ===

All values in the patches below are the default values. If you get confused it is a simple matter to replace all of one value with another value. (Say $0A with $0B)

The colors of fonts are opposite those of other items. Thus $02 is dark green and $0A is light green for most menu components, but the exact opposite is true for fonts. Items that involve font colors are marked with an * so the patcher can be made aware of this.

==== Things that can't be patched ====

Two sorts of menu items cannot be patched, or rather cannot be changed by patching. these are the 8x8 tiles (Used for the menu cursor for example) and the menu graphics (For example the image that says 'MAIN MENU' in the main menu.) These need to be altered with a graphics program to change their colors.

==== Main Menu and general setup ====

This is the menu the player is first presented with. It's graphic reads 'MAIN MENU' and it lists all the other options and sub-menus the player can access.

It consists of three parts, a top section, (Containing a single divider line and the menu graphic.) the middle section containing various options and a bottom section (Containing a divider and menu controls text.)

The Main Menu setup is used by most of the sub-menus (Such as the configure menu) so patches here have the widest effects.

The first thing that can be changed is the background. When the menu is drawn, first the menu graphic is drawn onscreen, then a box of a certain width and color is drawn over it. THEN the text is drawn over this. Changing the background color will also change the color of the font displayed on it, so be careful.

By default the background is $08 or dark grey so as not to interfere with font color. In the patch above two values for this are given, both must match. It is not wise to change the width of the background box, for if the text is too large for it, much confusion results.

It is also possible to change the color of the menu text. There are three main colors, selected, unselected and the text that appears at the bottom of the menu (Telling you to use the arrows to move and so on.) There are two less well known text colors, one light grey, one black. Finally the top and bottom divider line colors can be changed.

==== Menu Message Box ====

This box appears over the main menu, such as when the player selects the 'Quit' option. It is made of a top, bottom, left and right line with a bar in the middle that separates the top and bottom texts. It also has a background color that works the same way as the main menu. Each of these item's color can be changed. (Notice this box can have different text in it depending on what it's being used for, but the colors will remain the same.)

==== Configure menu ====

This mostly uses the Main Menu's colors except for the text explaining what currently controls Keen (Keyboard or joystick.) this has its own color.

==== Change keys menu ====

This is part of the configure menu and appears when the player wants to change what keys move Keen. It consists of two separate, but similar menus that consist of a list of actions paired with boxes showing what key controls that action.

As a separate menu it has its own background color setup, identical to that of the main menu's. It is also possible to change the selected and unselected text colors as well as the border color and background color of the boxes that show the current control keys.

Things get more complicated when a key is selected. The boxes containing the control key get their color from the selected and unselected text, plus a modifier. By default this modifier has no effect, but if it is patched, odd things can happen, so it is suggested that patchers be very careful when altering it.

==== Joystick\gamepad menu ====

These menus are much simpler than the keyboard menu, having only a background and text color.

==== Save\Load game menu ====

This consists of a series of savegame positions, each a name enclosed in a box. The color of the box is controlled by the same variable that controls that of the text. The 'selected' text color is the color of the selected game and also the color its box 'blinks' The text color modifier affects text color by adding to it. It thus affects both the selected and unselected text colors. By default it is $08. There is no point in patching this. There is also a background color, as well as a text AND background color for when the player is typing a name for their saved game.

==== Loading menu ====

This applies to windows that appear when the menu is being loaded or closed. (Such as the 'Demo' window when a demo is starting or 'Control panel' when the menu appears.) All that can currently be patched is the text color in these windows. They are not really part of the main menu proper.

== Menu mask ==

When certain actions are selected, such as the 'Quit' option, the menu is masked to show its inacessibility. By default this uses a masked bitmap that is a checkerboard pattern of grey pixels, placed over the menu screen to half-erase the text. The bitmap can be changed, moved and even prevented from appearing entirely.

=== Main Menu Mask ===
<syntaxhighlight lang="asm">
#Keen 4 Main menu bitmap mask
%patch $1AC2D [$0079W] #Bitmap
%patch $1AC31 [$0030W] #Horizontal position
%patch $1AC35 [$004AW] #Vertical position

#Don't mask
%patch $1AC2C $EB $12

#Keen 5 Main menu bitmap mask
%patch $1BBCB [$0063W] #Bitmap
%patch $1BBCF [$0030W] #Horizontal position
%patch $1BBD3 [$004AW] #Vertical position

#Don't mask
%patch $1BBCA $EB $12

#Keen 6 Main menu bitmap mask
%patch $1A89D [$002BW] #Bitmap
%patch $1A8A1 [$0030W] #Horizontal position
%patch $1A8A5 [$004AW] #Vertical position

#Don't mask
%patch $1A89C $EB $12</syntaxhighlight>

== Main Menu Demo Loop ==

The main menu [[Patch:Demo|demo loop]] is the sequence of events that plays out whenever the player selects 'Return to demo' from the main menu. The default sequence is 'play demo 1, story screen, demo 2 [[Patch:High Scores|highscore demo]], demo 3, demo 4' (Then the [[Patch:Terminator text|terminator text]] will display, resetting the cycle.

To remove an item from the loop simply replace its '$9A $xxxxxxxxRL' string with '$90 $90 $90 $90 $90' Items can also be rearranged, though this takes a little more nuance. It is also possible to rearrange the order the demos play in by changing the numbers before the demo calls. (See section below on demo numbers\disabling demos.)

=== Demo Loop ===
<syntaxhighlight lang="asm">
#Keen 4
%patch $3C2F $33 $C0 $50 {$9A $03ED1A31RL} $83 $C4 $02 $EB $65 {$9A} #Play demo 1
{$03ED18B8RL} $EB $5E $B8 [$0001W] $50 {$9A $03ED1A31RL} $83 $C4 $02 #Story screen\demo 2
$EB $50 {$9A $03ED1D55RL} $EB $49 $B8 [$0002W] $50 {$9A} #Highscores
{$03ED1A31RL} $83 $C4 $02 $EB $3B $33 $FF $B8 [$0003W] $50 {$9A} #Demo 3
{$03ED1A31RL} $83 $C4 $02 #Demo 4</syntaxhighlight>

=== Demo loop list ===

This is the pointer list to all the items in the above code. By simply swapping various pointers around it is possible to change the order that various actions appear or replace one action with another. A novel option is to replace the terminator text with the [[Patch:Story Screen (Galaxy)|star wars story]]

=== Keen 4 ===
<syntaxhighlight lang="asm">
#Main menu actions list
%patch $3CB9 {$0448W} #3C18: Terminator sequence and title screen
{$045FW} #3C2F: Demo 1
{$046CW} #3C3C: Star wars story
{$0473W} #3C43: Demo 2
{$0481W} #3C51: High score demo
{$0488W} #3C58: Demo 3
{$0496W} #3C66: Demo 4</syntaxhighlight>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Configuration|}}
{{PatchCategories|Misc|}}
{{PatchCategories|Text|}}

Patch talk:Executable Maps

2022-03-25T11:52:47Z

Levellass: /* Crediting of information */

== Crediting of information ==
I want to contribute some information I found about the Keen 2 executable, but the page credits the executable map to Levellass, and so far Levellass has been the only one editing the page. What do I do about this? [[User:TheBigV|TheBigV]] ([[User talk:TheBigV|talk]]) 20:58, 13 August 2021 (GMT)
:Do it, I'm sure she won't mind. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 11:52, 25 March 2022 (GMT)

Patch:Title screen

2020-08-14T08:56:24Z

Levellass: Add third titlescreen patch

This page covers patches relating to the title screen. The title screen in Keen Vorticons is where the [[Patch:Main menu|main menu]] appears. In Keen Dreams it is the image that appears ''before'' the [[Patch:Main menu|main menu]] as well as including the [[Patch:High Scores (Dreams)|High Scores table.]] In Keen Galaxy it is again a simple image leading to the main menu. Associated patches are [[Patch:Main menu]] and [[Patch:Start sequence]].

In Keen Vorticons a level is displayed that can be edited in a level editor. The level used is a screen from <tt>LEVEL90.CKx</tt>. In Dreams, the title screen image can be edited with [[Keengraph]]. In Galaxy, the title screen image can be edited with [[ModKeen]] along with most other Galaxy graphics.

Due to the different natures of the title screens, this page will be divided into three sections, Vorticons, Dreams and Galaxy. Patches for relevant episodes and outcomes will be listed under these sections.

== Vorticons title ==

At present, it is possible to patch the location and [[Patch:Images|bitmaps]] used for the title and the "F1 for help" graphics. (Note that the title graphic cannot be changed easily, as it is not given a value in the code, because it uses bitmap 0.) All values are the default values. For help with graphic location patches, see [[Patch:Images]].

<patch title="Title screen in Keen 1">
#Bitmaps:
%patch $97C0 [$0002W] #F1

#Locations:
%patch $97B2 [$0001W] #Title V
%patch $97B6 [$0008W] #Title H
%patch $97C4 [$00B6W] #F1 V
%patch $97C8 [$0010W] #F1 H

#Don't show...
%patch $97CB $90 $90 $90 #F1
%patch $97B9 $90 $90 $90 #Title
%patch $97AB $C3 #F1 AND title
%patch $97E4 $90 #F1 AND title when menu is open (Has side effects!)</patch>

<patch title="Title screen in Keen 2">
#Bitmaps:
%patch $9241 [$0002W] #F1

#Locations:
%patch $9233 [$0001W] #Title V
%patch $9237 [$0008W] #Title H
%patch $9245 [$00B6W] #F1 V
%patch $9249 [$0010W] #F1 H

#Don't show...
%patch $924C $90 $90 $90 #F1
%patch $923A $90 $90 $90 #Title</patch>

<patch title="Title screen in Keen 3">
#Bitmaps:
%patch $A09A [$0002W] #F1

#Locations:
%patch $A08C [$0001W] #Title V
%patch $A090 [$0008W] #Title H
%patch $A09E [$00B6W] #F1 V
%patch $A0A2 [$0013W] #F1 H

#Don't show...
%patch $A0A5 $90 $90 $90 #F1
%patch $A093 $90 $90 $90 #Title</patch>

== Dreams title ==

The Dreams title consists of a 'demo loop' that displays the title screen and the [[Patch:High Scores (Dreams)|High scores]] in a constant cycle. Though loading level 20 this is never shown in the game. (In the patchable version at least.)

=== Screen image file and errors ===

The screen image is loaded and decompressed form a separate file archive in which it is the only chunk. See also [[Patch:Files and filenames]].

There are three possible errors. The first occurs when the titlescreen archive file cannot be found. The second occurs if the file itself is corrupt and doesn't fit the expected parameters. The third occurs if the title chunk ''inside'' the file is corrupt.

<patch title="Title screen in Dreams">
#Dreams titlescreen archive
%patch $435C [$038DW] #Look for this file
%patch $438A [$038DW] #Load this file
%patch $23DFD "KDREAMS.CMP" $00

#Title screen file
%patch $23E23 "TITLESCR.LBM" $00

#No titlescreen archive
%patch $436D [$0399W]
%patch $23E09 "Couldn't find KDREAMS.CMP" $00

#Can't read titlescreen error
%patch $439D [$03C0W]
%patch $23E30 "Can't load TITLE SCREEN" $00

#Can't read title chunk error
%patch $9C61 [$25EDW]
%patch $2605D "Error Loading Compressed lib shape!" $00</patch>

=== Time titlescreen is visible for ===

By default the 'title sequence' loops between the titlescreen and the high score table. The first appearance of the title, when the game first loads, is especially long, while later appearances are shorter.

As such there are two times involved, the first for the special initial appearance and the second for the 'looping appearances'. Note that the first, longer, time is the ''sum'' of ''both'' times rather than a standalone value.

<patch title="Titlescreen display time">
#Titlescreen display time
%patch $43FA [$0118W] #First appearance extra time
%patch $4447 [$00D2W] #Loop appearances</patch>

=== Skip titlescreen, go straight to menu ===

The first patch causes the game to go straight to the menu instead of displaying the titlescreen. In fact there is no way to view the titlescreen (Or High score table that goes with it.), it is completely disabled.

The second patch is related, except the titlescreen appears, the player is sent to the menu after a time instead of seeing the High Scores.

<patch title="Go straight to menu">
#Skip titlescreen go straight to Main Menu
%patch $4395 $E9 $00FFW

#Go to menu after titlescreen
%patch $4408 $90 $90</patch>

=== Skip titlescreen, go straight to game ===

This patch causes the game to go straight to a new game instead of displaying the titlescreen. In fact there is no way to view the titlescreen (Or High score table that goes with it.), it is completely disabled and pressing 'esc' in-game will cause the entire game to 'reset'.

There are two variables that can be altered, thedifficulty level of the game and the first level entered. In this patch they are 'easy' and level 0 (the map).

<patch title="Go straight to game">
#Skip titlescreen go straight to game
%patch $4395 $E9 $00FFW
%patch $28B32 $4AB8W
%patch $5D01 $C7 $06 $7128W [$0001W] #Difficulty
%patch $3C0C $7124W [$0000W] #Level to start in</patch>

=== High scores table ===

The [[Patch:High Scores (Dreams)|High Score table]] appears after the title screen then, after a period of time, returns to the title screen again.

==== No High Scores in title sequence ====

This patch removes the High Score table in the title sequence only. While the palyer can enter a new high score and see the table at a Game Over they will not see the table when first starting the game and waiting.

<patch title="No High Scores in title sequence">
#No High scores in title sequence
%patch $4475 $EB $09</patch>

==== Time score table is visible ====

These patches control how long the High Scores table is visible before the title screen appears. There are two different situations, Game Over and title sequence, with different times.

<patch title="High Score display time">
#High Scores display time
%patch $4484 [$01A4W]</patch>

==== Go to main menu after Title\High Scores ====

These patches cause the game to go to the [[Patch:Main menu (Dreams)|main menu]] after the titlescreen or high scores are displayed, even if the player doesn't press a key.

<patch title="Go to main menu even if no key is pressed">
#Go to main menu after title displays
%patch $4455 $EB

#Go to main menu after High Score table displays
%patch $4492 $EB</patch>

== Galaxy title ==

The Galaxy title screen is much less involved than the Vorticons one. Like Dreams it is a fullscreen image, appearing after the [[Patch:Terminator text|'terminator text']] sequence has completed or been aborted by the player. (Check the terminator sequence page for related patches.)

There are in fact ''three'' situations where the titlescreen is displayed. The first is when the player allows the [[Patch:Terminator text|'terminator text']] to play out, whereupon the screen will fade to the title. The second situation is when the player presses a key, causing the titlescreen to appear. The third is after a [[Patch:Game over (Galaxy)|game over]] where pressing a key in the High Scores demo will cause the title to appear.

=== Skip screen, go to Main Menu ===

These patches skip the titlescreen, going straight to the [[Patch:Main menu (Galaxy)|Main Menu]]. But this only happens if the player skips the [[Patch:Terminator text|'terminator text']]; allowing it to play out will still cause the title fade.

<patch title="Skip Title screens">
#Skip title, go to Main Menu -Keen 4
%patch $51BC $EB

#Skip title, go to Main Menu -Keen 5
%patch $51B6 $EB

#Skip title, go to Main Menu -Keen 6
%patch $4FC5 $EB</patch>

=== Title screen image ===

As noted above, there are in fact, three different title screens that can be shown. The first appears when the [[Patch:Terminator text|'terminator text']] is allowed to scroll uninterrupted. This will result in a 'titelscreen fade' where the title slowly appears from a black screen. The second title screen appears instantly if the player presses any key. The third appears after a Game Over and the High Scores demo plays out. By default all three of these title imagess are identical, but they don't have to be.

Like all bitmaps, the title screen must be cached before it can be displayed. The number given in these patches is the chunk number (Properly labelled by [[Keengraph]]; [[ModKeen]] will label the bitmap with a different number.) As such there are a total of four lines of code, two for each title screen.

<patch title="Keen Galaxy Title screens">
#Keen 4 titlescreen images
%patch $4EDC [$006DW] #Cache for title fade
%patch $4CF4 [$006DW] #Display in title fade
%patch $51C4 [$006DW] #Cache for title jump
%patch $51D0 [$006DW] #Display in title jump
%patch $58A4 [$006DW] #Cache for after Game Over
%patch $58B0 [$006DW] #Display for after Game Over

#Keen 5 titlescreen images
%patch $4ED6 [$0058W] #Cache for title fade
%patch $4CEE [$0058W] #Display in title fade
%patch $51BE [$0058W] #Cache for title jump
%patch $51CA [$0058W] #Display in title jump
%patch $589E [$0058W] #Cache for after Game Over
%patch $58AA [$0058W] #Display for after Game Over

#Keen 6 titlescreen images
%patch $4CF7 [$0022W] #Cache for title fade
%patch $4B0F [$0022W] #Display in title fade
%patch $4FCD [$0022W] #Cache for title jump
%patch $4FD9 [$0022W] #Display in title jump
%patch $56AD [$0022W] #Cache for after Game Over
%patch $56B9 [$0022W] #Display for after Game Over</patch>

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}

Patch:Keygem door

2020-08-12T03:55:13Z

Levellass: Add patch

Gem doors require a [[Patch:Keygems|keygem]] to open and work in a similar way to switches, by animating tiles with an animate property, but no animation time. While doors can be any height, by default they must be made of three different tiles by default and will animate four frames. Door sprites control the number of door frames and animation speeds.

There are three kinds of door in Galaxy that Keen can enter. The most common kind are [[Patch:Doors (Galaxy)|'passage' doors]], allowing Keen to move between two points in the level, found in all Keen Galaxy games. The second kind are keygem doors found in all galaxy games. The third type are [[Patch:V Card Door|V card doors]] which require a [[Patch:Keycard (Galaxy)|V card]] to open and usually exit the level. Patches relating to Keen himself opening doors can be found at [[Patch:Keen opening doors]].

This page is divided into four sections. The first deals with keyholders, the tiles that activate doors. The second deals with doors themselves, the tiles that alter when a door is opened and how they do so. The third section deals with door metasprites, the invisible objects that control what happens to doors. The final section covers door related game errors.

= Keyholders =

== Gem holder tile code ==

The gem holder [[Patch:Tiles|tile code]] is responsible for initiating the opening of doors. The gem holder code is somewhat complicated. The first section of the code deals with checks. The first check checks to see if the gem holder tile is 1 tile below Keen's head (So Keen cannot open just any gem holder tile.) The next check determines whether the tile ''below'' the gem holder is upwards blocking (So Keen cannot open gem holders in the air.) On the second line Keen's [[Patch:Sprite actions|action]] is checked and if he is already placing a gem then the following code is skipped. (This avoids Keen constantly trying to place a gem but being unable to do so, see also [[Patch:Jump conditions]].)

The next check, on line 3, looks to see if Keen has the right kind of gem (See [[Patch:Game stats]].); four values are checked starting with the red gem. After all these checks are passed then Keen's action is set to 'turn away from screen', starting the door opening sequence and he begins to 'slide' into alignment with the holder. The final check looks to see that this alignment is complete (Otherwise he will try to use the wrong tile as a door locator causing a 'bad spot' error.) if so then the second section is run.

The second section causes Keen to go to the door opening code where his action is set to 'place gem' and a gem is removed from his inventory.

<patch title="Keen 4">
#Gem holder tile property code
%patch $D186 $8B $44 $32 $3B $46 $FE $74 $03 $E9 $00B0W $83 $7C {$36} [$00] {$75}
$03 $E9 $00A7W $81 $7C {$1C} [$0E1EW] {$75} $03 $E9 $009DW $8B $5E
$F6 $83 $EB $07 $D1 $E3 $83 $BF {$7A60W} [$00] {$75} $03 $E9 $008BW
$8B $C7 $B1 $08 $D3 $E0 $05 [$FFC0W] $89 $46 $F4 $8B $44 $0A $3B
$46 $F4 {$74} $11 $8B $46 $F4 $89 $44 $3E $C7 $44 $1C $0E3CW $5F
$5E $8B $E5 $5D $CB
$8B $5E $F6 $83 $EB $07 $D1 $E3 $FF $8F {$7A60W}
$B8 [$0E1EW] $50 $56 $9A $09DC120ARL $83 $C4 $04 $EB $28</patch>

<patch title="Keen 5">
#Gem holder tile property code
%patch $C499 $8B $44 $32 $3B $46 $FE $74 $03 $E9 $00B0W $83 $7C {$36} [$00] {$75}
$03 $E9 $00A7W $81 $7C {$1C} [$0CA2W] {$75} $03 $E9 $009DW $8B $5E
$F6 $83 $EB $07 $D1 $E3 $83 $BF {$6F60W} [$00] {$75} $03 $E9 $008BW
$8B $C7 $B1 $08 $D3 $E0 $05 [$FFC0W] $89 $46 $F4 $8B $44 $0A $3B
$46 $F4 {$74} $11 $8B $46 $F4 $89 $44 $3E $C7 $44 $1C [$0CC0W] $5F
$5E $8B $E5 $5D $CB
$8B $5E $F6 $83 $EB $07 $D1 $E3 $FF $8F {$6F60W}
$B8 [$0CA2W] $50 $56 $9A $090B1242RL $83 $C4 $04 $EB $28</patch>

== Gem holders vanish instead of animating ==

This patch causes gem holders to simply be removed from the level rather than being animated to another tile. (This in itself will appear like animation anyway.) This means all keyholders will behave the same way and removes the need for them to have specific, filled, tiles in the tileset.

In actuality the tile is changed to another tile, tile 0 by default. This value can be changed to make keyholders all animate to the same, non-zero, tile without triggering an animation error when the level loads.

<patch title="Keen 4">
#Keyholders are removed, not animated
%patch $C286 $57 $56 $50 $1E $B8 [$00BCW] $50 $90 $90 $90 $90

#Replacement tile
%patch $2EF2C [$0000W]</patch>

== Gem holder doesn't animate ==

This patch stops the keyholder animating; as such it can be used as many times as Keen has gems, 're-opening' a door each time. (When Keen runs out of gems he will be unable to use the holder until he finds more.)

An issue with this patch is that Keen will use ''all'' the keygems he has at once if he has more than one.

<patch title="Keen 4">
#Don't animate keyholder (Free $C283-$C299)
%patch $C281 $EB $17</patch>

= Doors and door tiles =

== Number of different tiles in door ==

As stated above a door is made of three tiles, a top tile, of which there can be as many as desired, a middle and a bottom tile. If a door is made of more or less different tiles 'static tile' errors will occur. It is however possible to patch this. By default a door animates as many top tiles as it find in a vertical column, then will animate two more tiles below it.

<patch title="Number of different tiles in door">
#Number of different tiles in door -1, Keen 4
%patch $E8D2 [$0002W]

#Number of different tiles in door -1, Keen 5
%patch $E002 [$0002W]

#Number of different tiles in door -1, Keen 6
%patch $DBC1 [$0002W]</patch>

== Doors of any (fixed) height or width in Keen 4 ==

This patch alters the door code so that rather than animating special tiles, it copies a block of the level (Both foreground and background) from another location onto the door, much like how [[Patch:Miragia|Miragia]] works. It relies on using the [[Patch:EGAGRAPH|EGAGRAPH check skip]] and so is incompatible with any other patches that use this.

This means that doors can be of any height or width, not just a single column. It also means any tiles may be used in a door, including animating ones and switches. The disadvantage is that ''all'' doors in a level will use the same tiles at the same location and so will do the same thing. This means that while doors can do more things, all doors in a level must do the same thing.

<patch title="Keen 4">
#Disable EGAGRAPH check (Frees 389 bytes at $3CF6) 037D0H
%patch $3CE5 $90 $90

#Doors use new behaviors below
%patch $3066C $037D0526RL #Door opens
%patch $3068A $037D054ERL #Door opens
%patch $306A8 $037D0576RL #Door opens

#Door tile replacement code, 2x4 block starting at 0,0 in the level
#Door 1, 2x4 at 0,0 in level
%patch $3CF6 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 2, 2x4 at 4,0 in level
%patch $3D1E $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0004W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 2, 2x4 at 8,0 in level
%patch $3D46 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0008W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB</patch>

=== Alternate patch and example ===

This alternate patch does not use the EGA skip, and so is compatible with other patches that use it. It instead disables the [[Patch:F10 T Cheat|sprite test cheat]]. In this example four frames are used for the door instead of three and the doors are 2x3 tiles in size.

<patch title="Keen 4">
#Disable sprite test cheat
%patch $6D39 $CB

#Door tile replacement code, 2x3 block starting at 0,0 in the level
#Door 1, 2x3 at 0,0 in level
%patch $6D3A $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 2, 2x3 at 0,4 in level
%patch $6D62 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0004W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 3, 2x3 at 0,8 in level
%patch $6D8A $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0008W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 4, 2x3 at 0,12 in level
%patch $6DB2 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$000CW] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB

#Door sprite actions:
%patch $3065C $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD016ARL $00000000L $00000000L $180AW
%patch $3067A $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD0192RL $00000000L $00000000L $1828W
%patch $30698 $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD01BARL $00000000L $00000000L $02D7W
%patch $2F147 $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD01E2RL $00000000L $00000000L $0000W</patch>

== Doors of any (fixed) height or width in Keen 5 ==

This patch alters the door code so that a door can be of any size, instead of a single column of tiles. It works by copying the [[Patch:V Card Door|V card door]] code and making the door sprite use it, with some alterations. It relies on using the [[Patch:EGAGRAPH|EGAGRAPH check skip]] and so is incompatible with any other patches that use this.

The tiles sued as a door require a very specific setup, exactly like the tiles used for the V-door; the door frames must be placed next to each other in the tileset in their totality and each tile must animate without an animation speed. Looking at how the V-door tiles are set up may help here.

It is possible to change the width and height of the door, as well as the number of opening frames (By altering how many door sprite actions are used.) Note that the 'door width in tileset' ''must'' be equal to the door's width to avoid problems. The animation speed of the door sprite controls how quickly the door opens.

Note: There appears to be a bug with this patch that means that only doors of the same width and frames as the [[Patch:V Card Door|V card door]] can be used. This is rather limiting and it is not known how this may be overcome at present.

<patch title="Keen 4">
#Custom door sizes in Keen 5
#Disable EGAGRAPH check in Keen 5 (Frees 389 bytes at $3CF0)
%patch $3CDF $90 $90

#New-door opening code
%patch $3CF0 $55 $8B $EC $83 $EC $26 $56 $57 $8D $46 $DA $8B $F8 $8B $5E $06
$8B $5F $0C $D1 $E3 $8B $87 $87 $BF $D1 $E8 $D1 $E0 $8B $16 $51
$9E $8B $5E $06 $8B $5F $0A $D1 $E3 $03 $C3 $89 $56 $FC $89 $46
$FA $C7 $46 $FE $00 $00 $EB $29 $33 $F6 $EB $15 $8B $C6 $D1 $E0
$C4 $5E $FA $03 $D8 $26 $8B $07 $2D [$0004W] $89 $05 $83 $C7 $02 #Door width in tileset
$46 $83 $FE $04 $7C $E6 $FF $46 $FE $A1 $4C $9E $D1 $E0 $01 $46
$FA $83 $7E $FE $04 $7C $D1 $B8 [$0004W] $50 $B8 [$0004W] $50 $8B #Door size h AND v = 4x4
$5E $06 $FF $77 $0C $FF $77 $0A $B8 $0001W $50 $16 $8D $46 $DA
$50 $9A $174E0F25RL $83 $C4 $0E $5F $5E $8B $E5 $5D $CB

#Alter door actions to use new V-card type behavior
%patch $318F6 $0000W $0000W $0000W $0000W $0000W [$000FW] $0000W $0000W
$037D0520RL $00000000L $00000000L $15D4W
%patch $31914 $0000W $0000W $0000W $0000W $0000W [$000FW] $0000W $0000W
$037D0520RL $00000000L $00000000L $15F2W
%patch $31932 $0000W $0000W $0000W $0000W $0000W [$000FW] $0000W $0000W
$037D0520RL $00000000L $00000000L $0000W</patch>

= Door sprites =

Door sprites are invisible [[Patch:Meta sprites|metasprite]] that are created when Keen places a keygem. They animate the door tiles and are then removed. In this respect they are very similar to [[Patch:Miragia|Miragia sprites]]. The following is the default action data for all three sprites:

<patch title="Keen 4">
#Door sprite actions:
%patch $3065C [$0000W $0000W] $0000W $0000W $0000W [$000AW] $0000W $0000W
{$0D8F0F85RL} $00000000L $00000000L {$180AW}
%patch $3067A [$0000W $0000W] $0000W $0000W $0000W [$000AW] $0000W $0000W
{$0D8F0F85RL} $00000000L $00000000L {$1828W}
%patch $30698 [$0000W $0000W] $0000W $0000W $0000W [$000AW] $0000W $0000W
{$0D8F0F85RL} $00000000L $00000000L {$0000W}</patch>

As can be seen each patch is one action and there are three of them. Four values per action are highlighted here as they are the most important. The first blue value is the sprite animation, door sprites do not have any, but they may be added if some sort of effect is desired along with the animating tiles. The second is the animation speed, this controls how fast each frame of the door animates (And thus controls the door opening speed.) This can be tweaked for some interesting effects.

The first brown value is the door behavior, this is what makes the tile animate. The second brown value is the next action, by default the first two lead to the next action, the final one is zero or 'remove sprite' This allows you to control the number of frames of door animation there are; making more actions then linking to them will allow more frames, it's even possible to link the last action back to the first in a loop, if the door tiles also loop in their animation then when a gem is placed the door will start animating forever. This allows the use of gems as 'animation activators'

=== [[Patch:Sprite type|Sprite Type]] ===

Doors use sprite type 1 which is used only by miscellaneous sprites and doesn't affect anything else.

<patch title="Door sprite type">
#Door sprite type -Keen 4
%patch $C346 [$01]

#Door sprite type -Keen 5
%patch $B764 [$01]

#Door sprite type -Keen 6
%patch $B547 [$01]</patch>

=== [[Patch:Sprite actions|Door actions]] ===

Door actions control how many 'frames' of animation a door has. (By default three.) When Keen places a keygem a door metasprite is inserted into the level where the keyholder points to. The door opening sequence is three actions long, each action animating the door 1 frame. after the third action the door metasprite vanishes.

Actions -Keen 4
$17ECW #Door open 1
$180AW #Door open 2
$1828W #Door open 3

<patch title="Keen 4">
#Gem door placed in level
%patch $C349 [$17ECW]

#Door sequence
%patch $30678 [$180AW]
%patch $30696 [$1828W]
%patch $306B4 [$0000W]</patch>

Actions -Keen 5
$15B6W #Open door 1
$15D4W #Open door 2
$15F2W #Open door 3

<patch title="Keen 5">
#Gem door placed in level
%patch $B767 [$15B6W]

#Door sequence
%patch $31912 [$15D4W]
%patch $31930 [$15F2W]
%patch $3194E [$0000W]</patch>

Actions -Keen 6
$15F2W #Door open 1
$1610W #Door open 2
$162EW #Door open 3

<patch title="Keen 6">
#Gem door placed in level
%patch $B54A [$15F2W]

#Door sequence
%patch $3233E [$1610W]
%patch $3235C [$162EW]
%patch $3237A [$0000W]</patch>

== [[Patch:Sprite behavior|Sprite Behavior]] ==

Doors have one behavior, this is the behavior that alters the door tiles. It is used for all three actions thus causing doors to have three 'frames' of opening.

<patch title="Sprite behaviors">
#Door opening behaviors -Keen 4
%patch $3066C $0D8F0F85RL
%patch $3068A $0D8F0F85RL
%patch $306A8 $0D8F0F85RL

#Door opening behaviors -Keen 5
%patch $31906 $0CCB12F5RL
%patch $31924 $0CCB12F5RL
%patch $31942 $0CCB12F5RL

#Door opening behaviors -Keen 6
%patch $32332 $0CA61104RL
%patch $32350 $0CA61104RL
%patch $3236E $0CA61104RL</patch>

== [[Patch:Sprite speed|Speed]] ==

The doors, as metasprites, do not move. Their animation speeds are zero.

<patch title="Sprite speeds">
#Door movement speeds -Keen 4
%patch $30668 [$0000W $0000W]
%patch $30686 [$0000W $0000W]
%patch $306A4 [$0000W $0000W]

#Door movement speeds -Keen 5
%patch $31902 [$0000W $0000W]
%patch $31920 [$0000W $0000W]
%patch $3193E [$0000W $0000W]

#Door movement speeds -Keen 6
%patch $3232E [$0000W $0000W]
%patch $3234C [$0000W $0000W]
%patch $3236A [$0000W $0000W]</patch>

== [[Patch:Sprite animations|Animations]] ==

Doors have no animations and so do not appear to the player in-level. Giving doors animations can cause issues. (In fact this cannot be done without altering the door's tile interaction to allow it to display images.)

Of greater importance is the animation speed, which controls how long each 'frame' of door opening takes.

<patch title="Door sprite animations">
#Door sprite animations -Keen 4
%patch $3065C $0000W $0000W
%patch $30666 $000AW #Animation speed
%patch $3067A $0000W $0000W
%patch $30684 $000AW #Animation speed
%patch $30698 $0000W $0000W
%patch $306A2 $000AW #Animation speed

#Door sprite animations -Keen 5
%patch $318F6 $0000W $0000W
%patch $31900 $000AW #Animation speed
%patch $31914 $0000W $0000W
%patch $3191E $000AW #Animation speed
%patch $31932 $0000W $0000W
%patch $3193C $000AW #Animation speed

#Door sprite animations -Keen 6
%patch $32322 $0000W $0000W
%patch $3232C $000AW #Animation speed
%patch $32340 $0000W $0000W
%patch $3234A $000AW #Animation speed
%patch $3235E $0000W $0000W
%patch $32368 $000AW #Animation speed</patch>

== [[Patch:Sprite collision|Sprite Collision]] ==

Doors are not supposed to interact with other sprites, so they have no sprite collision.

<patch title="Sprite collisions">
#Door sprite collisions -Keen 4
%patch $30670 $00000000L
%patch $3068E $00000000L
%patch $306AC $00000000L

#Door sprite collisions -Keen 5
%patch $3190A $00000000L
%patch $31928 $00000000L
%patch $31946 $00000000L

#Door sprite collisions -Keen 6
%patch $32336 $00000000L
%patch $32354 $00000000L
%patch $32372 $00000000L</patch>

== [[Patch:Sprite clipping and foreground|Clipping and foreground]] ==

Doors have no clipping so that they won't be messed about by solid tiles.

<patch title="Door clipping">
#Door clipping -Keen 4
%patch $C342 [$0000W]

#Door clipping -Keen 5
%patch $B760 [$0000W]

#Door clipping -Keen 6
%patch $B543 [$0000W]</patch>

== [[Patch:Sprite Activity Variable|Sprite Activity]] ==

Doors need to open whether or not Keen is near them. As such they have an activity value of 2, causing them to act wherever the player is. If this is changed to 1 then doors will only open when the player is close to them.

<patch title="Doors sprite activity">
#Doors sprite activity -Keen 4
%patch $C33D [$0002W]

#Doors sprite activity -Keen 5
%patch $B75B [$0002W]

#Doors sprite activity -Keen 6
%patch $B53E [$0002W]</patch>

== [[Patch:Sounds|Sounds]] ==

These are the sounds doors use in the game. A single sound is played when a keygem is placed and a door is opened. This can be muted.

<patch title="Keen 4">
#Door open sound
%patch $C29B $12

#Don't play Doors open sound
%patch $C29A $EB $0A</patch>

<patch title="Keen 5">
#Door open sound
%patch $B6B9 $3C

#Don't play Doors open sound
%patch $B6B8 $EB $0A</patch>

<patch title="Keen 6">
#Door open sound
%patch $B49C $12

#Don't play Doors open sound
%patch $B49B $EB $0A</patch>

== [[Patch:Sprite-tile interaction|Sprite-tile interaction]] ==

Doors are not meant to interact with tiles, though their behavior does cause them to alter a level's tiles. As such they have no tile interaction. Note that this also means that the door can have no animation as displaying sprite images is handled by the tile interaction code of a sprite.

<patch title="Sprite tile interactions">
#Door sprite tile interactions -Keen 4
%patch $30674 $00000000L
%patch $30692 $00000000L
%patch $306B0 $00000000L

#Door sprite tile interactions -Keen 5
%patch $3190E $00000000L
%patch $3192C $00000000L
%patch $3194A $00000000L

#Door sprite tile interactions -Keen 6
%patch $3233A $00000000L
%patch $32358 $00000000L
%patch $32376 $00000000L</patch>

== [[Patch:Galaxy Action Parameters#Action_Type|Action type]] ==

Door actions are basic in the extreme and thus type 0.

<patch title="Sprite action types">
#Door sprite action types -Keen 4
%patch $30660 [$0000W]
%patch $3067E [$0000W]
%patch $3069C [$0000W]

#Door sprite action types -Keen 5
%patch $318FA [$0000W]
%patch $31918 [$0000W]
%patch $31936 [$0000W]

#Door sprite action types -Keen 6
%patch $32326 [$0000W]
%patch $32344 [$0000W]
%patch $32362 [$0000W]</patch>

== [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] ==

Doors have no need for either of these variables and so have a value of 0 for both in all of their actions.

<patch title="Sprite deprotect, stick">
#Door deprotect, stick -Keen 4
%patch $30662 [$0000W $0000W]
%patch $30680 [$0000W $0000W]
%patch $3069E [$0000W $0000W]

#Door deprotect, stick -Keen 5
%patch $318FC [$0000W $0000W]
%patch $3191A [$0000W $0000W]
%patch $31938 [$0000W $0000W]

#Door deprotect, stick -Keen 6
%patch $32328 [$0000W $0000W]
%patch $32346 [$0000W $0000W]
%patch $32364 [$0000W $0000W]</patch>

= [[Patch:Game errors|Errors]] =

Doors and keygems can cause a number of [[Patch:Game errors|errors.]]

== Keyholder points to bad spot ==

This error should occur when the player tries to place a key gem to open a door. It occurs when the keyholder does not have a correct sprite value over it. usually this happens when the modder forgets to put a value in, giving a default value of 0,0. Other invalid values are those outside the level borders. This error is easy enough to fix since there should only be a small number of keyholders in the level to check for validity.

This error may also occur if a 'hidden' keyholder is triggered, say if the modder accidentally gives a tile the keyholder property. (The hidden holder will of course not be given a value and can be hard to find until the player accidentally runs into one while having the right colored gem.)

In either case the best course of action is to play the level and note exactly where the game crashes. This will be the exact location of the broken keyholder.

<patch title="Keyholder errors">
#Keen 4 :
%patch $C2E0 [$1426W] #Text called from
%patch $30296 "Keyholder points to a bad spot!" $00

#Keen 5 :
%patch $B6FE [$130EW] #Text called from
%patch $3164E "Keyholder points to a bad spot!" $00

#Keen 6 :
%patch $B4E1 [$129EW] #Text called from
%patch $31FCE "Keyholder points to a bad spot!" $00</patch>

== Door tiles become gibberish ==

This occurs when the game tries to turn a door tile into a tile that's not in the level. This is usually a tile bug, where the modder hasn't given each door tile the right number of animation frames. It can also occur when the modder changes how many different tiles can be in the door or how many frames it takes to open.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Sprite|}}

Patch:Sprite actions

2020-08-12T03:11:20Z

Levellass: Add some links

This page is a tutorial on patching sprite actions. A sprite action is a segment of code 30 bytes long that sets the variables for almost everything relating to a sprite in Keen Galaxy (and Dreams). First is a brief description of the action with links to pages explaining each section, then follows a section listing the default values of actions in the games.

As such, patching an entire sprite action is difficult because of the many variables involved. In general a modder will wish to patch a segment of the action, such as the sprite speeds. Therefore this page will simply outline the action's structure and function.

== Description ==

An action is 30 bytes long, composed of 9 words and 3 dwords. Information on each section is given in links in the table below

Int Description Values
Int 0: [[Patch:Sprite animations|Left sprite]] Valid animations only
Int 2: [[Patch:Sprite animations|Right sprite]] Valid animations only
Int 4: [[Patch:Galaxy Action Parameters#Action_Type|Action type]] 0-4
Int 6: [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect]] 0/1
Int 8: [[Patch:Galaxy Action Parameters#Deprotect_Animation|Stick to ground]] 0/1
Int 10: [[Patch:Sprite animations|Delay (Anim speed)]] 0-8000
Int 12: [[Patch:Sprite speed|H anim move amount]] +- any value
Int 14: [[Patch:Sprite speed|V anim move amount]] +- any value
Int 16: [[Patch:Sprite behavior|Behavior]] Start of behavior codes only
Int 20: [[Patch:Sprite collision|Check sprites]] Start of check sprite codes only
Int 24: [[Patch:Sprite-tile interaction|Check tiles]] Start of check tile code only
Int 30: [[Patch:Sprite actions#List_of_sprite_actions|Next action]] Valid actions only

Actions are treated like text strings (See [[Patch:Text patches]]) and are referred to by a text pointer, this includes the 'next action' word at the end of each action. As an example is a patch for changing what the [[Arachnut]] spawns as:

<patch title="Keen 4">
#Spawn walking Arachnut
%patch $1056B $2378W</patch>

== List of sprite actions ==

Each action has its own value (Actually a pointer to its location.) This is seen most often in the 'next action' variable, which tells a sprite what set of action instructions to follow next. Listed below are the default values found in Keen games plus a brief description of what they do.

Since this is a location pointer, it is possible for a modder to create totally new actions and refer to them.

=== Keen 4 sprite actions ===

$0000W #Null action (Vanish)
$098CW #[[Patch:Demo Sign|Demo sign in Highscores level (Invisible)]]
$098CW #Keen standing
$09AAW #[[Patch:Keen bored|Keen looks up (Bored)]]
$09C8W #[[Patch:Keen bored|Keen shrugs 1(Bored more)]]
$09E6W #[[Patch:Keen bored|Keen shrugs 2]]
$0A04W #[[Patch:Keen bored|Keen shrugs 3]]
$0A22W #[[Patch:Keen bored|Keen shrugs 4]]
$0A40W #[[Patch:Keen bored|Keen shrugs 5]]
$0A5EW #[[Patch:Keen bored|Keen shrugs 6]]
$0A7CW #[[Patch:Keen_mooning|Keen moons 1]]
$0A9AW #[[Patch:Keen_mooning|Keen moons 2]]
$0AB8W #[[Patch:Keen_mooning|Keen moons 3]]
$0AD6W #[[Patch:Keen bored|Keen starts reading book 1]]
$0AF4W #[[Patch:Keen bored|Keen starts reading book 2]]
$0B12W #[[Patch:Keen bored|Keen starts reading book 3]]
$0B30W #[[Patch:Keen bored|Keen starts reading book 4]]
$0B4EW #[[Patch:Keen bored|Keen reads book 1]]
$0B6CW #[[Patch:Keen bored|Keen reads book 2]]
$0B8AW #[[Patch:Keen bored|Keen reads book 3]]
$0BA8W #[[Patch:Keen bored|Keen stops reading book 1]]
$0BC6W #[[Patch:Keen bored|Keen stops reading book 2]]
$0BE4W #[[Patch:Keen bored|Keen stops reading book 3]]
$0C02W #[[Patch:Keen look|Keen start looking up]]
$0C20W #[[Patch:Keen look|Keen looking up]]
$0C3EW #[[Patch:Keen look|Keen start looking down]]
$0C5CW #[[Patch:Keen look|Keen looking down 1]]
$0C7AW #[[Patch:Keen look|Keen looking down 2]]
$0C98W #[[Patch:Keen look|Keen stop looking down]]
$0CB6W #[[Patch:Keen look|Keen jump down from one-way-up platforms (Unused)]]
$0CD4W #[[Patch:Keen_dying_(Keen_4)|Defunct dead action]]
$0CF2W #[[Patch:Keen_dying_(Keen_4)|Keen dies sprawled (Exits level if offscreen.)]]
$0D10W #[[Patch:Keen_dying_(Keen_4)|Keen dies clutched (Exits level if offscreen.)]]
$0D2EW #[[Patch:Keen_dying_(Keen_4)|Keen die swimming sprawled (Exits level if offscreen.)]]
$0D4CW #[[Patch:Keen_dying_(Keen_4)|Keen die swimming clutched (Exits level if offscreen.)]]
$0D6AW #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally 1]]
$0D88W #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally 2]]
$0DA6W #[[Patch:Keen shooting (Galaxy)|Keen shooting up 1]]
$0DC4W #[[Patch:Keen shooting (Galaxy)|Keen shooting up 2]]
$0DE2W #[[Patch:Keen Flipping Switches|Keen starts flicking switches]]
$0E00W #[[Patch:Keen Flipping Switches|Keen finishes flicking switches]]
$0E1EW #[[Patch:Keen opening doors|Keen places gem, door opens]]
$0E3CW #Keen adjust position
$0E5AW #[[Patch:Keen entering doors|Keen walks into door 1]]
$0E78W #[[Patch:Keen entering doors|Keen walks into door 2]]
$0E96W #[[Patch:Keen entering doors|Keen walks into door 3]]
$0EB4W #[[Patch:Keen entering doors|Keen walks into door 4]]
$0ED2W #[[Patch:Keen entering doors|Keen walks into door 5]]
$0EF0W #[[Patch:Keen on poles|Keen sitting still on a pole]]
$0F0EW #[[Patch:Keen on poles|Keen going up a pole]]
$0F2CW #[[Patch:Keen on poles|Keen going up a pole]]
$0F4AW #[[Patch:Keen on poles|Keen going up a pole]]
$0F68W #[[Patch:Keen on poles|Keen going down a pole]]
$0F86W #[[Patch:Keen on poles|Keen going down a pole]]
$0FA4W #[[Patch:Keen on poles|Keen going down a pole]]
$0FC2W #[[Patch:Keen on poles|Keen going down a pole]]
$0FE0W #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally on a pole 1]]
$0FFEW #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally on a pole 2]]
$101CW #[[Patch:Keen shooting (Galaxy)|Keen shoots up on pole 1]]
$103AW #[[Patch:Keen shooting (Galaxy)|Keen shoots up on pole 2]]
$1058W #[[Patch:Keen shooting (Galaxy)|Keen shooting down on a pole 1]]
$1076W #[[Patch:Keen shooting (Galaxy)|Keen shooting down on a pole 2]]
$1094W #[[Patch:Keen walking (Galaxy)|Keen standing (Walking action)]]
$10B2W #[[Patch:Keen walking (Galaxy)|Keen walking]]
$10D0W #[[Patch:Keen walking (Galaxy)|Keen walking]]
$10EEW #[[Patch:Keen walking (Galaxy)|Keen walking]]
$110CW #[[Patch:Keen pogoing (Galaxy)|Keen start pogoing]]
$112AW #[[Patch:Keen pogoing (Galaxy)|Keen pogoing]]
$1148W #[[Patch:Keen pogoing (Galaxy)|Keen pogo bouncing]]
$1166W #[[Patch:Keen jumping (Galaxy)|Keen jumping 1]]
$1184W #[[Patch:Keen jumping (Galaxy)|Keen jumping 2]]
$11A2W #[[Patch:Keen jumping (Galaxy)|Keen falling 1]]
$11C0W #[[Patch:Keen jumping (Galaxy)|Keen falling 2]]
$11DEW #[[Patch:Keen shooting (Galaxy)|Keen start shooting horizontally in air]]
$11FCW #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally in air 1]]
$121AW #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally in air 2]]
$1238W #[[Patch:Keen shooting (Galaxy)|Keen start shooting upwards in air]]
$1256W #[[Patch:Keen shooting (Galaxy)|Keen shooting up in air 1]]
$1274W #[[Patch:Keen shooting (Galaxy)|Keen shooting up in air 2]]
$1292W #[[Patch:Keen shooting (Galaxy)|Keen start shooting downwards in air ]]
$12B0W #[[Patch:Keen shooting (Galaxy)|Keen shoot down in air 1]]
$12CEW #[[Patch:Keen shooting (Galaxy)|Keen shoot down in air 2]]
$12ECW #[[Patch:Keen grabs ledge|Keen gripping ledge 1]]
$130AW #[[Patch:Keen grabs ledge|Keen gripping ledge 2]]
$1328W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 1]]
$1346W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 2]]
$1364W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 3]]
$1382W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 4]]
$13A0W #[[Patch:Keen grabs ledge|Keen standing on air (After pulling himself up. Doesn't fall)]]
$1456W #[[Patch:Demo Sign|Invisible Demo sign (For normal gameplay)]]
$1474W #[[Patch:Demo Sign|Demo sign (Unusable usually)]]
$1492W #[[Patch:Keen_on_map_(Galaxy)|Map Keen riding foot]]
$14B0W #[[Patch:Keen_on_map_(Galaxy)|Map Keen riding foot]]
$14CEW #[[Patch:Keen_on_map_(Galaxy)|Map Keen swimming]]
$14ECW #[[Patch:Keen_on_map_(Galaxy)|Map Keen standing still]]
$150AW #[[Patch:Keen_on_map_(Galaxy)|Map Keen waving when bored]]
$1528W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waving when bored]]
$1546W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waving when bored]]
$1564W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waving when bored]]
$1582W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waving when bored]]
$15A0W #[[Patch:Keen_on_map_(Galaxy)|Map Keen moving]]
$15EEW #[[Patch:Flags|Keen K flag waving 1]]
$160CW #[[Patch:Flags|Keen K flag waving 2]]
$162AW #[[Patch:Flags|Keen K flag waving 3]]
$1648W #[[Patch:Flags|Keen K flag waving 4]]
$1666W #[[Patch:Flags|Keen flag flips into holder 1]]
$1684W #[[Patch:Flags|Keen flag flips into holder 2]]
$16A2W #[[Patch:Flags|Keen flag flips into holder 3]]
$16C0W #[[Patch:Flags|Keen flag flips into holder 4]]
$16DEW #[[Patch:Flags|Keen flag flips into holder 5]]
$16FCW #[[Patch:Flags|Keen flag flips into holder 6]]
$171AW #[[Patch:Flags|Keen flag flips into holder 7]]
$1738W #[[Patch:Keen's_shot_(Galaxy)|Keen's bullet]]
$1756W #[[Patch:Keen's_shot_(Galaxy)|Keen's bullet]]
$1774W #[[Patch:Keen's_shot_(Galaxy)|Keen's bullet]]
$1792W #[[Patch:Keen's_shot_(Galaxy)|Keen's bullet]]
$17B0W #[[Patch:Keen's_shot_(Galaxy)|Keen's bullets zaps]]
$17CEW #[[Patch:Keen's_shot_(Galaxy)|Keen's bullets zaps]]
$17ECW #[[Patch:Keygem_door|Door open 1]]
$180AW #[[Patch:Keygem_door|Door open 2]]
$1828W #[[Patch:Keygem_door|Door open 3]]
$1846W #[[Patch:Scorebox|Something to do with scoreboard display]]
$19ECW #[[Patch:Keen_swimming|Keen swimming]]
$1A0AW #[[Patch:Keen_swimming|Keen swimming]]
$1A28W #[[Patch:Keen_swimming|Keen swimming]]
$1A46W #[[Patch:Keen_swimming|Keen swimming]]
$1A64W #[[Patch:Keen_swimming|Bubble 1]]
$1A82W #[[Patch:Keen_swimming|Bubble 2]]
$1AA0W #[[Patch:Keen_swimming|Bubble 3]]
$1ABEW #[[Patch:Keen_swimming|Bubble 4]]
$1DFCW #[[Patch:Miragia|Miragia animating]]
$1E1AW #[[Patch:Miragia|Miragia animating]]
$1E38W #[[Patch:Miragia|Miragia animating]]
$1E56W #[[Patch:Miragia|Miragia animating]]
$1E74W #[[Patch:Miragia|Miragia animating]]
$1E92W #[[Patch:Miragia|Miragia animating]]
$1EB0W #[[Patch:Miragia|Miragia animating]]
$1ECEW #[[Patch:Miragia|Miragia animating]]
$1EECW #[[Patch:Items|Items 1]]
$1F0AW #[[Patch:Items|Items 2]]
$1F28W #[[Patch:Items|Stuff got]]
$1F46W #[[Patch:Items|Raindrop splash 1]]
$1F64W #[[Patch:Items|Raindrop splash 2]]
$1F82W #[[Patch:Items|Raindrop splash 3]]
$1FB8W #[[Patch:Council member|Walking Council member]]
$1FD6W #[[Patch:Council member|Walking Council member]]
$1FF4W #[[Patch:Council member|Thinking Council Member]]
$2012W #[[Patch:Poison Slug|Poison Slug]]
$2030W #[[Patch:Poison Slug|Poison slug]]
$204EW #[[Patch:Poison Slug|Poison Slug sliming]]
$206CW #[[Patch:Poison Slug|Short stunned poison slug]]
$208AW #[[Patch:Poison Slug|Tall stunned poison slug]]
$20A8W #[[Patch:Poison Slug|Slug Slime]]
$20C6W #[[Patch:Poison Slug|Slug Slime drying]]
$20E4W #[[Patch:Mad Mushroom|Mad Mushroom start]]
$2102W #[[Patch:Mad Mushroom|Mad Mushroom ]]
$2120W #[[Patch:Egg|Egg]]
$213EW #[[Patch:Egg|Big bit of eggshell on ground]]
$215CW #[[Patch:Egg|Small bit of shell 1]]
$217AW #[[Patch:Egg|Small bit of shell 2]]
$2198W #[[Patch:Egg|Small bit of shell 3]]
$21B6W #[[Patch:Egg|BlueBird hatched]]
$21D4W #[[Patch:Blue Bird|BlueBird walking]]
$21F2W #[[Patch:Blue Bird|BlueBird walking]]
$2210W #[[Patch:Blue Bird|BlueBird walking]]
$222EW #[[Patch:Blue Bird|BlueBird walking]]
$224CW #[[Patch:Blue Bird|Bluebird flying]]
$226AW #[[Patch:Blue Bird|Bluebird flying]]
$2288W #[[Patch:Blue Bird|Bluebird flying]]
$22A6W #[[Patch:Blue Bird|Bluebird flying]]
$22C4W #[[Patch:Blue Bird|Bluebird go to land]]
$22E2W #[[Patch:Blue Bird|Stunned Bluebird]]
$2300W #[[Patch:Blue Bird|Bluebird unstunning]]
$231EW #[[Patch:Blue Bird|Bluebird unstunning]]
$233CW #[[Patch:Blue Bird|Bluebird unstunning]]
$235AW #[[Patch:Blue Bird|Bluebird unstunning]]
$2378W #[[Patch:Arachnut|Arachnut]]
$2396W #[[Patch:Arachnut|Arachnut]]
$23B4W #[[Patch:Arachnut|Arachnut]]
$23D2W #[[Patch:Arachnut|Arachnut]]
$23F0W #[[Patch:Arachnut|Arachnut stunned]]
$240EW #[[Patch:Arachnut|Arachnut unstunning]]
$242CW #[[Patch:Arachnut|Arachnut unstunning]]
$244AW #[[Patch:Arachnut|Arachnut unstunning]]
$2468W #[[Patch:Arachnut|Arachnut unstunning]]
$2486W #[[Patch:Skypest|Skypest flying]]
$24A4W #[[Patch:Skypest|Skypest flying]]
$24C2W #[[Patch:Skypest|Skypest squished]]
$24E0W #[[Patch:Skypest|Skypest preening]]
$24FEW #[[Patch:Skypest|Skypest preening]]
$251CW #[[Patch:Skypest|Skypest preening]]
$253AW #[[Patch:Skypest|Skypest preening]]
$2558W #[[Patch:Skypest|Skypest preening]]
$2576W #[[Patch:Skypest|Skypest preening]]
$2594W #[[Patch:Skypest|Skypest preening]]
$25B2W #[[Patch:Skypest|Skypest preening]]
$25D0W #[[Patch:Skypest|Skypest preening]]
$25EEW #[[Patch:Skypest|Skypest preening]]
$260CW #[[Patch:Skypest|Skypest preening]]
$262AW #[[Patch:Skypest|Skypest preening]]
$2648W #[[Patch:Skypest|Skypest preening]]
$2666W #[[Patch:Skypest|Skypest preening]]
$2684W #[[Patch:Skypest|Skypest preening]]
$26A2W #[[Patch:Skypest|Skypest preening]]
$26C0W #[[Patch:Skypest|Skypest preening]]
$26DEW #[[Patch:Wormouth|Wormouth small moving]]
$26FCW #[[Patch:Wormouth|Wormouth small looking around]]
$271AW #[[Patch:Wormouth|Wormouth looking around]]
$2738W #[[Patch:Wormouth|Wormouth looking around]]
$2756W #[[Patch:Wormouth|Wormouth looking around]]
$2774W #[[Patch:Wormouth|Wormouth looking around]]
$2792W #[[Patch:Wormouth|Wormouth looking around]]
$27B0W #[[Patch:Wormouth|Wormouth looking around]]
$27CEW #[[Patch:Wormouth|Wormouth looking around]]
$27ECW #[[Patch:Wormouth|Wormouth biting]]
$280AW #[[Patch:Wormouth|Wormouth biting]]
$2828W #[[Patch:Wormouth|Wormouth biting]]
$2846W #[[Patch:Wormouth|Wormouth biting]]
$2864W #[[Patch:Wormouth|Wormouth biting]]
$2882W #[[Patch:Wormouth|Wormouth stunned]]
$28A0W #[[Patch:Cloud|Cloud asleep]]
$28BEW #[[Patch:Cloud|Cloud awake and still]]
$28DCW #[[Patch:Cloud|Cloud moving]]
$28FAW #[[Patch:Cloud|Cloud turning\starting moving]]
$2918W #[[Patch:Cloud|Cloud moving]]
$2936W #[[Patch:Cloud|Cloud zapping Keen]]
$2954W #[[Patch:Cloud|Cloud zapping Keen ]]
$2972W #[[Patch:Cloud|Cloud zapping Keen ]]
$2990W #[[Patch:Cloud|Cloud zapping Keen ]]
$29AEW #[[Patch:Cloud|Cloud zapping Keen ]]
$29CCW #[[Patch:Cloud|Cloud zapping Keen ]]
$29EAW #[[Patch:Cloud|Cloud zapping Keen ]]
$2A08W #[[Patch:Cloud|Cloud zapping Keen]]
$2A26W #[[Patch:Cloud|Cloud zapping Keen (Lightning strikes)]]
$2A44W #[[Patch:Cloud|Lightning]]
$2A62W #[[Patch:Cloud|Lightning]]
$2A80W #[[Patch:Cloud|Lightning]]
$2A9EW #[[Patch:Cloud|Lightning]]
$2ABCW #[[Patch:Cloud|Lightning]]
$2ADAW #[[Patch:Cloud|Lightning]]
$2AF8W #[[Patch:Berkeloid|Berkeloid moving]]
$2B16W #[[Patch:Berkeloid|Berkeloid moving]]
$2B34W #[[Patch:Berkeloid|Berkeloid moving]]
$2B52W #[[Patch:Berkeloid|Berkeloid moving]]
$2B70W #[[Patch:Berkeloid|Berkeloid ready to flame]]
$2B8EW #[[Patch:Berkeloid|Berkeloid flaming]]
$2BACW #[[Patch:Berkeloid|Berkeloid flaming]]
$2BCAW #[[Patch:Berkeloid|Berkeloid flaming]]
$2BE8W #[[Patch:Berkeloid|Berkeloid flaming]]
$2C06W #[[Patch:Berkeloid|Berkeloid flaming]]
$2C24W #[[Patch:Berkeloid|Berkeloid flamed]]
$2C42W #[[Patch:Berkeloid|Berkeloid flamed]]
$2C60W #[[Patch:Berkeloid|Berkeloid flamed]]
$2C7EW #[[Patch:Berkeloid|Berkeloid flamed]]
$2C9CW #[[Patch:Berkeloid|Berkeloid flamed]]
$2CBAW #[[Patch:Berkeloid|Berkeloid flamed]]
$2CD8W #[[Patch:Berkeloid|Berkeloid tossed flame 1]]
$2CF6W #[[Patch:Berkeloid|Berkeloid tossed flame 2]]
$2D14W #[[Patch:Berkeloid|Berkeloid landed flame 3]]
$2D32W #[[Patch:Berkeloid|Berkeloid landed flame 4]]
$2D50W #[[Patch:Berkeloid|Berkeloid landed flame 5]]
$2D6EW #[[Patch:Berkeloid|Berkeloid landed flame 6]]
$2D8CW #[[Patch:Berkeloid|Berkeloid landed flame 7]]
$2DAAW #[[Patch:Berkeloid|Berkeloid landed flame 8]]
$2DAAW #[[Patch:Berkeloid|Berkeloid landed flame 9]]
$2DE6W #[[Patch:Berkeloid|Berkeloid landed flame 10]]
$2E04W #[[Patch:Berkeloid|Berkeloid landed flame 11]]
$2E22W #[[Patch:Foot|Foot appearing smoke 1]]
$2E40W #[[Patch:Foot|Foot appearing smoke 2]]
$2E5EW #[[Patch:Foot|Foot appearing smoke 3]]
$2E7CW #[[Patch:Foot|Foot appearing smoke 4]]
$2E9AW #[[Patch:Inchworm|Inchworm 1]]
$2EB8W #[[Patch:Inchworm|Inchworm 2]]
$2ED6W #[[Patch:Foot|The Foot (Spawned by Inchworms)]]
$2EF4W #[[Patch:Foot|The Foot (Placed in P.O.T.F.)]]
$2F12W #[[Patch:Bounder|Bounder bouncing vertically]]
$2F30W #[[Patch:Bounder|Bounder bouncing vertically]]
$2F4EW #[[Patch:Bounder|Bounder bouncing left/right]]
$2F6CW #[[Patch:Bounder|Bounder bouncing left/right]]
$2F8AW #[[Patch:Bounder|Stunned Bounder in air]]
$2FA8W #[[Patch:Bounder|Stunned Bounder on ground]]
$2FC6W #[[Patch:Lick|Lick]]
$2FE4W #[[Patch:Lick|Lick]]
$3002W #[[Patch:Lick|Lick ready to jump]]
$3020W #[[Patch:Lick|Lick landing/jumping]]
$303EW #[[Patch:Lick|Lick flaming]]
$305CW #[[Patch:Lick|Lick flaming]]
$307AW #[[Patch:Lick|Lick flaming]]
$3098W #[[Patch:Lick|Lick flaming]]
$30B6W #[[Patch:Lick|Lick flaming]]
$30D4W #[[Patch:Lick|Lick flaming]]
$30F2W #[[Patch:Lick|Lick flaming]]
$3110W #[[Patch:Lick|Lick done flaming]]
$312EW #[[Patch:Lick|Stunned Lick in air]]
$314CW #[[Patch:Lick|Stunned Lick]]
$316AW #[[Patch:Platform_(Keen_4)|Controllable Airboard]]
$3188W #[[Patch:Platform_(Keen_4)|Airboard still]]
$31A6W #[[Patch:Platform_(Keen_4)|Airboard fall]]
$31C4W #[[Patch:Platform_(Keen_4)|Airboard rise]]
$31E2W #[[Patch:Smirky|Smirky (a.k.a. Gnosticene Ancient / Red Guy who steals points)]]
$3200W #[[Patch:Smirky|Smirky]]
$321EW #[[Patch:Smirky|Smirky teleporting smoke]]
$323CW #[[Patch:Smirky|Smirky teleporting smoke]]
$325AW #[[Patch:Smirky|Smirky teleporting smoke]]
$3278W #[[Patch:Smirky|Smirky teleporting smoke]]
$3296W #[[Patch:Smirky|Smirky teleporting smoke]]
$32B4W #[[Patch:Smirky|Smirky teleporting smoke]]
$32D2W #[[Patch:Smirky|Smirky teleporting smoke]]
$32F0W #[[Patch:Smirky|Smirky teleporting smoke]]
$330EW #[[Patch:Smirky|Smirky jumping to steal stuff]]
$332CW #[[Patch:Smirky|Smirky jumping to steal stuff]]
$334AW #[[Patch:Smirky|Smirky jumping to steal stuff]]
$3368W #[[Patch:Smirky|Smirky jumping to steal stuff]]
$3386W #[[Patch:Smirky|Shot Smirky]]
$33A4W #[[Patch:Smirky|Stunned Smirky]]
$33C2W #[[Patch:Smirky|Candy stolen by Smirky]]
$33E0W #[[Patch:Smirky|Candy stolen by Smirky]]
$33FEW #[[Patch:Smirky|Candy stolen by Smirky]]
$341CW #[[Patch:Smirky|Candy stolen by Smirky]]
$343AW #[[Patch:Mimrock|Mimrock stuck to ground]]
$3458W #[[Patch:Mimrock|Mimrock sneaking]]
$3476W #[[Patch:Mimrock|Mimrock sneaking]]
$3494W #[[Patch:Mimrock|Mimrock sneaking]]
$34B2W #[[Patch:Mimrock|Mimrock sneaking]]
$34D0W #[[Patch:Mimrock|Mimrock sneaking]]
$34EEW #[[Patch:Mimrock|Mimrock sneaking]]
$350CW #[[Patch:Mimrock|Mimrock jumping]]
$352AW #[[Patch:Mimrock|Mimrock jumping]]
$3548W #[[Patch:Mimrock|Mimrock jumping]]
$3566W #[[Patch:Mimrock|Mimrock upside down bouncing]]
$3584W #[[Patch:Mimrock|Shot Mimrock]]
$35A2W #[[Patch:Mimrock|Stunned Mimrock]]
$35C0W #[[Patch:Dopefish|Dopefish swimming]]
$35DEW #[[Patch:Dopefish|Dopefish swimming]]
$35FCW #[[Patch:Dopefish|Dopefish chomping (Mouth wide open)]]
$361AW #[[Patch:Dopefish|Dopefish burping]]
$3638W #[[Patch:Dopefish|Dopefish burping]]
$3656W #[[Patch:Dopefish|Dopefish burping]]
$3674W #[[Patch:Dopefish|Dopefish burping]]
$3692W #[[Patch:Dopefish|Dead Schoolfish]]
$36B0W #[[Patch:Dopefish|Keen eaten by Dopefish (Stays still so can't be seen behind fish)]]
$36CEW #[[Patch:Keen dying (Keen 4)|Didn't make it past.. (Well of Wishes eaten death)]]
$36ECW #[[Patch:Dopefish|Big bubble]]
$370AW #[[Patch:Dopefish|Big bubble]]
$3728W #[[Patch:Dopefish|Big bubble]]
$3746W #[[Patch:Dopefish|Big bubble]]
$3764W #[[Patch:Schoolfish|Schoolfish]]
$3782W #[[Patch:Schoolfish|Schoolfish]]
$37A0W #[[Patch:Sprite|Sprite]]
$37BEW #[[Patch:Sprite|Sprite aiming]]
$37DCW #[[Patch:Sprite|Sprite shooting]]
$37FAW #[[Patch:Sprite|Sprite shooting]]
$3818W #[[Patch:Sprite|Sprite's bullet]]
$3836W #[[Patch:Sprite|Sprite's bullet]]
$3854W #[[Patch:Sprite|Sprite's bullet]]
$3872W #[[Patch:Sprite|Sprite's bullet]]
$3890W #[[Patch:Underwater Mine|Mine moving]]
$38AEW #[[Patch:Underwater Mine|Mine explodes 1]]
$38CCW #[[Patch:Underwater Mine|Mine explodes 2]]
$38EAW #[[Patch:Lindsey|Princess Lindsey (Floats up offscreen)]]
$3908W #[[Patch:Lindsey|Princess Lindsey]]
$3926W #[[Patch:Lindsey|Princess Lindsey]]
$3944W #[[Patch:Lindsey|Princess Lindsey]]
$3962W #[[Patch:Dart_Gun|Dart shooter (All four, by default sprite freezes, then shoots upwards dart)]]
$3980W #[[Patch:Dart_Gun|Dart left/right]]
$399EW #[[Patch:Dart_Gun|Dart left/right (Shoots immediately)]]
$39BCW #[[Patch:Dart_Gun|Dart up]]
$39DAW #[[Patch:Dart_Gun|Dart up (Shoots immediately)]]
$39F8W #[[Patch:Dart_Gun|Dart down]]
$3A16W #[[Patch:Dart_Gun|Dart down (Shoots immediately)]]
$3A34W #[[Patch:Wetsuit|The Wetsuit]]
$3ABBW #Keen enters Shadowlands (Sometimes takes a life if used wrong.)

=== Keen 5 sprite actions ===

$0000W #Null action (Vanish)
$0788W #[[Patch:Demo Sign|Demo sign in Highscores level (Invisible)]]
$0888W #Keen standing
$08A6W #[[Patch:Keen on Platforms|Keen on Platforms]]
$08C4W #[[Patch:Keen bored|Keen looks up (Bored)]]
$08E2W #[[Patch:Keen bored|Keen shrugs 1 (Bored more)]]
$0900W #[[Patch:Keen bored|Keen shrugs 2]]
$091EW #[[Patch:Keen bored|Keen shrugs 3]]
$093CW #[[Patch:Keen bored|Keen shrugs 4]]
$095AW #[[Patch:Keen bored|Keen shrugs 5]]
$0978W #[[Patch:Keen bored|Keen shrugs 6]]
$0996W #[[Patch:Keen bored|Keen starts reading book 1]]
$09B4W #[[Patch:Keen bored|Keen starts reading book 2]]
$09D2W #[[Patch:Keen bored|Keen starts reading book 3]]
$09F0W #[[Patch:Keen bored|Keen starts reading book 4]]
$0A0EW #[[Patch:Keen bored|Keen reads book 1]]
$0A2CW #[[Patch:Keen bored|Keen reads book 2]]
$0A4AW #[[Patch:Keen bored|Keen reads book 3]]
$0A68W #[[Patch:Keen bored|Keen stops reading book 1]]
$0A86W #[[Patch:Keen bored|Keen stops reading book 2]]
$0AA4W #[[Patch:Keen bored|Keen stops reading book 3]]
$0AC2W #[[Patch:Keen look|Keen start looking up]]
$0AE0W #[[Patch:Keen look|Keen looking up]]
$0AFEW #[[Patch:Keen look|Keen start looking down]]
$0B1CW #[[Patch:Keen look|Keen looking down 1]]
$0B3AW #[[Patch:Keen look|Keen looking down 2]]
$0B58W #[[Patch:Keen look|Keen stop looking down]]
$0B76W #[[Patch:Keen look|Keen jump down from one-way-up platforms (Unused)]]
$0B94W #[[Patch:Keen dying (Keen 5)|Defunct dead action]]
$0BB2W #[[Patch:Keen dying (Keen 5)|Keen dies sprawled (Restarts level if offscreen.)]]
$0BD0W #[[Patch:Keen dying (Keen 5)|Keen dies clutched (Restarts level if offscreen.)]]
$0BEEW #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally start]]
$0C0CW #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally]]
$0C2AW #[[Patch:Keen shooting (Galaxy)|Keen shooting up start]]
$0C48W #[[Patch:Keen shooting (Galaxy)|Keen shooting up]]
$0C66W #[[Patch:Keen Flipping Switches|Keen starts flicking switches]]
$0C84W #[[Patch:Keen Flipping Switches|Keen finishes flicking switches]]
$0CA2W #Keen places gem
$0CC0W #[[Patch:Keen opening doors|Keen start interaction with gem holders/ walk-in doors]]
$0CDEW #[[Patch:Keen entering doors|Keen attempt to open V-door]]
$0CFCW #[[Patch:Keen entering doors|Keen fail to open V-door (Unused)]]
$0D1AW #[[Patch:Keen entering doors|Keen walks into door 1]]
$0D38W #[[Patch:Keen entering doors|Keen walks into door 2]]
$0D56W #[[Patch:Keen entering doors|Keen walks into door 3]]
$0D74W #[[Patch:Keen entering doors|Keen walks into door 4]]
$0D92W #[[Patch:Keen entering doors|Keen walks into door 5]]
$0DB0W #[[Patch:Keen entering doors|Keen walks into door 6]]
$0DCEW #[[Patch:Keen on poles|Keen still on a pole]]
$0DECW #[[Patch:Keen on poles|Keen going up a pole]]
$0E0AW #[[Patch:Keen on poles|Keen going up a pole]]
$0E28W #[[Patch:Keen on poles|Keen going up a pole]]
$0E46W #[[Patch:Keen on poles|Keen going down a pole]]
$0E64W #[[Patch:Keen on poles|Keen going down a pole]]
$0E82W #[[Patch:Keen on poles|Keen going down a pole]]
$0EA0W #[[Patch:Keen on poles|Keen going down a pole]]
$0EBEW #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally on a pole start]]
$0EDCW #[[Patch:Keen shooting (Galaxy)|Keen shooting horizontally on a pole]]
$0EFAW #[[Patch:Keen shooting (Galaxy)|Keen shoots up on pole start]]
$0F18W #[[Patch:Keen shooting (Galaxy)|Keen shoots up on pole]]
$0F36W #[[Patch:Keen shooting (Galaxy)|Keen shooting down on a pole start]]
$0F54W #[[Patch:Keen shooting (Galaxy)|Keen shooting down on a pole]]
$0F72W #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0F90W #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0FAEW #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0FCCW #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0FEAW #[[Patch:Keen pogoing (Galaxy)|Keen start pogoing]]
$1008W #[[Patch:Keen pogoing (Galaxy)|Keen pogoing]]
$1026W #[[Patch:Keen pogoing (Galaxy)|Keen pogo bouncing]]
$1044W #[[Patch:Keen jumping (Galaxy)|Keen jumping 1]]
$1062W #[[Patch:Keen jumping (Galaxy)|Keen jumping 2]]
$1080W #[[Patch:Keen jumping (Galaxy)|Keen falling 1]]
$109EW #[[Patch:Keen jumping (Galaxy)|Keen falling 2]]
$10BCW #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally in air start]]
$10DAW #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally in air (Make shot)]]
$10F8W #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally in air]]
$1116W #[[Patch:Keen shooting (Galaxy)|Keen shoot up in air start]]
$1134W #[[Patch:Keen shooting (Galaxy)|Keen shoot up in air (Make shot)]]
$1152W #[[Patch:Keen shooting (Galaxy)|Keen shoot up in air]]
$1170W #[[Patch:Keen shooting (Galaxy)|Keen shoot down in air start]]
$118EW #[[Patch:Keen shooting (Galaxy)|Keen shoot down in air (Make shot)]]
$11ACW #[[Patch:Keen shooting (Galaxy)|Keen shoot down in air]]
$11CAW #[[Patch:Keen grabs ledge|Keen gripping ledge start]]
$11E8W #[[Patch:Keen grabs ledge|Keen gripping ledge]]
$1206W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 1]]
$1224W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 2]]
$1242W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 3]]
$1260W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledgegripping 4]]
$127EW #[[Patch:Keen grabs ledge|Keen stands back up]]
$133EW #[[Patch:Demo Sign|Invisible demo sign]]
$135CW #[[Patch:Demo Sign|Demo sign]]
$137AW #[[Patch:Keen_on_map_(Galaxy)|Map Keen standing (clear walking animations)]]
$1398W #[[Patch:Keen_on_map_(Galaxy)|Map Keen wait (Maintain existing animation until keypress)]]
$13B6W #[[Patch:Keen_on_map_(Galaxy)|Map Keen wave 1]]
$13D4W #[[Patch:Keen_on_map_(Galaxy)|Map Keen wave 2]]
$13F2W #[[Patch:Keen_on_map_(Galaxy)|Map Keen wave 3]]
$1410W #[[Patch:Keen_on_map_(Galaxy)|Map Keen wave 4]]
$142EW #[[Patch:Keen_on_map_(Galaxy)|Map Keen wave 5]]
$144CW #[[Patch:Keen_on_map_(Galaxy)|Map Keen moving]]
$148AW #[[Patch:Flags|Keen K flag waving 1]]
$14A8W #[[Patch:Flags|Keen K flag waving 2]]
$14C6W #[[Patch:Flags|Keen K flag waving 3]]
$14E4W #[[Patch:Flags|Keen K flag waving 4]]
$1502W #[[Patch:Keen's_shot_(Galaxy)|Keen's shot 1]]
$1520W #[[Patch:Keen's_shot_(Galaxy)|Keen's shot 2]]
$153EW #[[Patch:Keen's_shot_(Galaxy)|Keen's shot 3]]
$155CW #[[Patch:Keen's_shot_(Galaxy)|Keen's shot 4]]
$157AW #[[Patch:Keen's_shot_(Galaxy)|Keen's shot smash 1]]
$1598W #[[Patch:Keen's_shot_(Galaxy)|Keen's shot smash 2]]
$15B6W #[[Patch:Keygem_door|Open door 1]]
$15D4W #[[Patch:Keygem_door|Open door 2]]
$15F2W #[[Patch:Keygem_door|Open door 3]]
$1610W #Open V-card door
$1946W #[[Patch:Items|Items 1]]
$1964W #[[Patch:Items|Items 2]]
$1982W #[[Patch:Items|Blooglet gem-type item 1 (Unused)]]
$19A0W #[[Patch:Items|Blooglet gem-type item 2 (Unused)]]
$19BEW #[[Patch:Items|Stuff got]]
$19DCW #[[Patch:Vitalin|Vitalin got 1]]
$19FAW #[[Patch:Vitalin|Vitalin got 2]]
$1A18W #[[Patch:Vitalin|Vitalin got 3]]
$1A36W #[[Patch:Vitalin|Vitalin got 4]]
$1A6EW #[[Patch:Teleporter_(Sprite)|Teleporter upper zap 1]]
$1A8CW #[[Patch:Teleporter_(Sprite)|Teleporter upper zap 2]]
$1AAAW #[[Patch:Teleporter_(Sprite)|Teleporter lower zap 1]]
$1AC8W #[[Patch:Teleporter_(Sprite)|Teleporter lower zap 2]]
$1AE6W #[[Patch:Q.E.D_(Sprite)|QED and fuse explosion 1]]
$1B04W #[[Patch:Q.E.D_(Sprite)|QED and fuse explosion 2]]
$1B22W #[[Patch:Q.E.D_(Sprite)|QED and fuse explosion 3]]
$1B40W #[[Patch:Q.E.D_(Sprite)|QED and fuse explosion 4 (Invisible, behavior sets up fuse\Q.E.D window\ending)]]
$1B5EW #[[Patch:Horizontal-Vertical Platform (Keen 5)|Horizontal-Vertical Red Platform]]
$1B7CW #[[Patch:Horizontal-Vertical Platform (Keen 5)|Horizontal-Vertical Purple Platform 1]]
$1B9AW #[[Patch:Horizontal-Vertical Platform (Keen 5)|Horizontal-Vertical Purple Platform 2]]
$1BB8W #[[Patch:Dropping Platform (Keen 5)|Dropping Red Platform sit]]
$1BD6W #[[Patch:Dropping Platform (Keen 5)|Dropping Red Platform fall]]
$1BF4W #[[Patch:Dropping Platform (Keen 5)|Dropping Red Platform rise]]
$1C12W #[[Patch:Sitting Platform (Keen 5)|Sitting Red Platform]]
$1C30W #[[Patch:Goplat (Keen 5)|Red Goplat]]
$1C4EW #[[Patch:Goplat (Keen 5)|Purple Goplat 1]]
$1C6CW #[[Patch:Goplat (Keen 5)|Purple Goplat 2]]
$1CCCW #[[Patch:Volte-face|Volte-Face 1]]
$1CEAW #[[Patch:Volte-face|Volte-Face 2]]
$1D08W #[[Patch:Volte-face|Volte-Face 3]]
$1D26W #[[Patch:Volte-face|Volte-Face 4]]
$1D44W #[[Patch:Volte-face|Volte-Face stunned]]
$1DA4W #[[Patch:Sneaky Platform (Keen 5)|Sneaky Platform wait]]
$1DC2W #[[Patch:Sneaky Platform (Keen 5)|Sneaky Platform flee]]
$1DE0W #[[Patch:Sneaky Platform (Keen 5)|Sneaky Platform return]]
$1DFEW #[[Patch:Enemy_shooter_(Keen_5)|Gun wait]]
$1E1CW #[[Patch:Enemy_shooter_(Keen_5)|Gun make shot]]
$1E3AW #[[Patch:Enemy_shooter_(Keen_5)|Pink shot 1]]
$1E58W #[[Patch:Enemy_shooter_(Keen_5)|Pink shot 2]]
$1E76W #[[Patch:Enemy_shooter_(Keen_5)|Pink shot 3]]
$1E94W #[[Patch:Enemy_shooter_(Keen_5)|Pink shot 4]]
$1EB2W #[[Patch:Enemy_shooter_(Keen_5)|Pink shot zaps 1]]
$1ED0W #[[Patch:Enemy_shooter_(Keen_5)|Pink shot zaps 2]]
$1F0CW #[[Patch:Sparky|Sparky walk 1]]
$1F2AW #[[Patch:Sparky|Sparky walk 2]]
$1F48W #[[Patch:Sparky|Sparky walk 3]]
$1F66W #[[Patch:Sparky|Sparky walk 4]]
$1F84W #[[Patch:Sparky|Sparky look 1]]
$1FA2W #[[Patch:Sparky|Sparky look 2]]
$1FC0W #[[Patch:Sparky|Sparky look 3]]
$1FDEW #[[Patch:Sparky|Sparky look 4]]
$1FFCW #[[Patch:Sparky|Sparky look 5]]
$201AW #[[Patch:Sparky|Sparky look 6]]
$2038W #[[Patch:Sparky|Sparky look 7]]
$2056W #[[Patch:Sparky|Sparky look 8]]
$2074W #[[Patch:Sparky|Sparky prepare to charge 1]]
$2092W #[[Patch:Sparky|Sparky prepare to charge 2]]
$20B0W #[[Patch:Sparky|Sparky prepare to charge 3]]
$20CEW #[[Patch:Sparky|Sparky prepare to charge 4]]
$20ECW #[[Patch:Sparky|Sparky charge 1]]
$210AW #[[Patch:Sparky|Sparky charge 2]]
$2128W #[[Patch:Sparky|Sparky charge 3]]
$2146W #[[Patch:Sparky|Sparky charge 4]]
$2164W #[[Patch:Sparky|Sparky turn 1]]
$2182W #[[Patch:Sparky|Sparky turn 2]]
$21A0W #[[Patch:Sparky|Sparky turn 3]]
$21BEW #[[Patch:Sparky|Stunned Sparky]]
$21DCW #[[Patch:Little_Ampton|Lil Ampton walk 1]]
$21FAW #[[Patch:Little_Ampton|Lil Ampton walk 2]]
$2218W #[[Patch:Little_Ampton|Lil Ampton walk 3]]
$2236W #[[Patch:Little_Ampton|Lil Ampton walk 4]]
$2254W #[[Patch:Little_Ampton|Lil Ampton turn]]
$2272W #[[Patch:Little_Ampton|Lil Ampton start pole slide 1]]
$2290W #[[Patch:Little_Ampton|Lil Ampton start pole slide 2]]
$22AEW #[[Patch:Little_Ampton|Lil Ampton pole slide]]
$22CCW #[[Patch:Little_Ampton|Lil Ampton stop pole slide 1]]
$22EAW #[[Patch:Little_Ampton|Lil Ampton stop pole slide 2]]
$2308W #[[Patch:Little_Ampton|Lil Ampton flip switch 1]]
$2326W #[[Patch:Little_Ampton|Lil Ampton flip switch 2]]
$2344W #[[Patch:Little_Ampton|Lil Ampton flip switch 3]]
$2362W #[[Patch:Little_Ampton|Lil Ampton flip switch 4]]
$2380W #[[Patch:Little_Ampton|Lil Ampton flip switch 5]]
$239EW #[[Patch:Little_Ampton|Stunned Ampton]]
$23BCW #[[Patch:Slicestar|u/d/horizontally Slicestar]]
$23DAW #[[Patch:Slicestar|Bouncy Slicestar]]
$23F8W #[[Patch:Slicestar|lSlicestar smashed]]
$2416W #[[Patch:Shelly|Shelly walk]]
$2434W #[[Patch:Shelly|Shelly walk]]
$2452W #[[Patch:Shelly|Shelly walk]]
$2470W #[[Patch:Shelly|Shelly walk]]
$248EW #[[Patch:Shelly|Shelly prepare to jump]]
$24ACW #[[Patch:Shelly|Shelly jump]]
$24CAW #[[Patch:Shelly|Shelly fall]]
$24E8W #[[Patch:Shelly|Shelly fall]]
$2506W #[[Patch:Shelly|Shelly smash]]
$2524W #[[Patch:Shelly|Shelly smash]]
$2542W #[[Patch:Shelly|Shelly smash smoke]]
$2560W #[[Patch:Shelly|Shelly smash smoke]]
$257EW #[[Patch:Shelly|Shelly smash smoke]]
$259CW #[[Patch:Shelly|Shelly smash smoke]]
$25BAW #[[Patch:Shelly|Shelly fragments]]
$25D8W #[[Patch:Shelly|Shelly fragments]]
$2608W #[[Patch:Shikadi Mine|Shikadi mine sit]]
$2626W #[[Patch:Shikadi Mine|Shikadi mine move]]
$2644W #[[Patch:Shikadi Mine|Shikadi mine change direction]]
$2662W #[[Patch:Shikadi Mine|Shikadi mine detonate]]
$2680W #[[Patch:Shikadi Mine|Shikadi mine detonate]]
$269EW #[[Patch:Shikadi Mine|Shikadi mine detonate]]
$26BCW #[[Patch:Shikadi Mine|Shikadi mine detonate]]
$26DAW #[[Patch:Shikadi Mine|Shikadi mine detonate]]
$26F8W #[[Patch:Shikadi Mine|Shikadi mine detonate]]
$2716W #[[Patch:Shikadi Mine|Shikadi mine fragments]]
$2734W #[[Patch:Robo Red|Robo Red move]]
$2752W #[[Patch:Robo Red|Robo Red pause before shooting]]
$2770W #[[Patch:Robo Red|Robo Red shoot]]
$278EW #[[Patch:Robo Red|Robo Red shoot (Make shot)]]
$27ACW #[[Patch:Robo Red|Robo Red's shot]]
$27CAW #[[Patch:Robo Red|Robo Red's shot]]
$27E8W #[[Patch:Robo Red|Robo Red's shot smash]]
$2806W #[[Patch:Robo Red|Robo Red's shot smash]]
$2824W #[[Patch:Spirogrip|Spirogrip pause down]]
$2842W #[[Patch:Spirogrip|Spirogrip reverse down (Move up)]]
$2860W #[[Patch:Spirogrip|Spirogrip pause left]]
$287EW #[[Patch:Spirogrip|Spirogrip reverse left (Move right)]]
$289CW #[[Patch:Spirogrip|Spirogrip pause up]]
$28BAW #[[Patch:Spirogrip|Spirogrip reverse up]]
$28D8W #[[Patch:Spirogrip|Spirogrip pause right]]
$28F6W #[[Patch:Spirogrip|Spirogrip reverse right]]
$2914W #[[Patch:Spirogrip|Spirogrip spin 1]]
$2932W #[[Patch:Spirogrip|Spirogrip spin 2]]
$2950W #[[Patch:Spirogrip|Spirogrip spin 3]]
$296EW #[[Patch:Spirogrip|Spirogrip spin 4]]
$298CW #[[Patch:Spirogrip|Spirogrip spin 5]]
$29AAW #[[Patch:Spirogrip|Spirogrip spin 6]]
$29C8W #[[Patch:Spirogrip|Spirogrip spin 7]]
$29E6W #[[Patch:Spirogrip|Spirogrip spin 8]]
$2A04W #[[Patch:Spirogrip|Spirogrip move down]]
$2A22W #[[Patch:Spirogrip|Spirogrip move left]]
$2A40W #[[Patch:Spirogrip|Spirogrip move up]]
$2A5EW #[[Patch:Spirogrip|Spirogrip move right]]
$2A7CW #[[Patch:Spindred|Spindred 1]]
$2A9AW #[[Patch:Spindred|Spindred 2]]
$2AB8W #[[Patch:Spindred|Spindred 3]]
$2AD6W #[[Patch:Spindred|Spindred 4]]
$2AF4W #[[Patch:Shikadi Master|Shikadi Master stand 1]]
$2B12W #[[Patch:Shikadi Master|Shikadi Master stand 2]]
$2B30W #[[Patch:Shikadi Master|Shikadi Master stand 3]]
$2B4EW #[[Patch:Shikadi Master|Shikadi Master stand 4]]
$2B6CW #[[Patch:Shikadi Master|Shikadi Master shoot]]
$2B8AW #[[Patch:Shikadi Master|Shikadi Master shoot (Make shot)]]
$2BA8W #[[Patch:Shikadi Master|Shikadi Master teleport 1]]
$2BC6W #[[Patch:Shikadi Master|Shikadi Master teleport 2 (make groundsparks, vanish)]]
$2BE4W #[[Patch:Shikadi Master|Shikadi Master teleport 3 (reappear, fall)]]
$2C02W #[[Patch:Shikadi Master|Shikadi Master teleport 4]]
$2C20W #[[Patch:Shikadi Master|Shikadi Master's shot 1]]
$2C3EW #[[Patch:Shikadi Master|Shikadi Master's shot 2]]
$2C5CW #[[Patch:Shikadi Master|Shikadi Master's shot 3]]
$2C7AW #[[Patch:Shikadi Master|Shikadi Master's shot 4]]
$2C98W #[[Patch:Shikadi Master|Shikadi Master sparks 1]]
$2CB6W #[[Patch:Shikadi Master|Shikadi Master sparks 2]]
$2CD4W #[[Patch:Shikadi Master|Shikadi Master sparks 3]]
$2CF2W #[[Patch:Shikadi Master|Shikadi Master sparks 4]]
$2D10W #[[Patch:Shikadi|Shikadi stand]]
$2D2EW #[[Patch:Shikadi|Shikadi stand]]
$2D4CW #[[Patch:Shikadi|Shikadi stand]]
$2D6AW #[[Patch:Shikadi|Shikadi stand]]
$2D88W #[[Patch:Shikadi|Shikadi walk]]
$2DA6W #[[Patch:Shikadi|Shikadi walk]]
$2DC4W #[[Patch:Shikadi|Shikadi walk]]
$2DE2W #[[Patch:Shikadi|Shikadi walk]]
$2E00W #[[Patch:Shikadi|Shikadi polezaps]]
$2E1EW #[[Patch:Shikadi|Shikadi polezaps]]
$2E3CW #[[Patch:Shikadi|Shikadi stunned]]
$2E5AW #[[Patch:Shikadi|Shikadi polezap]]
$2E78W #[[Patch:Shikadi|Shikadi polezap]]
$2E96W #[[Patch:Shockshund|Shocksund sit 1]]
$2EB4W #[[Patch:Shockshund|Shocksund sit 2]]
$2ED2W #[[Patch:Shockshund|Shocksund bark 1]]
$2EF0W #[[Patch:Shockshund|Shocksund bark 2]]
$2F0EW #[[Patch:Shockshund|Shocksund walk 1]]
$2F2CW #[[Patch:Shockshund|Shocksund walk 2]]
$2F4AW #[[Patch:Shockshund|Shocksund walk 3]]
$2F68W #[[Patch:Shockshund|Shocksund walk 4]]
$2F86W #[[Patch:Shockshund|Shocksund jump]]
$2FA4W #[[Patch:Shockshund|Shocksund's shot 1]]
$2FC2W #[[Patch:Shockshund|Shocksund's shot 2]]
$2FE0W #[[Patch:Shockshund|Shocksund's shot smash 1]]
$2FFEW #[[Patch:Shockshund|Shocksund's shot smash 2]]
$301CW #[[Patch:Shockshund|Shocksund stunned]]
$303AW #[[Patch:Sphereful|Sphereful]]
$3058W #[[Patch:Sphereful|Sphereful]]
$3076W #[[Patch:Sphereful|Sphereful]]
$3094W #[[Patch:Sphereful|Sphereful]]
$30B2W #[[Patch:Sphereful|Sphereful]]
$30D2W #[[Patch:Korath|Korath walking]]
$30F0W #[[Patch:Korath|Korath walking]]
$310EW #[[Patch:Korath|Korath walking]]
$312CW #[[Patch:Korath|Korath walking]]
$314AW #[[Patch:Korath|Korath sit]]
$3168W #[[Patch:Korath|Korath stunned]]
$3186W #[[Patch:Q.E.D_(Sprite)|QED\Fuse counter]]

=== Keen 6 sprite actions ===

$0000W #Null action (Vanish)
$089AW #Keen standing
$08B8W #[[Patch:Keen bored|Keen look up (Bored)]]
$08D6W #[[Patch:Keen bored|Keen bored, hands on hips, looks at player]]
$08F4W #[[Patch:Keen bored|Keen hands on hips, blinks]]
$0912W #[[Patch:Keen bored|Keen hands on hips, looks at player 2]]
$0930W #[[Patch:Keen bored|Keen hands on hips, blinks 2]]
$094EW #[[Patch:Keen bored|Keen hands on hips, looks at player 3]]
$096CW #[[Patch:Keen bored|Keen shrugs]]
$098AW #[[Patch:Keen bored|Keen gets out book 1]]
$09A8W #[[Patch:Keen bored|Keen gets out book 2]]
$09C6W #[[Patch:Keen bored|Keen gets out book 3]]
$09E4W #[[Patch:Keen bored|Keen gets out book 4]]
$0A02W #[[Patch:Keen bored|Keen reads book]]
$0A20W #[[Patch:Keen bored|Keen bored, looks up from book 1]]
$0A3EW #[[Patch:Keen bored|Keen bored, looks up from book 2]]
$0A5CW #[[Patch:Keen bored|Keen stops reading book 1]]
$0A7AW #[[Patch:Keen bored|Keen stops reading book 2]]
$0A98W #[[Patch:Keen bored|Keen stops reading book 3]]
$0AB6W #[[Patch:Keen look|Keen start looking up]]
$0AD4W #[[Patch:Keen look|Keen looking up]]
$0AF2W #[[Patch:Keen look|Keen start looking down]]
$0B10W #[[Patch:Keen look|Keen looking down 1]]
$0B2EW #[[Patch:Keen look|Keen looking down 2]]
$0B4CW #[[Patch:Keen look|Keen stop looking down]]
$0B6AW #[[Patch:Keen look|Keen jump down from one-way-up platforms (Unused)]]
$0B88W #[[Patch:Keen dying (Keen 6)|Defunct dead action]]
$0BA6W #[[Patch:Keen dying (Keen 6)|Keen dies clutched (Exits level if offscreen.)]]
$0BC4W #[[Patch:Keen dying (Keen 6)|Keen dies sprawled (Exits level if offscreen.)]]
$0BE2W #[[Patch:Keen shooting (Galaxy)|Keen shoots horizontally 1]]
$0C00W #[[Patch:Keen shooting (Galaxy)|Keen shoots horizontally 2]]
$0C1EW #[[Patch:Keen shooting (Galaxy)|Keen shoots up 1]]
$0C3CW #[[Patch:Keen shooting (Galaxy)|Keen shoots up 2]]
$0C5AW #Keen places gem
$0C78W #Keen places gem
$0C96W #Keen places gem and opens door
$0CB4W #Keen adjust position
$0CD2W #[[Patch:Keen entering doors|Keen walks into door 1]]
$0CF0W #[[Patch:Keen entering doors|Keen walks into door 2]]
$0D0EW #[[Patch:Keen entering doors|Keen walks into door 3]]
$0D2CW #[[Patch:Keen entering doors|Keen walks into door 4]]
$0D4AW #[[Patch:Keen entering doors|Keen walks into door 5]]
$0D68W #[[Patch:Keen on poles|Keen sit on a pole]]
$0D86W #[[Patch:Keen on poles|Keen moving up a pole]]
$0DA4W #[[Patch:Keen on poles|Keen moving up a pole]]
$0DC2W #[[Patch:Keen on poles|Keen moving up a pole]]
$0DE0W #[[Patch:Keen on poles|Keen moving down a pole]]
$0DFEW #[[Patch:Keen on poles|Keen moving down a pole]]
$0E1CW #[[Patch:Keen on poles|Keen moving down a pole]]
$0E3AW #[[Patch:Keen on poles|Keen moving down a pole]]
$0E58W #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally on a pole 1]]
$0E76W #[[Patch:Keen shooting (Galaxy)|Keen shoot horizontally on a pole 2]]
$0E94W #[[Patch:Keen shooting (Galaxy)|Keen shoot up on a pole 1]]
$0EB2W #[[Patch:Keen shooting (Galaxy)|Keen shoot up on a pole 2]]
$0ED0W #[[Patch:Keen shooting (Galaxy)|Keen shoot down on a pole 1]]
$0EEEW #[[Patch:Keen shooting (Galaxy)|Keen shoot down on a pole 2]]
$0F0CW #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0F2AW #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0F48W #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0F66W #[[Patch:Keen walking (Galaxy)|Keen walking]]
$0F84W #[[Patch:Keen pogoing (Galaxy)|Keen start pogoing]]
$0FA2W #[[Patch:Keen pogoing (Galaxy)|Keen pogoing]]
$0FC0W #[[Patch:Keen pogoing (Galaxy)|Keen pogo bouncing]]
$0FDEW #[[Patch:Keen jumping (Galaxy)|Keen jumping 1]]
$0FFCW #[[Patch:Keen jumping (Galaxy)|Keen jumping 2]]
$101AW #[[Patch:Keen jumping (Galaxy)|Keen falling 1]]
$1038W #[[Patch:Keen jumping (Galaxy)|Keen falling 2]]
$1056W #[[Patch:Keen shooting (Galaxy)|Keen shoots horizontally in air 1]]
$1074W #[[Patch:Keen shooting (Galaxy)|Keen shoots horizontally in air 2]]
$1092W #[[Patch:Keen shooting (Galaxy)|Keen shoots horizontally in air 3]]
$10B0W #[[Patch:Keen shooting (Galaxy)|Keen shoots up in air 1]]
$10CEW #[[Patch:Keen shooting (Galaxy)|Keen shoots up in air 2]]
$10ECW #[[Patch:Keen shooting (Galaxy)|Keen shoots up in air 3]]
$110AW #[[Patch:Keen shooting (Galaxy)|Keen shoots down in air 1]]
$1128W #[[Patch:Keen shooting (Galaxy)|Keen shoots down in air 2]]
$1146W #[[Patch:Keen shooting (Galaxy)|Keen shoots down in air 3]]
$1164W #[[Patch:Keen grabs ledge|Keen gripping ledge start]]
$1182W #[[Patch:Keen grabs ledge|Keen gripping ledge]]
$11A0W #[[Patch:Keen grabs ledge|Keen pulls himself up from ledges]]
$11BEW #[[Patch:Keen grabs ledge|Keen pulls himself up from ledges]]
$11DCW #[[Patch:Keen grabs ledge|Keen pulls himself up from ledges]]
$11FAW #[[Patch:Keen grabs ledge|Keen pulls himself up from ledges]]
$1218W #[[Patch:Keen grabs ledge|Keen standing after ledgegrip]]
$130AW #[[Patch:Keen_on_map_(Galaxy)|Map Keen stand]]
$1328W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waves]]
$1346W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waves]]
$1364W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waves]]
$1382W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waves]]
$13A0W #[[Patch:Keen_on_map_(Galaxy)|Map Keen waves]]
$13BEW #[[Patch:Keen_on_map_(Galaxy)|Map Keen moving]]
$13F4W #[[Patch:Flags|Keen K flag waving]]
$1412W #[[Patch:Flags|Keen K flag waving]]
$1430W #[[Patch:Flags|Keen K flag waving]]
$144EW #[[Patch:Flags|Keen K flag waving]]
$146CW #[[Patch:Flags|Keen K flag to holder]]
$148AW #[[Patch:Flags|Keen K flag to holder]]
$14A8W #[[Patch:Flags|Keen K flag to holder]]
$14C6W #[[Patch:Flags|Keen K flag to holder]]
$14E4W #[[Patch:Flags|Keen K flag to holder]]
$1502W #[[Patch:Flags|Keen K flag to holder]]
$1520W #[[Patch:Flags|Keen K flag to holder]]
$153EW #[[Patch:Keen's_shot_(Galaxy)|Keen's shot]]
$155CW #[[Patch:Keen's_shot_(Galaxy)|Keen's shot]]
$157AW #[[Patch:Keen's_shot_(Galaxy)|Keen's shot]]
$1598W #[[Patch:Keen's_shot_(Galaxy)|Keen's shot]]
$15B6W #[[Patch:Keen's_shot_(Galaxy)|Keen's shot hits]]
$15D4W #[[Patch:Keen's_shot_(Galaxy)|Keen's shot hits]]
$15F2W #[[Patch:Keygem_door|Door open 1]]
$1610W #[[Patch:Keygem_door|Door open 2]]
$162EW #[[Patch:Keygem_door|Door open 3]]
$1868W #[[Patch:Keen stunned (Galaxy)|Keen stunned]]
$196AW #[[Patch:Items|Items 1]]
$1988W #[[Patch:Items|Items 2]]
$19A6W #[[Patch:Items|Blooglet Items 1]]
$19C4W #[[Patch:Items|Blooglet Items 2]]
$19E2W #[[Patch:Items|Items got]]
$1A00W #[[Patch:Items|Viva got 1]]
$1A1EW #[[Patch:Items|Viva got 2]]
$1A3CW #[[Patch:Items|Viva got 3]]
$1A5AW #[[Patch:Items|Viva got 4]]
$1A90W #[[Patch:Grabbiter|Grabbiter hungry 1]]
$1AAEW #[[Patch:Grabbiter|Grabbiter hungry 2]]
$1ACCW #[[Patch:Grabbiter|Grabbiter napping 1]]
$1AEAW #[[Patch:Grabbiter|Grabbiter napping 2]]
$1B08W #[[Patch:Bloogstar Rocket|Rocket sit]]
$1B26W #[[Patch:Bloogstar Rocket|Rocket flying]]
$1B44W #[[Patch:Bloogstar Rocket|Rocket flying]]
$1B62W #[[Patch:Bloogstar Rocket|Keen taking Rocket trip]]
$1B80W #[[Patch:Keen 6 map items|Climbable cliff (Invisible)]]
$1B9EW #[[Patch:Keen 6 map items|Keen throw rope]]
$1BBCW #[[Patch:Keen 6 map items|Keen throw rope]]
$1BDAW #[[Patch:Keen 6 map items|Keen climb rope]]
$1BF8W #[[Patch:Keen 6 map items|Keen climb rope]]
$1C16W #[[Patch:Keen 6 map items|Rope on map]]
$1C34W #[[Patch:Keen 6 map items|Rope being thrown]]
$1C52W #[[Patch:Satellite|Satellite dropoff point]]
$1C70W #[[Patch:Satellite|Keen hang from satellite]]
$1C8EW #[[Patch:Satellite|Satellite 1]]
$1CACW #[[Patch:Satellite|Satellite 2]]
$1CCAW #[[Patch:Satellite|Satellite 3]]
$1CE8W #[[Patch:Satellite|Satellite 4]]
$1D06W #[[Patch:Keen 6 map items|Sandwich]]
$1D24W #[[Patch:Keen 6 map items|Rope]]
$1D42W #[[Patch:Keen 6 map items|Card]]
$1D60W #[[Patch:Molly|Molly 1]]
$1D7EW #[[Patch:Molly|Molly 2]]
$1D9CW #[[Patch:Molly|Molly 3]]
$1DBAW #[[Patch:Molly|Molly 4]]
$1DD8W #[[Patch:Platform (Keen 6)|u/d/horizontally airboard]]
$1DF6W #[[Patch:Platform (Keen 6)|Drop/rise airboard sit]]
$1E14W #[[Patch:Platform (Keen 6)|Drop/rise airboard fall]]
$1E32W #[[Patch:Platform (Keen 6)|Drop/rise airboard rise]]
$1E50W #[[Patch:Platform (Keen 6)|Sit airboard]]
$1E6EW #[[Patch:Platform (Keen 6)|Info path airboard]]
$1E8CW #[[Patch:Platform (Keen 6)|Sneaky Airboard sit]]
$1EAAW #[[Patch:Platform (Keen 6)|Sneaky Airboard flee]]
$1EC8W #[[Patch:Platform (Keen 6)|Sneaky Airboard return]]
$1EE6W #[[Patch:Bloog|Bloog walking]]
$1F04W #[[Patch:Bloog|Bloog walking]]
$1F22W #[[Patch:Bloog|Bloog walking]]
$1F40W #[[Patch:Bloog|Bloog walking]]
$1F5EW #[[Patch:Bloog|Bloog stunned]]
$1F7CW #[[Patch:Blooguard|Blooguard walking]]
$1F9AW #[[Patch:Blooguard|Blooguard walking]]
$1FB8W #[[Patch:Blooguard|Blooguard walking]]
$1FD6W #[[Patch:Blooguard|Blooguard walking]]
$1FF4W #[[Patch:Blooguard|Blooguard clubbing]]
$2012W #[[Patch:Blooguard|Blooguard clubbing]]
$2030W #[[Patch:Blooguard|Blooguard clubbing]]
$204EW #[[Patch:Blooguard|Blooguard clubbing]]
$206CW #[[Patch:Blooguard|Blooguard stunned]]
$208AW #[[Patch:Blooglet|Red Blooglet running]]
$20A8W #[[Patch:Blooglet|Red Blooglet running]]
$20C6W #[[Patch:Blooglet|Red Blooglet running]]
$20E4W #[[Patch:Blooglet|Red Blooglet running]]
$2102W #[[Patch:Blooglet|Red Blooglet stunned]]
$2120W #[[Patch:Blooglet|Yellow Blooglet running]]
$213EW #[[Patch:Blooglet|Yellow Blooglet running]]
$215CW #[[Patch:Blooglet|Yellow Blooglet running]]
$217AW #[[Patch:Blooglet|Yellow Blooglet running]]
$2198W #[[Patch:Blooglet|Yellow Blooglet stunned]]
$21B6W #[[Patch:Blooglet|Blue Blooglet running]]
$21D4W #[[Patch:Blooglet|Blue Blooglet running]]
$21F2W #[[Patch:Blooglet|Blue Blooglet running]]
$2210W #[[Patch:Blooglet|Blue Blooglet running]]
$222EW #[[Patch:Blooglet|Blue Blooglet stunned]]
$224CW #[[Patch:Blooglet|Green Blooglet running]]
$226AW #[[Patch:Blooglet|Green Blooglet running]]
$2288W #[[Patch:Blooglet|Green Blooglet running]]
$22A6W #[[Patch:Blooglet|Green Blooglet running]]
$22C4W #[[Patch:Blooglet|Green Blooglet stunned]]
$2460W #[[Patch:Nospike|Nospike sit]]
$247EW #[[Patch:Nospike|Nospike walk 1]]
$249CW #[[Patch:Nospike|Nospike walk 2]]
$24BAW #[[Patch:Nospike|Nospike walk 3]]
$24D8W #[[Patch:Nospike|Nospike walk 4]]
$24F6W #[[Patch:Nospike|Nospike charge 1]]
$2514W #[[Patch:Nospike|Nospike charge 2]]
$2532W #[[Patch:Nospike|Nospike charge 3]]
$2550W #[[Patch:Nospike|Nospike charge 4]]
$256EW #[[Patch:Nospike|Nospike hanging in air]]
$258CW #[[Patch:Nospike|Nospike make a '?']]
$25AAW #[[Patch:Nospike|Nospike with '?']]
$25C8W #[[Patch:Nospike|Nospike fall (Will not hit ground unless it has Nospike property)]]
$25E6W #[[Patch:Nospike|Stunned Nospike]]
$2604W #[[Patch:Gik|Gik walking]]
$2622W #[[Patch:Gik|Gik walking]]
$2640W #[[Patch:Gik|Gik walking]]
$265EW #[[Patch:Gik|Gik jumping]]
$267CW #[[Patch:Gik|Gik slide 1]]
$269AW #[[Patch:Gik|Gik slide 2]]
$26B8W #[[Patch:Gik|Gik recover]]
$26F6W #[[Patch:Enemy shooter (Keen 6)|Enemy gun wait]]
$2714W #[[Patch:Enemy shooter (Keen 6)|Enemy gun shoot]]
$2732W #[[Patch:Enemy shooter (Keen 6)|Pink bullet 1]]
$2750W #[[Patch:Enemy shooter (Keen 6)|Pink bullet 2]]
$276EW #[[Patch:Enemy shooter (Keen 6)|Pink bullet 3]]
$278CW #[[Patch:Enemy shooter (Keen 6)|Pink bullet 4]]
$27AAW #[[Patch:Enemy shooter (Keen 6)|Pink bullet smash 1]]
$27C8W #[[Patch:Enemy shooter (Keen 6)|Pink bullet smash 2]]
$27E6W #[[Patch:Orbatrix|Orbatrix float 1]]
$2804W #[[Patch:Orbatrix|Orbatrix float 2]]
$2822W #[[Patch:Orbatrix|Orbatrix curls 1]]
$2840W #[[Patch:Orbatrix|Orbatrix curls 2]]
$285EW #[[Patch:Orbatrix|Orbatrix curls 3]]
$287CW #[[Patch:Orbatrix|Orbatrix uncurls 1]]
$289AW #[[Patch:Orbatrix|Orbatrix uncurls 2]]
$28B8W #[[Patch:Orbatrix|Orbatrix uncurls 3]]
$28D6W #[[Patch:Orbatrix|Orbatrix uncurls 4]]
$28F4W #[[Patch:Orbatrix|Orbatrix uncurls 5]]
$2912W #[[Patch:Orbatrix|Orbatrix uncurls 6]]
$2930W #[[Patch:Orbatrix|Orbatrix bounding 1]]
$294EW #[[Patch:Orbatrix|Orbatrix bounding 2]]
$296CW #[[Patch:Orbatrix|Orbatrix bounding 3]]
$298AW #[[Patch:Orbatrix|Orbatrix bounding 4]]
$29A8W #[[Patch:Bip|Bip standing]]
$29C6W #[[Patch:Bip|Bip walking 1]]
$29E4W #[[Patch:Bip|Bip walking 2]]
$2A02W #[[Patch:Bip|Bip walking 3]]
$2A20W #[[Patch:Bip|Bip walking 4]]
$2A3EW #[[Patch:Bip|Bip squished]]
$2A5CW #[[Patch:Bipship|Bipship moving horizontally]]
$2A7AW #[[Patch:Bipship|Bipship's shot]]
$2A98W #[[Patch:Bipship|Bipship turning 1]]
$2AB6W #[[Patch:Bipship|Bipship turning 2]]
$2AD4W #[[Patch:Bipship|Bipship turning 3]]
$2AF2W #[[Patch:Bipship|Bipship turning 4]]
$2B10W #[[Patch:Bipship|Bipship falling]]
$2B2EW #[[Patch:Bipship|Bipship crashing]]
$2B4CW #[[Patch:Bipship|Bipship wreckage]]
$2B6AW #[[Patch:Bipship|Bipship smoke 1]]
$2B88W #[[Patch:Bipship|Bipship smoke 2]]
$2BA6W #[[Patch:Flect|Flect standing]]
$2BC4W #[[Patch:Flect|Flect turning]]
$2BE2W #[[Patch:Flect|Flect walking 1]]
$2C00W #[[Patch:Flect|Flect walking 2]]
$2C1EW #[[Patch:Flect|Flect walking 3]]
$2C3CW #[[Patch:Flect|Flect walking 4]]
$2C5AW #[[Patch:Flect|Flect stunned]]
$2C78W #[[Patch:Fleex|Fleex walking 1]]
$2C96W #[[Patch:Fleex|Fleex walking 2]]
$2CB4W #[[Patch:Fleex|Fleex chasing 1]]
$2CD2W #[[Patch:Fleex|Fleex chasing 2]]
$2CF0W #[[Patch:Fleex|Fleex chasing 3]]
$2D0EW #[[Patch:Fleex|Fleex chasing 4]]
$2D2CW #[[Patch:Fleex|Fleex looking 1]]
$2D4AW #[[Patch:Fleex|Fleex looking 2]]
$2D68W #[[Patch:Fleex|Fleex stunned]]
$2D86W #[[Patch:Bobba|Bobba jump]]
$2DA4W #[[Patch:Bobba|Bobba fall]]
$2DC2W #[[Patch:Bobba|Bobba land]]
$2DE0W #[[Patch:Bobba|Bobba shoot]]
$2DFEW #[[Patch:Bobba|Bobba eye twinkle 1]]
$2E1CW #[[Patch:Bobba|Bobba eye twinkle 2]]
$2E3AW #[[Patch:Bobba|Bobba eye twinkle 3]]
$2E58W #[[Patch:Bobba|Bobba eye twinkle 4]]
$2E76W #[[Patch:Bobba|Bobba fireball 1]]
$2E94W #[[Patch:Bobba|Bobba fireball 2]]
$2EB2W #[[Patch:Bobba|Bobba fireball 3]]
$2ED0W #[[Patch:Bobba|Bobba fireball 4]]
$2EEEW #[[Patch:Bobba|Bobba fireball smash 1]]
$2F0CW #[[Patch:Bobba|Bobba fireball smash 2]]
$2F2AW #[[Patch:Bobba|Bobba fireball smash 3]]
$2F48W #[[Patch:Babobba|Babobba jump]]
$2F66W #[[Patch:Babobba|Babobba fall]]
$2F84W #[[Patch:Babobba|Babobba land]]
$2FA2W #[[Patch:Babobba|Babobba shoot]]
$2FC0W #[[Patch:Babobba|Babobba stunned]]
$2FDEW #[[Patch:Babobba|Babobba stunned and landed]]
$2FFCW #[[Patch:Babobba|Babobba napping 1]]
$301AW #[[Patch:Babobba|Babobba napping 2]]
$3038W #[[Patch:Babobba|Babobba napping 3]]
$3056W #[[Patch:Babobba|Babobba napping 4 (Asleep)]]
$3074W #[[Patch:Babobba|Babobba napping 5]]
$3092W #[[Patch:Babobba|Babobba napping 6]]
$30B0W #[[Patch:Babobba|Babobba napping 7 (Wake up)]]
$30CEW #[[Patch:Babobba|Babobba cinder tossed]]
$30ECW #[[Patch:Babobba|Babobba cinder landed 1]]
$310AW #[[Patch:Babobba|Babobba cinder landed 2]]
$3128W #[[Patch:Babobba|Babobba cinder dying 1]]
$3146W #[[Patch:Babobba|Babobba cinder dying 2]]
$3164W #[[Patch:Blorb|Blorb 1]]
$3182W #[[Patch:Blorb|Blorb 2]]
$31A0W #[[Patch:Blorb|Blorb 3]]
$31BEW #[[Patch:Ceilick|Ceilick waiting]]
$31DCW #[[Patch:Ceilick|Ceilick attack 1]]
$31FAW #[[Patch:Ceilick|Ceilick attack 2]]
$3218W #[[Patch:Ceilick|Ceilick attack 3]]
$3236W #[[Patch:Ceilick|Ceilick attack 4]]
$3254W #[[Patch:Ceilick|Ceilick attack 5]]
$3272W #[[Patch:Ceilick|Ceilick attack 6]]
$3290W #[[Patch:Ceilick|Ceilick attack 7]]
$32AEW #[[Patch:Ceilick|Ceilick attack 8]]
$32CCW #[[Patch:Ceilick|Ceilick attack 9]]
$32EAW #[[Patch:Ceilick|Ceilick attack 10]]
$3308W #[[Patch:Ceilick|Ceilick attack, hide]]
$3326W #[[Patch:Ceilick|Ceilick laugh 1]]
$3344W #[[Patch:Ceilick|Ceilick laugh 2]]
$3362W #[[Patch:Ceilick|Ceilick laugh 3]]
$3380W #[[Patch:Ceilick|Ceilick laugh 4]]
$339EW #[[Patch:Ceilick|Ceilick laugh 5]]
$33BCW #[[Patch:Ceilick|Ceilick laugh 6]]
$33DAW #[[Patch:Ceilick|Ceilick laugh 7]]
$33F8W #[[Patch:Ceilick|Ceilick laugh 8]]
$3416W #[[Patch:Ceilick|Ceilick laugh 9]]
$3434W #[[Patch:Ceilick|Ceilick stunned]]

=== Keen Dreams sprite actions ===

$0000W #Nothing at all
$0BB4W #???
$0BD2W #[[Patch:Keen's shot (Dreams)|Flower power thrown 1]]
$0BF0W #[[Patch:Keen's shot (Dreams)|Flower power thrown 2]]
$0C0EW #[[Patch:Boobus Bombs|Boobus bombs thrown 1]]
$0C2CW #[[Patch:Boobus Bombs|Boobus bombs thrown 2]]
$0C4AW #[[Patch:Boobus Bombs|Boobus Bomb explode 1]]
$0C68W #[[Patch:Boobus Bombs|Boobus Bomb explode 2]]
$0C86W #[[Patch:Boobus Bombs|Boobus Bomb explode 3]]
$0CA4W #[[Patch:Boobus Bombs|Boobus Bomb explode 4]]
$0CC2W #[[Patch:Boobus Bombs|Boobus Bomb explode 5]]
$0CE0W #[[Patch:Boobus Bombs|Boobus Bomb explode 6]]
$0CFEW #[[Patch:Keen's shot (Dreams)|Flower power thrown, blinking 1]]
$0D1CW #[[Patch:Keen's shot (Dreams)|Flower power thrown, blinking 2 (Invisible)]]
$0D3AW #[[Patch:Keen on map (Dreams)|Map Keen stand]]
$0D58W #[[Patch:Keen on map (Dreams)|Map Keen wave 1]]
$0D76W #[[Patch:Keen on map (Dreams)|Map Keen wave 2]]
$0D94W #[[Patch:Keen on map (Dreams)|Map Keen wave 3]]
$0DB2W #[[Patch:Keen on map (Dreams)|Map Keen wave 4]]
$0DD0W #[[Patch:Keen on map (Dreams)|Map Keen wave 5 (Goto nap)]]
$0DEEW #[[Patch:Keen on map (Dreams)|Map Keen nap 1]]
$0E0CW #[[Patch:Keen on map (Dreams)|Map Keen nap 2]]
$0E2AW #[[Patch:Keen on map (Dreams)|Map Keen nap 3 (Keep napping)]]
$0E48W #[[Patch:Keen on map (Dreams)|Map Keen moving]]
$0E7EW #[[Patch:Keen bored|Zzzz 1]]
$0E9CW #[[Patch:Keen bored|Zzzz 2]]
$0EBAW #[[Patch:Keen bored|Zzzz 3]]
$0ED8W [[Patch:Keen walking (Dreams)|#Keen stand]]
$0EF6W #[[Patch:Keen bored|Keen bored (Look up)]]
$0F14W #[[Patch:Keen bored|Keen bored (Yawn) 1]]
$0F32W #[[Patch:Keen bored|Keen bored (Yawn) 2]]
$0F50W #[[Patch:Keen bored|Keen bored (Yawn) 3]]
$0F6EW #[[Patch:Keen bored|Keen bored (Yawn) 4]]
$0F8CW #[[Patch:Keen bored|Keen bored (Blink-shrug) 1]]
$0FAAW #[[Patch:Keen bored|Keen bored (Blink-shrug) 2]]
$0FC8W #[[Patch:Keen bored|Keen bored (Blink-shrug) 3]]
$0FE6W #[[Patch:Keen bored|Keen bored (Blink-shrug) 4]]
$1004W #[[Patch:Keen bored|Keen bored (Blink-shrug) 5]]
$1022W #[[Patch:Keen bored|Keen bored (Blink-shrug) 6]]
$1040W #[[Patch:Keen bored|Keen bored (Nap) 1]]
$105EW #[[Patch:Keen bored|Keen bored (Nap) 2]]
$107CW #[[Patch:Keen bored|Keen bored (Nap) 3]]
$109AW #[[Patch:Keen bored|Keen bored (Nap) 4]]
$10B8W #[[Patch:Keen bored|Keen wake up]]
$10D6W #[[Patch:Keen dying (Dreams)|Keen die 1]]
$10F4W #[[Patch:Keen dying (Dreams)|Keen die 2]]
$1112W #[[Patch:Keen dying (Dreams)|Keen die 3]]
$1130W #[[Patch:Keen look|Keen look up]]
$114EW #[[Patch:Keen look|Keen crouch]]
$116CW #[[Patch:Keen look|Keen jump down from one-way-up platforms (Unused)]]
$118AW #[[Patch:Keen on poles|Keen sit on pole]]
$11A8W #[[Patch:Keen on poles|Keen climb up pole 1]]
$11C6W #[[Patch:Keen on poles|Keen climb up pole 2]]
$11E4W #[[Patch:Keen on poles|Keen climb up pole 3]]
$1202W #[[Patch:Keen on poles|Keen climb down pole 1]]
$1220W #[[Patch:Keen on poles|Keen climb down pole 2]]
$123EW #[[Patch:Keen on poles|Keen climb down pole 3]]
$125CW #[[Patch:Keen on poles|Keen climb down pole 4]]
$127AW #[[Patch:Keen shooting (Dreams)|Keen pole-throw horizontally 1]]
$1298W #[[Patch:Keen shooting (Dreams)|Keen pole-throw horizontally 2]]
$12B6W #[[Patch:Keen shooting (Dreams)|Keen pole-throw horizontally 3]]
$12D4W #[[Patch:Keen shooting (Dreams)|Keen pole-throw up 1]]
$12F2W #[[Patch:Keen shooting (Dreams)|Keen pole-throw up 2]]
$1310W #[[Patch:Keen shooting (Dreams)|Keen pole-throw up 3]]
$132EW #[[Patch:Keen shooting (Dreams)|Keen pole-throw down 1]]
$134CW #[[Patch:Keen shooting (Dreams)|Keen pole-throw down 2]]
$136AW #[[Patch:Keen shooting (Dreams)|Keen pole-throw down 3]]
$1388W #[[Patch:Keen walking (Dreams)|Keen walk 1]]
$13A6W #[[Patch:Keen walking (Dreams)|Keen walk 2]]
$13C4W #[[Patch:Keen walking (Dreams)|Keen walk 3]]
$13E2W #[[Patch:Keen walking (Dreams)|Keen walk 4]]
$1400W #[[Patch:Keen shooting (Dreams)|Keen throw horizontally 1]]
$141EW #[[Patch:Keen shooting (Dreams)|Keen throw horizontally 2]]
$143CW #[[Patch:Keen shooting (Dreams)|Keen throw horizontally 3]]
$145AW #[[Patch:Keen shooting (Dreams)|Keen throw horizontally 4]]
$1478W #[[Patch:Keen shooting (Dreams)|Keen throw up 1]]
$1496W #[[Patch:Keen shooting (Dreams)|Keen throw up 2]]
$14B4W #[[Patch:Keen shooting (Dreams)|Keen throw up 3]]
$14D2W #[[Patch:Keen jumping (Dreams)|Keen jump vertically 1]]
$14F0W #[[Patch:Keen jumping (Dreams)|Keen jump vertically 2]]
$150EW #[[Patch:Keen jumping (Dreams)|Keen jump vertically 3]]
$152CW #[[Patch:Keen jumping (Dreams)|Keen jump horizontally 1]]
$154AW #[[Patch:Keen jumping (Dreams)|Keen jump horizontally 2]]
$1568W #[[Patch:Keen jumping (Dreams)|Keen jump horizontally 3]]
$1586W #[[Patch:Keen shooting (Dreams)|Keen air-throw horizontally 1]]
$15A4W #[[Patch:Keen shooting (Dreams)|Keen air-throw horizontally 2]]
$15C2W #[[Patch:Keen shooting (Dreams)|Keen air-throw horizontally 3]]
$15E0W #[[Patch:Keen shooting (Dreams)|Keen air-throw up 1]]
$15FEW #[[Patch:Keen shooting (Dreams)|Keen air-throw up 2]]
$161CW #[[Patch:Keen shooting (Dreams)|Keen air-throw up 3]]
$163AW #[[Patch:Keen shooting (Dreams)|Keen air-throw down 1]]
$1658W #[[Patch:Keen shooting (Dreams)|Keen air-throw down 2]]
$1676W #[[Patch:Keen shooting (Dreams)|Keen air-throw down 3]]
$1732W #[[Patch:Doors (Dreams)|Door sit]]
$1750W #[[Patch:Doors (Dreams)|Door open]]
$176EW #[[Patch:Wilted Flower|Wilted flower 1]]
$178CW #[[Patch:Wilted Flower|Wilted flower 2]]
$17AAW #[[Patch:Wilted Flower|Wilted flower 3]]
$17C8W #[[Patch:Wilted Flower|Wilted flower 4]]
$17E6W #[[Patch:Wilted Flower|Wilted flower 5]]
$1804W #[[Patch:Wilted Flower|Wilted flower 6]]
$1822W #[[Patch:Wilted Flower|Wilting smoke 1]]
$1840W #[[Patch:Wilted Flower|Wilting smoke 2]]
$185EW #[[Patch:Wilted Flower|Wilting smoke 3]]
$187CW #[[Patch:Wilted Flower|Wilting smoke 4]]
$189AW #[[Patch:Wilted Flower|Recovery smoke 1]]
$18B8W #[[Patch:Wilted Flower|Recovery smoke 2]]
$18D6W #[[Patch:Wilted Flower|Recovery smoke 3]]
$18F4W #[[Patch:Wilted Flower|Recovery smoke 4]]
$1912W #[[Patch:Wilted Flower|Recovery smoke 5]]
$1930W #[[Patch:Wilted Flower|Recovery smoke 6]]
$194EW #[[Patch:Wilted Flower|Recovery smoke 7]]
$196CW #[[Patch:Items|Items]]
$198AW #[[Patch:Items|Items got]]
$19C0W #[[Patch:Broccolash|Broccolash run 1]]
$19DEW #[[Patch:Broccolash|Broccolash run 2]]
$19FCW #[[Patch:Broccolash|Broccolash run 3]]
$1A1AW #[[Patch:Broccolash|Broccolash run 4]]
$1A38W #[[Patch:Broccolash|Broccolash headslam 1]]
$1A56W #[[Patch:Broccolash|Broccolash headslam 2]]
$1A74W #[[Patch:Broccolash|Broccolash headslam 3]]
$1A92W #[[Patch:Broccolash|Broccolash headslam 4]]
$1AB0W #[[Patch:Broccolash|Broccolash headslam 5]]
$1ACEW #[[Patch:Broccolash|Broccolash headslam 6]]
$1AECW #[[Patch:Broccolash|Broccolash headslam 7]]
$1B0AW #[[Patch:Broccolash|Broccolash headslam 8]]
$1B28W #[[Patch:Broccolash|Broccolash headslam 9]]
$1B46W #[[Patch:Tomatooth|Tomatooth 1]]
$1B64W #[[Patch:Tomatooth|Tomatooth 2]]
$1B82W #[[Patch:Carrot_Courier|Carrot run 1]]
$1BA0W #[[Patch:Carrot_Courier|Carrot run 2]]
$1BBEW #[[Patch:Carrot_Courier|Carrot run 3]]
$1BDCW #[[Patch:Carrot_Courier|Carrot run 4]]
$1BFAW #[[Patch:Carrot_Courier|Carrot jump]]
$1C18W #[[Patch:Asparagusto|Asparagusto run 1]]
$1C36W #[[Patch:Asparagusto|Asparagusto run 2]]
$1C54W #[[Patch:Asparagusto|Asparagusto run 3]]
$1C72W #[[Patch:Asparagusto|Asparagusto run 4]]
$1C90W #[[Patch:Grape|Grape wait]]
$1CAEW #[[Patch:Grape|Grape fall]]
$1CCCW #[[Patch:Grape|Grape rise]]
$1CEAW #[[Patch:Grape|Grape stop]]
$1D08W #[[Patch:Tater_Trooper|Tater walk 1]]
$1D26W #[[Patch:Tater_Trooper|Tater walk 2]]
$1D44W #[[Patch:Tater_Trooper|Tater walk 3]]
$1D62W #[[Patch:Tater_Trooper|Tater walk 4]]
$1D80W #[[Patch:Tater_Trooper|Tater stab 1]]
$1D9EW #[[Patch:Tater_Trooper|Tater stab 2]]
$1DBCW #[[Patch:Tater_Trooper|Tater stab 3]]
$1DDAW #[[Patch:Minecart|Minecart 1]]
$1DF8W #[[Patch:Minecart|Minecart 2]]
$1E16W #[[Patch:Frenchy|Frenchy walking horizontally 1]]
$1E34W #[[Patch:Frenchy|Frenchy walking horizontally 2]]
$1E52W #[[Patch:Frenchy|Frenchy walking horizontally 3]]
$1E70W #[[Patch:Frenchy|Frenchy walking horizontally 4]]
$1E8EW #[[Patch:Frenchy|Frenchy charging horizontally 1]]
$1EACW #[[Patch:Frenchy|Frenchy charging horizontally 2]]
$1ECAW #[[Patch:Frenchy|Frenchy charging horizontally 3]]
$1EE8W #[[Patch:Frenchy|Frenchy charging horizontally 4]]
$1F06W #[[Patch:Frenchy|Frenchy tossing chip 1]]
$1F24W #[[Patch:Frenchy|Frenchy tossing chip 2]]
$1F42W #[[Patch:Frenchy|Frenchy tossing chip 3]]
$1F60W #[[Patch:Frenchy|Frenchy's chip 1]]
$1F7EW #[[Patch:Frenchy|Frenchy's chip 2]]
$1F9CW #[[Patch:Melon Lips|Horizontal melon wait]]
$1FBAW #[[Patch:Melon Lips|Horizontal melon spit]]
$1FD8W #[[Patch:Melon Lips|Horizontal melon return]]
$1FF6W #[[Patch:Melon Lips|Down melon wait]]
$2014W #[[Patch:Melon Lips|Down melon spit]]
$2032W #[[Patch:Melon Lips|Down melon return]]
$2050W #[[Patch:Melon Lips|Horizontal pip 1]]
$206EW #[[Patch:Melon Lips|Horizontal pip 2]]
$208CW #[[Patch:Melon Lips|Down pip 1]]
$20AAW #[[Patch:Melon Lips|Down pip 2]]
$20C8W #[[Patch:Squasher|Squash walk 1]]
$20E6W #[[Patch:Squasher|Squash walk 2]]
$2104W #[[Patch:Squasher|Squash jump]]
$2122W #[[Patch:Squasher|Squash fall]]
$2140W #[[Patch:Squasher|Squash land]]
$215EW #[[Patch:Apel|Apel walk 1]]
$217CW #[[Patch:Apel|Apel walk 2]]
$219AW #[[Patch:Apel|Apel walk 3]]
$21B8W #[[Patch:Apel|Apel poleclimb up 1]]
$21D6W #[[Patch:Apel|Apel poleclimb up 2]]
$21F4W #[[Patch:Apel|Apel poleclimb down 1]]
$2212W #[[Patch:Apel|Apel poleclimb down 2]]
$2230W #[[Patch:Apel|Apel poleclimb down 3]]
$224EW #[[Patch:Apel|Apel poleclimb down 4]]
$226CW #[[Patch:Apel|Apel fall]]
$228AW #[[Patch:Pea Brain|Pea fall]]
$22A8W #[[Patch:Pea Brain|Pea walk 1]]
$22C6W #[[Patch:Pea Brain|Pea walk 2]]
$22E4W #[[Patch:Pea Brain|Pea walk 3]]
$2302W #[[Patch:Pea Brain|Pea walk 4]]
$2320W #[[Patch:Pea Pod|Peapod walk 1]]
$233EW #[[Patch:Pea Pod|Peapod walk 2]]
$235CW #[[Patch:Pea Pod|Peapod walk 3]]
$237AW #[[Patch:Pea Pod|Peapod walk 4]]
$2398W #[[Patch:Pea Pod|Peapod spit 1]]
$23B6W #[[Patch:Pea Pod|Peapod spit 2]]
$23D4W #[[Patch:Boobus Tuber|Boobus walk 1]]
$23F2W #[[Patch:Boobus Tuber|Boobus walk 2]]
$2410W #[[Patch:Boobus Tuber|Boobus walk 3]]
$242EW #[[Patch:Boobus Tuber|Boobus walk 4]]
$244CW #[[Patch:Boobus Tuber|Boobus jump]]
$246AW #[[Patch:Boobus Tuber|Boobus die 1]]
$2488W #[[Patch:Boobus Tuber|Boobus die 2]]
$24A6W #[[Patch:Boobus Tuber|Boobus die 3]]
$24C4W #[[Patch:Boobus Tuber|Boobus death smoke 1]]
$24E2W #[[Patch:Boobus Tuber|Boobus death smoke 2]]
$2500W #[[Patch:Boobus Tuber|Boobus death smoke 3]]
$251EW #[[Patch:Boobus Tuber|Boobus death smoke 4]]
$253CW #[[Patch:Boobus Tuber|Boobus death smoke 5]]
$255AW #[[Patch:Boobus Tuber|Boobus death smoke 6]]

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Keen opening doors

2020-08-12T03:08:39Z

Levellass: Minor grammar tweaks

This page contains sprite patches relating to Keen as he opens [[Patch:Keygem door|keygem type doors.]] It does not contain patches relating to [[Patch:Keygems|keygems]], [[Patch:Tiles|keyholders]] or doors themselves.

= [[Patch:Sprite actions|Sprite Actions]] =

When Keen first contacts a keyholder tile the game will check to see if he is already performing the 'open door' action. If he is then it skips the code to start doing so to avoid an infinite loop. Next Keen turns away from the screen and adjusts his position so that he will align with the keyholder. This is required so Keen will properly register the door location. Finally, once in position, he will start his gem placing sequence.

The gem placing sequence is two actions long and afterwards Keen returns to standing. The second action is unnecessary and merely serves to lengthen the sequence. It is in fact shared with [[Patch:Keen Flipping Switches|Keen flipping switches sequence.]]

== Keen 4 ==

Actions:
$098CW #Keen standing
$0E00W #Keen pause after placing gem
$0E1EW #Keen placing gem
$0E3CW #Keen adjust position

<patch title="Keen 4">
#Check to see if Keen is already doing this
%patch $D19D [$0E1EW]

#Keen adjust position to holder
%patch $D1D3 [$0E3CW]

#Start door opening sequence
%patch $D1E8 [$0E1EW]

#Gem placing sequence
%patch $2FCAA [$0E00W]
%patch $2FC8C [$098CW]</patch>

= [[Patch:Sprite behavior|Sprite Behavior]] =

There is only one behavior relating to Keen placing a gem, it is used by the first placing action. The second action has no behavior and acts as a 'pauser' to lengthen the sequence.

Behaviors:
$0B800A34RL #Placing gem

<patch title="Keen 4 behaviors">
#Placing sequence
%patch $2FC9E $0B800A34RL
%patch $2FC80 $00000000L</patch>

== Behavior code ==

This is the complete placing gem behavior code. The first sections deals with the keyholder, reading the infoplane for the keyholder's destination. (This is 16 pixels or $00FFW up from keen's feet.) Starting at the end of line 5 the 'animate tile' code is run, animating the keyholder so it contains a gem. [[Patch:Sounds|Sound]] $12 is played on line 7. The rest of the code creates a door metasprite and places it in the level.

After being spawned on line 6 the door sprite's location is set to that of the keyholder destination. This is then checked four times to see if it is outside the level borders. (The first check is whether its horizontal position exceeds the level width variable, the second whether it is less than 2 tiles (the level border.), the third whether its vertical position exceeds the level height and the fourth whether it is less than 2 tiles.) If nay of these checks fail the 'Keyholder points to bad spot' code is run and the game crashes.

The final part of the code sets the door sprite's properties. It has no clipping so that it won't be affected by tiles, a type of 1 or 'misc' and an action variable of 2 or 'always active no matter how far away from Keen.'

<patch title="Keen 4">
#Keen place gem code
%patch $C234 $55 $8B $EC $83 $EC $10 $56 $57 $8B $76 $06 $8B $5C $32 $D1 $E3
$8B $87 $25 $C9 $D1 $E8 $03 $44 $34 $89 $46 $F6 $8B $5E $F6 $D1
$E3 $8E $06 $E9 $A7 $26 $8B $07 $05 [$0012W] $89 $46 $FE $8B $5E
$F6 $D1 $E3 $8E $06 $EB $A7 $26 $8B $07 $89 $46 $FC $B1 $08 $D3
$E8 $4689W $FA $8B $46 $FC $25 [$00FFW] $89 $46 $F8 $B8 $0001W
$50 $50 $FF $74 $32 $FF $74 $34 $50 $16 $8D $46 $FE $50 $9A
$16540F28RL $83 $C4 $0E $B8 [$0012W] $50 $9A $187409F1RL $83
$C4 $02 $33 $C0 $50 $9A $06BD1E11RL $83 $C4 $02 $8B $1E $D8
$A7 $8B $46 $FA $89 $47 $0A $8B $46 $F8 $89 $47 $0C $8B $46 $FA
$3B $06 [$A7E4W] {$77} $15 $83 $7E $FA [$02] {$72} $0F $8B $46 $F8 $3B
$06 [$A7E2W] {$77} $06 $83 $7E $F8 [$02] {$73} $0C $B8 [$1426W] $50 $9A
$037D022FRL $83 $C4 $02 $8B $5E $F8 $D1 $E3 $8B $87 $25 $C9
$D1 $E8 $E0D1W $8B $16 $E9 $8BA7W $5E $FA $D1 $E3 $03 $C3 $89
$56 $F4 $89 $46 $F2 $C4 $5E $F2 $26 $8B $07 $89 $46 $F0 $BF $01
$00 $A1 $E4 $A7 $D1 $E0 $01 $46 $F2 $EB $09 $47 $A1 $E4 $A7 $D1
$E0 $01 $46 $F2 $C4 $5E $F2 $26 $8B $07 $3B $46 $F0 $74 $EC $8B
$1E $D8 $A7 $89 $7F $3E $C7 $47 $02 [$0002W] $C7 $47 $06 [$0000W]
$C7 $07 [$0001W] $B8 [$17ECW] $50 $53 $9A $09DC118CRL $83 $C4
$04 $5F $5E $8B $E5 $5D $CB</patch>

= [[Patch:Sprite speed|Speed and Jump Height]] =

Keen does not move while placing gems, to do so would misalign him with the gem holder and cause the placement to fail.

<patch title="Keen 4 action speeds">
#Placing keygems
%patch $2FC9A [$0000W $0000W]
%patch $2FC7C [$0000W $0000W]</patch>

= [[Patch:Sprite collision|Sprite Collision]] =

Keen uses no sprite collision when placing gems. This means he cannot interact with point items and a few other things while doing so.

<patch title="Keen 4 sprite collisions">
#Placing keygems
%patch $2FCA2 $00000000L
%patch $2FC84 $00000000L</patch>

= [[Patch:Sprite animations|Animations]] =

Keen uses one animation when placing gems the 'facing away from screen' animation.

<patch title="Keen 4">
#Placing keygems
%patch $2FC8E $00C4W $00C4W
%patch $2FC98 $0006W #Pause before flip
%patch $2FC70 $00C4W $00C4W
%patch $2FC7A $0008W #Pause before done</patch>

= [[Patch:Sprite-tile interaction|Sprite-tile interaction]] =

Keen uses the same tile collision as he does when standing or doing other 'normal' things.

<patch title="Keen 4 tile collisions">
#Placing keygems
%patch $2FCA6 $0B801AA2RL
%patch $2FC88 $0B801AA2RL</patch>

= [[Patch:Galaxy Action Parameters#Action_Type|Action type]] =

Keen's gem placing actions are type 0, meaning their behaviors and movement are called only once during the action. This prevents 'multiple opening' when Keen activates a door.

<patch title="Keen 4">
#Placing keygems
%patch $2FC92 [$0000W]
%patch $2FC74 [$0000W]</patch>

= [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] =

Both of Keen's placing actions use the 'deprotect animation' variable for complex and subtle reasons.

<patch title="Keen 4">
#Placing keygems
%patch $2FC94 [$0000W $0001W]
%patch $2FC76 [$0000W $0001W]</patch>

{{PatchCategories|Player|}}
{{PatchCategories|Sprite|}}
{{PatchCategories|Keen 4|gameplay}}
{{PatchCategories|Keen 5|gameplay}}
{{PatchCategories|Keen 6|gameplay}}

Patch:Ending sequence (Keen 4)

2020-04-14T09:31:19Z

Levellass: Add patch

The ending sequence in [[Keen 4]] occurs after Keen has saved eight [[Patch:Oracle Council Member|Council Members]], the screen goes dark, the ending sequence of text and images plays, followed by the high scores level. The ending sequence is mostly due to a loaded text chunk that allows the game to load images and text in a defined sequence. This chunk is handled completely uniquely, not allowing the player just to scroll through it as fast as they wish, but making them wait until the page is 'ready.'

== Two possible ending sequences ==

This patch allows Keen 4 to have two possible ending sequences depending on how the game is played. The first (default ending) is triggered by saving all 8 Council Members. The second is triggered by completing level 2.

The brown values are the chunk number and memory offset for each ending. When using a different graphics chunk for the ending the memory offset must be changed by ''twice'' that amount. Here the chunk is changed by 1 and the offset by 2. (The chunk used is the unused 'Level not available in demo' chunk.)

As a side note, since the variables are not reset here the second ending will always occur after the player accesses it for the first time. A 'reset patch' would be needed to prevent this when a new game is started or loaded. Some code is also located over the Wetsuit collision, making that item unusable with this default patch.

<patch title="Keen 4">
#GAME HAS TWO ENDINGS
#Memory offset and ending document to use (Default values)
%patch $2F474 {$1287W $9FFBW}

#End sequence calls variables
%patch $9CB7 $A1 $0604W
%patch $9D7C $A1 $0606W

#MAKE GAME END AFTER LEVEL X
#Check level 2 is done, if so change variables
%patch $6B4B $A7EDW [$02] $75 $4C $B8 {$9FFDW} $A3 $0606W $B8 {$1288W} $A3 $0604W $EB $94

#Call right memory address call
%patch $9CC3 $9A $11A21010RL $90 $90 $90 $90

#Call the right memory address code
%patch $12A30 $55 $8B $EC $56 $8B $76 $06 $8B $44 $0A $A1 {$9FFBW} $81 $3E $0604W
{$1287W} $74 $03 $A1 {$9FFDW} $89 $46 $FE $A3 $C8B3W $5E $5D $CB</patch>

== No ending sequence ==

This patch skips the ending sequence entirely; instead the game simply goes straight to the highscores (Or entering a new score.) when Keen wins.

<patch title="Keen 4">
#No ending sequence, go straight to high scores
%patch $9C7D $CB</patch>

== EGAGRAPH text chunk ==

This is the [[Patch:EGAGRAPH|EGAGRAPH chunk]] used for the ending sequence. Everything that happens after Keen wins the game is dependent on this chunk. Note that when altering this value an associated variable has to be altered by ''twice'' the amount. (As an example, changing the chunk to $1286, or one less means changing the variable to $9FF9 or ''two'' less.)

<patch title="Keen 4">
#Ending sequence document
%patch $9CB8 $1287W #Text
%patch $9CC4 $9FFBW #Memory variable 1
%patch $9D7D $9FFBW #Memory variable 2</patch>

== Background color ==

The background color of the ending sequence is the same as that of the help sections and so cannot be changed without also altering the help section. By default it is $04, or red. The next two lines of the patch give the area of the screen affected by the color. (This makes it possible to display a color ''plus'' black as a background.

<patch title="Keen 4">
#Help\Ending pages background color
%patch $95FB [$0004W] #Color dark red used for screen background
%patch $95FF [$00C8W] #200x...
%patch $9603 [$0140W] #320...</patch>

== Page border images ==

Like the [[Patch:Computer Wrist|help section]] the ending sequence screen is bordered by four images, top, bottom, left and right. This screen and its images are separate from the main Computerwrist screen that first appears when F1 is pressed.

However, this screen is ''not'' separate from the help options screens; a total of five images are stored and both screens use the same code with a different bottom border image.

<patch title="Keen 4">
#Store images for display:
%patch $9822 [$0050W] #Top of help option screens
%patch $9829 [$0051W] #Left of help option screens
%patch $9830 [$0052W] #Right of help option screens
%patch $9837 [$0053W] #Right of help option screens
%patch $983E [$0054W] #Bottom of ending screen

#Top of help screen (At 0,0)
%patch $9613 [$0050W] #Bitmap

#Left of help screen (At 0,8)
%patch $9623 [$0051W] #Bitmap
%patch $9627 [$0008W] #Vertical position

#Right of help screen (At 312,8)
%patch $9636 [$0052W] #Bitmap
%patch $963A [$0008W] #Vertical position
%patch $963E [$0138W] #Horizontal position

#Bottom of help screen(At 8, 176)
%patch $964E [$0053W] #Bitmap
%patch $9652 [$00B0W] #Vertical position
%patch $9656 [$0008W] #Horizontal position

#Bottom of ending screen
%patch $9664 [$0054W] #Bitmap
%patch $9668 [$00C0W] #Vertical position
%patch $966C [$0008W] #Horizontal position

#Don't show...
%patch $9612 $EB $0E #Top help image
%patch $9622 $EB $11 #Left help image
%patch $9635 $EB $12 #Right help image
%patch $964D $EB $12 #Bottom help image
%patch $9663 $EB $12 #Bottom ending image
%patch $9612 $EB $63 #All images</patch>

=== Ending sequence doesn't have border images ===

This patch rearranges the screen code so that the ending sequence has no border images while the help screens do. This can help distinguish both kinds of screen. As a side effect the location and image values are shifted slightly from those in the section above, rendering all above patches dealing with them incompatible. Instead alterations must be made to the blue values in this patch.

As another note this means that the end sequence's bottom border image is not used and can be used for something else. There are modifications to this patch that allow one or more help border images to appear in the ending sequence.

<patch title="Ending sequence 'Ending sequence doesn't have border images">
#Ending sequence doesn't have border images
%patch $9612 $0B $FF $74 $4D $B8 [$0050W] $50 $33 $C0 $50 $50 $9A $1D060C79RL
$83 $C4 $06 $B8 [$0051W] $50 $B8 {$0008W} $50 $33 $C0 $50 $9A
$1D060C79RL $83 $C4 $06 $B8 [$0052W] $50 $B8 {$0008W} $50 $B8
{$0138W} $50 $9A $1D060C79RL $83 $C4 $06 $B8 [$0053W] $50 $B8
{$00B0W} $50 $B8 {$0008W} $50 $9A $1D060C79RL $83 $C4 $06 $EB
$14</patch>

<patch title="Ending sequence 'Patch modifiers, use ONE">
#End sequence pages also display...
%patch $9616 $37 #...bottom border
%patch $9616 $23 #...bottom and right borders
%patch $9616 $10 #...bottom, right and left borders</patch>

== Ready for next page images ==

When the current page of graphics and text has loaded and is ready for the player to press a key to move to the next page, a flashing animation of two images appears in the lower right of the page indicating this. By default this animation is of a dark\light green arrow. Both of these images and their location can be altered.

Both images must be cached first before being displayed.

<patch title="Ending sequence 'page ready' animation">
#Cache images for display
%patch $9CA0 [$0030W] #Dark green arrow
%patch $9CAC [$002FW] #Light green arrow

#Display dark green arrow at 184,298
%patch $9D04 [$002FW] #Image
%patch $9D08 [$00B8W] #Vertical location
%patch $9D0C [$012AW] #Horizontal location

#Display light green arrow at 184,298
%patch $9D37 [$0030W] #Image
%patch $9D3B [$00B8W] #Vertical location
%patch $9D3F [$012AW] #Horizontal location</patch>

=== Animation speed ===

The arrow switching speed can be controlled to an extent. By default it is the quickest it can be, and this can be doubled, tripled, etc. Doing this will create a slight lag between when a key can be pressed and when the page will change, but since this will generally only be a few cycles it will be unnoticeable unless the animation speed is lengthened to ridiculous levels.

In general the values given here are in seconds, so the default switch happens once every second for both arrows.

<patch title="Arrow animation speed">
#Seconds each arrow displays
%patch $9D25 [$0001W] #Dark
%patch $9D58 [$0001W] #Light</patch>

=== Don't show animation ===

This patch stops both images being displayed when the page is ready. This can make it difficult for the player to tell when they can press a key, however in some situations it may be desirable. Using just one line of the patch will make only one image appear, which is more subtle.

<patch title="Don't show ending sequence 'page ready' animation">
#Don't show ending sequence 'page ready' animation
%patch $9D0F $90 $90 $90 $90 $90
%patch $9D42 $90 $90 $90 $90 $90</patch>

=== Ending sequence doesn't wait for keypresses ===

This patch skips the animation and waiting when a page has loaded. This means that the player can do nothing once the ending sequence starts except wait for it to end. However this can be easily altered to make the ending sequence 'automatic'. By the use of timed bitmaps and texts a page can be lingered on for any desired amount of time.

<patch title="Ending sequence doesn't wait for keypresses">
#Ending sequence doesn't wait for keypresses
%patch $9D03 $EB $66</patch>

=== Ending sequence doesn't wait for keypresses for first x pages ===

This patch skips the animation and waiting when a page has loaded, but only for the first few pages. The value highlighted in blue is the number of pages that will pass on 'automatic' before the player is required to press a key to progress. As a side effect the 'ready for next page' animation sequence does not appear, though a replacement can be added into the ending chunk.

This value uses a stat in brown that can be changed during the game, changing how much of the ending sequence is automated.

<patch title="Ending sequence doesn't wait for keypresses">
#Ending sequence doesn't wait for keypresses for first 6 pages
%patch $9D03 $FF $06 {$7A1EW} $83 $3E {$7A1EW} [$08] $72 $5D $9A $14600F43RL
$0B $C0 $75 $54 $EB $F5</patch>

== Music played during ending sequence ==

This is the song played in the ending sequence. Due to the way music works it is actually the level whose music is played. See [[Patch:Music]].

<patch title="Keen 4">
#Ending Sequence (Slug Village)
%patch $9CD7 $0007W</patch>

=== No music in ending sequence ===

This patch prevents any music being played in the ending sequence. Using a value of $FFFFW (-1) in the above patch will achieve the same goal.

<patch title="Keen 4">
#Don't play E.S. music
%patch $9CDA $90 $90 $90 $90 $90</patch>

=== Don't change music for ending sequence ===

This requires two patches, one to keep the same music playing after the [[Patch:Oracle Council Message|Council Member]] is got, the second to stop the music changing in the ending sequence. The side effect is the member's background music will be the same as the levels. (If the first line is removed then the E.S. music will be the same as the member's music.)

<patch title="Keen 4">
#Ending sequence has same music as last level
%patch $F4CD $90 $90 $90 $90 $90 #Don't change music for member
%patch $F5E7 $90 $90 $90 $90 $90 #Don't change music after member rescued
%patch $9CDA $90 $90 $90 $90 $90 #Don't play E.S. music</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Text|}}
{{PatchCategories|Misc|}}

Patch:Scorebox

2020-04-01T13:34:02Z

Levellass: Add some patches

This page covers patches relating to the scorebox that appears in Keen galaxy in-level. It shows Keen's score, ammo and lives. It is possible to change what the scorebox tracks, and even stop it tracking something entirely. As such it requires knowledge of [[Patch:Game stats]] to patch properly.

== Scorebox sprite and location ==

These patches relate to the sprite used for the scorebox and its location on the screen. Everything drawn on the scorebox will be drawn ''relative'' to this sprite and its location. If the sprite chosen is too small then various counters and tiles will simply not be drawn over it.

The sprite used must be the same as the sprite [[Patch:Sprite spawning|cached by left and right Keen, Map Keen and Swimming Keen]] when they are spawned. By default this is $00FDW, and it is not likely the modder would want to change this. The location is in map units (10ths of a pixel), so the default location is 4,4 pixels (Or 1/4,1/4 of a tile) from the top left of the screen. It should also be noted that whatever sprite is used must have four sprite shifts saved (This is a graphics setting.) or the sprite will appear as gibberish.

<patch title="Keen 4">
#Scorebox display
%patch $E97B [$00FDW] #Left Keen cache
%patch $E9A7 [$00FDW] #Right Keen cache
%patch $E9CF [$00FDW] #Map Keen cache
%patch $ED28 [$00FDW] #Swimming Keen cache
%patch $DD83 [$00FDW] #Sprite displayed
%patch $DD8A [$0040W] #Vertical location
%patch $DD91 [$0040W] #Horizontal location</patch>

<patch title="Keen 5">
#Scorebox display
%patch $EEBB [$00EBW] #Left Keen cache
%patch $EEE5 [$00EBW] #Right Keen cache
%patch $EF01 [$00EBW] #Map Keen cache
%patch $D147 [$00EBW] #Sprite displayed
%patch $D14E [$0040W] #Vertical location
%patch $D155 [$0040W] #Horizontal location</patch>

<patch title="Keen 6">
#Scorebox display
%patch $E4AD [$00AFW] #Left Keen cache
%patch $E4D7 [$00AFW] #Right Keen cache
%patch $E4FD [$00AFW] #Map Keen cache
%patch $CEFA [$00AFW] #Sprite displayed
%patch $CF01 [$0040W] #Vertical location
%patch $CF08 [$0040W] #Horizontal location</patch>

<patch title="Keen Dreams">
#Scorebox display
%patch $6347 [$00D4W] #Sprite
%patch $634E [$0040W] #Vertical location
%patch $6355 [$0040W] #Horizontal location</patch>

== Counter location in scorebox ==

These patches control the location of the three counters in the scorebox relative to the top left of the scorebox sprite. Vertical locations are in pixels while horizontal locations are in 8 pixel blocks.

For the score counter it is only possible to move it up 2 pixels at a time. The patch below sets its location at 0,0. Deleting <tt>$90 $90</tt> will move it down two pixels.

<patch title="Keen 4">
#Decrease score counter vertical location 4 pixels
%patch $DAC0 $90 $90 $90 $90

#Lives counter location
%patch $DC94 [$0014W] #Vertical
%patch $DC9E [$02] #Horizontal

#Ammo counter location
%patch $DBA2 [$0014W] #Vertical
%patch $DBAC [$07] #Horizontal</patch>

<patch title="Keen 5">
#Decrease score counter vertical location 4 pixels
%patch $CE84 $90 $90 $90 $90

#Lives counter location
%patch $D058 [$0014W] #Vertical
%patch $D062 [$02] #Horizontal

#Ammo counter location
%patch $CF66 [$0014W] #Vertical
%patch $CF70 [$07] #Horizontal</patch>

<patch title="Keen 6">
#Decrease score counter vertical location 4 pixels
%patch $CC37 $90 $90 $90 $90

#Lives counter location
%patch $CE0B [$0014W] #Vertical
%patch $CE15 [$02] #Horizontal

#Ammo counter location
%patch $CD19 [$0014W] #Vertical
%patch $CD23 [$07] #Horizontal</patch>

== What is displayed ==

This is what the scorebox displays, where and with what tiles. At present only a limited number of patches are available. The 'blank tile' is the 8x8 tile treated as 'tile -1'; the tile to be displayed when there is no value for the square. (Keen's starting score is one '0' tile preceded by five 'blank' tiles for example.) Blank tiles are not displayed if the variable itself is disabled.

Note that the lives variable is referenced four times by the scorebox for various purposes. Note also that in Keen Dreams the 'ammo' counter ''and'' tiles change in a specific level.

<patch title="Keen 4">
#What scorebox tracks:
%patch $DA92 {$7A50W} #Score (refresh)
%patch $DADA {$7A50W} #Score (low)
%patch $DAD6 {$7A52W} #Score (high)
%patch $DB69 {$7A58W} #Ammo
%patch $DC64 {$7A6AW} #Lives
%patch $DCA8 {$7A6AW} #Lives
%patch $DCC8 {$7A6AW} #Lives
%patch $DD48 {$7A6AW} #Lives

#Don't display...
%patch $DA94 $90 $90 #Score (Score 0 tiles still show)
%patch $DB74 $90 $90 #Ammo
%patch $DC66 $90 $90 #Lives

#Blank tiles
%patch $DB09 $0029W #Score
%patch $DC07 $0029W #Ammo
%patch $DCFA $0029W #Lives

#Don't display blank tiles
%patch $DB0D $90 $90 $90 #Score
%patch $DC0B $90 $90 $90 #Ammo
%patch $DCFE $90 $90 $90 #Lives</patch>

<patch title="Keen 5">
#What scorebox tracks:
%patch $DA56 {$6F4EW} #Score (refresh)
%patch $CE9E {$6F4EW} #Score (low)
%patch $CE9A {$6F50W} #Score (high)
%patch $CF2D {$6F56W} #Ammo
%patch $D028 {$6F6AW} #Lives
%patch $D06C {$6F6AW} #Lives
%patch $D08C {$6F6AW} #Lives
%patch $D10C {$6F6AW} #Lives

#Don't display...
%patch $CE58 $90 $90 #Score (Score 0 tiles still show)
%patch $CF38 $90 $90 #Ammo
%patch $D02A $90 $90 #Lives

#Blank tiles
%patch $CECD $0029W #Score
%patch $CFCB $0029W #Ammo
%patch $D0BE $0029W #Lives

#Don't display blank tiles
%patch $CED1 $90 $90 $90 #Score
%patch $CFCF $90 $90 $90 #Ammo
%patch $D0C2 $90 $90 $90 #Lives</patch>

<patch title="Keen 6">
#What scorebox tracks:
%patch $CC09 {$7588W} #Score (refresh)
%patch $CC51 {$7588W} #Score (low)
%patch $CC4D {$758AW} #Score (high)
%patch $CCE0 {$7590W} #Ammo
%patch $CDDB {$75A6W} #Lives
%patch $CE1F {$75A6W} #Lives
%patch $CE3F {$75A6W} #Lives
%patch $CEBF {$75A6W} #Lives

#Don't display...
%patch $CC0B $90 $90 #Score (Score 0 tiles still show)
%patch $CCEB $90 $90 #Ammo
%patch $CDDD $90 $90 #Lives

#Blank tiles
%patch $CC80 $0029W #Score
%patch $CD7E $0029W #Ammo
%patch $CE71 $0029W #Lives

#Don't display blank tiles
%patch $CC84 $90 $90 $90 #Score
%patch $CD82 $90 $90 $90 #Ammo
%patch $CE75 $90 $90 $90 #Lives</patch>

<patch title="Keen Dreams">
#Level that decides between Flower Power and Bombs counter
%patch $6192 $8F3EW [$0F] {$75}

#Level that decides between Flower Power and Bombs tiles
%patch $5EF8 {$8F3EW} [$0F] {$75}

#What scorebox tracks:
%patch $6104 {$7116W} #Score (low)
%patch $6108 {$7114W} #Score (high)
%patch $6184 {$7116W} #Score (low)
%patch $618B {$7114W} #Score (high)
%patch $6198 {$711EW} #Boobus bombs
%patch $619D {$711CW} #Flower Power
%patch $62F5 {$7126W} #Lives
%patch $630A {$7126W} #Lives

#Don't display...
%patch $61A8 $90 $90 #Ammo
%patch $62D0 $EB $2E #Lives</patch>

=== What is displayed when lives or ammo > 99 ===

When Keen has more than 99 lives or ammunition the scorebox shows this by displaying a two character long string of text. By default this is '99', meaning that if Keen has more than 99 shots or lives the scorebox will simply read '99' instead of the true value. (Which can be seen in the [[Patch:Status Window (Galaxy)|Status Window.]])

In the case of the lives counter in Keen Dreams the limit is 9 lives. When this is exceeded an ''8x8 tile'' is placed instead. By default this is tile 10. (Which is an image of the number 9.) This mean extending the limit past 9 is very difficult.

<patch title="Scorebox max ammo\lives text">
#Keen 4 :
%patch $DBBB [$1846W] #Text called from (Shots)
%patch $306B6 "99" $00
%patch $DCAE [$1849W] #Text called from (Lives)
%patch $306B9 "99" $00

#Keen 5 :
%patch $CF7F [$162EW] #Text called from (Shots)
%patch $D072 [$162EW] #Text called from (Lives)
%patch $3196E "99" $00

#Keen 6 :
%patch $CD32 [$164CW] #Text called from (Shots)
%patch $3237C "99" $00
%patch $CE25 [$164FW] #Text called from (Lives)
%patch $3237F "99" $00

#Keen 7 :
%patch $61EF [$16B6W] #Text called from
%patch $25126 "99" $00 #Shots
%patch $62E4 $000AW #Lives (Tile)</patch>

==== Max ammo\lives to display ====

This is the limit referred to above; if Keen has more than this limit then the text above will appear. See also [[Patch:Jump conditions]]. Note that for Keen Dreams the limit on lives is 9.

<patch title="Scorebox '99' limit">
#Keen 4
%patch $DBB7 [$63] {$76} #Shots
%patch $DCAA [$63] {$7E} #Lives

#Keen 5
%patch $CF7B [$63] {$76} #Shots
%patch $D06E [$63] {$7E} #Lives

#Keen 6
%patch $CD2E [$63] {$76} #Shots
%patch $CE21 [$63] {$7E} #Lives

#Keen 7
%patch $61EB [$63] {$76} #Shots
%patch $CE21 [$09] {$7E} #Lives</patch>

== Disable ==

This disables the scorebox entirely, that is, it is never displayed in-level, even when it is turned on.

<patch title="Disable scorebox">
#Disable scorebox -Keen 4
%patch $DA4F $90 $90

#Disable scorebox -Keen 5
%patch $CE33 $90 $90

#Disable scorebox -Keen 6
%patch $CBC6 $90 $90</patch>

== Always show ==

This patch causes the scorebox to always be shown, even if the player disables it in the [[Patch:Main menu (Galaxy)|Main Menu.]] This allows that configuration option to be used for something else (Such as slow motion.) or to be eliminated entirely.

<patch title="Keen 4">
#Always display scorebox, -ignore scorebox variable
%patch $DA5A $19
%patch $7948 $EB $05
%patch $79AE $EB $25</patch>

== Counters are yellow ==

This patch changes the counters from light red to yellow. (Grey digits become light red.) This patch appears stable but may cause unknown issues.

<patch title="Keen 4">
#Ammo counter is yellow
%patch $DB99 $0280W

#Lives counter is yellow
%patch $DC8B $0280W

#Score counter is yellow
%patch $DAB9 $0280W</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}

Patch:Title screen

2020-04-01T03:23:33Z

Levellass: Add skip patches

This page covers patches relating to the title screen. The title screen in Keen Vorticons is where the [[Patch:Main menu|main menu]] appears. In Keen Dreams it is the image that appears ''before'' the [[Patch:Main menu|main menu]] as well as including the [[Patch:High Scores (Dreams)|High Scores table.]] In Keen Galaxy it is again a simple image leading to the main menu. Associated patches are [[Patch:Main menu]] and [[Patch:Start sequence]].

In Keen Vorticons a level is displayed that can be edited in a level editor. The level used is a screen from <tt>LEVEL90.CKx</tt>. In Dreams, the title screen image can be edited with [[Keengraph]]. In Galaxy, the title screen image can be edited with [[ModKeen]] along with most other Galaxy graphics.

Due to the different natures of the title screens, this page will be divided into three sections, Vorticons, Dreams and Galaxy. Patches for relevant episodes and outcomes will be listed under these sections.

== Vorticons title ==

At present, it is possible to patch the location and [[Patch:Images|bitmaps]] used for the title and the "F1 for help" graphics. (Note that the title graphic cannot be changed easily, as it is not given a value in the code, because it uses bitmap 0.) All values are the default values. For help with graphic location patches, see [[Patch:Images]].

<patch title="Title screen in Keen 1">
#Bitmaps:
%patch $97C0 [$0002W] #F1

#Locations:
%patch $97B2 [$0001W] #Title V
%patch $97B6 [$0008W] #Title H
%patch $97C4 [$00B6W] #F1 V
%patch $97C8 [$0010W] #F1 H

#Don't show...
%patch $97CB $90 $90 $90 #F1
%patch $97B9 $90 $90 $90 #Title
%patch $97AB $C3 #F1 AND title
%patch $97E4 $90 #F1 AND title when menu is open (Has side effects!)</patch>

<patch title="Title screen in Keen 2">
#Bitmaps:
%patch $9241 [$0002W] #F1

#Locations:
%patch $9233 [$0001W] #Title V
%patch $9237 [$0008W] #Title H
%patch $9245 [$00B6W] #F1 V
%patch $9249 [$0010W] #F1 H

#Don't show...
%patch $924C $90 $90 $90 #F1
%patch $923A $90 $90 $90 #Title</patch>

<patch title="Title screen in Keen 3">
#Bitmaps:
%patch $A09A [$0002W] #F1

#Locations:
%patch $A08C [$0001W] #Title V
%patch $A090 [$0008W] #Title H
%patch $A09E [$00B6W] #F1 V
%patch $A0A2 [$0013W] #F1 H

#Don't show...
%patch $A0A5 $90 $90 $90 #F1
%patch $A093 $90 $90 $90 #Title</patch>

== Dreams title ==

The Dreams title consists of a 'demo loop' that displays the title screen and the [[Patch:High Scores (Dreams)|High scores]] in a constant cycle. Though loading level 20 this is never shown in the game. (In the patchable version at least.)

=== Screen image file and errors ===

The screen image is loaded and decompressed form a separate file archive in which it is the only chunk. See also [[Patch:Files and filenames]].

There are three possible errors. The first occurs when the titlescreen archive file cannot be found. The second occurs if the file itself is corrupt and doesn't fit the expected parameters. The third occurs if the title chunk ''inside'' the file is corrupt.

<patch title="Title screen in Dreams">
#Dreams titlescreen archive
%patch $435C [$038DW] #Look for this file
%patch $438A [$038DW] #Load this file
%patch $23DFD "KDREAMS.CMP" $00

#Title screen file
%patch $23E23 "TITLESCR.LBM" $00

#No titlescreen archive
%patch $436D [$0399W]
%patch $23E09 "Couldn't find KDREAMS.CMP" $00

#Can't read titlescreen error
%patch $439D [$03C0W]
%patch $23E30 "Can't load TITLE SCREEN" $00

#Can't read title chunk error
%patch $9C61 [$25EDW]
%patch $2605D "Error Loading Compressed lib shape!" $00</patch>

=== Time titlescreen is visible for ===

By default the 'title sequence' loops between the titlescreen and the high score table. The first appearance of the title, when the game first loads, is especially long, while later appearances are shorter.

As such there are two times involved, the first for the special initial appearance and the second for the 'looping appearances'. Note that the first, longer, time is the ''sum'' of ''both'' times rather than a standalone value.

<patch title="Titlescreen display time">
#Titlescreen display time
%patch $43FA [$0118W] #First appearance extra time
%patch $4447 [$00D2W] #Loop appearances</patch>

=== Skip titlescreen, go straight to menu ===

The first patch causes the game to go straight to the menu instead of displaying the titlescreen. In fact there is no way to view the titlescreen (Or High score table that goes with it.), it is completely disabled.

The second patch is related, except the titlescreen appears, the player is sent to the menu after a time instead of seeing the High Scores.

<patch title="Go straight to menu">
#Skip titlescreen go straight to Main Menu
%patch $4395 $E9 $00FFW

#Go to menu after titlescreen
%patch $4408 $90 $90</patch>

=== Skip titlescreen, go straight to game ===

This patch causes the game to go straight to a new game instead of displaying the titlescreen. In fact there is no way to view the titlescreen (Or High score table that goes with it.), it is completely disabled and pressing 'esc' in-game will cause the entire game to 'reset'.

There are two variables that can be altered, thedifficulty level of the game and the first level entered. In this patch they are 'easy' and level 0 (the map).

<patch title="Go straight to game">
#Skip titlescreen go straight to game
%patch $4395 $E9 $00FFW
%patch $28B32 $4AB8W
%patch $5D01 $C7 $06 $7128W [$0001W] #Difficulty
%patch $3C0C $7124W [$0000W] #Level to start in</patch>

=== High scores table ===

The [[Patch:High Scores (Dreams)|High Score table]] appears after the title screen then, after a period of time, returns to the title screen again.

==== No High Scores in title sequence ====

This patch removes the High Score table in the title sequence only. While the palyer can enter a new high score and see the table at a Game Over they will not see the table when first starting the game and waiting.

<patch title="No High Scores in title sequence">
#No High scores in title sequence
%patch $4475 $EB $09</patch>

==== Time score table is visible ====

These patches control how long the High Scores table is visible before the title screen appears. There are two different situations, Game Over and title sequence, with different times.

<patch title="High Score display time">
#High Scores display time
%patch $4484 [$01A4W]</patch>

==== Go to main menu after Title\High Scores ====

These patches cause the game to go to the [[Patch:Main menu (Dreams)|main menu]] after the titlescreen or high scores are displayed, even if the player doesn't press a key.

<patch title="Go to main menu even if no key is pressed">
#Go to main menu after title displays
%patch $4455 $EB

#Go to main menu after High Score table displays
%patch $4492 $EB</patch>

== Galaxy title ==

The Galaxy title screen is much less involved than the Vorticons one. Like Dreams it is a fullscreen image, appearing after the [[Patch:Terminator text|'terminator text']] sequence has completed or been aborted by the player. (Check the terminator sequence page for related patches.)

=== Skip screen, go to Main Menu ===

These patches skip the titlescreen, going straight to the [[Patch:Main menu (Galaxy)|Main Menu]]. But this only happens if the player skips the terminator text; allowing it to play out will still cause the title fade.

<patch title="Skip Title screens">
#Skip title, go to Main Menu -Keen 4
%patch $51BC $EB

#Skip title, go to Main Menu -Keen 5
%patch $51B6 $EB

#Skip title, go to Main Menu -Keen 6
%patch $4FC5 $EB</patch>

=== Title screen image ===

As noted above, there are in fact, two different title screens that can be shown. The first appears when the [[Patch:Terminator text|'terminator text']] is allowed to scroll uninterrupted. This will result in a 'titelscreen fade' where the title slowly appears from a black screen. The second title screen appears instantly if the player presses any key. By default both of these titles are identical, but they don't have to be.

Like all bitmaps, the title screen must be cached before it can be displayed. The number given in these patches is the chunk number (Properly labelled by [[Keengraph]]; [[ModKeen]] will label the bitmap with a different number.) As such there are a total of four lines of code, two for each title screen.

<patch title="Keen Galaxy Title screens">
#Keen 4 titlescreen images
%patch $4EDC [$006DW] #Cache for title fade
%patch $4CF4 [$006DW] #Display in title fade
%patch $51C4 [$006DW] #Cache for title jump
%patch $51D0 [$006DW] #Display in title jump

#Keen 5 titlescreen images
%patch $4ED6 [$0058W] #Cache for title fade
%patch $4CEE [$0058W] #Display in title fade
%patch $51BE [$0058W] #Cache for title jump
%patch $51CA [$0058W] #Display in title jump

#Keen 6 titlescreen images
%patch $4CF7 [$0022W] #Cache for title fade
%patch $4B0F [$0022W] #Display in title fade
%patch $4FCD [$0022W] #Cache for title jump
%patch $4FD9 [$0022W] #Display in title jump</patch>

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}

Patch:Terminator text

2020-04-01T03:22:40Z

Levellass: Add new set of patches

The "terminator text" sequence is a sequence that appears when the Keen Galaxy games are first started. (It will also play again once all the demo sequences have been run.) It leads to the [[Patch:Title screen|title screen]] on completion or if interrupted by any keypress.

It consists of three specific phases. In the first, two large bitmaps, COMMANDER and KEEN that phase through each other as they scroll right-left and left-right respectively. The bitmaps are dark colors and where they overlap turn light. As this happens several credits bitmaps scroll up from the bottom of the screen, pause in the midscreen for a few seconds, then scroll up off the screen top.

After the two background bitmaps have scrolled past each other the sequence will move on to phase 2. The bitmaps will 'zoom out', getting smaller as they shrink towards the top of the screen. This phase ends with the words 'COMMANDER KEEN' at the top of a black screen.

This then leads to phase 3, where a semi-random pixel effect replaces the old, mostly black, screen with the title screen.

= Details =

The first phase uses a unique [[Patch:Palette|palette]] composed of far fewer colors than the main game. The two background bitmaps are monochrome and translucent and the palette is set up so that their individual colors are dark while their combined color is light. The credits bitmaps appear over this and do not change color.

More technically the EGA graphics planes are divided up between the two horizontally scrolling monochrome images and the vertically scrolling credit pictures, as follows: The KEEN graphic is drawn into plane 0, the COMMANDER graphic into plane 1, and the vertically scrolling credit images into planes 2 and 3.

By setting EGA registers so that drawing to select planes at a time is allowed, the game can update one component of the scrolling screen without disturbing the other two. Thus, by default, the palette is set so that the vertically scrolling credit images can only have three completely opaque colors, and one completely transparent color (i.e., both planes 2 and 3 are zero). This leaves four colors that can be created from all the combinations of the two planes dedicated to the horizontally scrolling images (because 2^2 = 4). COMMANDER and KEEN can both have a unique color, as can their union and the backdrop. Hence, seven colors can be shown at once, if vertically scrolling images are not to have any translucence.

= Skip sequences =

These patches skip various parts of the terminator sequence, from the entire sequence to small parts of it.

== Skip sequence, title screen & menu, go to new game ==

This patch causes a new game to start instead of the Terminator Text. The difficulty of the game is marked in blue. (By default it is 'normal'.) As a side effect the terminator text is permanently disabled, but the rest of the demos work fine.

<patch title="Go straight to new game">
#Go straight to new game on startup
%patch $4EA8 $C7 $06 $7A70W $0005W $C7 $06 $474AW [$0002W] $9A $146008A8RL
$9A $05C40063RL $5F $5E $8B $E5 $5D $CB</patch>

== Skip sequence & title screen, go to demo ==

This disables the Terminator text entirely and also the title screen. The game will go directly to the first demo instead. To simply disable a specific graphic see the 'images section below.

<patch title="Keen 4">
#Disable Terminator sequence and title screen (Frees $4E9F-$51B7)
%patch $3C26 $90 $90 $90 $90 $90</patch>

== Skip sequence & title screen, go to menu ==

This disables the Terminator text entirely and also the title screen. The game will go directly to the [[Patch:Main menu (Galaxy)|Main Menu]].

<patch title="Keen 4">
#Terminator sequence goes straight to main menu - Keen 4
%patch $50ED $A545W [$001CW]
%patch $51BC $EB

#Terminator sequence goes straight to main menu - Keen 5
%patch $50E7 $9BADW [$001CW]
%patch $51B6 $EB

#Terminator sequence goes straight to main menu - Keen 6
%patch $4F08 $A6D3W [$001CW]
%patch $4FC5 $EB</patch>

== Skip sequence, go to title or help ==

These patches skip the credit bitmaps scroll ''and'' zoom sequences and instead goes straight to the [[Patch:Title screen|title screen]] appearing. Changing the blue value to $003BW will cause the terminator sequence to go straight to the [[Patch:Computer Wrist|help screen]] instead.

<patch title="Skip terminator sequence, go straight to title">
#Terminator sequence goes straight to title - Keen 4
%patch $50ED $A545W [$001CW]

#Terminator sequence goes straight to title - Keen 5
%patch $50E7 $9BADW [$001CW]

#Terminator sequence goes straight to title - Keen 6
%patch $4F08 $A6D3W [$001CW]</patch>

== Skip scroll, go to zoom-out ==

These patches skip the credits scroll and go to the title zoom sequence, just before the title screen appears. (The terminator chunks do appear briefly but can be totally removed by altering their graphics to be totally black.)

<patch title="Skip terminator sequence, go straight to title zoom">
#Skip terminator sequence, go straight to title zoom -Keen 4
%patch $50F1 $90 $90 $90 $90

#Skip terminator sequence, go straight to title zoom -Keen 5
%patch $50EB $90 $90 $90 $90

#Skip terminator sequence, go straight to title zoom -Keen 6
%patch $4F0C $90 $90 $90 $90</patch>

== Skip zoom sequence ==

These patches skip the brief zoom out sequence after the credits have scrolled and before the title screen appears. If the COMMANDER\KEEN images are still onscreen they will change color to the default palette colors (Dark blue and green) which will look unusual. As such it's best to edit these images so that the screen will be completely black at the end of scrolling.

<patch title="Skip zoom sequence, go straight to title appearance">
#Skip the zoom out sequence -Keen 4
%patch $5140 $90 $90 $90 $90

#Skip the zoom out sequence -Keen 5
%patch $513A $90 $90 $90 $90

#Skip the zoom out sequence -Keen 6
%patch $4F5B $90 $90 $90 $90</patch>

= Replace Terminator Text with another action =

This is the [[Patch:Main menu|Main menu actions list,]] a list of various things the game does at the [[Patch:Main menu|main menu.]] By simply swapping various pointers around it is possible to change the order that various actions appear or replace one action with another. A novel option is to replace the terminator text with the [[Patch:Story Screen (Galaxy)|star wars story]]

<patch title="Keen 4">
#Main menu actions list
%patch $3CB9 {$0448W} #3C18: Terminator sequence and title screen
{$045FW} #3C2F: Demo 1
{$046CW} #3C3C: Star wars story
{$0473W} #3C43: Demo 2
{$0481W} #3C51: High score demo
{$0488W} #3C58: Demo 3
{$0496W} #3C66: Demo 4</patch>

= [[Patch:Palette|Colors]] =

These patches govern how terminator images are colored. Patches like these regarding how color maps are used are explained on the [[Patch:Palette|palettes page.]]

Unlike most of the game, the COMMANDER, KEEN and credits bitmaps don't use the same [[Patch:Palette||'color map'.]] Keen Galaxy uses 16 colors which are created from different sums of four 'plane values' of 1, 2, 4 and 8. In the normal game these planes are blue, green, red and brightness. Thus 'dark blue' is color 1, 'purple' is color 1 + 4 = 5 and white is color 1 + 2 + 4 + 8 = 15.

In the terminator sequence COMMANDER occupies the first plane of value 1 and KEEN occupies plane 2. In the normal game they would thus be blue and green. They are transparent so they produce a third color where they overlap. (Color 1 + 2 = 3.) The credits bitmaps use the remaining two planes and are not transparent, so their colors don't 'add' in the same way.

However the terminator sequence doesn't map colors to pixels in the same way as the regular game. For example, by default, both COMMANDER and KEEN appear the same color. Their ''different'' pixel values are mapped to the ''same'' color. (Their overlap however is mapped to a light version of that color. ''How'' the 16 possible pixel values are mapped to the 16 possible colors is governed by a 17-byte 'color map' (The extra byte is for the 'screen border'.) By using an odd color map the game can do neat stuff like the terminator sequence.

As a final complexity the value of colors goes 0,1,2...7,8,19,1A... Thus a value of 9 is not a valid color but $19 is. The following table shows what color each palette value will shoe:

$1F, white $1E, yellow $1D, light purple $1C, light red
$1B, light teal $1A, light green $19, light blue $18, dark grey (light black)
$17, white $16, yellow $15, light purple $14, light red
$13, light teal $12, light green $11, light blue $10, dark grey (light black)
$0F, light grey $0E, brown $0D, dark purple $0C, dark red
$0B, dark teal $0A, dark green $09, dark blue $08, black
$07, light grey $06, brown $05, dark purple $04, dark red
$03, dark teal $02, dark green $01, dark blue $00, black

There are ''two'' color maps. The first is used for the terminator sequence proper while the second is used during the 'zoom out' sequence just before the title screen appears. Both have a call to the color map and a second call to the screen border color. Interestingly the same border color is used in both cases. (It's the one belonging to the terminator sequence palette.)

<patch title="Keen 4">
#Terminator sequence
%patch $50BB [$0218W] #Screen border color
%patch $50C2 [$0208W] #Main color map

#Zoom out sequence
%patch $50B5 [$0218W] #Screen border color
%patch $50B8 [$0229W] #Main color map

#Terminator text color map:
%patch $2F078 [$00 $18 $18 $07 $01 $01 $01 $01] #Dark colors
[$11 $11 $11 $11 $13 $13 $13 $13] {$00} #Light colors (and border color)

#Zoom out color map:
%patch $2F089 [$00 $18 $18 $07 $01 $01 $01 $01] #Dark colors
[$11 $11 $11 $11 $13 $13 $13 $18] {$00} #Light colors (and border color)</patch>

<patch title="Keen 5">
#Terminator sequence
%patch $50B5 [$01C8W] #Screen border color
%patch $50BC [$01B8W] #Main color map

#Zoom out sequence
%patch $50AF [$01C8W] #Screen border color
%patch $50B2 [$01D9W] #Main color map

#Terminator text color map:
%patch $304F8 [$00 $04 $04 $1C $01 $01 $01 $01] #Dark colors
[$11 $11 $11 $11 $13 $13 $13 $13] {$00} #Light colors (and border color)

#Zoom out color map:
%patch $30509 [$00 $04 $04 $1C $01 $01 $01 $01] #Dark colors
[$11 $11 $11 $11 $13 $13 $13 $04] {$00} #Light colors (and border color)</patch>

<patch title="Keen 6">
#Terminator sequence
%patch $4ED6 [$015CW] #Screen border color
%patch $4EDD [$014CW] #Main color map

#Zoom out sequence
%patch $4ED0 [$015CW] #Screen border color
%patch $4ED3 [$016DW] #Main color map

#Terminator text color map:
%patch $30E7C [$00 $05 $05 $15 $01 $01 $01 $01] #Dark colors
[$11 $11 $11 $11 $13 $13 $13 $13] {$00} #Light colors (and border color)

#Zoom out color map:
%patch $30E8D [$00 $05 $05 $15 $01 $01 $01 $01] #Dark colors
[$11 $11 $11 $11 $13 $13 $13 $05] {$00} #Light colors (and border color)</patch>

= COMMANDER\KEEN images =

These are the 'COMMANDER KEEN' images that move past each other, they are in the same plane, behind the credit bitmaps. The values for what is used is the [[Patch:EGAGRAPH|chunk number,]] (properly labelled by [[Keengraph]], [[ModKeen]] does not extract the chunk properly and labels it differently.)

<patch title="Keen 4">
#Terminator chunks:
%patch $4EE8 $1281W #COMMANDER
%patch $4EF4 $1280W #KEEN</patch>

== Don't show COMMANDER and\or KEEN images ==

These patches allow a modder to selectively remove one or both of the background terminator images from the sequence. This also frees up a little patch space. Note however that ''both'' images will still appear in the 'zooming out' section at the end of the sequence.

<patch title="Keen 4">
#Don't display 'KEEN' (Free $4F3F-$4F9E)
%patch $4F3E $60

#Don't display 'COMMANDER' (Free $4FFF-$5074)
%patch $4FFC $E9 $00ACW</patch>

= Credit bitmaps =

These are the images crediting the game team that appear over the terminator text images for specific periods of time. They are read from a [[Patch:Text patches|pointer list]] whose pointer is stored elsewhere in the code. It is possible to change the number of images shown. (Less is simple, more becomes more difficult as there is only a limited time to display images.)

<patch title="Keen 4">
#Bitmap list:
%patch $3F46 [$0200W] #Location
%patch $50E0 [$04] #Number of bitmaps to show 1
%patch $5113 [$04] #Number of bitmaps to show 2

#Credit bitmaps:
%patch $2F070 $0068W
$0069W
$006AW
$006BW</patch>

<patch title="Keen 5">
#Bitmap list:
%patch $3F40 [$01B0W] #Location
%patch $50DA [$04] #Number of bitmaps to show 1
%patch $510D [$04] #Number of bitmaps to show 2

#Credit bitmaps:
%patch $304F0 $0053W
$0054W
$0055W
$0056W</patch>

<patch title="Keen 6">
#Bitmap list:
%patch $3D61 [$0144W] #Location
%patch $4EFB [$04] #Number of bitmaps to show 1
%patch $4F2E [$04] #Number of bitmaps to show 2

#Credit bitmaps:
%patch $30E74 $001DW
$001EW
$001FW
$0020W</patch>

== Don't display credits ==

This patch completely removes the credit bitmaps, skipping the code block entirely.

<patch title="Keen 4">
#Don't display credit bitmaps in terminator sequence (Keen 4; frees $4007-$41A7)
%patch $4006 $CB

#Don't display credit bitmaps in terminator sequence (Keen 5; frees $4001-$41A1)
%patch $4000 $CB

#Don't display credit bitmaps in terminator sequence (Keen 6; frees $3E21-$3FC1)
%patch $3E21 $CB</patch>

== Credits horizontal position ==

This patch changes the horizontal position of the credit images. by default this is right in the middle of the screen, but it needs to be made less if the images are wider.

<patch title="Credit images horizontal position">
#Credit images horizontal position -Keen 4
%patch $402C [$0014W]

#Credit images horizontal position -Keen 5
%patch $4026 [$0014W]

#Credit images horizontal position -Keen 6
%patch $3E47 [$0014W]</patch>

== Credits sitting time ==

This patch changes how long the credit images sit still for before moving up. If very small the images will just keep moving up the screen.

<patch title="Credit images horizontal position">
#Credit images sitting time -Keen 4
%patch $424F [$00C8W]

#Credit images sitting time -Keen 5
%patch $4249 [$00C8W]

#Credit images sitting time -Keen 6
%patch $406A [$00C8W]</patch>

== Credits wobble ==

This patch causes the credit images to 'wobble' back and forth once they rise into position.

<patch title="Credit images wobble">
#Credit images wobble -Keen 4
%patch $4012 $0005W

#Credit images wobble -Keen 5
%patch $400C $0005W

#Credit images wobble -Keen 6
%patch $3E2D $0005W</patch>

== Credits appear instantly ==

This patch makes the credit images appear in the middle of the screen instantly instead of sliding into place. It is slightly buggy ('Image dirt' may appear) but stable. The images will slide off the screen.

<patch title="Credit images appear instantly">
#Credit images appear instantly -Keen 4
%patch $4217 $0000W

#Credit images appear instantly -Keen 5
%patch $4211 $0000W

#Credit images appear instantly -Keen 5
%patch $4032 $0000W</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}

Patch:Title screen

2020-04-01T03:01:32Z

Levellass: Clear up the titlescreen patch for Galaxy

This page covers patches relating to the title screen. The title screen in Keen Vorticons is where the [[Patch:Main menu|main menu]] appears. In Keen Dreams it is the image that appears ''before'' the [[Patch:Main menu|main menu]] as well as including the [[Patch:High Scores (Dreams)|High Scores table.]] In Keen Galaxy it is again a simple image leading to the main menu. Associated patches are [[Patch:Main menu]] and [[Patch:Start sequence]].

In Keen Vorticons a level is displayed that can be edited in a level editor. The level used is a screen from <tt>LEVEL90.CKx</tt>. In Dreams, the title screen image can be edited with [[Keengraph]]. In Galaxy, the title screen image can be edited with [[ModKeen]] along with most other Galaxy graphics.

Due to the different natures of the title screens, this page will be divided into three sections, Vorticons, Dreams and Galaxy. Patches for relevant episodes and outcomes will be listed under these sections.

== Vorticons title ==

At present, it is possible to patch the location and [[Patch:Images|bitmaps]] used for the title and the "F1 for help" graphics. (Note that the title graphic cannot be changed easily, as it is not given a value in the code, because it uses bitmap 0.) All values are the default values. For help with graphic location patches, see [[Patch:Images]].

<patch title="Title screen in Keen 1">
#Bitmaps:
%patch $97C0 [$0002W] #F1

#Locations:
%patch $97B2 [$0001W] #Title V
%patch $97B6 [$0008W] #Title H
%patch $97C4 [$00B6W] #F1 V
%patch $97C8 [$0010W] #F1 H

#Don't show...
%patch $97CB $90 $90 $90 #F1
%patch $97B9 $90 $90 $90 #Title
%patch $97AB $C3 #F1 AND title
%patch $97E4 $90 #F1 AND title when menu is open (Has side effects!)</patch>

<patch title="Title screen in Keen 2">
#Bitmaps:
%patch $9241 [$0002W] #F1

#Locations:
%patch $9233 [$0001W] #Title V
%patch $9237 [$0008W] #Title H
%patch $9245 [$00B6W] #F1 V
%patch $9249 [$0010W] #F1 H

#Don't show...
%patch $924C $90 $90 $90 #F1
%patch $923A $90 $90 $90 #Title</patch>

<patch title="Title screen in Keen 3">
#Bitmaps:
%patch $A09A [$0002W] #F1

#Locations:
%patch $A08C [$0001W] #Title V
%patch $A090 [$0008W] #Title H
%patch $A09E [$00B6W] #F1 V
%patch $A0A2 [$0013W] #F1 H

#Don't show...
%patch $A0A5 $90 $90 $90 #F1
%patch $A093 $90 $90 $90 #Title</patch>

== Dreams title ==

The Dreams title consists of a 'demo loop' that displays the title screen and the [[Patch:High Scores (Dreams)|High scores]] in a constant cycle. Though loading level 20 this is never shown in the game. (In the patchable version at least.)

=== Screen image file and errors ===

The screen image is loaded and decompressed form a separate file archive in which it is the only chunk. See also [[Patch:Files and filenames]].

There are three possible errors. The first occurs when the titlescreen archive file cannot be found. The second occurs if the file itself is corrupt and doesn't fit the expected parameters. The third occurs if the title chunk ''inside'' the file is corrupt.

<patch title="Title screen in Dreams">
#Dreams titlescreen archive
%patch $435C [$038DW] #Look for this file
%patch $438A [$038DW] #Load this file
%patch $23DFD "KDREAMS.CMP" $00

#Title screen file
%patch $23E23 "TITLESCR.LBM" $00

#No titlescreen archive
%patch $436D [$0399W]
%patch $23E09 "Couldn't find KDREAMS.CMP" $00

#Can't read titlescreen error
%patch $439D [$03C0W]
%patch $23E30 "Can't load TITLE SCREEN" $00

#Can't read title chunk error
%patch $9C61 [$25EDW]
%patch $2605D "Error Loading Compressed lib shape!" $00</patch>

=== Time titlescreen is visible for ===

By default the 'title sequence' loops between the titlescreen and the high score table. The first appearance of the title, when the game first loads, is especially long, while later appearances are shorter.

As such there are two times involved, the first for the special initial appearance and the second for the 'looping appearances'. Note that the first, longer, time is the ''sum'' of ''both'' times rather than a standalone value.

<patch title="Titlescreen display time">
#Titlescreen display time
%patch $43FA [$0118W] #First appearance extra time
%patch $4447 [$00D2W] #Loop appearances</patch>

=== Skip titlescreen, go straight to menu ===

The first patch causes the game to go straight to the menu instead of displaying the titlescreen. In fact there is no way to view the titlescreen (Or High score table that goes with it.), it is completely disabled.

The second patch is related, except the titlescreen appears, the player is sent to the menu after a time instead of seeing the High Scores.

<patch title="Go straight to menu">
#Skip titlescreen go straight to Main Menu
%patch $4395 $E9 $00FFW

#Go to menu after titlescreen
%patch $4408 $90 $90</patch>

=== Skip titlescreen, go straight to game ===

This patch causes the game to go straight to a new game instead of displaying the titlescreen. In fact there is no way to view the titlescreen (Or High score table that goes with it.), it is completely disabled and pressing 'esc' in-game will cause the entire game to 'reset'.

There are two variables that can be altered, thedifficulty level of the game and the first level entered. In this patch they are 'easy' and level 0 (the map).

<patch title="Go straight to game">
#Skip titlescreen go straight to game
%patch $4395 $E9 $00FFW
%patch $28B32 $4AB8W
%patch $5D01 $C7 $06 $7128W [$0001W] #Difficulty
%patch $3C0C $7124W [$0000W] #Level to start in</patch>

=== High scores table ===

The [[Patch:High Scores (Dreams)|High Score table]] appears after the title screen then, after a period of time, returns to the title screen again.

==== No High Scores in title sequence ====

This patch removes the High Score table in the title sequence only. While the palyer can enter a new high score and see the table at a Game Over they will not see the table when first starting the game and waiting.

<patch title="No High Scores in title sequence">
#No High scores in title sequence
%patch $4475 $EB $09</patch>

==== Time score table is visible ====

These patches control how long the High Scores table is visible before the title screen appears. There are two different situations, Game Over and title sequence, with different times.

<patch title="High Score display time">
#High Scores display time
%patch $4484 [$01A4W]</patch>

==== Go to main menu after Title\High Scores ====

These patches cause the game to go to the [[Patch:Main menu (Dreams)|main menu]] after the titlescreen or high scores are displayed, even if the player doesn't press a key.

<patch title="Go to main menu even if no key is pressed">
#Go to main menu after title displays
%patch $4455 $EB

#Go to main menu after High Score table displays
%patch $4492 $EB</patch>

== Galaxy title ==

The Galaxy title screen is much less involved than the Vorticons one. All that can really be done is to change what image is used for it. There are, in fact, two different title screens shown. The first appears when the [[Patch:Terminator text|'terminator text']] is allowed to scroll uninterrupted. This will result in a 'titelscreen fade' where the title slowly appears from a black screen. The second title screen appears instantly if the player presses any key. By default both of these titles are identical, but they don't have to be.

Like all bitmaps, the title screen must be cached before it can be displayed. The number given in these patches is the chunk number (Properly labelled by [[Keengraph]]; [[ModKeen]] will label the bitmap with a different number.) As such there are a total of four lines of code, two for each title screen.

<patch title="Keen Galaxy Title screens">
#Keen 4 titlescreen chunks
%patch $4EDC [$006DW] #Cache for title fade
%patch $4CF4 [$006DW] #Display in title fade
%patch $51C4 [$006DW] #Cache for title jump
%patch $51D0 [$006DW] #Display in title jump

#Keen 5 titlescreen chunks
%patch $4ED6 [$0058W] #Cache for title fade
%patch $4CEE [$0058W] #Display in title fade
%patch $51BE [$0058W] #Cache for title jump
%patch $51CA [$0058W] #Display in title jump

#Keen 6 titlescreen chunks
%patch $4CF7 [$0022W] #Cache for title fade
%patch $4B0F [$0022W] #Display in title fade
%patch $4FCD [$0022W] #Cache for title jump
%patch $4FD9 [$0022W] #Display in title jump</patch>

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}

Patch:Bounder

2020-04-01T02:14:05Z

Levellass: Miiiinor format tweak

[[Bounder]]s are red, spherical creatures in [[Keen 4]]. They are harmless to Keen and can be ridden on by him. This effect is not due to anything in the Bounder's code but rather [[Patch:Keen (Keen 4)#Sprite_Collision|Keen's sprite collisions.]] As such patches that affect the finer points of this interaction (As opposed to whether or not the Bounder possesses that interaction) can be found at [[Patch:Keen (Keen 4)]].

= [[Patch:Sprite type|Sprite Type]] =

The Bounder uses sprite type 15, which means it can push Keen, and Keen can ride on it, much like a [[Patch:Platform (Keen 4)|moving platform.]] Changing this will make it so Keen can't ride on or be pushed by Bounders. The second sprite type is that the Bounder changes to when stunned. The default values makes it such that Keen can't stand on the Bounder once it has been stunned.

<patch title="Keen 4">
#Bounder sprite type
%patch $110FE [$0F] #When spawned
%patch $11174 [$21] #When stunned</patch>

== Bounder can still be stood on after being shot ==

This patch alter things so that the Bounder can still be stood on after they have been shot. This is important if the modder wants the Bounder to be shot multiple times.

<patch title="Keen 4">
#Bounder can still be stood on after being shot
%patch $11172 $EB $02</patch>

= [[Patch:Sprite actions|Sprite Actions]] =

The Bounder has a number of interesting actions. When created it is bouncing vertically, a two-frame action loop. Randomly it will go to bouncing left or right, another two frame action loop. After bouncing left or right it will return to bouncing vertically.

If Keen is standing directly on top of the Bounder then it will alter its action to bouncing vertically. When shot it jumps into the air as a stunned Bounder, that changes to a landed stunned bounder when it hits the ground. This will then do nothing.

Actions:
$2F12W #Bounder bouncing vertically
$2F30W #Bounder bouncing vertically
$2F4EW #Bounder bouncing left/right
$2F6CW #Bounder bouncing left/right
$2F8AW #Stunned Bounder in air
$2FA8W #Stunned Bounder on ground

<patch title="Keen 4">
#Bounder start -bounce vertically
%patch $1112A [$2F12W]

#Vertical bounce loop
%patch $31D9E [$2F30W]
%patch $31DBC [$2F12W]

#Randomly bounce left\right
%patch $1126E [$2F4EW]

#Bouncing left\right loop
%patch $31DDA [$2F6CW]
%patch $31DF8 [$2F4EW]

#After bouncing left\right bounce vertically
%patch $11221 [$2F12W]

#If Keen is on top of bounder bounce vertically
%patch $1127D [$2F12W]

#When shot, fly through air
%patch $11166 [$2F8AW]

#When stunned in air and landing go to stun
%patch $31E16 [$2FA8W]

#When stunned on ground do nothing
%patch $31E34 [$0000W]</patch>

= [[Patch:Sprite behavior|Sprite Behavior]] =

The Bounder does not have its own unique behavior. Instead it uses a generic 'stunned sprite' behavior, even while not stunned. This behavior lets it fly through the air and animate. (Bouncing it handled in its tile collision.)

Patches controlling how far left or right of the Bounder Keen must be to control it can be found in the sprite positioning section.

Behaviors:
$09DC16C9RL #Shot sprite

<patch title="Keen 4">
#Bound u-d
%patch $31D92 $09DC16C9RL
%patch $31DB0 $09DC16C9RL

#Bound l-r
%patch $31DCE $09DC16C9RL
%patch $31DEC $09DC16C9RL

#Stunned
%patch $31E0A $09DC16C9RL
%patch $31E28 $09DC16C9RL</patch>

== Bounder chases Keen ==

This patch changes things so that Bounders will always chase Keen. This is done by making it so that Keen doesn't have to be riding them to make them change direction, so they'll always head in his direction.

<patch title="Bounders chase Keen">
#Bounders chase Keen
%patch $111C2 $90 $90</patch>

== Bounder doesn't obey Keen when he rides it ==

These patches make the Bounder ignore Keen; the first makes the Bounder continue to bounce in random directions whether or not Keen is on it. The second and third patches stop the Bounder moving left or right when Keen is on it.

<patch title="Bounder doesn't obey Keen when he rides it">
#Bounder doesn't obey Keen when he rides it
%patch $111C2 $EB

#Don't obey Keen...
%patch $111D6 $EB #Left
%patch $111EC $EB #Right</patch>

= [[Patch:Sprite speed|Speed and Jump Height]] =

The Bounder does not use animation motion, its speed is defined entirely by its bounces, including the 'kick' it gets when it is shot by Keen. The Bounder has a set jump height, and two jump lengths (The same length left and right.), one for a 'free' Bounder, and one for a 'ridden' Bounder.

The Bounder also has a number of jump directions, that is, what directions to move. When being ridden by Keen these are quite obvious, it heads in the direction Keen is riding it. When 'free' they are random. (See the probability section below.) When riding Keen must be a certain number of pixels left or right of the Bounder's ''center'' to make it move in the direction he wishes.

<patch title="Bounder jump height">
#How high a bounder flies into the air when shot
%patch $11179 [$20]

%patch $111BC [$FFCEW] #Bounder's vertical jump height
%patch $111FE [$0018W] #Bounder's jump length (With Keen riding)
%patch $11260 [$0018W] #Bounder's jump length (Without Keen riding)</patch>

<patch title="Bounder's jump directions:">
#Direction bounder is set to after landing (Up)
%patch $11232 $0000W

#Free bounce directions
%patch $11245 $FFFFW #Left
%patch $11253 $0001W #Right
%patch $1125A $0000W #Up

#How far left\right Keen must be to make Bounder move in that direction
%patch $111D1 [$0040W] #Left
%patch $111E7 [$0040W] #Right

#Ridden bounce directions
%patch $111DB $FFFFW #Left (Keen riding l)
%patch $111F1 $0001W #Right (Keen riding r)
%patch $111F8 $$0000W #Up (Keen on top)</patch>

<patch title="Animation motion">
#Bounder bouncing Vertically
%patch $31D8E $0000W $0000W #Speed 1
%patch $31DAC $0000W $0000W #Speed 2

#Bounder bouncing side to side
%patch $31DCA $0000W $0000W #Speed 1
%patch $31DE8 $0000W $0000W #Speed 2

#Stunned
%patch $31E06 $0000W $0000W #Speed 1 (In air)
%patch $31E24 $0000W $0000W #Speed 2 (On ground)</patch>

== Bounder doesn't jump when shot ==

This patch stops the Bounder jumping when it is shot, it simply falls to the ground.

<patch title="Keen 4">
#Shot Bounder doesn't jump
%patch $11176 $5F $5E $5D $CB</patch>

= [[Patch:Sprite collision|Sprite Collision]] =

== Collision values ==

The Bounder has a unique collision that it uses when bounding left or right. Once it has been shot it has no collision, preventing it from being repeatedly stunnable.

<patch title="Keen 4">
#Bouncing vertical
%patch $31D96 $10800938RL
%patch $31DB4 $10800938RL

#Bouncing left\right
%patch $31DD2 $10800938RL
%patch $31DF0 $10800938RL

#Stunned
%patch $31E0E $00000000L #In air
%patch $31E2C $00000000L #On ground</patch>

== Collision code ==

The collision code is notable in that it sets a number of variables to zero when shot. it is not known what these are at present. The Bounder responds only to Keen's shot by default; while Keen can ride the bounder, this does not relate to the bounder's collision code.

<patch title="Keen 4">
#Bounder collision
%patch $11138 $55 $8B $EC $56 $57 $8B $76 $06 $8B $7E $08 $83 $3D {$03 $75} $32
$C7 $44 $3E [$0000W] $C7 $44 $40 [$0000W] $C7 $44 $42 [$0000W] $8B
$04 $89 $44 $44 $57 $9A $0D8F0D43RL $83 $C4 $02 $B8 [$2F8AW]
$50 $56 $9A $09DC120ARL $83 $C4 $04 $C7 $04 [$0021W] $83 $6C
$18 $20 $5F $5E $5D $CB</patch>

=== Bounder lethal but shootable ===

This patch adapts the [[Patch:Poison Slug|Poison Slug]]'s collision code for the Bounder. It does not require any extra space be created, but is incompatible with some of the patches on this page, such as the shot action and jump height when shot. (This patch removes the Bounder's ability to jump into the air when shot by Keen.)

<patch title="Keen 4">
#Bounder collision: Lethal, shootable
%patch $11138 $55 $8B $EC $56 $57 $8B $76 $06 $8B $7E $08 $83 $3D [$02] {$75} $09 #Check for Keen (Type 2)
$9A $0B8013E9RL $5F $5E $5D $CB $83 $3D [$03] {$75} $0E $B8 #If Keen, kill him; check for shot (Type 3)
[$2F8AW] $50 $57 $56 $9A $09DC1695RL $83 $C4 $06 $5F $5E $5D $CB #If shot, become $2F8AW</patch>

=== Bounder can be shot multiple times ===

This patch makes the Bounder stun for a short time when shot, before resuming as normal. The blue value is how long the Bounder will remain stunned.

<patch title="Bounder can be shot multiple times">
#Bounder stuns temporarily
%patch $31E18 $01EFW $01F0W $0000W $0000W $0001W [$00A8W] $00000W $0000W
$00000000L $10800938RL $09DC1847RL
%patch $31E34 $2F12W
%patch $11165 $C7 $44 $1C $2FA8W $5F $5E $5D $CB</patch>

=== Bounder jumps when touching Keen ===

This patch makes it so that the Bounder will jump into the air when Keen touches it in any way (Except from above, when he stands on it.) This means Keen can do things such as bounce the Bounder off of his head or launch it high in the air by jumping while under it.

<patch title="Bounder jumps when touching Keen">
#Bounder jumps when touching Keen:
%patch $11145 $02 $75 $04 $83 $6C $18 $20 $5F $5E $5D $CB</patch>

= [[Patch:Sprite animations|Animations]] =

The Bounder has three cycles of animation. The first relates to whether the Bounder is moving left or right, using different animations depending on the direction. The second is for when the Bounder is moving straight up and down. The third cycle involves the shot and stunned Bounder.

<patch title="Keen 4">
#Cache
%patch $30706 $01EBW #Bounder Cache start
%patch $30750 $01F1W #Bounder cache end

#Bouncing vertically
%patch $31D82 $01EFW $01EFW
%patch $31D8C $0014W #Animation speed
%patch $31DA0 $01F0W $01F0W
%patch $31DAA $0014W #Animation speed

#Bounder moving left/right
%patch $31DBE $01EBW $01EDW
%patch $31DC8 $0014W #Animation speed
%patch $31DDC $01ECW $01EEW
%patch $31DE6 $0014W #Animation speed

#Stunned Bounder in air
%patch $31DFA $01EFW $01EFW
%patch $31E04 $0000W #Animation speed

#Stunned Bounder (Do nothing)
%patch $31E18 $01F1W $01F1W
%patch $31E22 $0000W #Animation speed</patch>

= [[Patch:Sprite positioning|Sprite positioning]] =

The Bounder spawns 7 pixels higher then where it is placed in-level. This is not really important since the Bounder doesn't walk along the ground.

<patch title="Keen 4">
#Spawn height:
%patch $1111A [$FF80W] #7 pixels up</patch>

== Keen control positions ==

Keen can control the Bounder if he is less than 4 pixels from either edge of the sprite. These limits can be changed, however it is wise not to make them so wide that they overlap.

<patch title="Keen 4">
#Bounder control limits
%patch $111D1 [$0040W] #Left -4 pixels
%patch $111E7 [$0040W] #Right -4 pixels</patch>

= [[Patch:Sprite Sounds|Sounds]] =

The Bounder has a distinct bouncing sound, this can be blocked.

<patch title="Keen 4">
#Bounder bounce sound
%patch $111AE [$10]

#Don't make Bounder bounce sound:
%patch $111AD $EB $0A</patch>

= [[Patch:Sprite clipping and foreground|Clipping and foreground]] =

The Bounder has a foreground variable of 0, meaning it appears behind all sprites and foreground tiles. This avoids graphics oddities when it bounces against walls and ceilings.

<patch title="Keen 4">
#Bounder foreground variable
%patch $11108 [$0000W]</patch>

= [[Patch:Sprite-tile interaction|Sprite-tile interaction]] =

The Bounder's tile interaction is responsible for its actual bouncing, its bouncing sound and jump heights. (See above speed section.) It uses its tile collision whenever bouncing but of course uses a generic 'stunned sprite' tile collision after it has been shot.

<patch title="Keen 4">
%patch $31D9A $1080097ERL #Bounding up
%patch $31DB8 $1080097ERL #Bounding up

%patch $31DD6 $1080097ERL #Bounding l/r
%patch $31DF4 $1080097ERL #Bounding l/r

%patch $31E12 $09DC1913RL #Shot
%patch $31E30 $09DC1913RL #Stunned</patch>

== Interaction code ==

This is the Bounder's tile interaction code. It is quite complex due to the fact that it controls not only the Bounder interacting with walls, floors and ceilings, but also Keen controlling it while riding and random bouncing.

The first line checks for ceilings; if found then the Bounder's vertical speed is set to zero. On the second line floors are checked for, if found a big jump over the following code is itself jumped.

Following this (That is, if floor is found) an unknown subroutine is called and if it returns a value of 0, sound $10 played (The Bounder bouncing sound.) On the same line the Bounder's jump height is set to <tt>$FFCEW</tt>. Next online 5 the Bounder checks to see if Keen is riding it, if so its Misc Variable C is set to 0 and Keen's position relative to it checked.

First Keen's left hitbox side is compared to the Bounder's, if less than 40 pixels from the Bounder's edge the Boudner's horizontal direction is set to -1 (Left). The same is then done for Keen's right hitbox side, turning the Bounder right. If neither is the case the Bounder's horizontal direction is set to 0. Finally at the start of line 9 the Bounder is given a horizontal speed, a jump width and the remaining 'random bounce' code skipped.

The random bounce code starts at the end of line 9. The first two lines check to see if the Bounder has been bounding left\right, if so it is 'reset' to bounding up and down. This acts as a restraint to stop the Bounder 'getting stuck' bouncing in a single direction. After this the random number generator is called. If the resulting number is less than $64 the Bounder will bound left, if it is between $64 and $00C8W then it will bound right, larger than $00C8W then it will bound up and down. This gives a roughly 33% chance for each option. After ''that'' the Bounder checks what direction it is moving in. If it is moving up and down it changes its action to bouncing up and down, otherwise it changes its action to bouncing left\right.

Finally walls are checked for. If left or right walls are found the Bounder simply reverses its current direction. The remaining code draws the sprite onscreen.

<patch title="Keen 4">
#Bounder tile collision
%patch $1117E $55 $8B $EC $83 $EC $02 $56 $57 $8B $7E $06 $83 $7D {$3A} [$00] {$74}
$05 $C7 $45 $18 [$0000W] $83 $7D {$36} [$00] {$75} $03 $E9 $00ECW $FF
$45 $40 $57 $9A $09DC1260RL $83 $C4 $02 $0B $C0 $74 $0C $B8
[$0010W] $50 $9A $187409F1RL $83 $C4 $02 $C7 $45 $18 [$FFCEW]
$39 $3E [$7A6EW] {$75} $43 $C7 $45 $40 [$0000W] $8B $1E $D6 $A7 $8B
$45 $22 $2D [$0040W] $39 $47 [$22] {$73} $07 $C7 $45 $0E [$FFFFW] $EB
$1B $8B $1E $D6 $A7 $8B $45 $26 $05 [$0040W] $39 $47 $26 $76 $07
$C7 $45 $0E [$0001W] $EB $05 $C7 $45 $0E [$0000W] $8B $45 $0E $BA
[$0018W] $F7 $EA $89 $45 $16 $EB $60

#Randomly bounce
%patch $11207 $83 $7D $40 $02 $7E $06 $83
$7D $3E [$00] {$75} $1C $C7 $45 $3E [$0001W] $33 $C0 $89 $45 $16 $89
$45 $0E $B8 [$2F12W] $50 $57 $9A $09DC120ARL $83 $C4 $04 $EB
$38 $C7 $45 $3E $0000W $9A $1D02002ARL $89 $46 $FE $83 $7E
$FE [$64] {$7D} $07 $C7 $45 $0E [$FFFFW] $EB $13 $81 $7E $FE [$00C8W]
{$7D} $07 $C7 $45 $0E [$0001W] $EB $05 $C7 $45 $0E [$0000W] $8B $45
$0E $BA [$0018W] $F7 $EA $89 $45 $16 $83 $7D $0E [$00] {$74} $0F $B8
[$2F4EW] $50 $57 $9A $09DC120ARL $83 $C4 $04 $EB $0D $B8 [$2F12W]
$50 $57 $9A $09DC120ARL $83 $C4 $04

#Check for walls and drawn sprite
%patch $11289 $83 $7D {$38} [$00] {$75}
$06 $83 $7D {$3C} [$00] {$74} $10 $8B $45 $0E $F7 $D8 $89 $45 $0E $8B
$45 $16 $F7 $D8 $89 $45 $16 $FF $75 $20 $33 $C0 $50 $FF $75 $1E
$FF $75 $0C $FF $75 $0A $8B $C7 $05 $46 $00 $50 $9A $16541641RL
$83 $C4 $0C $5F $5E $8B $E5 $5D $CB</patch>

= [[Patch:Galaxy Action Parameters#Action_Type|Action type]] =

The Bounder uses action type 3 for all of its actions except when stunned. This allows it to respond to Keen while still moving smoothly through the air. Type 2 is used for both stunned actions as expected.

<patch title="Keen 4">
#Bouncing vertical
%patch $31D86 [$0003W]
%patch $31DA4 [$0003W]

#Bounder moving left/right
%patch $31DC2 [$0003W]
%patch $31DE0 [$0003W]

#Stunned Bounder in air
%patch $31DFE [$0002W]

#Stunned Bounder on ground
%patch $31E1C [$0002W]</patch>

= [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] =

The Bounder has no need for either of these variables and so has a value of 0 for both in all of its actions.

<patch title="Keen 4">
#Bouncing vertical
%patch $31D88 [$0000W $0000W]
%patch $31DA6 [$0000W $0000W]

#Bounder moving left/right
%patch $31DC4 [$0000W $0000W]
%patch $31DE2 [$0000W $0000W]

#Stunned in air
%patch $31E00 [$0000W $0000W]

#Stunned on ground
%patch $31E1E [$0000W $0000W]</patch>

= [[Patch:Probability|Probability, randomness and jump directions]] =

When the Bounder is not being ridden by Keen is randomly changes its bouncing directions. There are three directions it can bounce; left, right and vertical (Up and down.) This is handled via an unusual probability check. First the game takes a random number from 0-FF. Then it checks if the number is greater than $64. If ''not'' the Bounder bounds left. If it is then a second check is performed, this one seeing if the number if greater than $C8 ($64 + $64). If ''not'' the Bounder bounds right, otherwise it bounds vertically.

This means there is an equal chance of the Bounder bouncing left or right, but a smaller chance of it bouncing vertically. (0-100 is left, 101-200 is right, 201-255 is vertical. This is a ratio of about 2:2:1)

<patch title="Keen 4">
#Bounder bounce directions
%patch $11245 $FFFFW #Left
%patch $11253 $0001W #Right
%patch $1125A $0000W #Vertical

#Bounder bounce probabilities
%patch $1123F $64 #Left-right\vertical
%patch $1124C $C8 #Right-vertical</patch>

= [[Patch:Sprite spawning|Sprite spawn code]] =

In the initiation code notice the [[Patch:Sprite cache|Bounder cache]] being set (<tt>$C7 $06 $CB71W $0001W</tt>.)

In the spawning code the last blue highlighted value is the [[Patch:Sprite actions|sprite action]] the sprite uses as it proceeds to act in-level. <tt>$C7 $02 $xxxxW</tt> sets the [[Patch:Galaxy Sprite Parameters#Sprite_activity|sprite activity,]] <tt>$C7 $07 $xxxxW</tt> sets the [[Patch:Sprite type|sprite type,]] <tt>$C7 $20 $xxxxW</tt> sets the [[Patch:Sprite clipping and foreground|foreground value.]] Finally <tt>$D3 $E0 $05 $xxxx</tt> is how far down (Or more usually ''up'') the sprite is spawned from where it is placed. This is necessary for sprites that walk on the ground as they can only be placed in the level at multiples of 16 pixels high while their actual height can be anything.

The Bounder always starts the level moving down and right. (Odd, it has no reason to.) <tt>$C7 $47 $10 $xxxxW</tt> is the vertical direction the sprite starts moving in, either $0001W (Facing down), $FFFFW (Facing up) or $0000W (Neither, never used.) <tt>$C7 $47 $0E $xxxxW</tt> is the horizontal direction.

<patch title="Keen 4">
#Location of initiation code
%patch $EE9B [$01FCW] #Bounder (At $EAEC)

#Bounder Initiation code
%patch $EAEC $FF $76 $FC $57 $9A {$108008EARL} $83 $C4 $04 $C7 $06 $CB71W
$0001W $E9 $02FCW

#Bounder spawning code
%patch $110EA $55 $8B $EC $33 $C0 $50 $9A $06BD1E11RL $83 $C4 $02 $8B $1E
$D8 $A7 $C7 $07 [$000FW] $C7 $47 $02 [$0001W] $C7 $47 $20 [$0000W]
$8B $46 $06 $B1 $08 $D3 $E0 $89 $47 $0A $8B $46 $08 $D3 $E0 $05
[$FF80W] $89 $47 $0C $C7 $47 $10 [$0001W] $C7 $47 $0E [$0000W] $B8
[$2F12W] $50 $53 $9A $09DC118CRL $83 $C4 $04 $5D $CB</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Sprite|}}

Patch:Keen's shot (Galaxy)

2020-03-24T07:01:42Z

Levellass: Add Keen 6 patch

In Keen Galaxy Keen's shot is a green ball of energy that can be shot in four directions while Keen is standing, jumping or on a pole. Its behavior is near identical across all three Galaxy episodes and so all three are treated here. Patches for individual episodes that relate to the player can be found at [[Patch:Keen (Keen 4)]], [[Patch:Keen (Keen 5)]] and [[Patch:Keen (Keen 6)]].

This page deals only with the shot once it is produced, as well as the process of creating it. It does not contain patches relating to the player, such patches can be found on [[Patch:Keen shooting (Galaxy)]], which deals with when and how the player produces the shot. (Including the famous [[Keen_6_Bugs#Impossible_Bullet|'impossible bullet' bug.)]] As an example, this page will contain patches for the shooting sound and shot directions, while the other page will contain patches relating to disabling shooting on poles, having a machine gun or the player's shooting animations.

The first sections of the page deal with the shot being produced, while the latter sections deal with the produced shot's [[Patch:Galaxy Sprite Parameters|sprite variables.]]

= [[Patch:Sprite speed|Shot direction]] =

There are two aspects to shot direction. The first is the actual directions themselves. These are differentiated by giving different values of horizontal and vertical direction to a shot. However this code must be pointed to, and this is done with a pointer list that gets its value from what direction the player is facing.

There are eight possible directions for a shot to go (Up, up right, up left, left...) of which seven are on the list and only four are valid. (It is usually impossible to spawn an invalid shot, but it can happen.) These patches relate to the following section also, which passes a direction value to the game for the directions list.

<patch title="Keen 4">
#Location of pointer list (D8F0 + D35 = E625)
%patch $E5C5 $0D35W

#Length of list
%patch $E5BD $06

#Spawnshot pointer list (Origin D8F0)
%patch $E625 $0CD7W #Upwards
$0D17W #INVALID
$0CE7W #Rightwards
$0D17W #INVALID
$0CF7W #Downwards
$0D17W #INVALID
$0D07W #Leftwards

#Shot directions:
#Up
%patch $E5CE [$0000W] #Horizontal
%patch $E5D3 [$FFFFW] #Vertical

#Right
%patch $E5DE [$0001W] #Horizontal
%patch $E5E3 [$0000W] #Vertical

#Down
%patch $E5ED [$0000W] #Horizontal
%patch $E5F3 [$0001W] #Vertical

#Left
%patch $E5FD [$FFFFW] #Horizontal
%patch $E603 [$0000W] #Vertical</patch>

<patch title="Keen 5">
#Location of pointer list (D8F0 + D35 = E625)
%patch $DCF4 $10A5W

#Length of list
%patch $DCEC $06

#Spawnshot pointer list (Origin D8F0)
%patch $DD55 $1046W #Upwards
$1086W #INVALID
$1056W #Rightwards
$1086W #INVALID
$1066W #Downwards
$1086W #INVALID
$1076W #Leftwards

#Shot directions:
#Up
%patch $DCFD [$0000W] #Horizontal
%patch $DD02 [$FFFFW] #Vertical

#Right
%patch $DD0D [$0001W] #Horizontal
%patch $DD12 [$0000W] #Vertical

#Down
%patch $DD1C [$0000W] #Horizontal
%patch $DD22 [$0001W] #Vertical

#Left
%patch $DD2C [$FFFFW] #Horizontal
%patch $DD32 [$0000W] #Vertical</patch>

= Shot destruction =

The destruction of Keen's shot is caused by many things, such as colliding with enemies and solid tiles. Patches in this section deal with both causes and effects of destruction.

== Shot smashes on pole-going-through tiles ==

By default Keen can shoot up through ceilings and down through floors if they also have a pole going through them. This patch alters (And significantly shortens) the shot's tile interaction so that it will also smash on such tiles, preventing Keen from performing such 'pole tricks'.

<patch title="Keen 4">
#Keen's shots smash on pole ground
%patch $E722 $55 $8B $EC $83 $EC $02 $56 $57 $8B $7E $06
$83 $7D $36 $00 $75 $12 $83 $7D $3A $00 $75 $0C $83 $7D $38 $00
$75 $06 $83 $7D $3C $00 $74 $08 $57 $0E $E8 $FEE9W $83 $C4 $02
$FF $75 $20 $33 $C0 $50 $FF $75 $1E $FF $75 $0C $FF $75 $0A $8B
$C7 $05 $46 $00 $50 $9A $16541641RL $83 $C4 $0C $5F $5E $8B
$E5 $5D $CB</patch>

== Destroyed shots can still stun ==

See the section 'sprite type' for this patch.

= Shot spawn position relative to Keen =

Depending on what action is being used when shooting and sometimes on what direction Keen is facing, Keen's shot will spawn at different positions relative to him. This is because different animations are different sizes and different appearances. A single shot position would look exceedingly awkward.

In essence the game checks every possible shooting action individually, shooting left\right, shooting up, shooting up while jumping... In the case of shooting left\right the game also checks what direction Keen is facing, as those actions have different animations for Keen facing either way, each of which needs a unique shot position and direction.

To understand the following patches it is helpful to have some knowledge of [[Patch:Sprite positioning|Sprite positioning]] and [[Patch:Jump conditions|jump conditions.]] Note that two of the sprite positions are ''negative'', despite having positive values. (They are reversed.) A knowledge of [[Patch:Galaxy Sprite Parameters|galaxy sprite parameters]] will assist in making unique patches by altering the action\direction checks to something more complex.

And of course, when in doubt, simply tweak the relevant patch until the desired result is obtained.

The following patches are given by episode, in each section of patches are subsections for each different shooting action. There are a total of 15 unique positions in the following order: Shoot left, Shoot right, Jump Shoot left, Jump Shoot right, Jump Shoot down, Jump Shoot up, Shoot up, Shoot left on poles, Shoot right on poles, Shoot up on poles, and Shoot down on poles.

Note that shot direction is also included in the position; this is actually based in the Spawn_Shot code at another location, but the upshot is that no patchable value is up, 2 is right, 4 down and 6 left. Other values will cause an error and crash. (Bad dir.)

<patch title="Keen 4 shot positions">
#Check direction and action - Shoot left\right
%patch $C99D $7C {$1C} [$0D6AW] {$75} $3C $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 256,64
%patch $C9AA [$0002W] #Direction
%patch $C9B1 [$0040W] #Vertical position
%patch $C9B8 [$0100W] #Horizontal position

#Left Keen - Left -128,64
%patch $C9C6 [$0006W] #Direction
%patch $C9CD [$0040W] #Vertical position
%patch $C9D4 [$0080W] #Horizontal position

#Check direction and action - Shoot left\right jumping
%patch $C9E0 $7C {$1C} [$11FCW] {$75} $38 $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 32,256
%patch $C9ED [$0002W] #Direction
%patch $C9F4 [$0020W] #Vertical position
%patch $C9FB [$0100W] #Horizontal position

#Left Keen - Left 32,0
%patch $CA09 [$0006W] #Direction
%patch $CA10 [$0020W] #Vertical position

#Check action - Shoot down jumping
%patch $CA1F $7C {$1C} [$12B0W] {$75}

#Keen - Down 288,128
%patch $CA26 [$0004W] #Direction
%patch $CA2D [$0120W] #Vertical position
%patch $CA34 [$0080W] #Horizontal position

#Check action - Shoot up jumping
%patch $CA40 $7C {$1C} [$1256W] {$75}

#Keen - Up 160,80
%patch $CA4D [$00A0W] #Vertical position
%patch $CA54 [$0050W] #Horizontal position

#Check action - Shoot up
%patch $CA60 $7C {$1C} [$0DA6W] {$75}

#Keen - Up 160,80
%patch $CA6D [$00A0W] #Vertical position
%patch $CA74 [$0050W] #Horizontal position

#Check direction and action - Shoot left\right on poles
%patch $CA80 $7C {$1C} [$0FE0W] {$75} $3C $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 64,256
%patch $CA8D [$0002W] #Direction
%patch $CA94 [$0040W] #Vertical position
%patch $CA9B [$0100W] #Horizontal position

#Left Keen - Left 64,128
%patch $CAA9 [$0002W] #Direction
%patch $CAB0 [$0040W] #Vertical position
%patch $CAB7 [$0080W] #Horizontal position

#Check direction and action - Shoot up on poles
%patch $CAC3 $7C {$1C} [$101CW] {$75} $3A $83 $7C {$0E} [$01] {$75}

#Right Keen - Up 64,96
%patch $CAD6 [$0040W] #Vertical position
%patch $CADD [$0060W] #Horizontal position

#Left Keen - Up 64,192
%patch $CAF1 [$0040W] #Vertical position
%patch $CAF8 [$00C0W] #Horizontal position

#Check direction and action - Shoot down on poles
%patch $CB04 $7C {$1C} [$1058W] {$75} $3D $83 $7C {$0E} [$01] {$75}

#Right Keen - Down 384,96
%patch $CB11 [$0004W] #Direction
%patch $CB18 [$0180W] #Vertical position
%patch $CB1F [$0060W] #Horizontal position

#Left Keen - Down 384,192
%patch $CB2E [$0004W] #Direction
%patch $CB35 [$0180W] #Vertical position
%patch $CB3C [$00C0W] #Horizontal position</patch>

<patch title="Keen 5 shot positions">
#Check direction and action - Shoot left\right
%patch $BDBB $7C {$1C} [$0BEEW] {$75} $3C $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 256,64
%patch $BDC8 [$0002W] #Direction
%patch $BDCF [$0040W] #Vertical position
%patch $BDD6 [$0100W] #Horizontal position

#Left Keen - Left -128,64
%patch $BDE4 [$0006W] #Direction
%patch $BDEB [$0040W] #Vertical position
%patch $BDF2 [$0080W] #Horizontal position

#Check direction and action - Shoot left\right jumping
%patch $BDFE $7C {$1C} [$10DAW] {$75} $38 $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 32,256
%patch $BE0B [$0002W] #Direction
%patch $BE12 [$0020W] #Vertical position
%patch $BE19 [$0100W] #Horizontal position

#Left Keen - Left 32,0
%patch $BE27 [$0006W] #Direction
%patch $BE2E [$0020W] #Vertical position

#Check action - Shoot down jumping
%patch $BE3D $7C {$1C} [$118EW] {$75}

#Keen - Down 288,128
%patch $BE44 [$0004W] #Direction
%patch $BE4B [$0120W] #Vertical position
%patch $BE52 [$0080W] #Horizontal position

#Check action - Shoot up jumping
%patch $BE5E $7C {$1C} [$1134W] {$75}

#Keen - Up 160,80
%patch $BE6B [$00A0W] #Vertical position
%patch $BE72 [$0050W] #Horizontal position

#Check action - Shoot up
%patch $BE7E $7C {$1C} [$0C2AW] {$75}

#Keen - Up 160,80
%patch $BE8B [$00A0W] #Vertical position
%patch $BE92 [$0050W] #Horizontal position

#Check direction and action - Shoot left\right on poles
%patch $BE9E $7C {$1C} [$0EBEW] {$75} $3C $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 64,256
%patch $BEAB [$0002W] #Direction
%patch $BEB2 [$0040W] #Vertical position
%patch $BEB9 [$0100W] #Horizontal position

#Left Keen - Left 64,128
%patch $BEC7 [$0002W] #Direction
%patch $BECE [$0040W] #Vertical position
%patch $BED5 [$0080W] #Horizontal position

#Check direction and action - Shoot up on poles
%patch $BEE1 $7C {$1C} [$0EFAW] {$75} $3A $83 $7C {$0E} [$01] {$75}

#Right Keen - Up 64,96
%patch $BEF4 [$0040W] #Vertical position
%patch $BEFB [$0060W] #Horizontal position

#Left Keen - Up 64,192
%patch $BF0F [$0040W] #Vertical position
%patch $BF16 [$00C0W] #Horizontal position

#Check direction and action - Shoot down on poles
%patch $BF22 $7C {$1C} [$0F36W] {$75} $3D $83 $7C {$0E} [$01] {$75}

#Right Keen - Down 384,96
%patch $BF2F [$0004W] #Direction
%patch $BF36 [$0180W] #Vertical position
%patch $BF3D [$0060W] #Horizontal position

#Left Keen - Down 384,192
%patch $BF4C [$0004W] #Direction
%patch $BF53 [$0180W] #Vertical position
%patch $BF5A [$00C0W] #Horizontal position</patch>

<patch title="Keen 6 shot positions">
#Check direction and action - Shoot left\right
%patch $BB9E $7C {$1C} [$0BE2W] {$75} $3C $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 256,64
%patch $BBAB [$0002W] #Direction
%patch $BBB2 [$0040W] #Vertical position
%patch $BBB9 [$0100W] #Horizontal position

#Left Keen - Left -128,64
%patch $BBC7 [$0006W] #Direction
%patch $BBCE [$0040W] #Vertical position
%patch $BBD5 [$0080W] #Horizontal position

#Check direction and action - Shoot left\right jumping
%patch $BBE1 $7C {$1C} [$1074W] {$75} $38 $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 32,256
%patch $BBEE [$0002W] #Direction
%patch $BBF5 [$0020W] #Vertical position
%patch $BBFC [$0100W] #Horizontal position

#Left Keen - Left 32,0
%patch $BC0A [$0006W] #Direction
%patch $BC11 [$0020W] #Vertical position

#Check action - Shoot down jumping
%patch $BC20 $7C {$1C} [$1128W] {$75}

#Right Keen - Down 288,128
%patch $BC27 [$0004W] #Direction
%patch $BC2E [$0120W] #Vertical position
%patch $BC35 [$0080W] #Horizontal position

#Check action - Shoot up jumping
%patch $BC41 $7C {$1C} [$10CEW] {$75}

#Keen - Up 160,80
%patch $BC4E [$00A0W] #Vertical position
%patch $BC55 [$0050W] #Horizontal position

#Check action - Shoot up
%patch $BC61 $7C {$1C} [$0C1EW] {$75}

#Keen - Up 160,80
%patch $BC6E [$00A0W] #Vertical position
%patch $BC75 [$0050W] #Horizontal position

#Check direction and action - Shoot left\right on poles
%patch $BC81 $7C {$1C} [$0E58W] {$75} $3C $83 $7C {$0E} [$01] {$75}

#Right Keen - Right 64,256
%patch $BC8E [$0002W] #Direction
%patch $BC95 [$0040W] #Vertical position
%patch $BC9C [$0100W] #Horizontal position

#Left Keen - Left 64,128
%patch $BCAA [$0002W] #Direction
%patch $BCB1 [$0040W] #Vertical position
%patch $BCB8 [$0080W] #Horizontal position

#Check direction and action - Shoot up on poles
%patch $BCC4 $7C {$1C} [$0E94W] {$75} $3A $83 $7C {$0E} [$01] {$75}

#Right Keen - Up 64,96
%patch $BCD7 [$0040W] #Vertical position
%patch $BCDE [$0060W] #Horizontal position

#Left Keen - Up 64,192
%patch $BCF2 [$0040W] #Vertical position
%patch $BCF9 [$00C0W] #Horizontal position

#Check direction and action - Shoot down on poles
%patch $BD05 $7C {$1C} [$0ED0W] {$75} $3D $83 $7C {$0E} [$01] {$75}

#Right Keen - Down 384,96
%patch $BD12 [$0004W] #Direction
%patch $BD19 [$0180W] #Vertical position
%patch $BD20 [$0060W] #Horizontal position

#Left Keen - Down 384,192
%patch $BD2F [$0004W] #Direction
%patch $BD36 [$0180W] #Vertical position
%patch $BD3D [$00C0W] #Horizontal position</patch>

= [[Patch:Sprite type|Sprite Type]] =

The shot's sprite type is 3, the second most important type in the game, as this is what nearly all enemies respond to when they are shot. Changing this will make most enemies indestructible. It is one of the few sprite types that really matters.

The destroyed shot's sprite type is also important; if it is 3 problems occur, and if it is the same as the moving Platform, Keen can stand on it and perform the [[Keen 6 Bugs#Impossible_Bullet|impossible bullet trick]]

<patch title="Keen's shot sprite type">
#Keen 4
%patch $E5A5 $0003W #Shot
%patch $E63C $0001W #Changes to this when destroyed

#Keen 5
%patch $DCD4 $0003W #Shot
%patch $DD6C $0001W #Changes to this when destroyed

#Keen 6
%patch $D83F $0003W #Shot
%patch $D92B $0001W #Changes to this when destroyed</patch>

== Don't change type on smashing ==

These patches prevent the shot from changing its type to 'misc' when it is destroyed. This means it can still stun enemies (And thus be 're-destroyed' when smashed which may lead to an infinite loop if it happens to hit an indestructible enemy.

<patch title="Keen's shot sprite type doesn't change when it smashes">
#Keen's shot sprite type doesn't change when it smashes -Keen 4
%patch $E63A $EB $02

#Keen's shot sprite type doesn't change when it smashes -Keen 5
%patch $DD6A $EB $02

#Keen's shot sprite type doesn't change when it smashes -Keen 6
%patch $D929 $EB $02</patch>

= [[Patch:Sprite actions|Sprite Actions]] =

The shot is quite simple, it is produced by Keen when he shoots, loops constantly between four actions, and is destroyed when it hits sprites or tiles, the destroyed shot having two actions before going to nothing.

== Keen 4 ==

Actions:
$1738W #Keen's bullet 1
$1756W #Keen's bullet 2
$1774W #Keen's bullet 3
$1792W #Keen's bullet 4
$17B0W #Keen's bullets zaps 1
$17CEW #Keen's bullets zaps 2

<patch title="Keen 4">
#Spawn shot
%patch $E614 [$1738W]

#Shot destroyed
%patch $E63F [$17B0W]

#Shot moving
%patch $305C4 [$1756W] #Keen's bullet 1
%patch $305E2 [$1774W] #Keen's bullet 2
%patch $30600 [$1792W] #Keen's bullet 3
%patch $3061E [$1738W] #Keen's bullet 4

#Smashed shot
%patch $3063C [$17CEW] #Keen's bullets zaps 1
%patch $3065A [$0000W] #Keen's bullets zaps 2</patch>

== Keen 5 ==

Actions:
$1502W #Keen's shot 1
$1520W #Keen's shot 2
$153EW #Keen's shot 3
$155CW #Keen's shot 4
$157AW #Keen's shot smash 1
$1598W #Keen's shot smash 2

<patch title="Keen 5">
#Spawn shot
%patch $DD43 [$1502W]

#Shot moving
%patch $3185E [$1520W] #Keen's shot
%patch $3187C [$153EW] #Keen's shot
%patch $3189A [$155CW] #Keen's shot
%patch $318B8 [$1502W] #Keen's shot

#What shot becomes on colliding
%patch $DD6F [$157AW]

#Smashed shot
%patch $318D6 [$1598W] #Keen's shot smash
%patch $318F4 [$0000W] #Keen's shot smash</patch>

== Keen 6 ==

Actions:
$153EW #Keen's shot 1
$155CW #Keen's shot 2
$157AW #Keen's shot 3
$1598W #Keen's shot 4
$15B6W #Keen's shot hits 1
$15D4W #Keen's shot hits 2

<patch title="Keen 6">
#Spawn shot
%patch $D8AE [$153EW]

#Shot destroyed
%patch $D92E [$15B6W]

#Shot moving
%patch $3228A [$155CW] #Keen's bullet 1
%patch $322A8 [$157AW] #Keen's bullet 2
%patch $322C6 [$1598W] #Keen's bullet 3
%patch $322E4 [$153EW] #Keen's bullet 4

#Smashed shot
%patch $32302 [$15D4W] #Keen's bullets zaps 1
%patch $32320 [$0000W] #Keen's bullets zaps 2</patch>

= [[Patch:Sprite behavior|Sprite Behavior]] =

Keen's shot's behavior is quite complex though its function remains unknown. All of the shot frames use the same behavior and the two smashed frames have no behavior.

<patch title="Keen 4">
#Keen's shot's behavior
%patch $305B8 $0D8F0D6ARL
%patch $305D6 $0D8F0D6ARL
%patch $305F4 $0D8F0D6ARL
%patch $30612 $0D8F0D6ARL

#Keen's shot's smash behavior
%patch $30630 $00000000L
%patch $3064E $00000000L</patch>

<patch title="Keen 5">
#Keen's shot's behavior
%patch $31852 $0CCB10DARL
%patch $31870 $0CCB10DARL
%patch $3188D $0CCB10DARL
%patch $318AC $0CCB10DARL

#Keen's shot's smash behavior
%patch $318CA $00000000L
%patch $318E8 $00000000L</patch>

<patch title="Keen 6">
#Keen's shot's behavior
%patch $3227E $0CA60EE9RL
%patch $3229C $0CA60EE9RL
%patch $322BA $0CA60EE9RL
%patch $322D8 $0CA60EE9RL

#Keen's shot's smash behavior
%patch $322F6 $00000000L
%patch $32314 $00000000L</patch>

= [[Patch:Sprite speed|Speed of Keen's shots]] =

Keen's shots move via animation motion; the faster they animate the faster they move. Keen's smashed shots do not move by default but can be made to do so.

<patch title="Keen 4">
#Keen's bullet speeds
%patch $305B4 $0040W $0040W #Speed 1
%patch $305D2 $0040W $0040W #Speed 2
%patch $305F0 $0040W $0040W #Speed 3
%patch $3060E $0040W $0040W #Speed 4

#Smashed shot speeds
%patch $3062C $0000W $0000W #Speed 1
%patch $3064A $0000W $0000W #Speed 2</patch>

<patch title="Keen 5">
#Keen's bullet speeds
%patch $3184E $0040W $0040W #Speed 1
%patch $3186C $0040W $0040W #Speed 2
%patch $3188A $0040W $0040W #Speed 3
%patch $318A8 $0040W $0040W #Speed 4

#Smashed shot speeds
%patch $318C6 $0000W $0000W #Speed 1
%patch $318E4 $0000W $0000W #Speed 2</patch>

<patch title="Keen 6">
#Keen's bullet speeds
%patch $3227A $0040W $0040W #Speed 1
%patch $32298 $0040W $0040W #Speed 2
%patch $322B6 $0040W $0040W #Speed 3
%patch $322D4 $0040W $0040W #Speed 4

#Smashed shot speeds
%patch $322F2 $0000W $0000W #Speed 1
%patch $32310 $0000W $0000W #Speed 2</patch>

= [[Patch:Sprite collision|Sprite Collision]] =

Keen's shots have no sprite collision, they affect no sprites at all, instead other sprites respond to ''them.''

<patch title="Keen 4">
#Keen's shot's sprite collision
%patch $333BC $00000000L #Keen's shot
%patch $333DA $00000000L #Keen's shot
%patch $333F8 $00000000L #Keen's shot
%patch $33416 $00000000L #Keen's shot
%patch $33434 $00000000L #Keen's shot smash
%patch $33452 $00000000L #Keen's shot smash</patch>

<patch title="Keen 5">
#Keen's shot's sprite collision
%patch $31856 $00000000L #Keen's shot
%patch $31874 $00000000L #Keen's shot
%patch $31892 $00000000L #Keen's shot
%patch $318B0 $00000000L #Keen's shot
%patch $318CE $00000000L #Keen's shot smash
%patch $318EC $00000000L #Keen's shot smash</patch>

<patch title="Keen 6">
#Keen's shot's sprite collision
%patch $32282 $00000000L #Keen's shot
%patch $322A0 $00000000L #Keen's shot
%patch $322BE $00000000L #Keen's shot
%patch $322DC $00000000L #Keen's shot
%patch $322FA $00000000L #Keen's shot smash
%patch $32318 $00000000L #Keen's shot smash</patch>

= [[Patch:Sprite clipping and foreground|Clipping and foreground]] =

Keen's shot has the foreground value of 0, meaning it appears behind all sprites and foreground tiles. This is useful as it often needs to appear behind Keen or tiles when produced or destroyed.

<patch title="Keen 4">
#Foreground value
%patch $E5A1 $0000W</patch>

<patch title="Keen 5">
#Foreground value
%patch $DCD0 $0000W</patch>

<patch title="Keen 6">
#Foreground value
%patch $D83B $0000W</patch>

== [[Patch:Sprite Activity Variable|Shot Activity]] ==

The shot must be active when offscreen, so it specifically has its activity variable set to 2. If it is any other value the shots will stop moving when Keen cannot see them, meaning that they are much, ''much'' harder to use. (Keen will often find himself running into shots that went offscreen and froze, only to reactivate later.)

<patch title="Keen 4">
#Shot activity variable
%patch $E5AA $0002W</patch>

<patch title="Keen 5">
#Shot activity variable
%patch $DCD9 $0002W</patch>

<patch title="Keen 6">
#Shot activity variable
%patch $D844 $0002W</patch>

= [[Patch:Sprite Sounds|Sounds]] =

There is only one sound used for Keen shooting, which can be easily blocked. Keen's shot also makes a sound when destroyed.

<patch title="Keen 4">
#Keen shoots sound
%patch $E5AD $04

#Don't play Keen shoots sound
%patch $E5AC $EB $0A

#Keen's shot smashes sound
%patch $E64C $19

#Don't play Keen's shot smashes sound
%patch $E64B $EB $0A</patch>

<patch title="Keen 5">
#Keen shoot sound
%patch $DCDC $04

#Don't play Keen shoot sound
%patch $DCDB $EB $0A

#Keen's shot smashes sound
%patch $DD7C $19

#Don't play Keen's shot smashes sound
%patch $DD7B $EB $0A</patch>

<patch title="Keen 6">
#Keen shoot sound
%patch $D847 $04

#Don't play Keen shoot sound
%patch $D846 $EB $0A

#Keen's shot smashes sound
%patch $D93B $19

#Don't play Keen's shot smashes sound
%patch $D93A $EB $0A</patch>

= [[Patch:Sprite animations|Animations]] =

The animation speed of Keen's shots also controls their speed. (See speed section.) The animation speed of the smashed shot controls how long it takes before it vanishes.

<patch title="Keen 4">
#Keen's shot
%patch $305A8 $00AEW $00AEW
%patch $305B2 $0006W #Animation speed
%patch $305C6 $00AFW $00AFW
%patch $305D0 $0006W #Animation speed
%patch $305E4 $00B0W $00B0W
%patch $305EE $0006W #Animation speed
%patch $30602 $00B1W $00B1W
%patch $3060C $0006W #Animation speed

#Keen's shot smash
%patch $30620 $00B2W $00B2W
%patch $3062A $000CW #Animation speed
%patch $3063E $00B3W $00B3W
%patch $30648 $000CW #Animation speed</patch>

<patch title="Keen 5">
#Keen's shot
%patch $31842 $0099W $0099W
%patch $3184C $0006W #Animation speed
%patch $31860 $009AW $009AW
%patch $3186A $0006W #Animation speed
%patch $3187E $009BW $009BW
%patch $31888 $0006W #Animation speed
%patch $3189C $009CW $009CW
%patch $318A6 $0006W #Animation speed

#Keen's shot smash
%patch $318BA $009DW $009DW
%patch $318C4 $000CW #Animation speed
%patch $318D8 $009EW $009EW
%patch $318E2 $000CW #Animation speed</patch>

<patch title="Keen 6">
#Keen's shot
%patch $3226E $0060W $0060W
%patch $32278 $0006W #Animation speed
%patch $3228C $0061W $0061W
%patch $32296 $0006W #Animation speed
%patch $322AA $0062W $0062W
%patch $322B4 $0006W #Animation speed
%patch $322C8 $0063W $0063W
%patch $322D2 $0006W #Animation speed

#Keen's shot smash
%patch $322E6 $0064W $0064W
%patch $322F0 $000CW #Animation speed
%patch $32304 $0065W $0065W
%patch $3230E $000CW #Animation speed</patch>

= [[Patch:Sprite-tile interaction|Sprite-tile interaction]] =

There are two tile interactions used by Keen's shots in each game. The first is used by Keen's shot itself. This makes it smash on solid tiles and slopes as well as having other, unknown, functions. The second simply draws the sprite, this is used by the smashed shot since it no longer needs to interact with tiles.

== Keen 4 ==

Keen 4:
$0D8F0E32RL #Keen's shot (Hit walls, floors, ceilings and go zap.)
$09DC176ERL #Draw sprite

<patch title="Keen 4">
#Keen's shot
%patch $305C0 $0D8F0E32RL
%patch $305DE $0D8F0E32RL
%patch $305FC $0D8F0E32RL
%patch $3061A $0D8F0E32RL

#Keen's shot smash
%patch $30638 $09DC176ERL
%patch $30656 $09DC176ERL</patch>

== Keen 5 ==

Keen 5:
$0CCB11A2RL #Keen's shot (Hit walls, floors, ceilings and go zap.)
$090B17B5RL #Draw sprite

<patch title="Keen 5">
#Keen's shot
%patch $3185A $0CCB11A2RL
%patch $31878 $0CCB11A2RL
%patch $31896 $0CCB11A2RL
%patch $318B4 $0CCB11A2RL

#Keen's shot smash
%patch $318D2 $090B17B5RL
%patch $318F0 $090B17B5RL</patch>

== Keen 6 ==

Keen 6:
$0CA60FB1RL #Keen's shot (Hit walls, floors, ceilings and go zap.)
$08F4180ARL #Draw sprite

<patch title="Keen 6">
#Keen's shot
%patch $32286 $0CA60FB1RL
%patch $322A4 $0CA60FB1RL
%patch $322C2 $0CA60FB1RL
%patch $322E0 $0CA60FB1RL

#Keen's shot smash
%patch $322FE $08F4180ARL
%patch $3231C $08F4180ARL</patch>

= [[Patch:Galaxy Action Parameters#Action_Type|Action type]] =

Keen's shot uses type 1 for its actions allowing sooth movement through the air. The smashed shot uses type 0 as it doesn't need to move.

<patch title="Keen 4">
#Keen's shot
%patch $305AC [$0001W]
%patch $305CA [$0001W]
%patch $305E8 [$0001W]
%patch $30606 [$0001W]

#Keen's shot smash
%patch $30624 [$0000W]
%patch $30642 [$0000W]</patch>

<patch title="Keen 5">
#Keen's shot
%patch $31846 [$0001W]
%patch $31864 [$0001W]
%patch $31882 [$0001W]
%patch $318A0 [$0001W]

#Keen's shot smash
%patch $318BE [$0000W]
%patch $318DC [$0000W]</patch>

<patch title="Keen 6">
#Keen's shot
%patch $32272 [$0001W]
%patch $32290 [$0001W]
%patch $322AE [$0001W]
%patch $322CC [$0001W]

#Keen's shot smash
%patch $322EA [$0000W]
%patch $32308 [$0000W]</patch>

= [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] =

Keen's shot has no need for either of these variables and so has a value of 0 for both in all its actions. If its 'stick to ground' value is changed to 1 then Keen's shots can climb slopes.

<patch title="Keen 4">
#Keen's shot
%patch $305AE [$0000W $0000W]
%patch $305CC [$0000W $0000W]
%patch $305EA [$0000W $0000W]
%patch $30608 [$0000W $0000W]

#Keen's shot smash
%patch $30626 [$0000W $0000W]
%patch $30644 [$0000W $0000W]</patch>

<patch title="Keen 5">
#Keen's shot
%patch $31848 [$0000W $0000W]
%patch $31866 [$0000W $0000W]
%patch $31884 [$0000W $0000W]
%patch $318A2 [$0000W $0000W]

#Keen's shot smash
%patch $318C0 [$0000W $0000W]
%patch $318DE [$0000W $0000W]</patch>

<patch title="Keen 6">
#Keen's shot
%patch $32274 [$0001W $0000W]
%patch $32292 [$0001W $0000W]
%patch $322B0 [$0001W $0000W]
%patch $322CE [$0001W $0000W]

#Keen's shot smash
%patch $322EC [$0000W $0000W]
%patch $3230A [$0000W $0000W]</patch>

= Shot destroyed code =

The destruction of Keen's shot is trigger by both sprites and tiles. (It is called as $0D8F0D43RL.) It does three things; the first is to change the shot's sprite type to 1, or 'Misc' so it doesn't interfere with anything else. Next it changes the shot's action to $17B0W, so the shot stops and vanishes, finally it plays sound $19. Two of these things can be removed, singularly or in combination.

<patch title="Keen 4">
#Complete Keen's shot smashes code
%patch $E633 $55 $8B $EC $56 $8B $76 $06 $C7 $04 [$0001W] $B8 [$17B0W] $50 $56
$9A $09DC120ARL $83 $C4 $04 $B8 [$0019W] $50 $9A $187409F1RL
$83 $C4 $02 $5E $5D $CB</patch>

<patch title="Keen 5">
#Complete Keen's shot smashes code
%patch $DD63 $55 $8B $EC $56 $8B $76 $06 $C7 $04 [$0001W] $B8 [$157AW] $50 $56
$9A $090B1242RL $83 $C4 $04 $B8 [$0019W] $50 $9A $196E09EFRL
$83 $C4 $02 $5E $5D $CB</patch>

== No sound when shot destroyed ==

If the sound is removed, little else changes.

<patch title="Keen 4">
#Keen's shot smashes code - no sound
%patch $E633 $55 $8B $EC $56 $8B $76 $06 $C7 $04 [$0001W] $B8 [$17B0W] $50 $56
$9A $09DC120ARL $83 $C4 $04 $5E $5D $CB</patch>

<patch title="Keen 5">
#Keen's shot smashes code - no sound
%patch $DD63 $55 $8B $EC $56 $8B $76 $06 $C7 $04 [$0001W] $B8 [$157AW] $50 $56
$9A $090B1242RL $83 $C4 $04 $5E $5D $CB</patch>

== Don't destroy shot on collision ==

With the 'change action' code removed the Shot will keep on moving, this can cause problems when it hits tiles, as this will not longer destroy the shot. Another patch should be added to remove the shot in some way.

<patch title="Keen 4">
#Keen's shot smashes code - no shot destruction
%patch $E633 $55 $8B $EC $56 $8B $76 $06 $C7 $04 [$0001W] $B8 [$0019W] $50 $9A
$187409F1RL $83 $C4 $02 $5E $5D $CB</patch>

<patch title="Keen 5">
#Complete Keen's shot smashes code
%patch $DD63 $55 $8B $EC $56 $8B $76 $06 $C7 $04 [$0001W] $B8 [$0019W] $50 $9A
$196E09EFRL $83 $C4 $02 $5E $5D $CB</patch>

= Misc =

Patches in this section do not fit neatly into the above sections.

== Keen can teleport to where his shots smash near [B] sprites ==

This patch will teleport Keen to wherever his shot smashes IF that shot is on a [[Patch:B sprite|[B] sprite]] when it does so. (You can have as many [B] sprites in a level as you want.) The [B] sprite must be *outside* the solid tile that causes the shot smash (So for floors above the floor, ceilings below the ceiling, left of left walls and right of right walls.) Keen's head will appear where the shot zap was (This can be adjusted by altering <tt>$2D $0000W</tt>, larger moves Keen down, negative moves Keen up.) and trying to teleport to another place before the 'old' (invisible!) teleport target has vanished will cause him to return to the old target. If for some odd reason the target vanishes before Keen can teleport he will 'teleport' to the same place he's standing. Keen can teleport off of poles with no problems. (Keen can also teleport after being killed, this will save him.)

The screen will not move instantly to where Keen is at, instead it will 'slide' from his old position to his current one. During this slide Keen can move, die, etc. The screen cannot 'slide' past scrollbars so Keen can teleport to an area offscreen and stay offscreen. [B] sprites will not affect Keen's shots moving through the air, only those that have hit tiles.

This patch uses the [[Patch:EGAGRAPH|EGAGRAPH check skip]] which is the first line of the patch. it is thus incompatible with any other patches using this. it also utilizes some space for the new [[Patch:Sprite actions|actions]] used which may also cause problems with other patches.

<patch title="Keen 4">
#Disable EGAGRAPH check in Keen 4 (Frees 389 bytes at $3CF6)
%patch $3CE5 $90 $90

#Custom behavior: Force Keen to search = $037D0526RL
%patch $3CF6 $55 $8B $EC $56 $57 $8B $76 $06 $8B $7E $08
$9A $037D053ARL $5F $5E $5D $CB

#Custom player effect: goto searching Keen = $037D053ARL
%patch $3D0A $55 $8B $EC $8B $1E $A7D6W $81 $7F $1C $D4 $0C $74 $19 $C7 $47 #Set clipping = 1
{$06} [$0001W] $B8 [$015BW] $50 $FF $36 $D6 $A7 $9A $09DC120ARL #Turn Keen into searching
$83 $C4 $04 $8B $1E $A7D6W $5D $CB

#Player search for target sprite behavior = $037D0563RL
%patch $3D33 $55 $8B $EC $56 $57 $8B $7E $06 $C7 $45 $3E $0000W $8B $1E $D6
$A7 $8B $77 $48 $EB $28 $83 $3C [$22] $75 $20 $8B $44 $0A $2D [$0000W] #Keen's teleport height
$89 $45 $0A $8B $44 $0C $89 $45 $0C $B8 $11A2W $50 $57 $9A
$09DC118CRL $83 $C4 $04 $5F $5E $5D $CB
$8B $74 $48 $0B $F6
$75 $D4 $57 $9A $06BD1E8BRL $83 $C4 $02 $5F $5E $5D $CB

#Shot smash behavior = $037D05B2RL
%patch $3D82 $55 $8B $EC $83 $EC $04 $56 $57 $8B $7E $06 $8B $45 $0E $BA $0000W
$F7 $EA $F7 $2E $4C $A5 $A3 $23 $C9 $8B $45 $10 $BA $0000W
$F7 $EA $F7 $2E $4C $A5 $A3 $21 $C9 $8B $45 $26 $03 $06 $23 $C9
$89 $46 $FE $B1 $08 $D3 $E8 $89 $46 $FC $8B $5D $2E $D1 $E3 $8B
$9F $25 $C9 $D1 $EB $D1 $E3 $8E $06 $EB $A7 $8B $46 $FC $D1 $E0
$03 $D8 $26 $83 $3F $1F $75 $07 $C7 $45 $1C [$011FW] $EB $05 $C7
$45 $1C [$0000W] $8B $46 $FE $25 $FF $00 $8B $16 $23 $C9 $2B $D0
$89 $16 $23 $C9 $5F $5E $8B $E5 $5D $CB

#Adjust destroyed shot type to target type
%patch $E63C [$0022W]

#Tweak Keen's shot smash so that it spends time as an invisible target sprite
%patch $3063E $00B3W $00B3W $0000W $0000W $0000W $000CW $0000W $0000W #Check for [B]
$037D05B2RL $00000000L $09DC176ERL $0000W
%patch $2EF8F $00B3W $00B3W $0000W $0000W $0000W $0004W $0000W $0000W #Force player search
$037D0526RL $00000000L $09DC176ERL $013DW
%patch $2EFAD $FFFFW $FFFFW $0000W $0000W $0000W $00A0W $0000W $0000W #Invisible target
$00000000L $00000000L $09DC176ERL $0000W

#Keen searching action = $015BW
%patch $2EFCB $008AW $0082W $0000W $0000W $0000W $0004W $0000W $0000W
$037D0563RL $0B8014A9RL $09DC176ERL $098CW</patch>

== Keen can teleport to where his shots smash anywhere ==

This patch works identically to the above except that it does not matter how Keen's shots smash. Whether they collide with any tile or an enemy Keen will teleport to them.

<patch title="Keen 4">
#Disable EGAGRAPH check in Keen 4 (Frees 389 bytes at $3CF6)
%patch $3CE5 $90 $90

#Custom behavior: Kill Keen = $037D0526RL
%patch $3CF6 $55 $8B $EC $56 $57 $8B $76 $06 $8B $7E $08
$9A $037D053ARL $5F $5E $5D $CB

#Custom player effect: goto searching Keen = $037D053ARL
%patch $3D0A $55 $8B $EC $8B $1E $A7D6W $81 $7F $1C $D4 $0C $74 $19 $C7 $47 #Set clip = 0
{$06} [$0001W] $B8 [$013DW] $50 $FF $36 $D6 $A7 $9A $09DC120ARL #Turn Keen into searching
$83 $C4 $04 $8B $1E $A7D6W $5D $CB

#Player search for target sprite behavior = $037D0563RL
%patch $3D33 $55 $8B $EC $56 $57 $8B $7E $06 $C7 $45 $3E $0000W $8B $1E $D6
$A7 $8B $77 $48 $EB $28 $83 $3C [$22] $75 $20 $8B $44 $0A $2D [$0000W]
$89 $45 $0A $8B $44 $0C $89 $45 $0C $B8 $11A2W $50 $57 $9A
$09DC118CRL $83 $C4 $04 $5F $5E $5D $CB
$8B $74 $48 $0B $F6
$75 $D4 $57 $9A $06BD1E8BRL $83 $C4 $02 $5F $5E $5D $CB

#Adjust destroyed shot type to target type
%patch $E63C [$0022W]

#Tweak Keen's shot smash so that it spends time as an invisible target sprite
%patch $3063E $00B3W $00B3W $0000W $0000W $0000W $000CW $0000W $0000W #Player search
$037D0526RL $00000000L $09DC176ERL $011FW
%patch $2EF8F $FFFFW $FFFFW $0000W $0000W $0000W $00A0W $0000W $0000W #Invisible target
$00000000L $00000000L $09DC176ERL $0000W

#Keen searching action = $013DW
%patch $2EFAD $008AW $0082W $0000W $0000W $0000W $0004W $0000W $0000W
$037D0563RL $0B8014A9RL $09DC176ERL $098CW</patch>

{{PatchCategories|Player|}}
{{PatchCategories|Sprite|}}
{{PatchCategories|Keen 4|gameplay}}
{{PatchCategories|Keen 5|gameplay}}
{{PatchCategories|Keen 6|gameplay}}

User talk:Levellass

2020-03-23T21:57:45Z

Levellass: Missing Blegd & Smeeg webcomic

Hi Levelass - any reponse to [[Talk:Asparagusto|this]]? -- [[User:Malvineous|Malvineous]] 07:02, 13 July 2007 (GMT)

No, I have even less idea now what bug or not I thought they had, sorry. --[[User:Levellass|Levellass]] 11:05, 12 July 2010 (GMT)

== Edit summaries ==
Hey Levellass - when you edit a page, could you please put something in the summary field before submitting? Doing that makes it a lot easier to see what's going on when browsing the [[Special:Recentchanges|Recent Changes]] list. It doesn't have to be much, something like "More info", "Typo", "Spelling" or whatever is fine. -- [[User:Malvineous|Malvineous]] 03:11, 28 January 2007 (GMT)

Sorry, I keep forgetting. (message written by [[User:Levellass|Levellass]] a few minutes ago) --[[User:Shadow Master|Shadow Master]] 18:42, 6 July 2007 (GMT)

== Signing messages ==
Also try to use the toolbar button with the signature icon in it for signing your talk page messages before submitting your replies, so that we know who wrote that interesting paragraph. Or put the following at the end of your messages manually if you have trouble with the wiki edit toolbar:
<nowiki>--~~~~</nowiki>
Just a suggestion. --[[User:Shadow Master|Shadow Master]] 16:25, 10 July 2007 (GMT)

Levellass- PLEASE sign messages in talk pages-just use four tildes! Like this- <nowiki>--~~~~</nowiki>--[[User:Xterra1|Xterra1]] 17:33, 11 July 2007 (GMT)

:Nah, stuff it, I like to annoy and confuse and make things worse for everyone.--[[User:Levellass|Levellass]] 17:38, 11 July 2007 (GMT)

::Little joker.....--[[User:Xterra1|Xterra1]] 17:42, 11 July 2007 (GMT)

:::Actually, I only just figured out how the ---- you do this stuff, there are too many buttons, all I can do is write!--[[User:Levellass|Levellass]] 17:45, 11 July 2007 (GMT)

::::Levellass.........no expletives!--[[User:Xterra1|Xterra1]] 17:47, 11 July 2007 (GMT)

:::::Gosh, what did I write? I'm sure it was just 'hell' I'm so sorry!--[[User:Levellass|Levellass]] 17:49, 11 July 2007 (GMT)

::::::I had to blank it out, rules are rules.--[[User:Xterra1|Xterra1]] 18:14, 11 July 2007 (GMT)

:::::::Wow, who knew? I suppose that's right, you Americans are real stiff when it comes to religion. This is why I don't post much.--[[User:Levellass|Levellass]] 18:23, 11 July 2007 (GMT)

::::::::Not religion,wiki rules!--[[User:Xterra1|Xterra1]] 18:55, 11 July 2007 (GMT)

::::::::Well this wiki is run by an Australian, with British and Chilean moderators, so feel free to post some more ;-) (btw I wouldn't consider that word an expletive, but each to their own I guess.) -- [[User:Malvineous|Malvineous]] 01:21, 12 July 2007 (GMT)

== Automatic syntax highlighting ==

Hi Levellass - I just realised you seem to be manually entering in all the <nowiki></nowiki> tags to syntax highlight the patches! This isn't necessary, you can just enclose each patch in <nowiki><patch title="xyz"></patch></nowiki> tags which will take care of the highlighting for you (see [[Patch:About id]] for how it comes out.) Since this is a custom add-on to the wiki, if it doesn't work properly or you want additional features (like being able to highlight certain bytes) just let me know and I will add it. -- [[User:Malvineous|Malvineous]] 08:08, 12 July 2010 (GMT)

== Patch basics ==

Hey Levellass, I've just created [[Patches|a page]] on the basics of reading patches, specifically your patches. I was wondering if you could look it over and fix any mistakes or outright lies that I may have made; my knowledge of patching is extremely weak (for example I have no idea why some of your 16-bit integers are blue and some are orange, I'm sure the difference is important, I just can't figure it out). Thanks! -[[User:Flaose|Flaose]] 07:05, 14 March 2011 (GMT)

== Page naming ==

Hi Levellass - when you create pages with a note in brackets, can you please put a space before the bracket? I know it's only minor, but it looks weird when the universal wiki standard is "Pagename (info)" and half your pages are "Pagename(info)" ;-) -- [[User:Malvineous|Malvineous]] 04:45, 2 April 2011 (GMT)

:Hey, I'd notcied that, I've done t three times I'm aware of but wasn't quite sure what to do. It shouldn't happen in future. --[[User:Levellass|Levellass]] 09:02, 2 April 2011 (GMT)

== Blank lines before headings ==

Hi Levellass - could you please try to avoid adding an extra space before the <tt><nowiki>== section headings ==</nowiki></tt> in each page? It causes a large gap to appear before the heading which goes against the standard MediaWiki style. If you think the headings are too close together, you can edit your own custom style to put more space between them, and this will affect all pages without needing to do any editing. Thanks! -- [[User:Malvineous|Malvineous]] 13:54, 19 August 2012 (GMT)
:Hey there! I was going by our office's style of doing things, one line space between paragraphs, two between paragraphs and headings. I was unaware that this was not wiki policy. Will all the pages be reverted? --05:48, 20 August 2012 (GMT)

:: I reverted those changes on the most recent pages, but if you could remove the extra lines as you see them that would be great. The problem is that the wiki software automatically inserts extra space between paragraphs and before headings, according to the site style (the idea being if you don't like it, you adjust the site style and you don't need to edit any pages.) Because of this, the wiki software treats extra blank lines as if they were paragraphs, and puts extra space around them when generating the HTML view of each article. By putting two blank lines before a heading, you are effectively putting an empty, invisible paragraph before each heading (which has its own space around it, even though it's invisible.) Going by your office style, this is like putting three blank lines before each heading (the normal two, plus an extra one before the invisible paragraph.) Just as you'd be going against your office style by putting three blank lines before a heading, likewise putting two lines before a wiki heading is going against the wiki style for exactly the same reason. I hope this helps explain it! [[User:Malvineous|Malvineous]] 01:01, 30 August 2012 (GMT)
:::Righto, got it now! I shall endeavor to remove any double lines from the main wiki pages as I stumble across them. I imagine the problem would have been lessened if more people edited the wiki. --[[User:Levellass|Always so much to do!]] 01:12, 30 August 2012 (GMT)

:::: Quite possibly - and thanks! On that note, I have to say, I'm continually amazed by how much work you put in to the patch pages. It's very impressive. -- [[User:Malvineous|Malvineous]] 11:51, 30 August 2012 (GMT)

== Source of creatures' names ==

Hello. I'm new here but I hope to be a good contributor :) What I'd like to know is where the names of the creatures from Keen Dreams and Keen 6 were found because Keen Dreams doesn't seem to list them all while Keen 6 doesn't even contain a help section and some of the names mentioned in Keen 6 user manual are different from the names listed here. Can you help? [[User:Saluton|Saluton]] 13:22, 3 February 2013 (GMT)
: That's a good question and there is no one clear answer. Some names like the Treasure Eater were confirmed via emails to Id staff (Mostly Tom Hall.) Others were taken from the game manuals while still others are community lore or taken from external sources. This seems to be quite a problematic issue and I think a topic on the PCKF tracking down all creature name origins and thus letting us insert citations for them (And correct article names where necessary.) is in order.
:: Before you answered, I already have [[User_talk:Malvineous#Source of creatures' names|spoken to Malvineous]] about it. Thanks. [[User:Saluton|Saluton]] 05:22, 5 February 2013 (GMT)

== Keen Meets the Meats ==

Hello Levellass, could you add the number of levels to the [[Keen Meets the Meats]] article, please? --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 12:19, 12 June 2015 (UTC)
:Nobody knows? Really? Good heavens I could print out every single level's bitmap. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 01:06, 13 June 2015 (UTC)

== Renaming Tutorials ==

Open question to admins, bureaucrats and free time editors. Details over here:
[[Category_talk:Tutorials| Renaming/moving all Tutorials for better ease]]

Ceilick is ok with this idea, what about you?

::Sounds good to me. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 02:10, 16 April 2019 (UTC)

== Ultra Hard game patch side effect ==

Hey. In your (Keen 4 whatever for now) ultra hard game patch the side effect is that you can only save on the map. If you save in (any) level, I get uncached sprite error. --[[User:Szemigi|Szemigi]] ([[User talk:Szemigi|talk]]) 20:05, 14 April 2019 (UTC)

== KeenWave ==

Hi Levellass, a while ago Nisaba wrote a message on the [[Talk:KeenWave|KeenWave talk page]], which refers to a Keen: Modding post. Maybe you didn't notice it at the time. The most recent version of KeenWave is missing. [[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 14:35, 10 March 2020 (UTC)

== Missing Blegd & Smeeg webcomic ==

By the way, if I'm not mistaken, Levellord and you were avid readers of [[Blegd and Smeeg]] back then. Do you happen to have any of the comics? Almost everything is gone, except for the [https://s34.photobucket.com/user/Galaxieretter/media/Number1Introductionssuckcolorednoex.png.html 1st], [https://www.deviantart.com/galaxieretter/art/Blegd-and-Smeeg-11-27147233 11th] and [https://web.archive.org/web/20110207230149/http://blegdandsmeeg.com/ last] episode. [[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 14:35, 10 March 2020 (UTC)
:I don't have anything, but Levellord was friends with the creator and she says she has a folder of about 20 images she can send me. What do you want done with them? -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 12:48, 15 March 2020 (UTC)
::I would like to make them available to the general public again. On [http://archive.shikadi.net/pckf/more.htm this page], for example. However, I'm not so keen on doing so without Galaxieretter's permission. It would be easier if he just added them to his DeviantArt gallery. I wrote to his two known e-mail addresses (including the one available [https://www.youtube.com/user/Galaxieretter/about here]) months ago, but didn't receive a response. Maybe he wants them to remain offline (though many other old works are still available) or he doesn't care or is just too busy. Could Levellord ask Gal, or is there no contact at all now? Anyway, it's good to know that someone still has the comics, thanks for the info. --[[User:Grandy02|Grandy02]] ([[User talk:Grandy02|talk]]) 22:21, 17 March 2020 (UTC)
:::As far as both Levellord and I were aware he was dead, certainly it seems like his deviantart page is very sparse. We have no contact with him so can't help you there. If or when you want the images I now have them, but I don't hold out much hope for getting into contact with their creator. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 21:57, 23 March 2020 (UTC)

User talk:Levellass

2020-03-15T12:48:45Z

Levellass: Reply on Blegd and Smeeg

Patch:Keygem door

2020-03-15T12:38:12Z

Levellass: Add Keen 6 door tile variety

Gem doors require a [[Patch:Keygems|keygem]] to open and work in a similar way to switches, by animating tiles with an animate property, but no animation time. While doors can be any height, by default they must be made of three different tiles by default and will animate four frames. Door sprites control the number of door frames and animation speeds.

There are three kinds of door in Galaxy that Keen can enter. The most common kind are [[Patch:Doors (Galaxy)|'passage' doors]], allowing Keen to move between two points in the level, found in all Keen Galaxy games. The second kind are keygem doors found in all galaxy games. The third type are [[Patch:V Card Door|V card doors]] which require a [[Patch:Keycard (Galaxy)|V card]] to open and usually exit the level. Patches relating to Keen himself opening doors can be found at [[Patch:Keen opening doors]].

This page is divided into four sections. The first deals with keyholders, the tiles that activate doors. The second deals with doors themselves, the tiles that alter when a door is opened and how they do so. The third section deals with door metasprites, the invisible objects that control what happens to doors. The final section covers door related game errors.

= Keyholders =

== Gem holder tile code ==

The gem holder [[Patch:Tiles|tile code]] is responsible for initiating the opening of doors. The gem holder code is somewhat complicated. The first section of the code deals with checks. The first check checks to see if the gem holder tile is 1 tile below Keen's head (So Keen cannot open just any gem holder tile.) The next check determines whether the tile ''below'' the gem holder is upwards blocking (So Keen cannot open gem holders in the air.) On the second line Keen's [[Patch:Sprite actions|action]] is checked and if he is already placing a gem then the following code is skipped. (This avoids Keen constantly trying to place a gem but being unable to do so, see also [[Patch:Jump conditions]].)

The next check, on line 3, looks to see if Keen has the right kind of gem (See [[Patch:Game stats]].); four values are checked starting with the red gem. After all these checks are passed then Keen's action is set to 'turn away from screen', starting the door opening sequence and he begins to 'slide' into alignment with the holder. The final check looks to see that this alignment is complete (Otherwise he will try to use the wrong tile as a door locator causing a 'bad spot' error.) if so then the second section is run.

The second section causes Keen to go to the door opening code where his action is set to 'place gem' and a gem is removed from his inventory.

<patch title="Keen 4">
#Gem holder tile property code
%patch $D186 $8B $44 $32 $3B $46 $FE $74 $03 $E9 $00B0W $83 $7C {$36} [$00] {$75}
$03 $E9 $00A7W $81 $7C {$1C} [$0E1EW] {$75} $03 $E9 $009DW $8B $5E
$F6 $83 $EB $07 $D1 $E3 $83 $BF {$7A60W} [$00] {$75} $03 $E9 $008BW
$8B $C7 $B1 $08 $D3 $E0 $05 [$FFC0W] $89 $46 $F4 $8B $44 $0A $3B
$46 $F4 {$74} $11 $8B $46 $F4 $89 $44 $3E $C7 $44 $1C $0E3CW $5F
$5E $8B $E5 $5D $CB
$8B $5E $F6 $83 $EB $07 $D1 $E3 $FF $8F {$7A60W}
$B8 [$0E1EW] $50 $56 $9A $09DC120ARL $83 $C4 $04 $EB $28</patch>

<patch title="Keen 5">
#Gem holder tile property code
%patch $C499 $8B $44 $32 $3B $46 $FE $74 $03 $E9 $00B0W $83 $7C {$36} [$00] {$75}
$03 $E9 $00A7W $81 $7C {$1C} [$0CA2W] {$75} $03 $E9 $009DW $8B $5E
$F6 $83 $EB $07 $D1 $E3 $83 $BF {$6F60W} [$00] {$75} $03 $E9 $008BW
$8B $C7 $B1 $08 $D3 $E0 $05 [$FFC0W] $89 $46 $F4 $8B $44 $0A $3B
$46 $F4 {$74} $11 $8B $46 $F4 $89 $44 $3E $C7 $44 $1C [$0CC0W] $5F
$5E $8B $E5 $5D $CB
$8B $5E $F6 $83 $EB $07 $D1 $E3 $FF $8F {$6F60W}
$B8 [$0CA2W] $50 $56 $9A $090B1242RL $83 $C4 $04 $EB $28</patch>

== Gem holder doesn't animate ==

This patch stops the keyholder animating; as such it can be used as many times as Keen has gems, 're-opening' a door each time. (When Keen runs out of gems he will be unable to use the holder until he finds more.)

<patch title="Keen 4">
#Don't animate keyholder (Free $C283-$C299)
%patch $C281 $EB $17</patch>

= Doors and door tiles =

== Number of different tiles in door ==

As stated above a door is made of three tiles, a top tile, of which there can be as many as desired, a middle and a bottom tile. If a door is made of more or less different tiles 'static tile' errors will occur. It is however possible to patch this. By default a door animates as many top tiles as it find in a vertical column, then will animate two more tiles below it.

<patch title="Number of different tiles in door">
#Number of different tiles in door -1, Keen 4
%patch $E8D2 [$0002W]

#Number of different tiles in door -1, Keen 5
%patch $E002 [$0002W]

#Number of different tiles in door -1, Keen 6
%patch $DBC1 [$0002W]</patch>

== Doors of any (fixed) height or width in Keen 4 ==

This patch alters the door code so that rather than animating special tiles, it copies a block of the level (Both foreground and background) from another location onto the door, much like how [[Patch:Miragia|Miragia]] works. It relies on using the [[Patch:EGAGRAPH|EGAGRAPH check skip]] and so is incompatible with any other patches that use this.

This means that doors can be of any height or width, not just a single column. It also means any tiles may be used in a door, including animating ones and switches. The disadvantage is that ''all'' doors in a level will use the same tiles at the same location and so will do the same thing. This means that while doors can do more things, all doors in a level must do the same thing.

<patch title="Keen 4">
#Disable EGAGRAPH check (Frees 389 bytes at $3CF6) 037D0H
%patch $3CE5 $90 $90

#Doors use new behaviors below
%patch $3066C $037D0526RL #Door opens
%patch $3068A $037D054ERL #Door opens
%patch $306A8 $037D0576RL #Door opens

#Door tile replacement code, 2x4 block starting at 0,0 in the level
#Door 1, 2x4 at 0,0 in level
%patch $3CF6 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 2, 2x4 at 4,0 in level
%patch $3D1E $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0004W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 2, 2x4 at 8,0 in level
%patch $3D46 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0008W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB</patch>

=== Alternate patch and example ===

This alternate patch does not use the EGA skip, and so is compatible with other patches that use it. It instead disables the [[Patch:F10 T Cheat|sprite test cheat]]. In this example four frames are used for the door instead of three and the doors are 2x3 tiles in size.

<patch title="Keen 4">
#Disable sprite test cheat
%patch $6D39 $CB

#Door tile replacement code, 2x3 block starting at 0,0 in the level
#Door 1, 2x3 at 0,0 in level
%patch $6D3A $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0000W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 2, 2x3 at 0,4 in level
%patch $6D62 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0004W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 3, 2x3 at 0,8 in level
%patch $6D8A $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$0008W] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB
#Door 4, 2x3 at 0,12 in level
%patch $6DB2 $55 $8B $EC $56 $8B $76 $06 $B8 [$0004W] $50 $B8 [$0002W] $50 $FF #Block size is here
$74 $0C $FF $74 $0A $B8 [$0000W] $50 $B8 [$000CW] $50 $9A $16540D78RL #Block location here
$83 $C4 $0C $5E $5D $CB

#Door sprite actions:
%patch $3065C $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD016ARL $00000000L $00000000L $180AW
%patch $3067A $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD0192RL $00000000L $00000000L $1828W
%patch $30698 $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD01BARL $00000000L $00000000L $02D7W
%patch $2F147 $0000W $0000W $0000W $0000W $0000W $000AW $0000W $0000W
$06BD01E2RL $00000000L $00000000L $0000W</patch>

== Doors of any (fixed) height or width in Keen 5 ==

This patch alters the door code so that a door can be of any size, instead of a single column of tiles. It works by copying the [[Patch:V Card Door|V card door]] code and making the door sprite use it, with some alterations. It relies on using the [[Patch:EGAGRAPH|EGAGRAPH check skip]] and so is incompatible with any other patches that use this.

The tiles sued as a door require a very specific setup, exactly like the tiles used for the V-door; the door frames must be placed next to each other in the tileset in their totality and each tile must animate without an animation speed. Looking at how the V-door tiles are set up may help here.

It is possible to change the width and height of the door, as well as the number of opening frames (By altering how many door sprite actions are used.) Note that the 'door width in tileset' ''must'' be equal to the door's width to avoid problems. The animation speed of the door sprite controls how quickly the door opens.

Note: There appears to be a bug with this patch that means that only doors of the same width and frames as the [[Patch:V Card Door|V card door]] can be used. This is rather limiting and it is not known how this may be overcome at present.

<patch title="Keen 4">
#Custom door sizes in Keen 5
#Disable EGAGRAPH check in Keen 5 (Frees 389 bytes at $3CF0)
%patch $3CDF $90 $90

#New-door opening code
%patch $3CF0 $55 $8B $EC $83 $EC $26 $56 $57 $8D $46 $DA $8B $F8 $8B $5E $06
$8B $5F $0C $D1 $E3 $8B $87 $87 $BF $D1 $E8 $D1 $E0 $8B $16 $51
$9E $8B $5E $06 $8B $5F $0A $D1 $E3 $03 $C3 $89 $56 $FC $89 $46
$FA $C7 $46 $FE $00 $00 $EB $29 $33 $F6 $EB $15 $8B $C6 $D1 $E0
$C4 $5E $FA $03 $D8 $26 $8B $07 $2D [$0004W] $89 $05 $83 $C7 $02 #Door width in tileset
$46 $83 $FE $04 $7C $E6 $FF $46 $FE $A1 $4C $9E $D1 $E0 $01 $46
$FA $83 $7E $FE $04 $7C $D1 $B8 [$0004W] $50 $B8 [$0004W] $50 $8B #Door size h AND v = 4x4
$5E $06 $FF $77 $0C $FF $77 $0A $B8 $0001W $50 $16 $8D $46 $DA
$50 $9A $174E0F25RL $83 $C4 $0E $5F $5E $8B $E5 $5D $CB

#Alter door actions to use new V-card type behavior
%patch $318F6 $0000W $0000W $0000W $0000W $0000W [$000FW] $0000W $0000W
$037D0520RL $00000000L $00000000L $15D4W
%patch $31914 $0000W $0000W $0000W $0000W $0000W [$000FW] $0000W $0000W
$037D0520RL $00000000L $00000000L $15F2W
%patch $31932 $0000W $0000W $0000W $0000W $0000W [$000FW] $0000W $0000W
$037D0520RL $00000000L $00000000L $0000W</patch>

= Door sprites =

Door sprites are invisible [[Patch:Meta sprites|metasprite]] that are created when Keen places a keygem. They animate the door tiles and are then removed. In this respect they are very similar to [[Patch:Miragia|Miragia sprites]]. The following is the default action data for all three sprites:

<patch title="Keen 4">
#Door sprite actions:
%patch $3065C [$0000W $0000W] $0000W $0000W $0000W [$000AW] $0000W $0000W
{$0D8F0F85RL} $00000000L $00000000L {$180AW}
%patch $3067A [$0000W $0000W] $0000W $0000W $0000W [$000AW] $0000W $0000W
{$0D8F0F85RL} $00000000L $00000000L {$1828W}
%patch $30698 [$0000W $0000W] $0000W $0000W $0000W [$000AW] $0000W $0000W
{$0D8F0F85RL} $00000000L $00000000L {$0000W}</patch>

As can be seen each patch is one action and there are three of them. Four values per action are highlighted here as they are the most important. The first blue value is the sprite animation, door sprites do not have any, but they may be added if some sort of effect is desired along with the animating tiles. The second is the animation speed, this controls how fast each frame of the door animates (And thus controls the door opening speed.) This can be tweaked for some interesting effects.

The first brown value is the door behavior, this is what makes the tile animate. The second brown value is the next action, by default the first two lead to the next action, the final one is zero or 'remove sprite' This allows you to control the number of frames of door animation there are; making more actions then linking to them will allow more frames, it's even possible to link the last action back to the first in a loop, if the door tiles also loop in their animation then when a gem is placed the door will start animating forever. This allows the use of gems as 'animation activators'

=== [[Patch:Sprite type|Sprite Type]] ===

Doors use sprite type 1 which is used only by miscellaneous sprites and doesn't affect anything else.

<patch title="Door sprite type">
#Door sprite type -Keen 4
%patch $C346 [$01]

#Door sprite type -Keen 5
%patch $B764 [$01]

#Door sprite type -Keen 6
%patch $B547 [$01]</patch>

=== [[Patch:Sprite actions|Door actions]] ===

Door actions control how many 'frames' of animation a door has. (By default three.) When Keen places a keygem a door metasprite is inserted into the level where the keyholder points to. The door opening sequence is three actions long, each action animating the door 1 frame. after the third action the door metasprite vanishes.

Actions -Keen 4
$17ECW #Door open 1
$180AW #Door open 2
$1828W #Door open 3

<patch title="Keen 4">
#Gem door placed in level
%patch $C349 [$17ECW]

#Door sequence
%patch $30678 [$180AW]
%patch $30696 [$1828W]
%patch $306B4 [$0000W]</patch>

Actions -Keen 5
$15B6W #Open door 1
$15D4W #Open door 2
$15F2W #Open door 3

<patch title="Keen 5">
#Gem door placed in level
%patch $B767 [$15B6W]

#Door sequence
%patch $31912 [$15D4W]
%patch $31930 [$15F2W]
%patch $3194E [$0000W]</patch>

Actions -Keen 6
$15F2W #Door open 1
$1610W #Door open 2
$162EW #Door open 3

<patch title="Keen 6">
#Gem door placed in level
%patch $B54A [$15F2W]

#Door sequence
%patch $3233E [$1610W]
%patch $3235C [$162EW]
%patch $3237A [$0000W]</patch>

== [[Patch:Sprite behavior|Sprite Behavior]] ==

Doors have one behavior, this is the behavior that alters the door tiles. It is used for all three actions thus causing doors to have three 'frames' of opening.

<patch title="Sprite behaviors">
#Door opening behaviors -Keen 4
%patch $3066C $0D8F0F85RL
%patch $3068A $0D8F0F85RL
%patch $306A8 $0D8F0F85RL

#Door opening behaviors -Keen 5
%patch $31906 $0CCB12F5RL
%patch $31924 $0CCB12F5RL
%patch $31942 $0CCB12F5RL

#Door opening behaviors -Keen 6
%patch $32332 $0CA61104RL
%patch $32350 $0CA61104RL
%patch $3236E $0CA61104RL</patch>

== [[Patch:Sprite speed|Speed]] ==

The doors, as metasprites, do not move. Their animation speeds are zero.

<patch title="Sprite speeds">
#Door movement speeds -Keen 4
%patch $30668 [$0000W $0000W]
%patch $30686 [$0000W $0000W]
%patch $306A4 [$0000W $0000W]

#Door movement speeds -Keen 5
%patch $31902 [$0000W $0000W]
%patch $31920 [$0000W $0000W]
%patch $3193E [$0000W $0000W]

#Door movement speeds -Keen 6
%patch $3232E [$0000W $0000W]
%patch $3234C [$0000W $0000W]
%patch $3236A [$0000W $0000W]</patch>

== [[Patch:Sprite animations|Animations]] ==

Doors have no animations and so do not appear to the player in-level. Giving doors animations can cause issues. (In fact this cannot be done without altering the door's tile interaction to allow it to display images.)

Of greater importance is the animation speed, which controls how long each 'frame' of door opening takes.

<patch title="Door sprite animations">
#Door sprite animations -Keen 4
%patch $3065C $0000W $0000W
%patch $30666 $000AW #Animation speed
%patch $3067A $0000W $0000W
%patch $30684 $000AW #Animation speed
%patch $30698 $0000W $0000W
%patch $306A2 $000AW #Animation speed

#Door sprite animations -Keen 5
%patch $318F6 $0000W $0000W
%patch $31900 $000AW #Animation speed
%patch $31914 $0000W $0000W
%patch $3191E $000AW #Animation speed
%patch $31932 $0000W $0000W
%patch $3193C $000AW #Animation speed

#Door sprite animations -Keen 6
%patch $32322 $0000W $0000W
%patch $3232C $000AW #Animation speed
%patch $32340 $0000W $0000W
%patch $3234A $000AW #Animation speed
%patch $3235E $0000W $0000W
%patch $32368 $000AW #Animation speed</patch>

== [[Patch:Sprite collision|Sprite Collision]] ==

Doors are not supposed to interact with other sprites, so they have no sprite collision.

<patch title="Sprite collisions">
#Door sprite collisions -Keen 4
%patch $30670 $00000000L
%patch $3068E $00000000L
%patch $306AC $00000000L

#Door sprite collisions -Keen 5
%patch $3190A $00000000L
%patch $31928 $00000000L
%patch $31946 $00000000L

#Door sprite collisions -Keen 6
%patch $32336 $00000000L
%patch $32354 $00000000L
%patch $32372 $00000000L</patch>

== [[Patch:Sprite clipping and foreground|Clipping and foreground]] ==

Doors have no clipping so that they won't be messed about by solid tiles.

<patch title="Door clipping">
#Door clipping -Keen 4
%patch $C342 [$0000W]

#Door clipping -Keen 5
%patch $B760 [$0000W]

#Door clipping -Keen 6
%patch $B543 [$0000W]</patch>

== [[Patch:Sprite Activity Variable|Sprite Activity]] ==

Doors need to open whether or not Keen is near them. As such they have an activity value of 2, causing them to act wherever the player is. If this is changed to 1 then doors will only open when the player is close to them.

<patch title="Doors sprite activity">
#Doors sprite activity -Keen 4
%patch $C33D [$0002W]

#Doors sprite activity -Keen 5
%patch $B75B [$0002W]

#Doors sprite activity -Keen 6
%patch $B53E [$0002W]</patch>

== [[Patch:Sounds|Sounds]] ==

These are the sounds doors use in the game. A single sound is played when a keygem is placed and a door is opened. This can be muted.

<patch title="Keen 4">
#Door open sound
%patch $C29B $12

#Don't play Doors open sound
%patch $C29A $EB $0A</patch>

<patch title="Keen 5">
#Door open sound
%patch $B6B9 $3C

#Don't play Doors open sound
%patch $B6B8 $EB $0A</patch>

<patch title="Keen 6">
#Door open sound
%patch $B49C $12

#Don't play Doors open sound
%patch $B49B $EB $0A</patch>

== [[Patch:Sprite-tile interaction|Sprite-tile interaction]] ==

Doors are not meant to interact with tiles, though their behavior does cause them to alter a level's tiles. As such they have no tile interaction. Note that this also means that the door can have no animation as displaying sprite images is handled by the tile interaction code of a sprite.

<patch title="Sprite tile interactions">
#Door sprite tile interactions -Keen 4
%patch $30674 $00000000L
%patch $30692 $00000000L
%patch $306B0 $00000000L

#Door sprite tile interactions -Keen 5
%patch $3190E $00000000L
%patch $3192C $00000000L
%patch $3194A $00000000L

#Door sprite tile interactions -Keen 6
%patch $3233A $00000000L
%patch $32358 $00000000L
%patch $32376 $00000000L</patch>

== [[Patch:Galaxy Action Parameters#Action_Type|Action type]] ==

Door actions are basic in the extreme and thus type 0.

<patch title="Sprite action types">
#Door sprite action types -Keen 4
%patch $30660 [$0000W]
%patch $3067E [$0000W]
%patch $3069C [$0000W]

#Door sprite action types -Keen 5
%patch $318FA [$0000W]
%patch $31918 [$0000W]
%patch $31936 [$0000W]

#Door sprite action types -Keen 6
%patch $32326 [$0000W]
%patch $32344 [$0000W]
%patch $32362 [$0000W]</patch>

== [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] ==

Doors have no need for either of these variables and so have a value of 0 for both in all of their actions.

<patch title="Sprite deprotect, stick">
#Door deprotect, stick -Keen 4
%patch $30662 [$0000W $0000W]
%patch $30680 [$0000W $0000W]
%patch $3069E [$0000W $0000W]

#Door deprotect, stick -Keen 5
%patch $318FC [$0000W $0000W]
%patch $3191A [$0000W $0000W]
%patch $31938 [$0000W $0000W]

#Door deprotect, stick -Keen 6
%patch $32328 [$0000W $0000W]
%patch $32346 [$0000W $0000W]
%patch $32364 [$0000W $0000W]</patch>

= [[Patch:Game errors|Errors]] =

Doors and keygems can cause a number of [[Patch:Game errors|errors.]]

== Keyholder points to bad spot ==

This error should occur when the player tries to place a key gem to open a door. It occurs when the keyholder does not have a correct sprite value over it. usually this happens when the modder forgets to put a value in, giving a default value of 0,0. Other invalid values are those outside the level borders. This error is easy enough to fix since there should only be a small number of keyholders in the level to check for validity.

This error may also occur if a 'hidden' keyholder is triggered, say if the modder accidentally gives a tile the keyholder property. (The hidden holder will of course not be given a value and can be hard to find until the player accidentally runs into one while having the right colored gem.)

In either case the best course of action is to play the level and note exactly where the game crashes. This will be the exact location of the broken keyholder.

<patch title="Keyholder errors">
#Keen 4 :
%patch $C2E0 [$1426W] #Text called from
%patch $30296 "Keyholder points to a bad spot!" $00

#Keen 5 :
%patch $B6FE [$130EW] #Text called from
%patch $3164E "Keyholder points to a bad spot!" $00

#Keen 6 :
%patch $B4E1 [$129EW] #Text called from
%patch $31FCE "Keyholder points to a bad spot!" $00</patch>

== Door tiles become gibberish ==

This occurs when the game tries to turn a door tile into a tile that's not in the level. This is usually a tile bug, where the modder hasn't given each door tile the right number of animation frames. It can also occur when the modder changes how many different tiles can be in the door or how many frames it takes to open.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Sprite|}}

Patch:Lifewater

2020-03-15T12:27:02Z

Levellass: Add links to game stats

Lifewater is the system used in [[Keen 4]] to allow the player to collect extra lives. There are two collectables that can be acquired; the first is lifewater drops, which are tiles that can be collected, 100 giving the player an extra life, the second collectable is the lifewater flask, both a tile and sprite that can be collected to give an extra life directly.

This page is divided into three sections. The first section relates to lifewater drop tiles, the second relates to lifewater flask tiles and the third to the splash and 1UP sprites produced when tiles are collected. This apge does ''not'' cover aptches relating to 1UP sprites; there are [[Patch:Items|items]] and aptches relating to them can be found on the items page.

= Lifewater drops =

These are 16x16 foreground tiles with a specific property allowing the player to get them. When 100 are obtained an extra life is gained. The following patches relate to both getting a single drop and an extra life.

== [[Patch:Game stats|What the drops give]] ==

This is what is increased when the player obtains a drop. By default the [[Patch:Game stats|drops counter]] is incremented by 1.

<patch title="Keen 4">
#What to increase
%patch $D075 $FF $06 {$7A5AW}</patch>

== [[Patch:Game stats|What is needed to get 1UP]] ==

This is what is required to obtain an extra life. By default this is exactly 100 drops. The game code is set up so that it is impossible for the player to get more than one drop at a time, but if this happened the player might not get an extra life and continue obtaining more drops.

Replacing the $75 with $EB will mean the player never gets an extra life (And can accumulate drops in perpetuity.) Replacing it with $90 $90 will mean the player gets an extra life with every drop.

<patch title="Keen 4">
#What is needed to get an extra life (100 drops)
%patch $D07A {$7A5AW} $3D [$0064W] {$75}</patch>

=== Can only get a maximum of x drops, no 1UP ===

This patch changes the game so that the player can only get a certain number of drops. After this their drops counter does not increase anymore. This effectively puts a 'cap' on drops. (And renders them useless, unless other patches make use of them.)

<patch title="Keen 4">
#Can only get a maximum of [x] drops, no 1UP
%patch $D075 $A1 {$7A5AW} $3D [$xxxxW] {$73} $04 $FF $06 {$7A5AW} $5F $5E $5D $CB</patch>

== What is changed when 1UP obtained ==

Two things are changed when an extra life is obtained, firstly the player's life counter is incremented by 1, and secondly the drop counter is set to zero, requiring them to obtain another 100 drops.

<patch title="Keen 4">
#What to change
%patch $D083 {$7A5AW} [$0000W] #Set drops to 0
%patch $D093 $FF $06 {$7A6AW} #Increase Keen's life count</patch>

=== 1UP decreases drops instead of setting; can have multi-drop items ===

This patch alters things so that drops can be increased in increments of more than 1. By default the 1UP code runs only when exactly 100 drops are obtained and it sets drops to 0 when it does so. In that case if a player were to have 99 drops and get an item that gave 20 drops (Total 119) the 1UP code would not trigger and they would be unable to get any more lives. Likewise if the 1UP code ''were'' triggered it would set the counter to 0 instead of the 19 'extra' drops the player should have.

This patch makes it so that any amount equal to or above 100 (the first blue value) triggers the code and that the count is decreased by 100 when this happens. (-100 = $FF9CW).

<patch title="Keen 4">
#Change 1UP to drop 100 instead of set, needs>100 to trigger
%patch $D07D [$0064W] {$72} $64 $81 $06 {$7A5AW} [$FF9CW]</patch>

== [[Patch:Sounds|Sounds played]] ==

There are two sounds played, one when the droplet is got, the other when an extra life is gained.

<patch title="Keen 4">
#Play sounds
%patch $D060 $000AW #Get drop
%patch $D088 $0011W #Get 1UP</patch>

<patch title="Keen 4">
#Don't play sounds
%patch $D05F $EB $0A #Get drop
%patch $D087 $EB $0A #Get 1UP</patch>

== Drops are health (Hit points) ==

See [[Patch:Dead Keen]].

== Complete Lifewater code ==

This is the complete code run whenever a raindrop tile it touched by Keen. It is called by his [[Patch:Tiles|tile code]]. The first two lines remove the tile; $1424W calls $30294 which replaces the tile with tile 0.

The third line plays [[Patch:Sounds|sound $0A]]. On the fourth line Keen's [[Patch:Game stats|drops variable]] is increased by 1, loaded into memory and compared with 100. If it is less the code skips to the end.

If however it is 100 then Keen's drops are set to 0 and sound $11 played. On the next line Keen's lives are increased by and a type 1 sprite is created. (The !UP sprite.) This sprite is given the sprite type 1, a foreground value of 3, vertical direction of -1 ($FFFFW or 'up'.) and the animation $DA. It uses action $1F28W (Item got) and has a clipping set to 0.

<patch title="Keen 4">
#Complete Lifewater got code
%patch $D03F $55 $8B $EC $56 $57 $8B $76 $06 $8B $7E $08 $B8 $0001W $50 $50
$57 $56 $50 $1E $B8 {$1424W} $50 $9A $16540F28RL $83 $C4 $0E
$B8 [$000AW] $50 $9A $187409F1RL $83 $C4 $02 $57 $56 $9A
$0FA8020CRL $83 $C4 $04 $FF $06 {$7A5AW} $A1 {$7A5AW} $3D [$0064W]
{$75} $64 $C7 $06 {$7A5AW} [$0000W] $B8 [$0011W] $50 $9A $187409F1RL
$83 $C4 $02 $FF $06 {$7A6AW} $B8 $0001W $50 $9A $06BD1E11RL
$83 $C4 $02 $8B $1E $D8 $A7 $C7 $07 [$0001W] $C7 $47 $20 [$0003W]
$8B $C6 $B1 $08 $D3 $E0 $89 $47 $0A $8B $C7 $48 $D3 $E0 $89
$47 $0C $C7 $47 $10 [$FFFFW] $B8 [$00DAW] $89 $47 $1E $89 $47 $40
$B8 [$1F28W] $50 $53 $9A $09DC118CRL $83 $C4 $04 $8B $1E $D8
$A7 $C7 $47 $06 [$0000W] $5F $5E $5D $CB</patch>

= Lifewater flasks =

These are either 16x16 foreground tiles with a specific property allowing the player to get them or [[Patch:Items|item sprites]] that gives the player an extra life when the player touches them. As items proper, patches relating to them are covered on the [[Patch:Items|items page.]] Any patches here are not item patches ''per se'' but rather additional patches relating to 'flask-like' items.

== Create a 3 life item ==

This patch creates an item that gives the player three lives. It has two requirements; firstly it uses the [[Patch:EGAGRAPH|EGAGRAPH check skip]] and so is incompatible with any other patches that also use it, secondly it requires [[Patch:Princess Lindsey|Princess Lindsey]] to use only one animation since the 3-up item uses her graphics. (This can be changed.)

The 3-up sprite is spawned from the 'I Keen' sprite. To do so Lindsey's initiation code is overwritten and she is given a new initiation code overwriting part of her hovering behavior which is now no longer used. Lindsey is also given a new animation since all of hers are being used.

In the 3-up's spawn code there are four blue values. The first is the [[Patch:Sprite type|sprite's type,]] (1 or 'misc); the second is the sprite's [[Patch:Sprite Activity Variable|activity;]] the third its [[Patch:Sprite clipping and foreground|foreground variable]] (0, or appear behind all tiles.) and the final value it the 3-up's initial [[Patch:Sprite actions|action]] (The same action as Lindsey's now unused second action.)

The 3-up has three frames of animation plus a fourth 'got' animation used when Keen touches it. These are all Lindsey's frames.

The 3-up's sprite collision is what gives Keen things. It reacts to Keen's sprite type (2) and increases his [[Patch:Game stats|life variable]] 3 times. It changes its own action to 'got' and its [[Patch:Sprite speed|vertical direction]] to up (So the got item will move upwards like other got item sprites.) and finally plays sound $11.

<patch title="Keen 4">
#Disable EGAGRAPH check in Keen 4 (Frees 389 bytes at $3CF6)
%patch $3CE5 $90 $90

#Lindsey spawn caches just one animation, $00CDW
%patch $EE8F $3F31W #Lindsey (At $12821)
%patch $12821 $FF $76 $FC $57 $9A $11A20DB5RL $83 $C4 $04 $B8 $2A3ARW $8A
$16 $EC $7A $8E $C0 $26 $08 $16 [$00CDW] $E9 $C5BFW

#Lindsey has one frame, no hovering
%patch $3276A $00000000L
%patch $32776 $38EAW
%patch $3275A $00CDW $00CDW

#I Keen tile spawns 3-up
%patch $EECB $0122W

#3-up spawn code (Uses Lindsey cache at present)
%patch $EA17 $037D0526RL

#3-up spawn code = $037D0526RL
%patch $3CF6 $55 $8B $EC $33 $C0 $50 $9A $06BD1E11RL $83 $C4 $02 $8B $1E
$D8 $A7 $C7 $07 [$0001W] $C7 $47 $02 [$0001W] $C7 $47 $20 [$0000W]
$8B $46 $06 $B1 $08 $D3 $E0 $89 $47 $0A $8B $46 $08 $05 [$FFFDW]
$D3 $E0 $89 $47 $0C $B8 [$3908W] $50 $53 $9A $09DC118CRL $83
$C4 $04 $5D $CB

#3-up sprite collision (With Keen gives 3 lives, play 1-Up sound $11) = $037D056ARL
%patch $3D3A $55 $8B $EC $56 $57 $8B $76 $06 $8B $7E $08 $83 $3D [$02] {$75} $22
$FF $06 {$7A6AW} $FF $06 {$7A6AW} $FF $06 {$7A6AW} $C7 $44 $1C [$011FW]
$C7 $44 $10 [$FFFFW] $B8 [$0011W] $50 $9A $187409F1RL $83
$C4 $02 $5F $5E $5D $CB

#3-up actions, use 3 Lindsey actions: $3908W-$3944W; $0008W is anim speed
%patch $32778 $014AW $014AW $0000W $0000W $0000W $0008W $0000W $0000W
$00000000L $037D056ARL $09DC176ERL $3926W
%patch $32796 $014BW $014BW $0000W $0000W $0000W $0008W $0000W $0000W
$00000000L $037D056ARL $09DC176ERL $3944W
%patch $327B4 $014CW $014CW $0000W $0000W $0000W $0008W $0000W $0000W
$00000000L $037D056ARL $09DC176ERL $3908W

#3-up got action $011FW: acts like item got $0028W is appearance time, $0008W rise speed
%patch $2EF8F $0149W $0149W $0001W $0000W $0000W $0028W $0000W $0008W
$00000000L $00000000L $09DC176ERL $0000W</patch>

= 1UP and splash sprites =

There are four lifewater-related sprites. The first is the 1UP produced when a [[Patch:Items|1UP item]] sprite is taken, patches relating to that sprite can be found on the items page. The second is the 1UP produced when a 1UP tile is obtained. These too are treated on the items page. The last two relate to drops tiles; the first is the 'drop splash' that appears when any drop is taken while the second is the 1UP produced when the 100th drop is taken.

== [[Patch:Sprite type|Sprite Type]] ==

Both the splashes and 1UP sprites are type 1 or 'misc', not affecting anything in particular.

<patch title="Keen 4">
#Lifewater related sprite types
%patch $FCAB [$0001W] #Splash
%patch $D0A9 [$0001W] #1UP</patch>

== [[Patch:Sprite actions|Sprite Actions]] ==

Actions relating to these sprites are quite simple. Both are produced in only one situation. The drop splash is produced when drop tiles are obtained and proceeds to a three action sequence that then vanishes. The 1UP is a variation of the standard 'item got' sprite so altering what it becomes will alter other item got sprites.

Actions:
$1F28W #Stuff got
$1F46W #Raindrop splash 1
$1F64W #Raindrop splash 2
$1F82W #Raindrop splash 3

<patch title="Keen 4">
#Produce splash
%patch $FCC0 [$1F46W]

#Splash sequence
%patch $30DD2 [$1F64W]
%patch $30DF1 [$1F82W]
%patch $30E0E [$0000W]

#Produce 1UP
%patch $D0D0 [$1F28W]

#1UP sequence
%patch $30DB4 [$0000W]</patch>

== [[Patch:Sprite behavior|Sprite Behavior]] ==

None of these sprite actions have any behavior. Changing the 1UP's behavior will also change the behavior of other 'items got' sprites.

<patch title="Keen 4">
#1UP
%patch $30DA8 $00000000L

#Splash
%patch $30DC6 $00000000L
%patch $30DE4 $00000000L
%patch $30E02 $00000000L</patch>

== [[Patch:Sprite speed|Speed and Jump Height]] ==

The splash sprite does not move. However the 1UP does. Since its direction is set as upwards its speed is reversed. Altering this speed will alter the speed of all 'item got' sprites. In the main this will alter how far up the sprite gets before vanishing.

<patch title="Keen 4">
#1UP initial direction
%patch $D0C4 [$FFFFW]

#1UP speed
%patch $30DA4 $0000W $0008W

#Splash speeds
%patch $30DC2 $0000W $0000W
%patch $30DE0 $0000W $0000W
%patch $30DFE $0000W $0000W</patch>

== [[Patch:Sprite collision|Sprite Collision]] ==

None of the sprite actions have any sprite collision.

<patch title="Keen 4">
#1UP
%patch $30DAC $00000000L

#Splash
%patch $30DCA $00000000L
%patch $30DE8 $00000000L
%patch $30E06 $00000000L</patch>

== [[Patch:Sprite animations|Animations]] ==

The splash and 1UP sprites are cached with in-level Keen when he spawns. The 1UP sprite's specific animation is set when it is created, its action itself has no animation of its own. (If one is given then it will change the animations of all other 'item got' sprites.) The splash however has its own animations, a different one for each action.

The animation speeds of the splash control how long it appears onscreen before vanishing. That of the 1UP controls how long it moves upwards before vanishing. (Changing it will change all other 'item got' sprites.)

As a [[Patch:Items|item]] th lifewater flask comes in two types, tile and sprite based. The tile-based flask has a customizable appearance based on tileswhile the sprite-based flask uses two animations, the first of which is taken from the 'sprite animation list'. The animation for when both obtained is taken from the 'got item animations list' and by default is different from that which appears when 100 drops are obtained.

<patch title="Keen 4">
#1UP item sprite set
%patch $30E24 $00EFW

#100 drop 1UP sprite set
%patch $D0C7 $00DAW

#1UP item sprite set
%patch $30290 $00E1W

#1UP action has no animations
%patch $30D98 $0000W $0000W

#Splash
%patch $30DB6 $00D7W $00D7W
%patch $30DC0 $000AW #Animation speed
%patch $30DD4 $00D8W $00D8W
%patch $30DDE $000AW #Animation speed
%patch $30DF2 $00D9W $00D9W
%patch $30DFC $000AW #Animation speed</patch>

== [[Patch:Sprite Sounds|Sounds]] ==

There are two relevant sounds, one played when a drop is obtained and another when 100 drops are obtained. Both sounds can be disabled. Patches relating to these sounds can be found in the sounds section near the top of this page.

== [[Patch:Sprite clipping and foreground|Clipping and foreground]] ==

Both the splash and 1UP sprites have a foreground value of 3 so that they will appear in front of all other sprites and tiles. (So the player can see what has happened.) and no clipping. (So they are not pushed about by tiles.) These can be altered apart from the usual 'item got' sprites.

<patch title="Keen 4">
#Drop Splash
%patch $FCA7 [$0003W] #Foreground
%patch $FCA2 [$0000W] #Clipping

#1UP
%patch $D0AE [$0003W] #Foreground
%patch $D0E3 [$0000W] #Clipping</patch>

== [[Patch:Sprite-tile interaction|Sprite-tile interaction]] ==

All the sprites use the 'sit' tile interaction; this means they do not specifically interact with tiles. Since they have no clipping they will not even be stopped by solid tiles. Altering the 1UPs collision will affect other 'item got' sprites.

<patch title="Keen 4">
#1UP
%patch $30DB0 $09DC176ERL

#Splash
%patch $30DCE $09DC176ERL
%patch $30DEC $09DC176ERL
%patch $30E0A $09DC176ERL</patch>

== [[Patch:Galaxy Action Parameters#Action_Type|Action type]] ==

The 1UP uses type 1 for its action; this allows it to move smoothly. The splash by contrast uses type 0 since they do not have to move or use a behavior.

<patch title="Keen 4">
#Splash
%patch $30DBA [$0000W]
%patch $30DD8 [$0000W]
%patch $30DF6 [$0000W]

#1UP
%patch $30D9C [$0001W]</patch>

== [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] ==

The splash and 1UP have no need for either of these variables and so have a value of 0 for both in all of their actions.

<patch title="Keen 4">
#Splash
%patch $30D9E [$0000W $0000W]
%patch $30DBC [$0000W $0000W]
%patch $30DDA [$0000W $0000W]

#1UP
%patch $30DF8 [$0000W $0000W]</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Gameplay|}}
{{PatchCategories|Item|}}
{{PatchCategories|Sprite|}}

File:Colander Ken - Map.png

2020-03-03T21:31:12Z

Levellass: The map level from Colander Ken Not that it will appear on the stupid mod level list.

The map level from [[Colander Ken]]

Not that it will appear on the stupid mod level list.

File:Colander Ken - Level 08.png

2020-03-03T21:30:52Z