KeenWiki - User contributions [en-gb]

Patch:Keen shooting (Vorticons)

2014-02-11T03:32:53Z

Commander Spleen: Replaced outdated andy.durdin.net link with current keenmodding.org URL

This page contains patches that cover Keen shooting and his firing rate, as well as his shots in Keen Vorticons. Some patches will overlap other game actions, such as patches relating to Keen shooting while jumping. Since the three Vorticons games are so similar patches for all three are treated together on this page. Patches for individual episodes that relate to the player can be found at [[Patch:Keen (Keen 1)]], [[Patch:Keen (Keen 2)]] and [[Patch:Keen (Keen 3)]]. Unlike Keen galaxy, there is not a separate page for Keen's shots, since they behave in a very basic manner. Closely related patches, especially regarding the destruction of shots can be found at [[Patch:Zap and zot]].

Due to the sheer number of patches relating to Keen and his shots this page is divided into two sections. The first deals with Keen's shot and shot production, the second deals with Keen's shooting behavior. (Which ''uses'' the shot production code.)

= Keen's shooting behavior =

This section of the page deals with the behavior of Keen when shooting. Animations, behavior, what happens next and so on. This includes the conditions under which a shot is created. (Such as not having ammunition.) and the shooting sound.

== Change shooting controls ==

This changes the controls of the game to be more like Keen Galaxy. Spacebar shoots, enter brings up the [[Patch:Status Window (Vorticons)|status screen.]] See http://keenmodding.org/viewtopic.php?t=433 for the original topic. Note that the first two lines alter the status window key and the remaining lines Keen's shot key (In various situations.) To change the key simply alter the blue highlighted values. (Consulting [[Patch:Scancodes]] will be informative.)

In this patch the status box lines are included since the shooting key is now the spacebar. This patch also causes the shooting key to be one key, not two (Both ctrl and alt by default.) This can cause some issues with things like keyboard setup and joystick.

<patch title="Keen 1">
#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</patch>

<patch title="Keen 2">
#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</patch>

<patch title="Keen 3">
#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</patch>

== Keen reloads when out of ammo ==

This patch causes Keen to 'reload' his raygun when he has 0 ammo and tries to shoot. This has a number of side effects. The first is that the [[Patch:C T Space Cheat|C T Space cheat]] is disabled for code space. The second side effect is Keen will have infinite ammunition, gaining more when he is out.

The first line calls the extra code. The second ad start of the third line [[Patch:Vorticons Sprite Parameters|sets Keen's shooting animations.]] (This overrides all of Keen's other shooting animations.) which are $0014 and the next frame in this example. The rest of the third line performs a check of Keen's ammunition; if it is above zero then the code will be exited and a shot spawned as usual.

If Keen has zero ammo then on the fourth line his 'reloading' animation will be set ($0076 in this example.) and Keen's ammo is reset. (To $0004W in this example.) The code is then exited and the 'out of ammo' sound is played.

<patch title="Keen reloads when out of ammo">
#Keen reloads when out of ammo - Keen 3
%patch $74D5 $E9 $994BW
%patch $0E22 $C3 $C7 $06 {$9938W} [$0014W] $81 $3E $78 $62 $0000W $7F $04 #Set shooting sprite
%patch $0E31 $FF $06 {$9938W} $81 $3E {$9D48W} [$0000W] $74 $03 $E9 $669CW #Ammo check; Goto normal shot creation
%patch $0E40 $81 $06 {$9938W} [$0076W] $C7 $06 {$9D48W} [$0004W] $E9 $66B1W #Sprite 118; ammo=4, Goto no ammo</patch>

== Keen's shooting rate ==

There is a maximum rate at which the player can produce shots; this is controlled in part by how long Keen holds his shooting animation for. If this is made smaller the player can shoot faster, if it is made larger they must wait longer. There are two limits to this patch; firstly, even a value of 0 will still result in a significant pause between shots; secondly, the maximum pause is $7F ticks, any higher and the game treats it as a value of 0.

<patch title="Keen's shooting rate">
#Keen 1 Keen's shooting rate
%patch $3E6A [$1E]

#Keen 2 Keen's shooting rate
%patch $6CAC [$1E]

#Keen 3 Keen's shooting rate
%patch $7512 [$1E]</patch>

== [[Patch:Sprite Sounds|Keen's shooting and out-of-ammo sounds]] ==

There are two sounds relevant to Keen shooting. The first is that played when Keen successfully shoots; the second is played when he tries to shoot but does not have any ammunition. (See section below.) Both sounds can be disabled.

<patch title="Keen 1 shooting sounds">
#Keen has no ammo sound
%patch $3E58 $24 #Keen has no ammo sound
%patch $3E57 $EB $07 #Keen has no ammo sound disabled

#Keen shoot sound
%patch $3E33 $0B #Keen shoot sound
%patch $3E32 $EB $07 #Keen shoot sound disabled</patch>

<patch title="Keen 2 shooting sounds">
#Keen has no ammo sound
%patch $6C9A $24 #Keen Keen has no ammo sound
%patch $6C99 $EB $07 #Keen Keen has no ammo sound disabled

#Keen shoot sound
%patch $6C75 $0C #Keen shoot sound
%patch $6C74 $EB $07 #Keen shoot sound disabled</patch>

<patch title="Keen 3 shooting sounds">
#Keen has no ammo sound
%patch $7501 $24 #Keen has no ammo sound
%patch $7500 $EB $06 #Keen has no ammo disabled

#Keen shoot sound
%patch $74DD $0C #Keen shoot sound
%patch $74DC $EB $06 #Keen shoot sound disabled</patch>

== Keen's shooting height ==

This controls the height at which Keen's shots are spawned. It is divided into two values, the first in a 'fine-tuner', the number of pixels down from the player's sprite's top the bullet appears. The second value is much rougher and is worth 256 pixels when +-1 It is really only useful when making the shot appear a negative number of pixels below (That is ''above'') the sprite, when it will be changed to $FFFFW.

<patch title="Keen 1">
#Robot shot height (Default $000009, if zero then no shot appears)
%patch $46DC [$09]
%patch $46DE [$0000W]</patch>

<patch title="Keen 2">
#Robot shot height (Default $000009, if zero then no shot appears)
%patch $743B [$09]
%patch $743D [$0000W]</patch>

<patch title="Keen 3">
#Robot shot height (Default $000009, if zero then no shot appears)
%patch $7CFA [$09]
%patch $7CFC [$0000W]</patch>

== Keen can shoot up and down ==

This patch allows Keen to shoot up by pressing up and shoot, and down by pressing down and shoot. (He can shoot down while standing, which is a big waste of a shot.) Keen will use the same shooting animation when shooting in any direction and can still shoot left and right. This patch overwrites the code that checks for pg up, pg down, end and insert, so these keys will be unavailable. Another side effect is the border flash when a [[Patch:Vorticon (Keen 1)|Vorticon]] is shot is disabled.

This patch works by setting Keen's horizontal and vertical shot speeds to one of three values in the patch, marked in blue; $0190W, $FE70W and $0000W. For example, when the player presses the up key Keen's shot's vertical speed is set to $FE70W (up) and its left and right speeds are set to 0. When the player shoots right Keen's shot's vertical speed is set to 0 and its left and right speeds set to $0190W and $FE70W. Therefore changing the three blue values will change how fast Keen's shot moves.

This means that this default patch will make Keen's shot's vertical speeds the same as its horizontal speeds, but if this is not desired it can easily be changed so that horizontal\vertical speeds are different.

<patch title="Keen 1">
#Keen can shoot up and down using the ^v keys
%patch $55EF $90 $90 $2E $A1 $46EEW $8B $1E $CA $7F $D1 $E3 $2E $FF $A7 $4A48W
$2E $A1 $4A5CW $2E $A3 $46EEW $EB $08 $2E $A1 $4A5AW $2E
$A3 $46EEW $2E $A1 $4A5EW $2E $A3 $4704W $2E $A3 $4779W $EB
$1B $2E $A1 $4A5EW $2E $A3 $46EEW $2E $A1 $4A5AW $2E $A3 $4704W
$2E $A1 $4A5CW $2E $A3 $4779W $90 $90 $90

#Jump table
%patch $4A45 $C3 $5600W $5600W $5600W $5620W $560AW $560AW
$560AW $5620W $5600W $5620W [$0190W $FE70W]
[$0000W]</patch>

<patch title="Keen 3">
#Keen can shoot up and down using the ^v keys
%patch $1B4A $90 $90 $2E $A1 $7D0CW $8B $1E $BA $96 $D1 $E3 $2E $FF $A7 $804BW
$2E $A1 $805FW $2E $A3 $7D0CW $EB $08 $2E $A1 $805DW $2E
$A3 $7D0CW $2E $A1 $8061W $2E $A3 $7D22W $2E $A3 $7D95W $EB
$1B $2E $A1 $8061W $2E $A3 $7D0CW $2E $A1 $805DW $2E $A3 $7D22W
$2E $A1 $805FW $2E $A3 $7D95W $90 $90 $90

#Jump table
%patch $8048 $C3 $1B5BW $1B5BW $1B5BW $1B7BW $1B65W $1B65W
$1B65W $1B7BW $1B5BW $1B7BW [$0190W $FE70W]
[$0000W]</patch>

=== Control Keen's shot angle with up and down arrow keys ===

This patch allows keen to "tune" his shot angle by pressing up or down. When up or down is released, the variable returns to its default value. This patch overwrites the code that checks for pg up, pg down, end and insert, so these keys will be unavailable. Another side effect is the border flash when a [[Patch:Vorticon (Keen 1)|Vorticon]] is shot is disabled. This patch works best with the control change patch above that let's Keen shoot with the spacebar. (Since pressing three keys to shoot is tricky.)

The jump table section of the patch can be completely ignored. (It is technical.) The variable being changed, (Keen's shot's vertical speed.) is highlighted in brown.

Note the five blue values; the first is the maximum upwards angle, the second the rate of upwards change per keypress, the third the maximum upwards angle, the fourth the rate of downwards change per keypress and the fifth is the 'neutral value' (The value when no keys are being pressed.) The second and fourth values ''must'' be a simple fraction of the first and fourth (E.g one half, one third, one quarter...) and must ''not'' be larger than them, or problems will occur.

In this patch Keen can fire only straight ahead (no keys pressed) up 15 degrees (up key pressed) or down 15 degrees (down key pressed.) If the rate changes are made smaller then Keen has more leeway. If for example they are half of the maximum rate Keen can shoot across, up at 8 degrees, up at 15 degrees and so on. (However getting the exact angle can be tricky.)

If intending to stick with this basic setup the exact angle of Keen's shot can be determined by taking the max up/down value, multiplying by $2D and dividing by $190 (Keen's horizontal shot speed.) So in this patch $40 * $2D / $190 = $0E (14 degrees). Altering the min\max values will alter this angle.

The original page discussing this patch is here: #http://keenmodding.org/viewtopic.php?t=1229 Note that the [[Keen 1]] patch will be incompatible with any other patches that use the <tt>$55EF</tt> line to free up space, such as the [[Patch:Levels_(Vorticons)#Everything_in_levels_is_pulled_sideways|'breeze patch']], so check your patchfile before adding this patch.

<patch title="Keen 1">
#Change Keen's firing angle by using ^v keys in-game.
%patch $55EF $90 $90 $2E $A1 {$46EEW} $8B $1E $CA $7F $D1 $E3 $2E $FF $A7 $4A48W
$3D [$FFC0W] $7C $16 $05 [$FFC0W] $EB $0D $3D [$0040W] $7F $0C
$05 [$0040W] $EB $03 $B8 [$0000W] $2E $A3 {$46EEW} $E9 $001DW

#Jump table
%patch $4A45 $C3 $5600W $5600W $5600W $5614W $560AW $560AW
$560AW $5614W $5600W $5614W</patch>

<patch title="Keen 3">
#Change Keen's firing angle by using ^v keys in-game.
%patch $1B4A $90 $90 $2E $A1 {$7D0CW} $8B $1E $BA $96 $D1 $E3 $2E $FF $A7 $804BW
$3D [$FFC0W] $7C $16 $05 [$FFC0W] $EB $0D $3D [$0040W] $7F $0C
$05 [$0040W] $EB $03 $B8 [$0000W] $2E $A3 {$7D0CW} $E9 $001DW

#Jump table
%patch $8048 $C3 $1B5BW $1B5BW $1B5BW $1B6FW $1B65W $1B65W
$1B65W $1B6FW $1B5BW $1B6FW</patch>

== Ammo ==

These patches relate to what Keen uses as ammo.

=== What Keen needs to shoot ===

By default Keen needs raygun shots to shoot (See [[Patch:Game stats]].), without them he cannot shoot. But it is possible to make him use other things instead. Keen can also shoot if he has negative ammo. In the patch below the game stat is marked in brown and the number in blue. (The second brown value is a [[Patch:Jump conditions|jump condition,]] changing it to '$90 $90' will mean Keen doesn't need ammo at all to shoot.)

<patch title="Keen 1">
#What Keen needs to shoot
%patch $3E2D {$AAC8W} [$00] {$74}</patch>

<patch title="Keen 2">
#What Keen needs to shoot
%patch $6C6F {$9ADEW} [$00] {$74}</patch>

<patch title="Keen 3">
#What Keen needs to shoot
%patch $74D7 {$9D48W} [$00] {$74}</patch>

=== Infinite ammo ===

This patch skips the 'ammo check'; this means that Keen can shoot as many times as he wants no matter how many shots he has. It is also combined on the second line with the 'don't lose a shot' patch below so that Keen doesn't loose a shot each time he shoots (This is optional but prevents Keen getting a negative number of shots which can look odd.)

<patch title="Keen 1">
#Infinite ammo
%patch $3E2B $EB $05
%patch $3E3B $90 $90 $90 $90</patch>

<patch title="Keen 2">
#Infinite ammo
%patch $6C6D $EB $05
%patch $6C7D $90 $90 $90 $90</patch>

<patch title="Keen 3">
#Infinite ammo
%patch $74D5 $EB $05
%patch $74E4 $90 $90 $90 $90</patch>

==== Infinite ammo IF Keen has a raygun ====

This patch has a slightly different effect than the one above. Keen can shoot as much as he likes, IF he has a raygun. It works by stopping Keen losing a shot when he shoots, meaning that while he can't shoot when he has 0 shots, as soon as he gets even a single raygun he can shoot as much as he wants without it running out.

<patch title="Keen 1">
#Infinite ammo IF Keen has a raygun
%patch $3E3B $90 $90 $90 $90</patch>

<patch title="Keen 2">
#Infinite ammo IF Keen has a raygun
%patch $6C7D $90 $90 $90 $90</patch>

<patch title="Keen 3">
#Infinite ammo IF Keen has a raygun
%patch $74E4 $90 $90 $90 $90</patch>

=== What decreases when Keen shoots ===

By default Keen loses 1 ammo each time he shoots. It is possible to make something increase when Keen shoots, or change what is decreased. (See [[Patch:Game stats]].)

<patch title="Keen 1">
#What Keen needs to shoot
%patch $3E3D {$AAC8W}</patch>

<patch title="Keen 2">
#What Keen needs to shoot
%patch $6C7F {$9ADEW}</patch>

<patch title="Keen 3">
#What Keen needs to shoot
%patch $74E6 {$9D48W}</patch>

=== Keen has an ammo limit ===

This patch sets a limit as to how many shots Keen can have. It is [[Patch:Incompatible patches|incompatible with all other $0AF2 using patches without modification.]]

If Keen has equal or more ammo than the limit then the raygun tile will be taken, but no ammo added to Keen. The first blue value is the limit, the second how many shots are given per raygun tile. Note that using this patch means that there is no need to use the above patches altering what the raygun gives (They will in fact break this patch.)

<patch title="Keen 1">
#Keen has ammo limit of 100
#If ammo tile, go to new ammo code
%patch $44A0 $E9 $C650W

#New ammo code
%patch $0AF2 $C3 $83 $3E {$AAC8W} [$64] $7D $05 $83 $06 {$AAC8W} [$05] $E9 $39A3W</patch>

==== Ammo limit and unique sound ====

This patch is similar to the above. However getting the raygun can have a different sound from the pogo (see sound section.) and the raygun will not make a sound if Keen is above the ammo limit. (To make the raygun make a sound even when not giving Keen ammo change $7D $0E to $7D $05.) The unique sound is the third blue value and in this patch is unchanged from the default sound (same as the pogo.)

Note that using this patch means that there is no need to use the above patches altering what the raygun gives (They will in fact break this patch.) It is also [[Patch:Incompatible patches|incompatible with all other $0AF2 using patches without modification.]]

<patch title="Keen 1">
#Keen has ammo limit of 100
#If ammo tile, go to new ammo code
%patch $44A0 $E9 $C650W

%patch $0AF2 $C3 $83 $3E {$AAC8W} [$64] $7D $0E $83 $06 {$AAC8W} [$05] $B8 [$000AW]
$50 $E8 $B3EDW $44 $44 $E9 $39AFW</patch>

== Machine gun shooting patch ==

This patch lets Keen spawn a constant stream of shots. It makes his shot count meaningless. Removing the last line results in a 'flamethrower' effect where bullets will destroy each other, limiting their range. (But this can look a bit odd, shots can 'escape' and behave like normal shots.)

The first line increases Keen's shot rate, the second line stops Keen losing shots and the third stops the 'out of ammo' sound being played. Any line can be removed at the patcher's whim.

<patch title="Keen 1">
#Keen has a Machine Gun!
%patch $3E24 $90 $90
%patch $3E3B $90 $90 $90 $90
%patch $3E5B $90 $90 $90
%patch $46F3 [$3360W] #Optional last line</patch>

<patch title="Keen 2">
#Keen has a machine gun
%patch $6C66 $90 $90
%patch $6C7D $90 $90 $90 $90
%patch $6C9D $90 $90 $90
%patch $7452 [$61A2W] #Optional last line</patch>

<patch title="Keen 3">
#Keen has a machine gun
%patch $74CC $90 $90
%patch $74E4 $90 $90 $90 $90
%patch $7503 $90 $90 $90
%patch $7D11 [$6A00W] #Optional last line</patch>

== Keen's gun has recoil ==

This patch makes Keen slide backwards whenever he shoots (recoil.) Note that the [[Keen 1]] patch will be incompatible with any other patches that use the <tt>$55EF</tt> line to free up space, such as the [[Patch:Levels_(Vorticons)#Everything_in_levels_is_pulled_sideways|'breeze patch']], so check your patchfile before adding this patch.

There are two variables controlling the recoil; the first is the 'wait after shooting time' that controls how long Keen uses his shooting animation for (How long before he can shoot again.); if this is too small or the recoil too large the recoil will be 'cut short', so this variable will need to be increased. The second is the actual recoil, making this larger or smaller will alter how much Keenis pushed back. Both values are marked in blue.

<patch title="Keen 1">
#Give Keen's gun recoil:
%patch $3E6A [$1E] #Wait time after shot
%patch $3E52 $E9 $179CW
%patch $55EF $EB $4A $56 $57 $BE [$0030W] $BF $00 $02
$A1 $4C $60 $3D $00 $00 $7E $04 $F7 $DE $F7 $DF $89 $36
$40 $82 $89 $3E $3C $82 $5F $5E $83 $C4 $08 $E9 $E840W</patch>

== Stop Keen shooting ==

This patch stops Keen from shooting entirely, though he wills till use the shooting animation when he presses the shoot keys. (This can also be easily patched.)

<patch title="Keen 1">
#Remove shooting entirely:
%patch $3E24 $EB</patch>

<patch title="Keen 3">
#Remove shooting entirely:
%patch $74CC $EB</patch>

=== Stop Keen making shots ===

This patch prevents Keen from producing shots. He will still lose one ammo, make the shooting sound and use the shooting animation, but no shot will appear.

<patch title="Keen 3">
#Stop Keen making bullets (Frees $7CD8-$7D)
%patch $74F8 $90 $90 $90</patch>

== Keen's shooting animations ==

Keen does not have one single shooting animation, but rather several depending on what keys are pressed and in what order.

<patch title="Keen 1">
#Keen shooting animations
%patch $3B61 [$0014W] #Shooting right (ctrl + alt: normal)
%patch $3B69 [$0015W] #Shooting left (ctrl + alt: normal)

%patch $3C7E [$0014W] #Shooting right (ctrl -> alt)
%patch $3C86 [$0015W] #Shooting left (ctrl -> alt)

%patch $3DF7 [$0014W] #Shooting right (ctrl -> alt while jumping)
%patch $3DFF [$0015W] #Shooting left (ctrl -> alt while jumping)

%patch $402C [$0014W] #Shooting right (alt -> ctrl while pogoing)
%patch $4034 [$0015W] #Shooting left (alt -> ctrl while pogoing)

%patch $40DA [$0014W] #Shooting right (alt\ctrl at same time)
%patch $40E2 [$0015W] #Shooting left (alt\ctrl at same time)</patch>

<patch title="Keen 3">
#Keen shooting animations
%patch $720F [$0015W] #Keen presses ctrl and alt at same time
%patch $7207 [$0014W] #Keen presses ctrl and alt at same time

%patch $732A [$0015W] #Keen moves then presses ctrl and alt
%patch $7332 [$0014W] #Keen moves then presses ctrl and alt

%patch $749F [$0015W] #Keen jumping left and shooting together (Ctrl pressed Then alt)
%patch $74A7 [$0014W] #Keen jumping right and shooting together (Ctrl pressed Then alt)

%patch $76D9 [$0015W] #Keen pogoing left and shooting (alt pressed first, then ctrl)
%patch $76D1 [$0014W] #Keen pogoing right and shooting (alt pressed first, then ctrl)

%patch $7788 [$0015W] #Keen presses alt then ctrl quickly, but not at same time
%patch $7780 [$0014W] #Keen presses alt then ctrl quickly, but not at same time </patch>

= Keen's shot =

This section deals with patches that affect Keen's shot and its properties. This includes things like its speed, animation and direction.

== Keen's shot properties ==

There are five basic properties of Keen's shot that can be altered, its [[Patch:Sprite animations|animation,]] [[Patch:Sprite type|sprite type,]] [[Patch:Sprite speed|vertical speed and its left/right speeds.]]

Keen's shot uses only one animation by default,t he same no matter what direction it moves in. Changing it should often be unnecessary. Likewise the shot's sprite type is a special one that kills enemies, if changed it becomes harmless to them so shouldn't be tinkered with. The most useful things to alter are the horizontal speeds, making the shot faster or slower. (Or even sit still!)

<patch title="Keen 1 shot properties">
#Keen's shot properties
%patch $46C5 [$000AW] #Sprite type
%patch $46EE [$0000W] #Vertical speed
%patch $46F8 [$006CW] #Animation
%patch $4704 [$0190W] #Right speed
%patch $4779 [$FE70W] #Left speed</patch>

<patch title="Keen 2 shot properties">
#Keen's shot properties
%patch $7424 [$000AW] #Sprite type
%patch $744D [$0000W] #Vertical speed
%patch $7457 [$007AW] #Animation
%patch $7463 [$0190W] #Right speed
%patch $74D8 [$FE70W] #Left speed</patch>

<patch title="Keen 3 shot properties">
#Keen's shot properties
%patch $7CE3 [$000FW] #Sprite type
%patch $7D0C [$0000W] #Vertical speed
%patch $7D16 [$0066W] #Animation
%patch $7D22 [$0190W] #Right speed
%patch $7D95 [$FE70W] #Left speed</patch>

== Complete shot creation code ==

This is the complete shot creation code that results in the production of a single shot. It is quite complex.

On the first line the shot is created and its sprite type set. ($000FW, changing this makes Keen's shots harmless to enemies.) On the third line the vertical position (9 pixels down from the top of Keen) is set and the shot's behavior.

On the fourth line the vertical speed is set (no vertical speed.), as well as the shot collision and animation.

Until this point all code was for both left and right moving shots. Line 5 checks the player's direction and splits the code into that for right moving and left moving shots. (This is marked in brown, replacing the two bytes with $90 $90 will make Keen always shoot right.) At the end of the first line of the right shot code the right shot's horizontal speed is set.

The code for the right shot takes up the next seven lines. On lines 2-4 the game checks to see if Keen is firing against a wall. If he is then a shot will ''not'' be created, instead a special [[Patch:Zap and zot|zap\zot]] sprite is created.

The first thing to happen is sound $0025 is played, in line 4. In line 5 the shot's type s changed to $0012W and its behavior to that of a zap\zot. (Pause then vanish.) On the next line the animation timer is set to 0 and a random check is performed and a zap or zot animation assigned depending on the result.

The first line of the left moving shot code sets its horizontal speed, the next three lines check again to see if Keen is shooting against a wall, if so another zap\zot sprite is created instead of a shot. The variables here work exactly the same as for the right moving shot. This leads to the end of the code.

<patch title="Keen 1">
#Keen make shot code - all shot properties
%patch $46BA $55 $8B $EC $56 $E8 $E274W $8B $F0 $C7 $04 [$000AW] $8B $46 $06 #Set shot sprite type
$8B $56 $04 $89 $54 $04 $89 $44 $06 $8B $46 $0A $8B $56 $08 $81
$C2 $00 [$09] $15 [$0000W] $89 $54 $08 $89 $44 $0A $C7 $44 $32 {$4808W} #Set shot behavior, vertical position
$C7 $44 $22 [$0000W] $C7 $44 $34 {$4849W} $C7 $44 $28 [$006CW] #Set vertical speed, collision and animation
$83 $3E $4C $60 $00 {$7C $75}

#Right moving shot
%patch $4701 $C7 $44 $20 [$0190W] $8B $56 $06 $8B #Set right shot's speed
$46 $04 $B1 $0C $E8 $9A61W $8B $56 $0A $50 $8B $46 $08 $B1 $0C
$E8 $9A55W $05 $0001W $83 $D2 $00 $50 $A1 $6C08W $52 $99 $59
$5B $E8 $9E35W $5A $03 $D0 $42 $D1 $E2 $C4 $1E $48 $6C $03 $DA
$26 $8B $1F $D1 $E3 $83 $BF $FA $0E $00 $75 $03 $E9 $009CW $B8
[$0025W] $50 $E8 $77A3W $44 $44 $C7 $04 [$000DW] $C7 $44 $32 #Shooting wall, play sound; Zap\zot type
{$47E8W} $C7 $44 $2A [$0000W] $E8 $796BW $3D [$0080W] $7E $07 $C7 $44 #Zap\zot behavior, Timer = 0, random animation assignment
$28 [$006EW] $EB $76 $C7 $44 $28 [$006FW] $EB $6F

#Left moving shot
%patch $4776 $C7 $44 $20 [$FE70W] #Set left shot's speed
$8B $56 $0A $8B $46 $08 $B1 $0C $E8 $99ECW $05 $0001W $83
$D2 $00 $50 $A1 $6C08W $52 $99 $59 $5B $E8 $9DCCW $8B $56 $06
$50 $8B $46 $04 $B1 $0C $E8 $99CFW $5A $03 $D0 $D1 $E2 $C4 $1E
$48 $6C $03 $DA $26 $8B $1F $D1 $E3 $83 $BF $86 $18 $00 $74 $2B
$B8 [$0025W] $50 $E8 $7732W $44 $44 $C7 $04 [$000DW] $C7 $44 $32 #Shooting wall, play sound; Zap\zot type
{$47E8W} $C7 $44 $2A [$0000W] $E8 $78FAW $3D [$0080W] $7E $07 $C7 #Zap\zot behavior, Timer = 0, random animation assignment
$44 $28 [$006EW] $EB $05 $C7 $44 $28 [$006FW] $5E $5D $C3</patch>

<patch title="Keen 2">
#Keen make shot code - all shot properties
%patch $7419 $55 $8B $EC $56 $E8 $E357W $8B $F0 $C7 $04 [$000AW] $8B $46 $06 #Set shot sprite type
$8B $56 $04 $89 $54 $04 $89 $44 $06 $8B $46 $0A $8B $56 $08 $81
$C2 $00 [$09] $15 [$0000W] $89 $54 $08 $89 $44 $0A $C7 $44 $32 {$7567W} #Set shot behavior, vertical position
$C7 $44 $22 [$0000W] $C7 $44 $34 {$75A8W} $C7 $44 $28 [$007AW] #Set vertical speed, collision and animation
$83 $3E $28 $60 $00 {$7C $75}

#Right moving shot
%patch $7460 $C7 $44 $20 [$0190W] $8B $56 $06 $8B #Set right shot's speed
$46 $04 $B1 $0C $E8 $6432W $8B $56 $0A $50 $8B $46 $08 $B1 $0C
$E8 $6426W $05 $0001W $83 $D2 $00 $50 $A1 $6BE4W $52 $99 $59
$5B $E8 $67D6W $5A $03 $D0 $42 $D1 $E2 $C4 $1E $24 $6C $03 $DA
$26 $8B $1F $D1 $E3 $83 $BF $CE $10 $00 $75 $03 $E9 $009CW $B8
[$0025W] $50 $E8 $415CW $44 $44 $C7 $04 [$000CW] $C7 $44 $32 {$7547W} #Shooting wall, play sound; Zap\zot type
$C7 $44 $2A [$0000W] $E8 $4324W $3D [$0080W] $7E $07 $C7 $44 #Zap\zot behavior, Timer = 0, random animation assignment
$28 $[$007CW] $EB $76 $C7 $44 $28 [$007DW] $EB $6F

#Left moving shot
$C7 $44 $20 [$FE70W] #Set left shot's speed
%patch $74D5 $8B $56 $0A $8B $46 $08 $B1 $0C $E8 $63BDW $05 $0001W $83
$D2 $00 $50 $A1 $6BE4W $52 $99 $59 $5B $E8 $676DW $8B $56 $06
$50 $8B $46 $04 $B1 $0C $E8 $63A0W $5A $03 $D0 $D1 $E2 $C4 $1E
$24 $6C $03 $DA $26 $8B $1F $D1 $E3 $83 $BF $92 $1B $00 $74 $2B
$B8 [$0025W] $50 $E8 $40EBW $44 $44 $C7 $04 [$000CW] $C7 $44 $32 #Shooting wall, play sound; Zap\zot type
{$7547W} $C7 $44 $2A [$0000W] $E8 $42B3W $3D [$0080W] $7E $07 $C7 #Zap\zot behavior, Timer = 0, random animation assignment
$44 $28 [$007CW] $EB $05 $C7 $44 $28 [$007DW] $5E $5D $C3</patch>

<patch title="Keen 3">
#Keen make shot code - all shot properties
%patch $7CD8 $55 $8B $EC $56 $E8 $E2DEW $8B $F0 $C7 $04 [$000FW] $8B $46 $06 #Set shot sprite type
$8B $56 $04 $89 $54 $04 $89 $44 $06 $8B $46 $0A $8B $56 $08 $81
$C2 $00 [$09] $15 [$0000W] $89 $54 $08 $89 $44 $0A $C7 $44 $32 {$7E29W} #Set shot behavior, vertical position
$C7 $44 $22 [$0000W] $C7 $44 $34 {$7E6BW} $C7 $44 $28 [$0066W] #Set vertical speed, collision and animation
$83 $3E $78 $62 $00 {$7C $73}

#Right moving shot
%patch $7D1F $C7 $44 $20 [$0190W] $8B $56 $06 $8B #Set right shot's speed
$46 $04 $B1 $0C $E8 $6EB3W $8B $56 $0A $50 $8B $46 $08 $B1 $0C
$E8 $6EA7W $05 $0001W $83 $D2 $00 $50 $A1 $6E34W $52 $99 $59
$5B $E8 $7257W $5A $03 $D0 $42 $D1 $E2 $C4 $1E $74 $6E $03 $DA
$26 $8B $1F $D1 $E3 $83 $BF $6A $11 $00 $74 $2C $B8 [$0025W] $50 #Shooting wall, play sound
$E8 $FE4BW $59 $C7 $04 [$0012W] $C7 $44 $32 {$7E05W} $C7 $44 $2A #Zap\zot type, behavior
[$0000W] $E8 $4DC7W $3D [$0080W] $7E $07 $C7 $44 $28 [$0069W] $EB #Timer = 0, random animation assignment
$05 $C7 $44 $28 [$006AW] $EB $72 $EB $70

#Left moving shot
%patch $7D92 $C7 $44 $20 [$FE70W] $8B #Set left shot's speed
$56 $0A $8B $46 $08 $B1 $0C $E8 $6E40W $05 $0001W $83 $D2 $00
$50 $A1 $6E34W $52 $99 $59 $5B $E8 $71F0W $8B $56 $06 $50 $8B
$46 $04 $B1 $0C $E8 $6E23W $5A $03 $D0 $D1 $E2 $C4 $1E $74 $6E
$03 $DA $26 $8B $1F $D1 $E3 $83 $BF $96 $1C $00 $74 $2C $B8 [$0025W] #Shooting wall, play sound
$50 $E8 $4B8CW $59 $C7 $04 [$0012W] $C7 $44 $32 {$7E05W} $C7 #Zap\zot type, behavior
$44 $2A [$0000W] $E8 $4D55W $3D [$0080W] $7E $07 $C7 $44 $28 [$0069W] #Timer = 0, random animation assignment
$EB $05 $C7 $44 $28 [$006AW] $EB $00 $5E $5D $C3</patch>

== Complete shot behavior ==

This is the behavior code used by Keen's shots. It is reasonably simple and is more a tile check. On the first line the 'detect tiles' code is called and if the shot is touching any tile that blocks in ''any'' direction the shot will zap\zot.

At the end of line 1 [[Patch:Sprite Sounds|sound]] 25 is played; on line 2 the shot's [[Patch:Sprite type|sprite type]] is set to that of a Zap/zot, on line 3 its behavior is set to that of a Zap\zot and its collision is set to 'nothing'. Finally on the fourth line a random check is made and the sprite's animation is changed to one of the two Zap\zot animations.

<patch title="Keen 1">
#Keen 1 shot behavior
%patch $4808 $55 $8B $EC $56 $E8 $E45EW $8B $F0 $0B $C0 $74 $31 $B8 [$0025W]
$50 $E8 $76D7W $44 $44 $C7 $06 $20 $82 [$000DW] $C7 $06 $52 $82
{$47E8W} $C7 $06 $4A $82 {$0000W} $E8 $789BW $3D [$0080W] $7E $08
$C7 $06 $48 $82 [$006EW] $EB $06 $C7 $06 $48 $82 [$006FW] $5E $5D
$C3</patch>

<patch title="Keen 3">
#Keen 3 shot behavior
%patch $7E29 $55 $8B $EC $56 $E8 $E4C7W $8B $F0 $0B $F6 $74 $32 $B8 [$0025W]
$50 $E8 $4B2CW $59 $C7 $06 $10 $99 [$0012W] $C7 $06 $42 $99 {$7E05W}
$C7 $06 $3A $99 {$0000W} $E8 $4CF1W $3D [$0080W] $7E $08 $C7
$06 $38 $99 [$0069W] $EB $06 $C7 $06 $38 $99 [$006AW] $EB $00 $5E
$5D $C3</patch>

=== Keen's shot falls under gravity ===

This patch alters Keen's shot behavior so that his shot will fall instead of moving in a straight line. Notably, if Keen's shot is given an upwards speed it will move in an arc. All other marked properties in this behavior work identically to those in the default behavior in the above section.

A side effect of this patch is that the Zap\zot also falls and doesn't have its animation timer reset. This doesn't affect the default Zap\zots much. A more notable side effect is that the [[Patch:Tank Robot|Tank Robot's]] shots also fall under gravity also.

<patch title="Keen 1">
#Keen's shot obeys gravity
%patch $4808 $55 $8B $EC $56 $E8 $E45EW $8B $F0 $0B $C0 $74 $2B $B8 [$0025W]
$50 $E8 $76D7W $44 $44 $C7 $06 $20 $82 [$000DW] $C7 $06 $52 $82
{$47E8W} $E8 $78A1W $3D [$0080W] $7E $08 $C7 $06 $48 $82 [$006EW]
$EB $06 $C7 $06 $48 $82 [$006FW] $E8 $E3E7W $5E $5D $C3</patch>

=== Keen's shot hangs in the air after moving a short time ===

This patch causes Keen's shots to freeze in the air, but only after moving for a short time. Depending on the shot's speed and direction they can act as landmines or traps. This is almost identical to simply removing Keen's shot's speed, but the shot does in fact move for about a second.

Again all other marked properties in this behavior work identically to those in the default behavior in the above section.

<patch title="Keen 1">
#Keen's shot hangs in the air after moving a short time
%patch $4808 $55 $8B $EC $56 $E8 $E45EW $8B $F0 $0B $C0 $74 $2B $B8 [$0025W]
$50 $E8 $76D7W $44 $44 $C7 $06 $20 $82 [$000DW] $C7 $06 $52 $82
{$47E8W} $E8 $78A1W $3D [$0080W] $7E $08 $C7 $06 $48 $82 [$006EW]
$EB $06 $C7 $06 $48 $82 [$006FW] $E8 $E42AW $5E $5D $C3</patch>

{{PatchCategories|Incompatible|}}
{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Gameplay|}}
{{PatchCategories|Player|}}
{{PatchCategories|Sprite|}}
{{PatchCategories|Keen 1|gameplay}}
{{PatchCategories|Keen 2|gameplay}}
{{PatchCategories|Keen 3|gameplay}}

KeenFX

2010-09-05T13:28:44Z

Commander Spleen: unstub

[[Image:keenfx_splash.png|320px|thumb|''KeenFX'' splash screen]]
[[Image:keenfx_interface.png|320px|thumb|''KeenFX'' interface]]

'''KeenFX''' is a Keen 1-3 PC Speaker sound editor written by [[User:Commander Spleen|Commander Spleen]].

The utility is designed to work with an external sound file. This means it is only directly usable with Keen 1. However, it is possible to extract the sound effects data from the Keen 2 and 3 executable files, save them in an external file, edit them with KeenFX, and then use [[CKPatch]]'s %patchfile feature to load the sounds into a mod.

[[Category:Modding Tools (Vorticons)]]
[[Category:Audio Modding Tools (Vorticons)]]

=External Links=
* [http://www.planetkeen.com/files/keenfx.zip Download KeenFX]

KeenFX

2010-09-05T13:28:09Z

Commander Spleen: Expanded description and added download link and images.

[[Image:keenfx_splash.png|320px|thumb|''KeenFX'' splash screen]]
[[Image:keenfx_interface.png|320px|thumb|''KeenFX'' interface]]

{{Stub}}

'''KeenFX''' is a Keen 1-3 PC Speaker sound editor written by [[User:Commander Spleen|Commander Spleen]].

The utility is designed to work with an external sound file. This means it is only directly usable with Keen 1. However, it is possible to extract the sound effects data from the Keen 2 and 3 executable files, save them in an external file, edit them with KeenFX, and then use [[CKPatch]]'s %patchfile feature to load the sounds into a mod.

[[Category:Modding Tools (Vorticons)]]
[[Category:Audio Modding Tools (Vorticons)]]

=External Links=
* [http://www.planetkeen.com/files/keenfx.zip Download KeenFX]

File:KeenFX.png

2010-09-05T13:25:03Z

Commander Spleen: KeenFX splash screen

[[KeenFX]] splash screen

File:Keenfx interface.png

2010-09-05T13:24:19Z

Commander Spleen: description

[[KeenFX]] interface

File:Keenfx interface.png

2010-09-05T13:23:28Z

Commander Spleen:

Category:Gameplay patches

2010-07-14T06:20:00Z

Commander Spleen: added to Patches category

Patches that patch gameplay of the games.

[[Category: Patches]]

Category:Keen 1 gameplay patches

2010-07-14T06:14:55Z

Commander Spleen: added to Gameplay_patches category

wooo Keen 1 gameplay patches!

[[Category:Gameplay_patches]]

Category:Keen 1 gameplay patches

2010-07-14T06:09:52Z

Commander Spleen: temporary desecription text

wooo Keen 1 gameplay patches!

Stupendous Sandwich of Chungella IV

2009-02-20T08:52:09Z

Commander Spleen: Removed detail from spoiler regarding the Keen 6 ending, which is completely irrelevant to the sandwich.

{{Stub}}
{{Item Infobox
| Image = Stupendous_sandwich.png
| Appears = [[Keen 6]]
| Collectible = Yes
}}

The '''Stupendous Sandwich of Chungella IV''' was renowned as the largest sandwich in the galaxy until its consumption. It was bought (or possibly stolen) by the [[Bloog]]s of [[Fribbulus Xax]] in [[Keen 6]]. They were told its whereabouts in exchange for kidnapping [[Molly McMire]], the babysitter of [[Commander Keen]], in order to distract him from a plot to blow up the universe.

Keen, once seeing it, mentions that it's the second biggest sandwich he has ever seen. Where he has seen a larger one remains untold.

{{Spoiler|The sandwich is hidden in the top right corner of [[Bloogfoods, Inc.]], and when obtained, can be fed to the [[Grabbiter]] in exchange for a secret. The secret is that the Grabbiter will fall asleep after a big meal, thus allowing Keen to pass.}}

[[Category:Items]]
[[Category:Keen 6 items]]

Yorphius II

2007-02-12T12:40:56Z

Commander Spleen:

{{Stub}}

[[Image:Title_yorphius.png|thumb|320px|"Yorphius II" title screen.]]

'''Yorphius II''' is a [[Keen 1]] mod created by [[KeenRush]], and the first Keen mod ever created. The plot involves Keen rescuing his pet Yorp from the planet Yorphius II. Unfortunately the story text included with the mod is very short and does not explain several details. This mod, despite being before the time of many utilities and patches, has a stamp of great quality and is one of the most well-respected mods. A multi-page thread on [[http://andy.durdin.net/keen/modding Keen:Modding]] is at present underway, discussing the level design of the mod. The levels are typically concise, well-planned scenarios and puzzles. KeenRush's style changed somewhat between this mod and [[Keen Smile | Episode Smile]].

== Sound confusion ==

Many have wondered the strange sounds they have heard when they have been playing the mod. The mod requires the original SOUNDS.CK1 file from the original Keen 1, and many have not noticed that (even if it is pointed out in the readme), and that has created slight confusion. The mod does not have modified (nor corrupted) sound data.

== Technical Information ==

* Levels: 16 levels
* Tools used: [[ModKeen]] 1.0, [[Keen Make-Over]] 2, Paint Shop Pro 7, MSPaint

== Trivia ==

Yorphius II is the only place you're ever likely to discover KeenRush's real name, under the entry called 'Read' in the main menu.

[[Category:Keen 1 mods]]
[[Category:Mods]]

Dopefish

2007-02-04T23:19:39Z

Commander Spleen: Left-aligned GBC image, modified some text.

[[Image:Dopefish.png|frame|The Dopefish in [[Keen 4]]]]

[[Image:Dopefish_face.png|left]]

Probably the most well-known creature in all of the Commander Keen universe, the [[Dopefish]] has spawned a cult following and made numerous appearances in many other games. For a full list of guest appearances, visit the Dopefish's homepage - http://www.dopefish.com

The only level in Commander Keen that the Dopefish appears in is the [[Well of Wishes]], the underwater level in [[Keen 4]].

The in-game helptext states that the Dopefish won't mess with a [[Sprite]], however it is possible to lure a Dopefish into contact with a Sprite - unfortunately, nothing happens - the Sprite will fire at Keen, but its shots are harmless to the Dopefish.

The official help text says of the Dopefish:

{{Box|The second-dumbest creature in the universe, this creature's thought patterns go "swim swim hungry, swim swim hungry." They'll eat anything alive and moving near them, though they prefer heroes.}}

This is a reference to Douglas Adams' ''Hitchiker's Guide to the Galaxy'' which describes the dumbest creature in the universe as the Ravenous Bugblatter Beast of Traal. Obviously, the 'Dope' part of the name is a reference to its low intelligence, and has nothing do do with drugs.

See also [[Schoolfish]].

=== Appearance in Keen GBC ===

[[Image:Dopefish.gif|left]]

The Dopefish appears in [[Keen GBC]] as decoration on some tiles and as a real enemy. The tile art was directly taken over from the [[Keen 4]] sprite. The new enemy version looks a lot like the first one and can be found in [[Blooglet Lake]] on [[Fribbulus Xax]]. In contradiction to Keen 4 the Dopefish is now much smaller and more fragile, being easily defeatable when they are out of water. They spend their time jumping in and out of the water, hoping to snap up [[Keen]].

== External links ==

http://www.dopefish.com - The official Dopefish homepage

[[Category:Keen 4 enemies]]
[[Category:Invincible creatures]]
[[Category:Enemies]]

OrbKeen

2007-02-01T13:18:49Z

Commander Spleen:

{{Stub}}

[[Image:Title_OrbKeen1.png|thumb|320px|"Monky Business" beta title screen.]]

'''Monky Business: An Essence of Mayhem''', also known by its production name, '''OrbKeen''', is a [[Keen 1]] mod by [[Commander Spleen]] that has been in production since August 2003. Its first beta was released about a year later in August 2004. The final release date has not been publicly announced, but it is rumored that it will be released in the year 2007.

== External links ==

* [http://dosclassics.com/download/121 Download 'Monky Business: An Essence Of Mayhem beta']

[[Category:Mods]]
[[Category:Keen 1 mods]]

The Perilous Pursuit

2007-02-01T13:15:04Z

Commander Spleen:

{{Stub}}

[[Image:Ppursuit1.gif|frame|'The Perilous Pursuit' title screen.]]

[[The Perilous Pursuit]] is a Keen 1 mod created by Ceilick in 2005. Commander Spleen helped out with various details, such as patching, sound effects and minor graphical/level tweaks.

One of the key features of the mod is its "Keen4ish" 2.5D graphical style.

== External links ==

* [http://dosclassics.com/download/120 Download 'The Perilous Pursuit']

[[Category:Keen 1 mods]]
[[Category:Mods]]