KeenWiki - User contributions [en-gb]

Patch:Terminator text

2016-07-15T16:05:29Z

Lemm: Explained terminator screen operation in more detail

The "terminator text" is side-scrolling text that appears at the start of the Keen Galaxy games, along with several credits images. In reality, it is composed of two translucent monochrome images. The images themselves can be exported and imported with [[Keengraph]]. This sequence uses a different palette from the usual game, which alters the colors of various images, mostly for the interesting effects as the two images pass each other.

There are two palettes, one for as the "text" scrolls, the other for when the image "moves out" and becomes the title of the [[Patch:Title screen|titlescreen]] bitmap. For the scrolling text segment, the EGA graphics planes are divided up between the two horizontally scrolling monochrome images (i.e., "COMMANDER" and "KEEN") 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 registers on the EGA that only allow drawing to select planes at a time, the game can update one component of the scrolling screen without disturbing the other two. Thus, by default, the palettes are 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 colours can be shown at once, if vertically scrolling images are not to have any translucence.

See [[Patch:Palette]] for more details.

It is possible to make either or both of the scrolling images not appear, as well as change what graphic chunks are used for them.

= Disable entire sequence =

This disables the Terminator text entirely, but as a side effect also removes 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>

== Go straight to title screen or help ==

The first set of patches in this section skips the credit bitmaps sequence 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.

The second set of patches goes to he title zoom sequence, just before the title screen. (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">
#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>

<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>

== 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>

= Palettes =

These govern how the images are colored. Notice that the 16 EGA entries have only 6 colors in them. This is because all the images displayed are transparent, meaning things look very unusual if 16 colors are used. Care has to be taken when altering the palette colors. The 2nd, 3rd and 4th entries determine the color of the 'COMMANDER KEEN' images.

The following table shows are what colors each value is:

$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

<patch title="Keen 4">
#Palettes called from:
%patch $50B5 [$0218W]
%patch $50B8 [$0229W]

#Terminator text palette:
%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)

#Terminator text palette 2, screen moves out:
%patch $2F099 $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 text palette:
%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)

#Terminator text palette 2, screen moves out:
%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 text palette:
%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)

#Terminator text palette 2, screen moves out:
%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 + KEEN images ==

This is an alternate and more stable version of the patch above which allows the modder to selectively remove one or both of the terminator images. Note that disabling both images also frees $4571-$459E.

<patch title="Keen 4">
#Don't display 'KEEN' (Free $4F59-$4F9F)
%patch $4F56 $E9 $0046W

#Don't display 'COMMANDER' (Free $504D-$5075)
%patch $504A $E9 $0028W</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 iamges 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 th 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:Arachnut

2013-07-05T08:00:53Z

Lemm: /* Sprite Collision */ arachnut patch

This page covers patches relating to the [[Arachnut]]s in [[Keen 4]]. The Arachnuts appear in several levels and are notable in that they cannot be permanently stunned, eventually recovering from being shot.

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

Arachnuts use sprite type 10 which is used only by the them and doesn't affect anything else.

<patch title="Keen 4">
#Arachnut sprite type
%patch $10522 $0A</patch>

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

Arachnuts have three states, walking, stunned and recovering. Arachnuts are spawned running and will do nothing else until shot, whereapon they will be stunned. Stunned Arachnuts will, after some time recover, and after that return to running. Notice that the Arachnut cannot be permanently stunned.

Actions:
$2378W #Arachnut walk 1
$2396W #Arachnut walk 2
$23B4W #Arachnut walk 3
$23D2W #Arachnut walk 4
$23F0W #Arachnut stunned
$240EW #Arachnut recovering 1
$242CW #Arachnut recovering 2
$244AW #Arachnut recovering 3
$2468W #Arachnut recovering 4

<patch title="Keen 4">
#Place Arachnut in level
%patch $1056B [$2378W] #Walk

#walking Arachnut
%patch $31204 [$2396W] #Walk
%patch $31222 [$23B4W] #Walk
%patch $31240 [$23D2W] #Walk
%patch $3125E [$2378W] #Walk

#When shot
%patch $105A9 [$23F0W] #When shot, stun
%patch $105D5 [$23F0W] #When shot while stunned, stun again

#Stunned
%patch $3127C [$240EW] #Recover

#Recovering
%patch $3129A [$242CW] #Arachnut unstunning 1
%patch $312B8 [$244AW] #Arachnut unstunning 2
%patch $312D6 [$2468W] #Arachnut unstunning 3
%patch $312F4 [$2378W] #Walk</patch>

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

The Arachnut has only one behavior of note, the one that makes it slightly random. Like the [[Patch:Inchworm|Inchworm]] it will head towards Keen, but it does so randomly, and only one of its actions uses it, meaning it takes a long time to change direction, allowing Keen to evade it.

Behaviors:
$0FA80AF9RL #Randomly change direction towards Keen

<patch title="Keen 4 Arachnut behaviors">
#Walking
%patch $311F8 {$00000000L} #Nothing
%patch $31216 {$00000000L} #Nothing
%patch $31234 {$00000000L} #Nothing
%patch $31252 {$0FA80AF9RL} #Arachnut search

#Stunned
%patch $31270 {$00000000L} #Nothing

#Recovering
%patch $3128E {$00000000L} #Nothing
%patch $312AC {$00000000L} #Nothing
%patch $312CA {$00000000L} #Nothing
%patch $312E8 {$00000000L} #Nothing</patch>

=== Movement code ===

The Arachnut movement code checks for Keen's horizontal position and then changes the Arachnut's direction to head towards Keen. It is quite simple, but the fact that only one frame uses this behavior means the Arachnut takes time to respond and can 'overshoot' Keen, making it seem more erratic.

<patch title="Keen seeking">
#Arachnut movement code
%patch $10579 $55 $8B $EC $56 $8B $76 $06 $8B $44 $0A $8B $1E $D6 $A7 $3B $47
$0A {$76 $08} $C7 $44 $0E [$FFFFW] $5E $5D $CB $C7 $44 $0E [$0001W]
$5E $5D $CB</patch>

=== [[Patch:Seeking Keen|Seeking Keen]] ===

By default the Arachnuts will move towards Keen all the time. It is possible to make them ignore Keen, they then just move back and forth. (Exactly the same as if they were given no behavior at all.) It is also possible to make them slightly more random by making them randomly turn right (Or left if $0001W is changed to $FFFFW) [[Patch:Probability|The probability given here is $80, or 50/50.]]

<patch title="Keen seeking">
#Walk towards Keen
%patch $1058F [$0001W]
%patch $10597 [$FFFFW]</patch>

<patch title="Ignore Keen">
#Arachnuts ignore Keen
%patch $1058A $5E $5D $CB</patch>

<patch title="Ignore Keen, be randomish">
#Arachnut randomly turn right
%patch $10583 $8B $76 $06 $9A $1D02002ARL $3D [$80] $00 $7D $03 $5E $5D $CB
$C7 $44 $0E $0001W $5E $5D $CB</patch>

= [[Patch:Sprite speed|Speed and Jump Height]] =

The Arachnut's speed is determined entirely by its animation. By default the Arachnut moves a total of 128 per frame. Changing how fast the Arachnut animates (See animation section below) will change how fast it moves. The Arachnut moves only left and right. The stunned and recovering Arachnut do not move.

<patch title="Keen 4">
%patch $311F4 [$0080W $0000W] #Speed 1
%patch $31212 [$0080W $0000W] #Speed 2
%patch $31230 [$0080W $0000W] #Speed 3
%patch $3124E [$0080W $0000W] #Speed 4

#Stunned
%patch $3126C [$0000W $0000W] #Speed

#Unstunning
%patch $3128A [$0000W $0000W] #Speed 1
%patch $312A8 [$0000W $0000W] #Speed 2
%patch $312C6 [$0000W $0000W] #Speed 3
%patch $312E4 [$0000W $0000W] #Speed 4</patch>

= [[Patch:Sprite collision|Sprite Collision]] =

The Arachnut collision is complex. There are two basic collisions, that of the Arachnut and that of the stunned Arachnut. They are the same, excepting that the stunned Arachnut is not dangerous to Keen. The stunned Arachnut is interesting in that it is set up so that eventually it will 'unstun' and come after Keen again.

== Collision values ==

The Arachnut uses the 'dangerous' collision when walking. Everything else uses the 'safe' collision.

<patch title="Keen 4">
#Walking
%patch $311FC $0FA80B1CRL #Arachnut
%patch $3121A $0FA80B1CRL #Arachnut
%patch $31238 $0FA80B1CRL #Arachnut
%patch $31256 $0FA80B1CRL #Arachnut

#Stunned
%patch $31274 $0FA80B48RL #Stunned Arachnut

#Unstunning
%patch $31292 $0FA80B48RL #Stunned Arachnut
%patch $312B0 $0FA80B48RL #Stunned Arachnut
%patch $312CE $0FA80B48RL #Stunned Arachnut
%patch $312EC $0FA80B48RL #Stunned Arachnut</patch>

== Arachnut stuns permanently ==

This patch adjusts the stunned Arachnut action so that instead of recovering that Arachnut stays permanently stunned, complete with stun stars. This makes it much more like every other enemy. Be aware that this patch contains, and is thus incompatible with, a number of patches elsewhere on this page involving the stunned Arachnut. (For example its animations, action type and behavior.)

This patch frees up the recovering Arachnut's actions for use elsewhere.

<patch title="Keen 4">
#Arachnut stuns permanently
%patch $31260 $01ADW $01ADW $0002W $0000W $0001W $0000W $0000W $0000W
$09DC16C9RL $00000000L $09DC1913RL $23F0W</patch>

== Stunner doesn't affect Arachnut ==

This patch makes the stunner shot fly through the Arachnut.

<patch title="Keen 4">
#Stunner shot passes through arachnut
%patch $105B0 $90 $90 $90 $90 $90
</patch>

= [[Patch:Sprite animations|Animations]] =

The Arachnut's animation is quite straightforward, it uses four images for walking left ''and'' right and a fifth frame for when it is stunned. Alternating stunned-walking images are used as the Arachnut recovers. This means the Arachnut is very image-efficient.

Notice that the animation speed for the stunned Arachnut determines how long it will be stunned for, and those of the recovering Arachnut determine both how long it will take to recover and how fast it animates while recovering.

<patch title="Keen 4">
#Cache
%patch $306FC $A9 $01 #Arachnut Cache start
%patch $30746 $AD $01 #Arachnut cache end

#Walking
%patch $311E8 $01A9W $01ACW
%patch $311F2 $0006W #Animation speed
%patch $31206 $01AAW $01ABW
%patch $31210 $0006W #Animation speed
%patch $31224 $01ABW $01AAW
%patch $3122E $0006W #Animation speed
%patch $31242 $01ACW $01A9W
%patch $3124C $0006W #Animation speed

#Arachnut stunned
%patch $31260 $01ADW $01ADW
%patch $3126A $00F0W #Animation speed

#Arachnut unstunning
%patch $3127E $01A9W $01A9W
%patch $31288 $0014W #Animation speed
%patch $3129C $01ADW $01ADW
%patch $312A6 $0014W #Animation speed
%patch $312BA $01A9W $01A9W
%patch $312C4 $0014W #Animation speed
%patch $312D8 $01ADW $01ADW
%patch $312E2 $0014W #Animation speed</patch>

= [[Patch:Sprite positioning|Sprite positioning]] =

Arachnuts are spawned 1 tile, 7 pixels up from their placed position, so that they can walk smoothly on the ground.

<patch title="Keen 4">
#Spawn height:
%patch $1053E $FE8FW #1 tile, 7 pixels up</patch>

= [[Patch:Sprite clipping and foreground|Clipping and foreground]] =

The Arachnut has a foreground variable of 0, meaning it appears behind all sprites and foreground tiles.

<patch title="Keen 4">
#Arachnut foreground variable
%patch $1052C [$0000W]</patch>

= [[Patch:Sprite-tile interaction|Sprite-tile interaction]] =

The Arachnut uses general tile collisions; when walking it uses the 'turn around at walls or edges' collision and when stunned or recovering it uses the 'sit' collision.

<patch title="Keen 4">
%patch $31200 $09DC1795RL #Walking
%patch $3121E $09DC1795RL #Walking
%patch $3123C $09DC1795RL #Walking
%patch $3125A $09DC1795RL #Walking

%patch $31278 $09DC176ERL #Stunned

%patch $31296 $09DC176ERL #Unstunning
%patch $312B4 $09DC176ERL #Unstunning
%patch $312D2 $09DC176ERL #Unstunning
%patch $312F0 $09DC176ERL #Unstunning</patch>

= [[Patch:Galaxy Action Parameters#Action_Type|Action type]] =

The Arachnut uses type 0 for all of its actions. This means that its motion is technically jerky, but it animates fast enough that this is not really noticeable.

<patch title="Keen 4">
#Arachnut moving
%patch $311EC [$0000W]
%patch $3120A [$0000W]
%patch $31228 [$0000W]
%patch $31246 [$0000W]

#Arachnut stunned
%patch $31264 [$0000W]

#Arachnut unstunning
%patch $31282 [$0000W]
%patch $312A0 [$0000W]
%patch $312BE [$0000W]
%patch $312DC [$0000W]</patch>

= [[Patch:Galaxy Action Parameters#Deprotect_Animation|Deprotect and stick to ground]] =

The Arachnut needs to move up and down slopes, so uses the stick-to-ground parameter in all of its actions. (Even when stunned.)

<patch title="Keen 4">
#Arachnut moving
%patch $311EE [$0000W $0001W]
%patch $3120C [$0000W $0001W]
%patch $3122A [$0000W $0001W]
%patch $31248 [$0000W $0001W]

#Arachnut stunned
%patch $31266 [$0000W $0001W]

#Arachnut unstunning
%patch $31284 [$0000W $0001W]
%patch $312A2 [$0000W $0001W]
%patch $312C0 [$0000W $0001W]
%patch $312DE [$0000W $0001W]</patch>

= [[Patch:Probability|Probability and randomness]] =

The Arachnut's initial direction is randomly decided with a 50:50 chance. This has little effect as the Arachnut chases Keen.

<patch title="Keen 4">
#Probability of initially moving right
%patch $10549 $80</patch>

= [[Patch:Sprite spawning|Sprite spawn code]] =

There are three different difficulties of Arachnut in the game. In the initiation code notice the [[Patch:Sprite cache|Arachnut cache]] being set (<tt>$C7 $06 $CB67W $0001W</tt>.)

<patch title="Keen 4">
#Location of initiation code
%patch $EEAB [$02FAW] #Easy Arachnut (At $EBEA)
%patch $EF15 [$02F0W] #Medium Arachnut (At $EBE0)
%patch $EF17 [$02E6W] #Hard Arachnut (At $EBD6)

#Arachnut Initiation code
%patch $EBD6 $83 $3E [$7A6CW] {$03 $7D} $03 $E9 $021DW $83 $3E [$7A6CW] {$02 $7D}
$03 $E9 $0213W $FF $76 $FC $57 $9A {$0FA80A8ERL} $83 $C4 $04
$C7 $06 $CB67W $0001W $E9 $01FEW</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Sprite|}}

Patch:Music

2012-03-25T16:03:50Z

Lemm: additional songs patch

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:

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

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

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

== 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]], see the page for details.

<patch title="Keen 4">
#Where music list is read from:
%patch $8CCD $96 $03 #$2F206

#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 $00 $00 #Map (Shadowlands) 0
$04 $00 #Border Village (Kick in the Pants) 1
$03 $00 #Slug Village (Slug Village) 2
$03 $00 #Perilous Pit (Slug Village) 3
$02 $00 #Cave of Descendants (Too Hot) 4
$02 $00 #Chasm of Chills (Too Hot) 5
$04 $00 #Crystalus (Kick in the Pants) 6
$03 $00 #Hiliville (Slug Village) 7
$01 $00 #Sand Yego (Eat your Veggies) 8
$01 $00 #Miragia (Eat your Veggies) 9
$01 $00 #Lifwater Oasis (Eat your Veggies) 10
$02 $00 #Pyramid of Moons (Too Hot) 11
$02 $00 #Pyramid of Shadows (Too Hot) 12
$02 $00 #Pyramid of Ancients (Too Hot) 13
$02 $00 #Pyramid of Forbidden (Too Hot) 14
$02 $00 #Isle of Tar (Too Hot) 15
$02 $00 #Isle of Fire (Too Hot) 16
$01 $00 #Well of Wishes (Eat your Veggies) 17
$03 $00 #Bwb Megarocket (Slug Village) 18
$FF $FF #High scores (No music, "Fanfare") 19

#Other music played: (Values here is number of LEVEL who's music is used)
%patch $5836 $0C $00 #Story demo (Too hot)
%patch $9CD7 $07 $00 #Ending Sequence (Slug Village)
%patch $F107 $FF $FF #Talking to Lindsey (Ancient)
%patch $F4CA $FF $FF #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 6 # Total Number of Songs
</patch>

<patch title="Keen 5">
#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 $0B $00 #Map (Omegamatic) 0
$05 $00 #Ion Ventilation System (Wednesday on the Beach) 1
$07 $00 #Security Center (Security Center) 2
$09 $00 #Defense Tunnel Vlook (Be Sphereful) 3
$0A $00 #Energy Flow Systems (Make it Tighter) 4
$09 $00 #Defense Tunnel Burrh (Be Sphereful) 5
$0A $00 #Regulation Control Center (Make it Tighter) 6
$09 $00 #Defense Tunnel Sorra (Be Sphereful) 7
$0A $00 #Neutrino Burst Injector (Make it Tighter) 8
$09 $00 #Defense Tunnel Teln (Be Sphereful) 9
$0A $00 #Brownian Motion Inducer (Make it Tighter) 10
$03 $00 #Gravitational Damping Hub (Snooping) 11
$0D $00 #Quantum Explosion Dynamo (QED) 12
$04 $00 #Korath III Base (Bagpipes) 13
$0C $00 #Ending (Fanfare)
$02 $00 #High Scores (High Scores) 15
%patch $3069C $01 $00 #Scrolling Story (Armageddon Machine)
$00 $00 #Game Over (Came In)
$08 $00 #Help (Help)

#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 14 # Total Number of Songs

</patch>

<patch title="Keen 6">
#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 $05 $00 #Map (Aliens Ate My Babysitter) 0
$03 $00 #Bloogwaters Crossing (Faster) 1
$01 $00 #Guard Post One (Brer Tar) 2
$08 $00 #First Dome of Darkness (Mamba Snake) 3
$08 $00 #Second Dome of Darkness (Mamba Snake) 4
$08 $00 #Bloogdome (Mamba Snake) 5
$07 $00 #Bloogton Manufacturing (Metal) 6
$02 $00 #Bloogton Tower (To the Future) 7
$07 $00 #Bloogfoods, Inc. (Metal) 8
$01 $00 #Guard Post 2 (Brer Tar) 9
$03 $00 #Bloogville (Faster) 10
$02 $00 #BASA (To the Future) 11
$01 $00 #Guard Post 3 (Brer Tar) 12
$04 $00 #Bloogbase Recreational District(Space Funk) 13
$04 $00 #Bloogbase Management District (Space Funk) 14
$06 $00 #Bloog Control Center (Ominous) 15
$02 $00 #Blooglab Space Station (To the Future) 16
$00 $00 #Bean-with-Bacon Megarocket (A World of Wonderment) 17
$00 $00 #High Scores (A World of Wonderment) 18

#Other music played:
%patch $563F $0D $00 #Star wars text (Space funk)
%patch $E33C $01 $00 #Molly ending (Faster)

#Index of first music chunk within audio chunks:
%patch $8AC0 $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 9 # Total number of songs

</patch>

== Music and extra levels ==

[[Patch:Levels#Extra_levels|It is possible to have extra levels in Keen Vorticons an 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.

== Other ==

Keen 4:
<patch>
#Insuff mem message:
%patch $8D30 $EC $06 #Read from
%patch $2F55C "Insufficient memory" $0A
"for background music!" $00
</patch>

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

Patch:Main menu

2012-02-17T07:52:10Z

Lemm: /* Colors */ control menus proc was buggy

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]]. It is divided into three sections, Vorticons, Dreams and Galaxy, relating to the three different menu styles employed in those games.

= Vorticons =

The menu appears over the title screen. It has seven items, New game, Continue game, Story, About id, High scores, Ordering info, Previews and Restart demo. The currently selected item is shown by an 8x8 cursor taken from the 8x8 tiles. The menu window itself is set up like a normal "game window" and uses the same tiles.

There are three basic things to consider when changing the menu; the menu text, the menu item and what the item does. To properly alter the menu, all three must be considered. As an example, if we wanted to delete the "Continue game" option we would have to do three things; remove the continue game text so the player cannot see it, "shorten" the menu so that the player cannot select an "empty" option, and finally rearrange what the items do so they make sense again. See the example at the end of this section.

== Menu items ==

Menu items are independent of the text displayed in the menu. Each item is a "line" that the player can select with the cursor. For simplicity you can change the number of items by changing the last two values of this patch. (Default 7 items.) More complexly, this patch controls where the cursor navigates to when the arrow keys are pressed. There is a value for the top and the bottom of the menu so that the cursor knows where to go when "wrapping around" (going from the top of the menu to the bottom and vice versa). These should be the same to avoid problems.

Making the menu "shorter" will simply mean that there are items the player cannot select and thus cannot use. For example, making the bottom item 5 means the last two items, Previews and Restart demo appear, but cannot be selected. Making the top item 1 means "New game" cannot be selected.

<patch title="Keen 1, Change number of menu items">
#Menu start item
%patch $9331 $00 #When moving up
%patch $9472 $00 $00 #When wrapping around from bottom

#Menu bottom item
%patch $9414 $07 #Moving down
%patch $938F $07 $00 #When wrapping from top
</patch>

== Menu cursor ==

As mentioned above, the cursor uses graphics from the 8x8 tiles (also known as the "font"). It can use any number of these when moving about the menu. The first 8x8 tile is 0, and so on. Only the idle (no keys being pressed) cursor animates. The cursor also leaves behind a vertical "trail" of tiles which should, usually, be the same as the background (space) tile of the menu window.

<patch title="Keen 1, 8x8 cursor graphics">
#Idle
%patch $92FB $09 $00
%patch $9316 $02 $00 #Animation frames - 1

#Moving up
%patch $933E $09 $00 #While moving
%patch $93B5 $09 $00 #After moving (Should be the same as above line)
%patch $937E $02 $00 #Animation frames - 1
%patch $9361 $20 $00 #Tile left behind (White space)

#Moving down
%patch $9421 $09 $00 #While moving
%patch $9498 $09 $00 #After moving (Should be the same as above line)
%patch $9461 $02 $00 #Animation frames - 1
%patch $9444 $20 $00 #Tile left behind (White space)

#Cursor speed:
%patch $9358 $01 $00 #Up
%patch $943B $01 $00 #Down</patch>

== Window size ==

The menu size is in 8x8 blocks. Try not to make a window shorter or narrower than the text in it, it does not look pretty.

<patch title="Keen 1">
%patch $9601 [$000AW] #Height
%patch $9605 [$0012W] #Width</patch>

<patch title="Keen 2">
%patch $9094 [$000AW] #Height
%patch $9098 [$0012W] #Width</patch>

== Menu options ==

These are a collection of two-byte addresses that "point" to the various options. The actual values are not important unless the actual option code is being patched (which is more complicated and should be unnecessary). When "removing" an option, your best bet is to simply delete the pointer. To keep the line in the menu box but make it unuseable, '''replace''' the pointer with the value replace the pointer with $95CAW or 'do nothing'

<patch title="Keen 1">
#Menu pointers
%patch $95ED $9570W # New Game
$9577W # Continue Game
$957FW # Story
$9589W # About ID...
$9596W # High Scores
$95A3W # Ordering Info
$95B5W # Previews!
$95C2W # Restart Demo</patch>

== Text ==

The menu text is one line of text for each item plus a bottom of window instruction telling the player how to use the menu. Two things can be done, the text can be removed entirely or it can be changed.

=== Remove text ===

Removing an item's text does not in fact disable the item, it merely changes the whole menu to not have that text. So for example, using the first line of the patch shown below deletes the "New game" line from the menu. New game is now "Continue game", Continue is now "Story", and so on, with the last item having a blank line. These patches are thus not very useful unless you are deleting items from the bottom of the menu.

<patch title="Keen 1, Remove item text">
%patch $9628 $90 $90 $90 #New Game
%patch $9631 $90 $90 $90 #Continue Game
%patch $963A $90 $90 $90 #Story
%patch $9643 $90 $90 $90 #About Id
%patch $964C $90 $90 $90 #High Scores
%patch $9655 $90 $90 $90 #Ordering Info
%patch $965E $90 $90 $90 #Previews!
%patch $9667 $90 $90 $90 #Restart Demo</patch>

=== Change text ===

Changing the text is more complicated. See [[Patch:Text patches]]. If your new text fits into the old text's space you only need to edit that, but it's possible you will need to edit the text pointers too. These are the 'addresses' of the text and seeing the link above will show you how they work.

<patch title="Keen 1">
#Menu text:
%patch $15EE6 " New Game" $0A $00
%patch $15EF3 " Continue Game" $0A $00
%patch $15F05 " Story" $0A $00
%patch $15F0F " About ID..." $0A $00
%patch $15F1F " High Scores" $0A $00
%patch $15F2F " Ordering Info" $0A $00
%patch $15F41 " Previews!" $0A $00
%patch $15F4F " Restart Demo" $0A $0A $00
%patch $15F61 "Use the " $00
%patch $15F6A "arrows" $00
%patch $15F71 "mouse" $00
%patch $15F77 "joystick" $00

#Text read from
%patch $9625 [$2E96W] #New Game
%patch $962E [$2EA3W] #Continue Game
%patch $9637 [$2EB5W] #Story
%patch $9640 [$2EBFW] #About Id
%patch $9649 [$2ECFW] #High Scores
%patch $9652 [$2EDFW] #Ordering info
%patch $965B [$2EF1W] #Previews!
%patch $9664 [$2EFFW] #Restart demo
%patch $966D [$2F11W] #Use the
%patch $9686 [$2F1AW] #Arrows (Using keyboard)
%patch $968B [$2F21W] #Mouse (Using mouse)
%patch $9690 [$2F27W] #Joystick (Using joystick)</patch>

<patch title="Keen 2">
#Menu text:
%patch $1A6B9 " New Game" $0A $00
%patch $1A6C6 " Continue Game" $0A $00
%patch $1A6D8 " Story" $0A $00
%patch $1A6E2 " About ID..." $0A $00
%patch $1A6F2 " High Scores" $0A $00
%patch $1A702 " Ordering Info" $0A $00
%patch $1A714 " Previews!" $0A $00
%patch $1A722 " Restart Demo" $0A $0A $00
%patch $1A734 "Use the " $00
%patch $1A73D "arrows" $00
%patch $1A744 "mouse" $00
%patch $1A74A "joystick" $00

#Text read from
%patch $90B8 [$2F39W] #New Game
%patch $90C1 [$2F46W] #Continue Game
%patch $90CA [$2F58W] #Story
%patch $90D3 [$2F62W] #About Id
%patch $90DC [$2F72W] #High Scores
%patch $90E5 [$2F82W] #Ordering info
%patch $90EE [$2F94W] #Previews!
%patch $90F7 [$2FA2W] #Restart demo
%patch $9100 [$2FB4W] #Use the
%patch $9119 [$2FBDW] #Arrows (Using keyboard)
%patch $911E [$2FC4W] #Mouse (Using mouse)
%patch $9123 [$2FCAW] #Joystick (Using joystick)</patch>

<patch title="Keen 3">
#Menu text:
%patch $1C7D5 " New Game" $0A $00
%patch $1C7E2 " Continue Game" $0A $00
%patch $1C7F4 " Story" $0A $00
%patch $1C7FE " About ID..." $0A $00
%patch $1C80E " High Scores" $0A $00
%patch $1C81E " Ordering Info" $0A $00
%patch $1C830 " Previews!" $0A $00
%patch $1C83E " Restart Demo" $0A $0A $00
%patch $1C850 "Use the " $00
%patch $1C859 "arrows" $00
%patch $1C860 "mouse" $00
%patch $1C866 "joystick" $00

%patch $9F13 [$2FB5W] #New Game
%patch $9F1B [$2FC2W] #Continue Game
%patch $9F23 [$2FD4W] #Story
%patch $9F2B [$2FDEW] #About Id
%patch $9F33 [$2FEEW] #High Scores
%patch $9F3B [$2FFEW] #Ordering info
%patch $9F43 [$3010W] #Previews!
%patch $9F4B [$301EW] #Restart demo
%patch $9F53 [$3030W] #Use the
%patch $9F6B [$3039W] #Arrows (Using keyboard)
%patch $9F75 [$3040W] #Mouse (Using mouse)
%patch $9F7F [$3046W] #Joystick (Using joystick)
</patch>

= Dreams =

The Dreams menu is the most complex of any Keen game. In consists of a number of bitmaps that can be selected using the mouse or keyboard. The menu is divided into a number of screens that contain further options. At present, only the graphics can be changed and it is likely very difficult to change the layout.

= Galaxy =

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). At present, both the text and the graphics of the menu can be changed.

== Text ==

<patch title="Keen 4">
%patch $33656 "BEGIN EASY GAME" $00
"BEGIN NORMAL GAME" $00
"BEGIN HARD GAME" $00
%patch $3372F "NEW GAME" $00
"LOAD GAME" $00
"SAVE GAME" $00
"CONFIGURE" $00
"END GAME" $00
"PADDLE WAR" $00
"QUIT" $00

%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 $33874 "SCORE BOX (ON)" $00
"SCORE BOX (OFF)" $00
%patch $33893 "TWOBUTTON FIRING (ON)" $00
"TWOBUTTON FIRING (OFF)" $00
%patch $338C2 "FIX JERKY MOTION (ON)" $00
"FIX JERKY MOTION (OFF)" $00
%patch $338EF "SVGA COMPATIBILITY (ON)" $00
"SVGA COMPATIBILITY (OFF)" $00
%patch $33920 "USE GRAVIS GAMEPAD (ON)" $00
"USE GRAVIS GAMEPAD (OFF)" $00
%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</patch>

<patch title="Keen 5">
%patch $3412F "BEGIN EASY GAME" $00
"BEGIN NORMAL GAME" $00
"BEGIN HARD GAME" $00
%patch $341F2 "NEW GAME" $00
"LOAD GAME" $00
"SAVE GAME" $00
"CONFIGURE" $00
"END GAME" $00
"PADDLE WAR" $00
"QUIT" $00
%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 $34324 "SCORE BOX (ON)" $00
%patch $34333 "SCORE BOX (OFF)" $00
%patch $34343 "TWO-BUTTON FIRING (ON)" $00
%patch $34354 "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
%patch $343D0 "USE GRAVIS GAMEPAD (ON)" $00
%patch $343E8 "USE GRAVIS GAMEPAD (OFF)" $00
%patch $34401 "Score box now on" $00
"Score box now off" $00
"Press any key" $00

#Text 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
%patch $1C142 $4090W #Gravis on
%patch $1C147 $40A8W #Gravis off</patch>

<patch title="Keen 6">
%patch $34F90 "BEGIN EASY GAME" $00
"BEGIN NORMAL GAME" $00
"BEGIN HARD GAME" $00
%patch $35069 "NEW GAME" $00
"LOAD GAME" $00
"SAVE GAME" $00
"CONFIGURE" $00
"END GAME" $00
"PADDLE WAR" $00
"QUIT" $00
%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 $35604 "RETURN TO GAME" $00
"RETURN TO DEMO" $00
%patch $3564B "Quitting..." $00

#Options menu
%patch $351AE "SCORE BOX (ON)" $00
"SCORE BOX (OFF)" $00
%patch $351CD "TWO-BUTTON FIRING (ON)" $00
"TWO-BUTTON FIRING (OFF)" $00
%patch $351FC "FIX JERKY MOTION (ON)" $00
"FIX JERKY MOTION (OFF)" $00
%patch $35229 "SVGA COMPATIBILITY (ON)" $00
"SVGA COMPATIBILITY (OFF)" $00
%patch $3525A "USE GRAVIS GAMEPAD (ON)" $00
"USE GRAVIS GAMEPAD (OFF)" $00
%patch $3528B "Score box now on" $00
"Score box now off" $00
"Press any key" $00</patch>

== Colors ==

There are numerous functions that set watch text and background colours, allowing you to have different colours in different parts of the watch. Note that the font colour is dependent on the background color.

<patch title="Keen 4">

# draw_menu_item
%patch $1A9C6
$B0 8 # mov al, BGCOLOR ; NOTE THIS WORKS BECAUSE AX MUST BE 0 AT THIS OP
$50 # push ax
$B0 8 # mov al 8
$50 # push ax
$B0 $9F # mov al 9fh
$50 # push ax

%patch $1AA06 2 #menu font 1
%patch $1AA0D 10 #menu font 2
%patch $1AA33 15 #menu font 3

# draw_menu_footer
%patch $1AA40 10 #font 1
%patch $1AABF 0 #font 2
%patch $1AAC1 10W #hlin 1

# draw_current_menu
%patch $1AB14 10W #Hlin 1

# center_watch_window
%patch $1AC5B 8W #BAR 1
%patch $1AC75 10W #Hlin 1
%patch $1AC90 10W #Hlin 2
%patch $1ACAE 10W #Vlin 1
%patch $1ACC9 10W #Vlin 2

#green_message_box
%patch $1AE6C 2 #font 1
%patch $1AEA3 10W #hlin 1
%patch $1AEC8 10 #fontcolor 1

#configure_menu_proc
%patch $1B2F6 10 #font 1

#set_key_control
%patch $1B33B 2 # font 1
%patch $1B35E 8W # BAR 1
%patch $1B381 8W # BAR 2

#controls_menu_proc
%patch $1B50E
$B0 3 # mov al, BGCOLOR ; NOTE THIS WORKS BECAUSE AH MUST BE 0 AT THIS OP
$50 # push ax
$B0 8 # mov al 8
$50 # push ax
$B0 $9F # mov al 9fh
$50 # push ax

%patch $1B543 2 # font1
%patch $1B547 10 # font1B
%patch $1B572 8W # BAR 2 (XOR)
%patch $1B595 8W # BAR 3

#print_joystick_prompt
%patch $1B64F 8W # Bar 1
%patch $1B670 2 # font1

#print_gamepad_prompt
%patch $1B987 8W # Bar 1

#gamepad_menu_proc
%patch $1BB9C 2 #font 1

#draw_savegame_item
%patch $1BC73 2 #font 1a
%patch $1BC77 10 #font 1b

%patch $1BC7E 8W #Hlin 1, 2, Vlin 1,2

#load_game_menu_proc
%patch $1BEA7 8W #bar 1

#save_savegame_item
%patch $1BFAF 2 #font 1
%patch $1BFB1 8W #Bar 1

#Paddle War left out

#do_main_menu
%patch $1CC69 15 #font 1

#init_menu
%patch $1CD8E 15 #font 1
</patch>

=== 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 who's music is used. (For example a value of 0 will play the map level's music.) See [[Patch:Music]].

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

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

Patch:Main menu

2012-02-17T06:46:07Z

Lemm: /* Galaxy */ Watch Colours for Keen 4

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]]. It is divided into three sections, Vorticons, Dreams and Galaxy, relating to the three different menu styles employed in those games.

= Vorticons =

The menu appears over the title screen. It has seven items, New game, Continue game, Story, About id, High scores, Ordering info, Previews and Restart demo. The currently selected item is shown by an 8x8 cursor taken from the 8x8 tiles. The menu window itself is set up like a normal "game window" and uses the same tiles.

There are three basic things to consider when changing the menu; the menu text, the menu item and what the item does. To properly alter the menu, all three must be considered. As an example, if we wanted to delete the "Continue game" option we would have to do three things; remove the continue game text so the player cannot see it, "shorten" the menu so that the player cannot select an "empty" option, and finally rearrange what the items do so they make sense again. See the example at the end of this section.

== Menu items ==

Menu items are independent of the text displayed in the menu. Each item is a "line" that the player can select with the cursor. For simplicity you can change the number of items by changing the last two values of this patch. (Default 7 items.) More complexly, this patch controls where the cursor navigates to when the arrow keys are pressed. There is a value for the top and the bottom of the menu so that the cursor knows where to go when "wrapping around" (going from the top of the menu to the bottom and vice versa). These should be the same to avoid problems.

Making the menu "shorter" will simply mean that there are items the player cannot select and thus cannot use. For example, making the bottom item 5 means the last two items, Previews and Restart demo appear, but cannot be selected. Making the top item 1 means "New game" cannot be selected.

<patch title="Keen 1, Change number of menu items">
#Menu start item
%patch $9331 $00 #When moving up
%patch $9472 $00 $00 #When wrapping around from bottom

#Menu bottom item
%patch $9414 $07 #Moving down
%patch $938F $07 $00 #When wrapping from top
</patch>

== Menu cursor ==

As mentioned above, the cursor uses graphics from the 8x8 tiles (also known as the "font"). It can use any number of these when moving about the menu. The first 8x8 tile is 0, and so on. Only the idle (no keys being pressed) cursor animates. The cursor also leaves behind a vertical "trail" of tiles which should, usually, be the same as the background (space) tile of the menu window.

<patch title="Keen 1, 8x8 cursor graphics">
#Idle
%patch $92FB $09 $00
%patch $9316 $02 $00 #Animation frames - 1

#Moving up
%patch $933E $09 $00 #While moving
%patch $93B5 $09 $00 #After moving (Should be the same as above line)
%patch $937E $02 $00 #Animation frames - 1
%patch $9361 $20 $00 #Tile left behind (White space)

#Moving down
%patch $9421 $09 $00 #While moving
%patch $9498 $09 $00 #After moving (Should be the same as above line)
%patch $9461 $02 $00 #Animation frames - 1
%patch $9444 $20 $00 #Tile left behind (White space)

#Cursor speed:
%patch $9358 $01 $00 #Up
%patch $943B $01 $00 #Down</patch>

== Window size ==

The menu size is in 8x8 blocks. Try not to make a window shorter or narrower than the text in it, it does not look pretty.

<patch title="Keen 1">
%patch $9601 [$000AW] #Height
%patch $9605 [$0012W] #Width</patch>

<patch title="Keen 2">
%patch $9094 [$000AW] #Height
%patch $9098 [$0012W] #Width</patch>

== Menu options ==

These are a collection of two-byte addresses that "point" to the various options. The actual values are not important unless the actual option code is being patched (which is more complicated and should be unnecessary). When "removing" an option, your best bet is to simply delete the pointer. To keep the line in the menu box but make it unuseable, '''replace''' the pointer with the value replace the pointer with $95CAW or 'do nothing'

<patch title="Keen 1">
#Menu pointers
%patch $95ED $9570W # New Game
$9577W # Continue Game
$957FW # Story
$9589W # About ID...
$9596W # High Scores
$95A3W # Ordering Info
$95B5W # Previews!
$95C2W # Restart Demo</patch>

== Text ==

The menu text is one line of text for each item plus a bottom of window instruction telling the player how to use the menu. Two things can be done, the text can be removed entirely or it can be changed.

=== Remove text ===

Removing an item's text does not in fact disable the item, it merely changes the whole menu to not have that text. So for example, using the first line of the patch shown below deletes the "New game" line from the menu. New game is now "Continue game", Continue is now "Story", and so on, with the last item having a blank line. These patches are thus not very useful unless you are deleting items from the bottom of the menu.

<patch title="Keen 1, Remove item text">
%patch $9628 $90 $90 $90 #New Game
%patch $9631 $90 $90 $90 #Continue Game
%patch $963A $90 $90 $90 #Story
%patch $9643 $90 $90 $90 #About Id
%patch $964C $90 $90 $90 #High Scores
%patch $9655 $90 $90 $90 #Ordering Info
%patch $965E $90 $90 $90 #Previews!
%patch $9667 $90 $90 $90 #Restart Demo</patch>

=== Change text ===

Changing the text is more complicated. See [[Patch:Text patches]]. If your new text fits into the old text's space you only need to edit that, but it's possible you will need to edit the text pointers too. These are the 'addresses' of the text and seeing the link above will show you how they work.

<patch title="Keen 1">
#Menu text:
%patch $15EE6 " New Game" $0A $00
%patch $15EF3 " Continue Game" $0A $00
%patch $15F05 " Story" $0A $00
%patch $15F0F " About ID..." $0A $00
%patch $15F1F " High Scores" $0A $00
%patch $15F2F " Ordering Info" $0A $00
%patch $15F41 " Previews!" $0A $00
%patch $15F4F " Restart Demo" $0A $0A $00
%patch $15F61 "Use the " $00
%patch $15F6A "arrows" $00
%patch $15F71 "mouse" $00
%patch $15F77 "joystick" $00

#Text read from
%patch $9625 [$2E96W] #New Game
%patch $962E [$2EA3W] #Continue Game
%patch $9637 [$2EB5W] #Story
%patch $9640 [$2EBFW] #About Id
%patch $9649 [$2ECFW] #High Scores
%patch $9652 [$2EDFW] #Ordering info
%patch $965B [$2EF1W] #Previews!
%patch $9664 [$2EFFW] #Restart demo
%patch $966D [$2F11W] #Use the
%patch $9686 [$2F1AW] #Arrows (Using keyboard)
%patch $968B [$2F21W] #Mouse (Using mouse)
%patch $9690 [$2F27W] #Joystick (Using joystick)</patch>

<patch title="Keen 2">
#Menu text:
%patch $1A6B9 " New Game" $0A $00
%patch $1A6C6 " Continue Game" $0A $00
%patch $1A6D8 " Story" $0A $00
%patch $1A6E2 " About ID..." $0A $00
%patch $1A6F2 " High Scores" $0A $00
%patch $1A702 " Ordering Info" $0A $00
%patch $1A714 " Previews!" $0A $00
%patch $1A722 " Restart Demo" $0A $0A $00
%patch $1A734 "Use the " $00
%patch $1A73D "arrows" $00
%patch $1A744 "mouse" $00
%patch $1A74A "joystick" $00

#Text read from
%patch $90B8 [$2F39W] #New Game
%patch $90C1 [$2F46W] #Continue Game
%patch $90CA [$2F58W] #Story
%patch $90D3 [$2F62W] #About Id
%patch $90DC [$2F72W] #High Scores
%patch $90E5 [$2F82W] #Ordering info
%patch $90EE [$2F94W] #Previews!
%patch $90F7 [$2FA2W] #Restart demo
%patch $9100 [$2FB4W] #Use the
%patch $9119 [$2FBDW] #Arrows (Using keyboard)
%patch $911E [$2FC4W] #Mouse (Using mouse)
%patch $9123 [$2FCAW] #Joystick (Using joystick)</patch>

<patch title="Keen 3">
#Menu text:
%patch $1C7D5 " New Game" $0A $00
%patch $1C7E2 " Continue Game" $0A $00
%patch $1C7F4 " Story" $0A $00
%patch $1C7FE " About ID..." $0A $00
%patch $1C80E " High Scores" $0A $00
%patch $1C81E " Ordering Info" $0A $00
%patch $1C830 " Previews!" $0A $00
%patch $1C83E " Restart Demo" $0A $0A $00
%patch $1C850 "Use the " $00
%patch $1C859 "arrows" $00
%patch $1C860 "mouse" $00
%patch $1C866 "joystick" $00

%patch $9F13 [$2FB5W] #New Game
%patch $9F1B [$2FC2W] #Continue Game
%patch $9F23 [$2FD4W] #Story
%patch $9F2B [$2FDEW] #About Id
%patch $9F33 [$2FEEW] #High Scores
%patch $9F3B [$2FFEW] #Ordering info
%patch $9F43 [$3010W] #Previews!
%patch $9F4B [$301EW] #Restart demo
%patch $9F53 [$3030W] #Use the
%patch $9F6B [$3039W] #Arrows (Using keyboard)
%patch $9F75 [$3040W] #Mouse (Using mouse)
%patch $9F7F [$3046W] #Joystick (Using joystick)
</patch>

= Dreams =

The Dreams menu is the most complex of any Keen game. In consists of a number of bitmaps that can be selected using the mouse or keyboard. The menu is divided into a number of screens that contain further options. At present, only the graphics can be changed and it is likely very difficult to change the layout.

= Galaxy =

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). At present, both the text and the graphics of the menu can be changed.

== Text ==

<patch title="Keen 4">
%patch $33656 "BEGIN EASY GAME" $00
"BEGIN NORMAL GAME" $00
"BEGIN HARD GAME" $00
%patch $3372F "NEW GAME" $00
"LOAD GAME" $00
"SAVE GAME" $00
"CONFIGURE" $00
"END GAME" $00
"PADDLE WAR" $00
"QUIT" $00

%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 $33874 "SCORE BOX (ON)" $00
"SCORE BOX (OFF)" $00
%patch $33893 "TWOBUTTON FIRING (ON)" $00
"TWOBUTTON FIRING (OFF)" $00
%patch $338C2 "FIX JERKY MOTION (ON)" $00
"FIX JERKY MOTION (OFF)" $00
%patch $338EF "SVGA COMPATIBILITY (ON)" $00
"SVGA COMPATIBILITY (OFF)" $00
%patch $33920 "USE GRAVIS GAMEPAD (ON)" $00
"USE GRAVIS GAMEPAD (OFF)" $00
%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</patch>

<patch title="Keen 5">
%patch $3412F "BEGIN EASY GAME" $00
"BEGIN NORMAL GAME" $00
"BEGIN HARD GAME" $00
%patch $341F2 "NEW GAME" $00
"LOAD GAME" $00
"SAVE GAME" $00
"CONFIGURE" $00
"END GAME" $00
"PADDLE WAR" $00
"QUIT" $00
%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 $34324 "SCORE BOX (ON)" $00
%patch $34333 "SCORE BOX (OFF)" $00
%patch $34343 "TWO-BUTTON FIRING (ON)" $00
%patch $34354 "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
%patch $343D0 "USE GRAVIS GAMEPAD (ON)" $00
%patch $343E8 "USE GRAVIS GAMEPAD (OFF)" $00
%patch $34401 "Score box now on" $00
"Score box now off" $00
"Press any key" $00

#Text 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
%patch $1C142 $4090W #Gravis on
%patch $1C147 $40A8W #Gravis off</patch>

<patch title="Keen 6">
%patch $34F90 "BEGIN EASY GAME" $00
"BEGIN NORMAL GAME" $00
"BEGIN HARD GAME" $00
%patch $35069 "NEW GAME" $00
"LOAD GAME" $00
"SAVE GAME" $00
"CONFIGURE" $00
"END GAME" $00
"PADDLE WAR" $00
"QUIT" $00
%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 $35604 "RETURN TO GAME" $00
"RETURN TO DEMO" $00
%patch $3564B "Quitting..." $00

#Options menu
%patch $351AE "SCORE BOX (ON)" $00
"SCORE BOX (OFF)" $00
%patch $351CD "TWO-BUTTON FIRING (ON)" $00
"TWO-BUTTON FIRING (OFF)" $00
%patch $351FC "FIX JERKY MOTION (ON)" $00
"FIX JERKY MOTION (OFF)" $00
%patch $35229 "SVGA COMPATIBILITY (ON)" $00
"SVGA COMPATIBILITY (OFF)" $00
%patch $3525A "USE GRAVIS GAMEPAD (ON)" $00
"USE GRAVIS GAMEPAD (OFF)" $00
%patch $3528B "Score box now on" $00
"Score box now off" $00
"Press any key" $00</patch>

== Colors ==

There are numerous functions that set watch text and background colours, allowing you to have different colours in different parts of the watch. Note that the font colour is dependent on the background color.

<patch title="Keen 4">

# draw_menu_item
%patch $1A9C6
$B0 8 # mov al, BGCOLOR ; NOTE THIS WORKS BECAUSE AX MUST BE 0 AT THIS OP
$50 # push ax
$B0 8 # mov al 8
$50 # push ax
$B0 $9F # mov al 9fh
$50 # push ax

%patch $1AA06 2 #menu font 1
%patch $1AA0D 10 #menu font 2
%patch $1AA33 15 #menu font 3

# draw_menu_footer
%patch $1AA40 10 #font 1
%patch $1AABF 0 #font 2
%patch $1AAC1 10W #hlin 1

# draw_current_menu
%patch $1AB14 10W #Hlin 1

# center_watch_window
%patch $1AC5B 8W #BAR 1
%patch $1AC75 10W #Hlin 1
%patch $1AC90 10W #Hlin 2
%patch $1ACAE 10W #Vlin 1
%patch $1ACC9 10W #Vlin 2

#green_message_box
%patch $1AE6C 2 #font 1
%patch $1AEA3 10W #hlin 1
%patch $1AEC8 10 #fontcolor 1

#configure_menu_proc
%patch $1B2F6 10 #font 1

#set_key_control
%patch $1B33B 2 # font 1
%patch $1B35E 8W # BAR 1
%patch $1B381 8W # BAR 2

#controls_menu_proc
%patch $1B50F 8W # BAR 1
%patch $1B543 2 # font1
%patch $1B547 10 # font1B
%patch $1B572 8W # BAR 2 (XOR)
%patch $1B595 8W # BAR 3

#print_joystick_prompt
%patch $1B64F 8W # Bar 1
%patch $1B670 2 # font1

#print_gamepad_prompt
%patch $1B987 8W # Bar 1

#gamepad_menu_proc
%patch $1BB9C 2 #font 1

#draw_savegame_item
%patch $1BC73 2 #font 1a
%patch $1BC77 10 #font 1b

%patch $1BC7E 8W #Hlin 1, 2, Vlin 1,2

#load_game_menu_proc
%patch $1BEA7 8W #bar 1

#save_savegame_item
%patch $1BFAF 2 #font 1
%patch $1BFB1 8W #Bar 1

#Paddle War left out

#do_main_menu
%patch $1CC69 15 #font 1

#init_menu
%patch $1CD8E 15 #font 1
</patch>

=== 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 who's music is used. (For example a value of 0 will play the map level's music.) See [[Patch:Music]].

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

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

Patch:Levels

2012-01-22T01:52:02Z

Lemm: keen 4 end game after n'th level

This page covers patches relating to levels. Related patches are [[Patch:Level exit]] and [[Patch:Gameplay]]. For patches involving the cities needing to be saved in [[Keen 2]] see [[Patch:Cities]].

== Editing levels ==

Keen Vorticons levels have a number of editors available, editing is a simple process and does not require patching. Keen Galaxy on the other hand requires patching of the 'maphead' file when levels are edited. (See [[TED5]].) Keen Dreams requires that the levels be decompressed by [[KDLevel]] before being edited by any Galaxy editor and recompressed before playing them.

== Extra 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 $A6 $AA, but level 2 is $A7 $AA 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)]]

<patch title="Keen 1">
#32 levels:
#Let Keen enter levels if these values are 0
%patch $7D3A $90 $90 $80 $BF $A6 $AA $00
%patch $7FCA $90 $90 $80 $BF $A5 $AA $00
#When starting a new game, make all 32 levels not done
%patch $9065 $90 $90 $C6 $87 $A6 $AA $00 $90
%patch $9070 $83 $7E $F8 $20
#Change things when marking a level as done
%patch $8013 $90 $90 $C6 $87 $A5 $AA [$01] $90
%patch $7E48 $83 $7E $FC $20</patch>

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

The number of levels in Keen 4-6 and Dreams are limited by a simple check on the map, it is currently possible to change the number of levels in Keen 4, however this is complicated by the fact that all levels must have valid names and level entry texts. It is possible to use level 14 in Keen 5 however, as it is available, but unused.

The check works as follows, if a sprite is between two values, a third value is subtracted from it and this is the level number. For Keen Galaxy this 'base value' is $C000. So If Keen tries to enter a sprite of value $C011 he can, it passes both value checks, and represents level $0011, or 17. Levels not falling between this value can be warped to or have demos recorded in them (And played back) if those two cheats allow it, but cannot be entered from the map. The high scores is one of these levels.

If the number of levels is increased then care must be taken, [[Patch:Levels#Level_text| each level must have a valid level entry text, AND music, or the game will freeze.]]

<patch title="Keen 4">
#How many levels
%patch $DF56 $C000W #Sprite value of map level
%patch $DF5D $C012W #Sprite value of highest playable level
%patch $DF71 $C000W #This must match first value (Value of any level is sprite value minus this)</patch>

== 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#Extra_levels| see above.)]] In Keen Galaxy these level(s) are known as 'bwb levels' as the only level this applies to by default is the BWB. The bwb patch uses [[Patch:Jump conditions|jump conditions]]. Use only one of the three possibilities given at a time, they are mutually exclusive.

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

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

<patch title="Keen 4">
#BwB level(s):
%patch $60FD [$xx] $77 #Any level above [$xx]
%patch $60FD [$xx] $7C #Any level below [$xx]
%patch $60FD [$xx] $74 #Just level [$xx] (If 0, NO BwB level)</patch>

== 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]]

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

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

Keen 4 has a 2-level demo trial parameter (/DEMO switch). By tweaking this code a little bit, it can be used to end the game after a certain level is beaten. If you want to make a "trial demo" of your own, you can patch this in as well.

<patch title="Keen 4">
# MAKE GAME END AFTER LEVEL X
# Always check to see if level X was beat, even if not in demo mode.
%patch $6B4E $90 $90 #nop out if-else jump
# Specify level that must be beaten to win game (default is 2)
%patch $6B54 2 #change level
%patch $6B57 $EB $99 #jump to end if we beat level x

# Enable "2 level demo" parameter by default
# Note: this is not necessary to make the game end after level X
%patch $3E90 $90 $90 #nop out an if else
</patch>

== Level text ==

Keen Galaxy and Dreams has individual names for its levels. These work in a complex manner. There are lists of level names, the location of which is controlled by lists of pointers, the location of which is referenced in the code. All patches that follow use the default values.

=== Pointer list locations ===

These are the start of the level names, where the list of level names are read from. They are in [[Patch:Text patches|standard text patch format]] with one twist, there are TWO word values giving the location in the code minus the text start location instead of one. In the Keen 4 example below the text starts at $2EE70 so the level name list is at $2EE70 + $18F4 = $30764

There are two values for each reference because the level name pointers are 32-bit (Four bytes), meaning that two values each of two bytes must be read then added together. The first value is by default unimportant since all of those values are zero. (A side effect of this is that all default level names must be multiples of 16 bytes long.) The two values in each reference don't have to be anywhere near each other, but unless they are two bytes different this makes things a lot more complex.

There shouldn't be any need to relocate the pointer lists unless you are planning on adding a lot of extra levels and the default locations don't have enough space. There are three references, one loads the level entry text when Keen enters levels. The remaining two loads the level name when Keen dies and when the status window is displayed.

<patch title="Keen 4">
#Where level entry text list is located:
%patch $6274 [$1958W]
%patch $6270 [$195AW]

#Where level name list is located:
%patch $6648 [$18F4W] #Didn't make it past 1
%patch $6644 [$18F6W] #Didn't make it past 2
%patch $7D2C [$18F4W] #Status window 1
%patch $7D28 [$18F6W] #Status window 2</patch>

=== Level Name Pointer Lists ===

The next step is the level name pointer list, a list of [[Patch:Executable segments|32-bit values giving the location of the level entry texts and names.]] By default the lower two bytes of these values is zero, meaning the location of each text entry can be found by reading the first five letters of the patch. Thus the Keen 4 map name value of $1F040000RL points to the text at $1F040. This leads to the side effect that all level names are multiples of 16 bytes long.

There is some space in the level lists for extra levels, in Keen 4 up to six new entries are allowed without having to change the list location. (Just add them to the end of the default list.) [[Patch:Levels#Extra_levels|This is important when adding extra levels as levels need text or the game will freeze.]]

<patch title="Keen 4">
#Level name pointers:
%patch $30764 $1F040000RL #Map
$1F050000RL #Level 1
$1F060000RL #Level 2
$1F070000RL #Level 3
$1F090000RL #Level 4...
$1F0B0000RL
$1F0C0000RL
$1F0D0000RL
$1F0E0000RL
$1F0F0000RL
$1F100000RL
$1F110000RL
$1F130000RL
$1F150000RL
$1F180000RL
$1F1A0000RL
$1F1B0000RL
$1F1C0000RL
$1F1D0000RL #Bwb Rocket

#Level entrance text pointers
%patch $307C8 $1F1F0000RL #Map
$1F210000RL #Level 1
$1F240000RL #Level 2
$1F260000RL #Level 3...
$1F290000RL
$1F2D0000RL
$1F300000RL
$1F330000RL
$1F350000RL
$1F380000RL
$1F3A0000RL
$1F3D0000RL
$1F400000RL
$1F430000RL
$1F470000RL
$1F4B0000RL
$1F4E0000RL
$1F510000RL
$1F540000RL #Bwb Rocket</patch>

=== Level names and entrance texts ===

These are almost standard [[Patch:Text patches|text patches]]. There is a program to automate patching level names, [[Startext]].

<patch title="Keen 4">
#Level names:
%patch $1F040 "Shadowlands " $00
%patch $1F050 "Border Village " $00
%patch $1F060 "Slug Village " $00
%patch $1F0B0 "Chasm of Chills" $00
%patch $1F0C0 "Crystalus " $00
%patch $1F0D0 "Hillville " $00
%patch $1F0E0 "Sand Yego " $00
%patch $1F0F0 "Miragia " $00
%patch $1F100 "Lifewater Oasis" $00
%patch $1F1A0 "Isle of Tar " $00
%patch $1F1B0 "Isle of Fire " $00
%patch $1F1C0 "Well of Wishes " $00
%patch $1F1D0 "Bean-with-Bacon" $0A
"Megarocket " $00
%patch $1F070 "The Perilous Pit " $00
%patch $1F090 "Cave of the Descendents " $00
%patch $1F110 "Pyramid of the Moons " $00
%patch $1F130 "Pyramid of Shadows " $00
%patch $1F150 "Pyramid of the" $0A
"Gnosticene Ancients " $00
%patch $1F180 "Pyramid of the Forbidden " $00

#Keen entering levels
%patch $1F1F0 "Keen enters the" $0A "Shadowlands " $00
%patch $1F240 "Keen slips into" $0A "Slug Village " $00
%patch $1F330 "Keen stubmles upon" $0A "Hillville " $00
%patch $1F380 "Keen disappears into" $0A "Miragia " $00
%patch $1F210 "Keen makes a run for" $0A "the Border Village " $00
%patch $1F260 "Keen plummets into" $0A "the The Perilous Pit " $00
%patch $1F2D0 "Keen shivers along" $0A "the Chasm of Chills " $00
%patch $1F300 "Keen reflects upon" $0A "entering Crystalus " $00
%patch $1F350 "Keen grits his teeth" $0A "and enters Sand Yego " $00
%patch $1F3A0 "Keen crawls into" $0A "Lifewater Oasis " $00
%patch $1F3D0 "Keen backs into the" $0A "Pyramid of the Moons " $00
%patch $1F400 "Keen move silently in" $0A "the Pyramid of Shadows " $00
%patch $1F4B0 "Keen mucks along the" $0A "Isle of Tar " $00
%patch $1F4E0 "Keen blazes across the" $0A "Isle of Fire " $00
%patch $1F510 "Keen hopefully enters" $0A "the Well of Wishes " $00
%patch $1F290 "Keen plods down into" $0A "the Cave of the Descendents " $00
%patch $1F430 "Keen reverently enters" $0A "the Pyramid of the" $0A "Gnosticene Ancients " $00
%patch $1F470 "Keen hesitantly crosses" $0A "into the Pyramid of the" $0A "Forbidden " $00
%patch $1F540 "Keen launches into the" $0A "Bean-with-Bacon" $0A "Megarocket " $00
</patch>

=== Misc level text ===

There are also level entry texts and some texts used in the 'try again' window. These are of course [[Patch:Text patches|text patches]].

<patch title="Keen 4">
#Try again window text
%patch $2F16F "You didn't make it past" $00
%patch $2F187 "Try Again" $00
%patch $2F191 "Exit to Shadowlands" $00
%patch $2F1F9 "One moment" $00 #Used while loading a level
%patch $2F47C "PAUSED" $00

#Try again texts read from:
%patch $66A7 $FF $02 #Didn't make it past
%patch $66DC $17 $03 #Try again
%patch $66F6 $21 $03 #Exit</patch>

<patch title="Keen 5">
#Try again window text
%patch $305E3 "You didn't make it past" $00
%patch $305FB "Try Again" $00
%patch $30605 "Exit to Armageddon" $00</patch>

<patch title="Keen 6">
#Try again texts read from:
%patch $30F73 "You didn't make it past" $00
%patch $30F8B "Try Again" $00
%patch $30F95 "Exit to Fribbulus Xax" $00</patch>

== Level markers ==

For patches relating to level markers see [[Patch:Done markers]], [[Patch:Done sign]] and [[Patch:Flags]]. The remaining patches deal with when the markers are used. (Note, the above patch for replayable levels affects where Keen Vorticons done signs appear.)

In Keen Vorticons there are two stages to the flag, the flipping stage, and the placement stage. Any tiles in the foreground layer that have the level's entrance sprite on them will also be changed (By default to tile 0)

<patch title="Keen 4">
#Never produce a flipping flag on level exit,
#but still have 'placed' flags
%patch $6145 $90 $90 $90 $90 $90

#No flags at all, ever
%patch $6137 $D0

#Flags appear in holders AND on all level entry sprites
%patch $6139 $90 $90

#Tile $D0xx marked map tiles are replaced with when
#level finished. (By default, 0, tile removed entirely)
%patch $6130 [$0000W]</patch>

== Misc ==

The last patch in this section uses [[Patch:Jump conditions|jump conditions]]. Use only one of the three possibilities given.

<patch title="Keen 4">
#Keen can exit the well of wishes by going offscreen (like normal levels, changes scrolling)
%patch $905B $90 $90

#Automatically restart a level when killed (No map option) IF:
%patch $6686 [$xx] $7D #Keen has [$xx] or less lives left
%patch $6686 [$xx] $7E #Keen has [$xx] or more lives left
%patch $6687 $90 $90 #Always</patch>

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

Patch:Keen (Keen 4)

2011-12-20T18:30:48Z

Lemm: formatting

This page contains patches relating to Keen as a sprite in [[Keen 4]]. That is, such things as the sprites used, the speeds and sounds. It does not cover patches relating to gameplay such as those that make levels scroll or change keys. Those can be found at [[Patch:Gameplay (Keen Galaxy)]]. It is divided into sections relating to the various sprite properties the patches involved. Being fluent with various sprite patch pages will help when working with these patches.

As little is known about Keen, there is less information here than for most sprites.

== Swimming Keen ==

These patches relate to Keen swimming, in the Well Of Wishes.

=== Speed ===

When swimming Keen has momentum, if you press the right arrow key, Keen will move right, and continue moving right for a short time before coming to a stop. The following patches control this momentum, that is, they are not the speeds Keen has when arrows are pressed.

By default these speeds counteract Keen's speed, the left speed slows his left speed to a standstill for example. If these are set to $0000W then Keen will keep moving in that direction unless another arrow key is pressed. (He will become 'frictionless') If they are set to one value Keen will feel a constant tug in that direction, as if a current were pulling him. (For example, setting all horizontal speeds to $0001W will make Keen drift right, even if no keys are pressed, and make it harder for him to swim left.) If the values are $0003W or above the 'current' is so strong Keen will not be able to move against it, effectively making him constantly move in one direction.

Increasing all values makes Keen swim faster overall.

There are three sections, the first controls horizontal movement, the second vertical, the third is unknown. Notably, gravity is ''always'' 'on' by default, constantly pulling Keen down. There are two values for each direction, the first when no arrow key is pressed (when Keen will slowly stop moving) and the second, larger when Keen is trying to turn around (when Keen will quickly stop moving and start moving in the opposite direction.) If the 'turning' values are set to $0000W then Keen will have to stop moving before he can start moving in the opposite direction.

<patch title="Swimming momentum speeds">
#Horizontal
%patch $F7C4 [$FFFDW] #Left (Change direction)
%patch $F7CF [$FFFFW] #Left
%patch $F7DA [$0001W] #Right
%patch $F7DF [$0003W] #Right (Change direction)

#Vertical
%patch $F819 [$FFFDW] #Up (Change direction)
%patch $F826 [$FFFFW] #Up
%patch $F833 [$0001W] #Down (This doubles as gravity)
%patch $F83A [$0003W] #Down (Change direction)

#Unknown
%patch $F92D [$0001W]
%patch $F93B [$FFFFW]</patch>

=== Bubbles\no bubbles produced ===

By default Keen regularly produces bubble sprites which then move offscreen. It is possible to alter what is produced, however if the sprites are not regularly disposed of then they will quickly build up and overload the sprite array. It is also possible to stop anything being produced at all. There are four values, each produces a bubble with a different animation.

<patch title="What swimming Keen produces">
#What is produced by swimming Keen
%patch $F6AB [$1A64W] #Bubble 1
%patch $F6BD [$1A82W] #Bubble 2
%patch $F6CF [$1AA0W] #Bubble 3
%patch $F6E1 [$1ABEW] #Bubble 4

#Stop bubbles being produced (Each line stops one of the above bubbles)
%patch $F6B2 $90 $90 $90 $90 $90
%patch $F6C4 $90 $90 $90 $90 $90
%patch $F6D6 $90 $90 $90 $90 $90
%patch $F6E8 $90 $90 $90 $90 $90</patch>

=== Bubble sound ===

This sound is produced every time swimming Keen produces a bubble (See above section) about once per second.

<patch title="Bubble sound">
#Sound
%patch $F6F1 [$24]

#Don't play sound
%patch $F6F4 $90 $90 $90 $90 $90</patch>

== Terrestrial Keen ==

=== Jumping Physics ===

The variables that control the height and duration of Keen's jumps are spread over several behaviours. There are two important parameters: initial velocity, and duration. The velocity is the initial speed of the jump or pogo, while the duration is the maximum time that this initial velocity can be sustained before Keen feels gravity.

Ramifications in simple terms:
More negative (faster) velocity and longer duration means that Keen jumps higher.

<patch title="Jumping Physics">
# Jump from standstill
%patch $BAF0 [$FFD8W] # V_i
%patch $BAFC [18W] # time

# Pogo from standstill
%patch $BB33 [$FFD0W] # V_i
%patch $BB3F [24W] # time

# Jump from walking
%patch $BF0A [$FFD8W] # V_i
%patch $BF18 [18W] # time

# Pogo from walking
%patch $BF51 [$FFD0W] # V_i
%patch $BF5D [24W] # time

# Pogo bounce
%patch $C4D3 [$FFD0W] # V_i
%patch $C4E4 [24W] # time

# Pogo air
%patch $C50E [9] # time thresh-hold, after which gravity changes
# end of pogo linear region

# Jump from a pole
%patch $C6AB [$FFECW] # V_i
%patch $C6B6 [10W] # time

# Pogo Bounce
%patch $D830 [$FFD0W] # V_i
%patch $D836 [24W] # time
</patch>

Details:
(If the jump or pogo button is released, then Keen will start to feel gravity even if the jump timer has not expired). The timer is measured in tics (70 Hz), so a timer of 70 means that Keen can jump upwards for 1 second before feeling gravity. The initial velocity is in map units per tic, which is 256ths of a tile per 70th of a second.

Example problems:
Q1. If Keen is given an initial velocity of -18 ($FFEEW) and a max timer of 70 tics (1 second), what is the tile-height at his jump apex?
A1. -18 (map units/tic) * 70 tics * 1 (tile/256 map units) = 4 tiles.

Q2. We have given Keen an initial velocity of 8, and we want his jump apex to be 5 tiles high. What will his maximum timer need to be set at?
A2. 8 (map units/tic) * 1 (tile / 256 map units) * X tics = 5 tiles --> rearrange to solve for X --> X = 160 tics.

Note that these problems only consider the linear region of Keen's jump (i.e., when the jump button is depressed and velocity is constant upwards in the y-axis). After this linear region, Keen will still travel upwards as gravity begins to pull him down (i.e., he has reached the parabolic region of his jump). This extra distance is dependent only on velocity at the end of the linear region (i.e., the initial velocity that you patched), and not on the jump timer. Once Keen has reached the parabolic region, he will accelerate downwards at 2 map units / tic^2 (or 1.5 on easy mode).

Q3. Reread Q1. In consideration of the extra height that Keen will acquire due to the parabolic region of his jump, what is his TRUE tile-height at his jump apex?
A3. At the end of the linear region, Keen had travelled 4 tiles and retained a velocity of -18 (map units / tic).
Use v^2 = u^2 + 2as to deduce maximum height, at which point v^2 = 0.
0 = u^2 + 2as --> --> s = -u^2/2a
s = [- 324 (mu^2/tic^2) ] / [ 4 (mu/tic^2) ] = -81 mu = ~ -0.3 tiles.

So the calculated height is 4.3 tiles. In actuality, Keen jumps a little over 5 tiles, because the acceleration is not uniform per tic (it is actually applied twice after every second tic) and it is distorted a little bit at the apex. In addition, at the end of the linear region of the pogo, gravity is greatly decreased, and the duration of this decreased gravity effect can be altered. Even after considering the parabolic region, jump height will likely be a little bit higher than calculated, so you'll have to fine tune it by testing.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Sprite|}}

Patch:Keen (Keen 4)

2011-12-20T18:26:48Z

Lemm: jumping physics

This page contains patches relating to Keen as a sprite in [[Keen 4]]. That is, such things as the sprites used, the speeds and sounds. It does not cover patches relating to gameplay such as those that make levels scroll or change keys. Those can be found at [[Patch:Gameplay (Keen Galaxy)]]. It is divided into sections relating to the various sprite properties the patches involved. Being fluent with various sprite patch pages will help when working with these patches.

As little is known about Keen, there is less information here than for most sprites.

== Swimming Keen ==

These patches relate to Keen swimming, in the Well Of Wishes.

=== Speed ===

When swimming Keen has momentum, if you press the right arrow key, Keen will move right, and continue moving right for a short time before coming to a stop. The following patches control this momentum, that is, they are not the speeds Keen has when arrows are pressed.

By default these speeds counteract Keen's speed, the left speed slows his left speed to a standstill for example. If these are set to $0000W then Keen will keep moving in that direction unless another arrow key is pressed. (He will become 'frictionless') If they are set to one value Keen will feel a constant tug in that direction, as if a current were pulling him. (For example, setting all horizontal speeds to $0001W will make Keen drift right, even if no keys are pressed, and make it harder for him to swim left.) If the values are $0003W or above the 'current' is so strong Keen will not be able to move against it, effectively making him constantly move in one direction.

Increasing all values makes Keen swim faster overall.

There are three sections, the first controls horizontal movement, the second vertical, the third is unknown. Notably, gravity is ''always'' 'on' by default, constantly pulling Keen down. There are two values for each direction, the first when no arrow key is pressed (when Keen will slowly stop moving) and the second, larger when Keen is trying to turn around (when Keen will quickly stop moving and start moving in the opposite direction.) If the 'turning' values are set to $0000W then Keen will have to stop moving before he can start moving in the opposite direction.

<patch title="Swimming momentum speeds">
#Horizontal
%patch $F7C4 [$FFFDW] #Left (Change direction)
%patch $F7CF [$FFFFW] #Left
%patch $F7DA [$0001W] #Right
%patch $F7DF [$0003W] #Right (Change direction)

#Vertical
%patch $F819 [$FFFDW] #Up (Change direction)
%patch $F826 [$FFFFW] #Up
%patch $F833 [$0001W] #Down (This doubles as gravity)
%patch $F83A [$0003W] #Down (Change direction)

#Unknown
%patch $F92D [$0001W]
%patch $F93B [$FFFFW]</patch>

=== Bubbles\no bubbles produced ===

By default Keen regularly produces bubble sprites which then move offscreen. It is possible to alter what is produced, however if the sprites are not regularly disposed of then they will quickly build up and overload the sprite array. It is also possible to stop anything being produced at all. There are four values, each produces a bubble with a different animation.

<patch title="What swimming Keen produces">
#What is produced by swimming Keen
%patch $F6AB [$1A64W] #Bubble 1
%patch $F6BD [$1A82W] #Bubble 2
%patch $F6CF [$1AA0W] #Bubble 3
%patch $F6E1 [$1ABEW] #Bubble 4

#Stop bubbles being produced (Each line stops one of the above bubbles)
%patch $F6B2 $90 $90 $90 $90 $90
%patch $F6C4 $90 $90 $90 $90 $90
%patch $F6D6 $90 $90 $90 $90 $90
%patch $F6E8 $90 $90 $90 $90 $90</patch>

=== Bubble sound ===

This sound is produced every time swimming Keen produces a bubble (See above section) about once per second.

<patch title="Bubble sound">
#Sound
%patch $F6F1 [$24]

#Don't play sound
%patch $F6F4 $90 $90 $90 $90 $90</patch>

== Terrestrial Keen ==

=== Jumping Physics ===

The variables that control the height and duration of Keen's jumps are spread over several behaviours. There are two important parameters: initial velocity, and duration. The velocity is the initial speed of the jump or pogo, while the duration is the maximum time that this initial velocity can be sustained before Keen feels gravity.

Ramifications in simple terms:
More negative (faster) velocity and longer duration means that Keen jumps higher.

<patch title="Jumping Physics">
# Jump from standstill
%patch $BAF0 $FFF8W # V_i
%patch $BAFC 160W # time

# Pogo from standstill
%patch $BB33 $FFD0W # V_i
%patch $BB3F 24W # time

# Jump from walking
%patch $BF0A $FFD8W # V_i
%patch $BF18 18W # time

# Pogo from walking
%patch $BF51 $FFD0W # V_i
%patch $BF5D 24W # time

# Pogo bounce
%patch $C4D3 $FFD0W # V_i
%patch $C4E4 24W # time

# Pogo air
%patch $C50E 9 # time thresh-hold, after which gravity changes
# end of pogo linear region

# Jump from a pole
%patch $C6AB $FFECW # V_i
%patch $C6B6 10W # time

# Pogo Bounce
%patch $D830 $FFD0W # V_i
%patch $D836 24W # time
</patch>

Details:
(If the jump or pogo button is released, then Keen will start to feel gravity even if the jump timer has not expired). The timer is measured in tics (70 Hz), so a timer of 70 means that Keen can jump upwards for 1 second before feeling gravity. The initial velocity is in map units per tic, which is 256ths of a tile per 70th of a second.

Example problems:
Q1. If Keen is given an initial velocity of -18 ($FFEEW) and a max timer of 70 tics (1 second), what is the tile-height at his jump apex?
A1. -18 (map units/tic) * 70 tics * 1 (tile/256 map units) = 4 tiles.

Q2. We have given Keen an initial velocity of 8, and we want his jump apex to be 5 tiles high. What will his maximum timer need to be set at?
A2. 8 (map units/tic) * 1 (tile / 256 map units) * X tics = 5 tiles --> rearrange to solve for X --> X = 160 tics.

Note that these problems only consider the linear region of Keen's jump (i.e., when the jump button is depressed and velocity is constant upwards in the y-axis). After this linear region, Keen will still travel upwards as gravity begins to pull him down (i.e., he has reached the parabolic region of his jump). This extra distance is dependent only on velocity at the end of the linear region (i.e., the initial velocity that you patched), and not on the jump timer. Once Keen has reached the parabolic region, he will accelerate downwards at 2 map units / tic^2 (or 1.5 on easy mode).

Q3. Reread Q1. In consideration of the extra height that Keen will acquire due to the parabolic region of his jump, what is his TRUE tile-height at his jump apex?
A3. At the end of the linear region, Keen had travelled 4 tiles and retained a velocity of -18 (map units / tic).
Use v^2 = u^2 + 2as to deduce maximum height, at which point v^2 = 0.
0 = u^2 + 2as --> --> s = -u^2/2a
s = [- 324 (mu^2/tic^2) ] / [ 4 (mu/tic^2) ] = -81 mu = ~ -0.3 tiles.

So the calculated height is 4.3 tiles. In actuality, Keen jumps a little over 5 tiles, because the acceleration is not uniform per tic (it is actually applied twice after every second tic) and it is distorted a little bit at the apex. In addition, at the end of the linear region of the pogo, gravity is greatly decreased, and the duration of this decreased gravity effect can be altered. Even after considering the parabolic region, jump height will likely be a little bit higher than calculated, so you'll have to fine tune it by testing.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy actions

2011-08-23T13:49:37Z

Lemm: linked the galaxy action parameters

This page is about sprite actions in Keen Galaxy and Dreams. Unlike in Vorticons, in Galaxy and Dreams there are two main components of a sprite, it's code, which behaves as in Vorticons, containing most of the decisions a sprite must make (What to do when faced with a wall, hit by a shot, etc) and actions, which define simpler things, such as animations to use, most speeds and pointers to more code.

Each action is 30 bytes long and consists of the following:

Int Description Values
Int 0: Left sprite Valid sprite chunks
Int 2: Right sprite Valid sprite chunks
Int 4: Type 0-4
Int 6: Deprotect Animation 0/1
Int 8: Stick to Ground 0/1
Int 10: Delay (Anim speed) 0-8000
Int 12: H anim move amount +- any value
Int 14: V anim move amount +- any value
Int 16: Behavior Start of behavior codes
Int 18: Behavior segment Segment values
Int 20: Check sprites Start of check sprite codes
Int 22: Check segment Segment values only
Int 24: Check tiles Start of check tile code
Int 26: Check segment Segment values
Int 30: Next action Valid actions

Actions can be treated like [[Patch:Text patches|text strings]], with pointers to them. They are located in the text segment of the executable, usually in chunks. More information can be gained from each value's page: [[Patch:Sprite animations]], [[Patch:Sprite behavior]], [[Patch:Sprite collision code]], [[Patch:Sprite tile check]], [[Patch:Galaxy Action Parameters]].

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy Action Parameters

2011-08-23T13:45:02Z

Lemm: Figured out the final parameter!

Galaxy action parameters are integral fields within [[Patch:Galaxy actions|Galaxy actions]] that control the movement of the objects (i.e., "sprites") or the action timing. The relevant subset of action fields is tabulated below. Note that the "Next action" field is a 2-byte (near) pointer to another action, but is included here anyway for completeness' sake. Remember that the game has (at optimum speed), 35 animation frames per second, corresponding to 70 game "tics" per second (thus, one frame completes in two tics). "Calling" a function means that the function code is executed in that animation frame.

Int Description Values
Int 4: Action Type 0-4
Int 6: Deprotect Animation 0/1
Int 8: Stick to Ground 0/1
Int 10: Delay (Anim speed) 0-0x7FFF
Int 12: H anim move amount +- any value
Int 14: V anim move amount +- any value
Int 30: Next action Valid actions

== Action Type ==

The action type defines how often the the [[Patch:Sprite behavior | behaviour]] function is called and how often the action movement amount offsets are applied. It takes five meaningful values (0-4) summarized below:

Movement Parm Behaviour Called... Action Movements Applied... Delay field is used?
0 Once Once Yes
1 Once Every frame Yes
2 Every frame Not applied No
3 Every frame Once Yes
4 Every frame Every frame Yes

The behaviour is called either once, right before the action changes to the next action, or on every animation frame. The action movements are applied to the object either once, when the action changes, or on every animation frame, scaled by the number of tics consumed by one animation frame (usually 2 tics/frame at optimum speed). The delay field is used, meaning it specifies the number of tics before the action is advanced to the next action, or it is unused, meaning the action repeats itself every frame.

In general, a behaviour that is called once would be used for spawning something (e.g., a slime puddle or projectile), while a behaviour called every frame would be used as a sensor. Movements applied once per action are used for jerky locomotion (pedal, or serpentine), whereas movements application every frame is used for smooth motion. Movement can also be defined in the behaviour, collision, and tile checking functions, in addition to the action movement parameters. Examples of where action parameters are found, and how they can be used are described below.

=== Type 0 ===
The bulk of sprites use type 0, meaning that the behavior is called AND the object is moved when action advances ( (i.e., when the sprite animates.) This is what makes poison slugs or arachnuts, for example, 'crawl' in jerks. If animation is often enough and speed slow enough, motion seems smooth.

=== Type 1 ===
Type 1 is similar to type 0, but movement is smoother. Here, the H/V movement offsets are applied every frame, depending on which way the berkeloid is facing. Berkeloids use this to make sure their 'floating' movement isn't jerky.

=== Type 2 ===
Type 2 actions ignore any movement and delay timers (animation speed). It is used notably for stunned falling sprites which keep falling all the time until they hit ground and move on. Airboards also use this. In other words, used for things that need to be instantly responsive. They won't animate and need movement defined in their behavior. Type 2 is best used for sensory behaviours. Type 2 actions are executed once, and only once, per animation frame.

=== Type 3 ===
Movement is jerky, happening every time the sprite animates. This is for things that need to be very responsive, but also animate. Dopefish and Mad Mushrooms use this because they must be able to react to walls and floors to avoid getting stuck. The behaviour function of these creatures defines the motion, which is why they do not move in jerks.

=== Type 4 ===
Type 4 is a rarely used case, sometimes used for things that are going to need to land on or leave the ground somehow. The flying bluebird does this for example, and it is about the only Keen 4 example.

== Deprotect Animation ==
The rarely-used, boolean "Deprotect Animation" parameter forces the action to run for the proper number of tics, even if this means skipping over an animation. If this flag is not set, the sprites for actions will be drawn for at least one animation frame, no matter how short the delay is (even a delay of 0 or 1 tics). If the flag is set, then these fleeting actions will still have their sprite behaviour function and movement parameters processed (but not the sprite collision nor tile-checking functions), but the animation MIGHT not be drawn (see the detailed explanation). This flag is most useful if you want to apply the action movement parameters or a behaviour instantaneously (using 0 for the delay), and you don't want the intermediate sprite to be seen, or you don't want a hiccup in the animation.

For example, you might want object A to call a single behaviour six times in a row by writing six sequential type 0 actions of delay 0. This behaviour might spawn object B at object A's location. If the animation is protected (flag = 0), then this will take a minimum of six animation frames, and object A will be drawn every frame. If the animation is deprotected (flag = 1), then all sprites will spawn on the same animation frame. In addition, the movement parameters can be tweaked so that object A is located at a different position for each object B spawn, and returns to its initial position after the sixth spawn. If animation is protected, then object A will skip around the screen, whereas if it is protected, its intermediate positions will not be drawn.

This parameter has no meaning for type 2 actions.

Detailed explanation: For any animation frame, when an action expires because it reaches its delay, the game runs the old action for a fraction of the frame length, and the new action for the remainder of the frame. As an example, assume that action 1 has 3 more tics to go, and the animation frame took 5 tics to complete. Then action 3 would be run for 3 tics and action 2 would be run for 2 tics. In the event that the second action is so short that there are still tics to be processed, the "Deprotect Animation" flag comes into use. If reset (zero), then the action is run for delay - 1 tics and no more actions are processed for that frame. If the "Deprotect Animation" flag is set (1), then the action is run for the specified number of tics and the 3rd action in the chain is processed for the remaining number of tics. Since the 3rd action is the last to be processed, its frame will be displayed, and the sprite frame for action 2 is never seen.

== Stick to Ground ==
The boolean "Stick to Ground" (formerly, "Change V") parameter affects the vertical movement of the object. If Stick to Ground is 1, then the sprite will move DOWNWARDS by however far it moved left or right, for each animation frame. Some objects will malfunction if they leave the ground (e.g., inchworms and arachnuts). Because slopes are always less than 45 degrees, objects will always be forced into the ground if they are moving downhill. If an object is to walk along the ground, this flag should be set to 1. If the object is airborne, the flag must be set to 0.

== Delay and Next Action ==
The "Delay" field specifies how many tics will pass before the action pointed to by the "Next action" pointer is selected. If an action has a delay of 70, that action will remain valid for one second until the next action is selected. Both fields serve no purpose for action type 2. For movement types 0, 1, and 3, the delay also regulates how often the behaviour function or the movement parameters are applied (see table above). If the next action is zero, then the sprite freezes.

== H/V Movement Amount ==
The movement offsets allow for action-defined motion. Movement offsets (here, and in general) are always in 16ths of a pixel, or 256ths of a tile. Objects have an X-Motion (-1 = left, 0 = none, 1 = right), and a Y-motion parameter (-1 = up, 0 = none, 1 = down) that is defined by the sprite behaviour, collision, and tile-checking functions. For action types 0 and 3, the H and V values are applied when the action delay timer expires. For example, an action of parameter type 0, H-offset of 128, and delay of 35 will move right or left by a half tile every half second. For action types 1 and 4, the H and V values are applied every animation frame, and scaled by the number of tics consumed during that frame (approximately 2 tics/frame on DOSBox), meaning that the action delay is irrelevant for motion and that the motion is smooth. An object with action type 1 or 4 and a V-offset of 4 will move 1/4 (four 16ths) of a pixel every game tic, which is equal to 1/2 a pixel every game frame and about 17 pixels a second.

Movement can also be defined in the behaviour, collision, or tile-check functions. The offset applied in these functions is added to that defined by the action, and the net movement is applied to the object. Remember that, if the Stick-to-Ground flag is set, the vertical movement defined by either the action or a function is ignored.

== Behaviour, Collision, and Tile Checking Functions ==

These are double-word pointers to the start of a function described in detail elsewhere. Note that the behaviour function is called every frame for action types 1,2, and 4, but it is called right when the action switches to the next action for types 0 and 3. The collision function is called every frame whenever an object is in contact with another object, and the tile-collion (draw function) is called every frame when the object is on screen.

== Other Games ==
Although not part of the "Id Engine" proper, the physics and action code is shared by many games that use the Keen:Galaxy engine. BioMenace, Dangerous Dave 3 and 4, and Rescue Rover 2 all use actions. Shadow Nights, Dave 2, and Rescue Rover 1 might use actions.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy Action Parameters

2011-08-23T10:11:24Z

Lemm: Undo revision 19174 by Lemm (talk)

Galaxy action parameters are integral fields within [[Patch:Galaxy actions|Galaxy actions]] that control the movement of the objects (i.e., "sprites") or the action timing. The relevant subset of action fields is tabulated below. Note that the "Next action" field is a 2-byte (near) pointer to another action, but is included here anyway for completeness' sake. Remember that the game has (at optimum speed), 35 animation frames per second, corresponding to 70 game "tics" per second (thus, one frame completes in two tics). "Calling" a function means that the function code is executed in that animation frame.

Int Description Values
Int 4: Movement parameter 0-4
Int 6: Change h 0/1
Int 8: Stick to Ground 0/1
Int 10: Delay (Anim speed) 0-0x7FFF
Int 12: H anim move amount +- any value
Int 14: V anim move amount +- any value
Int 30: Next action Valid actions

== Movement Parameter ==

The movement parameter defines how often the the [[Patch:Sprite behavior | behaviour]] function is called and how often the action movement amount offsets are applied. It takes five meaningful values (0-4) summarized below:

Movement Parm Behaviour Called... Action Movements Applied... Delay field is used?
0 Once Once Yes
1 Once Every frame Yes
2 Every frame Not applied No
3 Every frame Once Yes
4 Every frame Every frame Yes

The behaviour is called either once, right before the action changes to the next action, or on every animation frame. The action movements are applied to the object either once, when the action changes, or on every animation frame, scaled by the number of tics consumed by one animation frame (usually 2 tics/frame at optimum speed). The delay field is used, meaning it specifies the number of tics before the action is advanced to the next action, or it is unused, meaning the action repeats itself every frame.

In general, a behaviour that is called once would be used for spawning something (e.g., a slime puddle or projectile), while a behaviour called every frame would be used as a sensor. Movements applied once per action are used for jerky locomotion (pedal, or serpentine), whereas movements application every frame is used for smooth motion. Movement can also be defined in the behaviour, collision, and tile checking functions, in addition to the action movement parameters. Examples of where action parameters are found, and how they can be used are described below.

=== Type 0 ===
The bulk of sprites use type 0, meaning that the behavior is called AND the object is moved when action advances ( (i.e., when the sprite animates.) This is what makes poison slugs or arachnuts, for example, 'crawl' in jerks. If animation is often enough and speed slow enough, motion seems smooth.

=== Type 1 ===
Type 1 is similar to type 0, but movement is smoother. Here, the H/V movement offsets are applied every frame, depending on which way the berkeloid is facing. Berkeloids use this to make sure their 'floating' movement isn't jerky.

=== Type 2 ===
Type 2 actions ignore any movement and delay timers (animation speed). It is used notably for stunned falling sprites which keep falling all the time until they hit ground and move on. Airboards also use this. In other words, used for things that need to be instantly responsive. They won't animate and need movement defined in their behavior. Type 2 is best used for sensory behaviours.

=== Type 3 ===
Movement is jerky, happening every time the sprite animates. This is for things that need to be very responsive, but also animate. Dopefish and Mad Mushrooms use this because they must be able to react to walls and floors to avoid getting stuck. The behaviour function of these creatures defines the motion, which is why they do not move in jerks.

=== Type 4 ===
Type 4 is a rarely used case, sometimes used for things that are going to need to land on or leave the ground somehow. The flying bluebird does this for example, and it is about the only Keen 4 example.

== Change h ==
The boolean "Change h" parameter affects the action timing in some manner. It seems to be a flag telling an action to alter its timing if it is referenced as the "next action" of the previous action.

== Stick to Ground ==
The boolean "Stick to Ground" (formerly, "Change V") parameter affects the vertical movement of the object. If Stick to Ground is 1, then the sprite will move DOWNWARDS by however far it moved left or right, for each animation frame. Some objects will malfunction if they leave the ground (e.g., inchworms and arachnuts). Because slopes are always less than 45 degrees, objects will always be forced into the ground if they are moving downhill. If an object is to walk along the ground, this flag should be set to 1. If the object is airborne, the flag must be set to 0.

== Delay and Next Action ==
The "Delay" field specifies how many tics will pass before the action pointed to by the "Next action" pointer is selected. If an action has a delay of 70, that action will remain valid for one second until the next action is selected. Both fields serve no purpose for movement parameter type 2. For movement types 0, 1, and 3, the delay also regulates how often the behaviour function or the movement parameters are applied (see table above). If the next action is zero, then the sprite freezes.

== H/V Movement Amount ==
The movement offsets allow for action-defined motion. Movement offsets (here, and in general) are always in 16ths of a pixel, or 256ths of a tile. Objects have an X-Motion (-1 = left, 0 = none, 1 = right), and a Y-motion parameter (-1 = up, 0 = none, 1 = down) that is defined by the sprite behaviour, collision, and tile-checking functions. For movement parameter types 0 and 3, the H and V values are applied when the action delay timer expires. For example, an action of parameter type 0, H-offset of 128, and delay of 35 will move right or left by a half tile every half second. For movement parameter types 1 and 4, the H and V values are applied every animation frame, and scaled by the number of tics consumed during that frame (approximately 2 tics/frame on DOSBox), meaning that the action delay is irrelevant for motion and that the motion is smooth. An object with movement parameter 1 or 4 and a V-offset of 4 will move 1/4 (four 16ths) of a pixel every game tic, which is equal to 1/2 a pixel every game frame and about 17 pixels a second.

Movement can also be defined in the behaviour, collision, or tile-check functions. The offset applied in these functions is added to that defined by the action, and the net movement is applied to the object. Remember that, if the Stick-to-Ground flag is set, the vertical movement defined by either the action or a function is ignored.

== Behaviour, Collision, and Tile Checking Functions ==

These are double-word pointers to the start of a function described in detail elsewhere. Note that the behaviour function is called every frame for movement parameter types 1,2, and 4, but it is called right when the action switches to the next action for types 0 and 3. The collision function is called every frame whenever an object is in contact with another object, and the tile-collion (draw function) is called every frame when the object is on screen.

== Other Games ==
Although not part of the "Id Engine" proper, the physics and action code is shared by many games that use the Keen:Galaxy engine. BioMenace, Dangerous Dave 3 and 4, and Rescue Rover 2 all use actions. Shadow Nights, Dave 2, and Rescue Rover 1 might use actions.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy Action Parameters

2011-08-23T10:00:08Z

Lemm: actions

Galaxy action parameters are integral fields within [[Patch:Galaxy actions|Galaxy actions]] that control the movement of the objects (i.e., "sprites") or the action timing. The relevant subset of action fields is tabulated below. Note that the "Next action" field is a 2-byte (near) pointer to another action, but is included here anyway for completeness' sake. Remember that the game has (at optimum speed), 35 animation frames per second, corresponding to 70 game "tics" per second (thus, one frame completes in two tics). "Calling" a function means that the function code is executed in that animation frame.

Int Description Values
Int 4: Movement parameter 0-4
Int 6: Change h 0/1
Int 8: Stick to Ground 0/1
Int 10: Delay (Anim speed) 0-0x7FFF
Int 12: H anim move amount +- any value
Int 14: V anim move amount +- any value
Int 30: Next action Valid actions

== Movement Parameter ==

The movement parameter defines how often the the [[Patch:Sprite behavior | behaviour]] function is called and how often the action movement amount offsets are applied. It takes five meaningful values (0-4) summarized below:

Movement Parm Behaviour Called... Action Movements Applied... Delay field is used?
0 Once Once Yes
1 Once Every frame Yes
2 Every frame Not applied No
3 Every frame Once Yes
4 Every frame Every frame Yes

The behaviour is called either once, right before the action changes to the next action, or on every animation frame. The action movements are applied to the object either once, when the action changes, or on every animation frame, scaled by the number of tics consumed by one animation frame (usually 2 tics/frame at optimum speed). The delay field is used, meaning it specifies the number of tics before the action is advanced to the next action, or it is unused, meaning the action repeats itself every frame.

In general, a behaviour that is called once would be used for spawning something (e.g., a slime puddle or projectile), while a behaviour called every frame would be used as a sensor. Movements applied once per action are used for jerky locomotion (pedal, or serpentine), whereas movements application every frame is used for smooth motion. Movement can also be defined in the behaviour, collision, and tile checking functions, in addition to the action movement parameters. Examples of where action parameters are found, and how they can be used are described below.

=== Type 0 ===
The bulk of sprites use type 0, meaning that the behavior is called AND the object is moved when action advances ( (i.e., when the sprite animates.) This is what makes poison slugs or arachnuts, for example, 'crawl' in jerks. If animation is often enough and speed slow enough, motion seems smooth.

=== Type 1 ===
Type 1 is similar to type 0, but movement is smoother. Here, the H/V movement offsets are applied every frame, depending on which way the berkeloid is facing. Berkeloids use this to make sure their 'floating' movement isn't jerky.

=== Type 2 ===
Type 2 actions ignore any movement and delay timers (animation speed). It is used notably for stunned falling sprites which keep falling all the time until they hit ground and move on. Airboards also use this. In other words, used for things that need to be instantly responsive. They won't animate and need movement defined in their behavior. Type 2 is best used for sensory behaviours.

=== Type 3 ===
Movement is jerky, happening every time the sprite animates. This is for things that need to be very responsive, but also animate. Dopefish and Mad Mushrooms use this because they must be able to react to walls and floors to avoid getting stuck. The behaviour function of these creatures defines the motion, which is why they do not move in jerks.

=== Type 4 ===
Type 4 is a rarely used case, sometimes used for things that are going to need to land on or leave the ground somehow. The flying bluebird does this for example, and it is about the only Keen 4 example.

== Change h ==
The boolean "Change h" parameter affects the action timing in some manner. It seems to be a flag telling an action to alter its timing if it is referenced as the "next action" of the previous action.

== Stick to Ground ==
The boolean "Stick to Ground" (formerly, "Change V") parameter affects the vertical movement of the object. If Stick to Ground is 1, then the sprite will move DOWNWARDS by however far it moved left or right, for each animation frame. Some objects will malfunction if they leave the ground (e.g., inchworms and arachnuts). Because slopes are always less than 45 degrees, objects will always be forced into the ground if they are moving downhill. If an object is to walk along the ground, this flag should be set to 1. If the object is airborne, the flag must be set to 0.

== Delay and Next Action ==
The "Delay" field specifies how many tics will pass before the action pointed to by the "Next action" pointer is selected. If an action has a delay of 70, that action will remain valid for one second until the next action is selected. Both fields serve no purpose for movement parameter type 2. For movement types 0, 1, and 3, the delay also regulates how often the behaviour function or the movement parameters are applied (see table above). If the next action is zero, then the sprite freezes.

== H/V Movement Amount ==
The movement offsets allow for action-defined motion. Movement offsets (here, and in general) are always in 16ths of a pixel, or 256ths of a tile. Objects have an X-Motion (-1 = left, 0 = none, 1 = right), and a Y-motion parameter (-1 = up, 0 = none, 1 = down) that is defined by the sprite behaviour, collision, and tile-checking functions. For movement parameter types 0 and 3, the H and V values are applied when the action delay timer expires. For example, an action of parameter type 0, H-offset of 128, and delay of 35 will move right or left by a half tile every half second. For movement parameter types 1 and 4, the H and V values are applied every animation frame, and scaled by the number of tics consumed during that frame (approximately 2 tics/frame on DOSBox), meaning that the action delay is irrelevant for motion and that the motion is smooth. An object with movement parameter 1 or 4 and a V-offset of 4 will move 1/4 (four 16ths) of a pixel every game tic, which is equal to 1/2 a pixel every game frame and about 17 pixels a second.

Movement can also be defined in the behaviour, collision, or tile-check functions. The offset applied in these functions is added to that defined by the action, and the net movement is applied to the object. Remember that, if the Stick-to-Ground flag is set, the vertical movement defined by either the action or a function is ignored.

== Behaviour, Collision, and Tile Checking Functions ==

These are double-word pointers to the start of a function described in detail elsewhere. Note that the behaviour function is called every frame for movement parameter types 1,2, and 4, but it is called once, at the start of the action, for types 0 and 3. The collision function is called every frame whenever an object is in contact with another object, and the tile-collion (draw function) is called every frame when the object is on screen.

== Other Games ==
Although not part of the "Id Engine" proper, the physics and action code is shared by many games that use the Keen:Galaxy engine. BioMenace, Dangerous Dave 3 and 4, and Rescue Rover 2 all use actions. Shadow Nights, Dave 2, and Rescue Rover 1 might use actions.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy Action Parameters

2011-08-23T08:59:07Z

Lemm: H/V movement amounts

Galaxy action parameters are integral fields within [[Patch:Galaxy actions|Galaxy actions]] that control the movement of the objects (i.e., "sprites") or the action timing. The relevant subset of action fields is tabulated below. Note that the "Next action" field is a 2-byte (near) pointer to another action, but is included here anyway for completeness' sake. Remember that the game has (at optimum speed), 35 animation frames per second, corresponding to 70 game "tics" per second (thus, one frame completes in two tics). "Calling" a function means that the function code is executed in that animation frame.

Int Description Values
Int 4: Movement parameter 0-4
Int 6: Change h 0/1
Int 8: Stick to Ground 0/1
Int 10: Delay (Anim speed) 0-0x7FFF
Int 12: H anim move amount +- any value
Int 14: V anim move amount +- any value
Int 30: Next action Valid actions

== Movement Parameter ==

The movement parameter defines how often the the [[Patch:Sprite behavior | behaviour]] function is called and how often the action movement amount offsets are applied. It takes five meaningful values (0-4) summarized below:

Movement Parm Behaviour Called... Action Movements Applied... Delay field is used?
0 Once Once Yes
1 Once Every frame Yes
2 Every frame Not applied No
3 Every frame Once Yes
4 Every frame Every frame Yes

The behaviour is called either once, right before the action changes to the next action, or on every animation frame. The action movements are applied to the object either once, when the action changes, or on every animation frame, scaled by the number of tics consumed by one animation frame (usually 2 tics/frame at optimum speed). The delay field is used, meaning it specifies the number of tics before the action is advanced to the next action, or it is unused, meaning the action repeats itself every frame.

In general, a behaviour that is called once would be used for spawning something (e.g., a slime puddle or projectile), while a behaviour called every frame would be used as a sensor. Movements applied once per action are used for jerky locomotion (pedal, or serpentine), whereas movements application every frame is used for smooth motion. Movement can also be defined in the behaviour, collision, and tile checking functions, in addition to the action movement parameters. Examples of where action parameters are found, and how they can be used are described below.

=== Type 0 ===
The bulk of sprites use type 0, meaning that the behavior is called AND the object is moved when action advances ( (i.e., when the sprite animates.) This is what makes poison slugs or arachnuts, for example, 'crawl' in jerks. If animation is often enough and speed slow enough, motion seems smooth.

=== Type 1 ===
Type 1 is similar to type 0, but movement is smoother. Here, the H/V movement offsets are applied every frame, depending on which way the berkeloid is facing. Berkeloids use this to make sure their 'floating' movement isn't jerky.

=== Type 2 ===
Type 2 actions ignore any movement and delay timers (animation speed). It is used notably for stunned falling sprites which keep falling all the time until they hit ground and move on. Airboards also use this. In other words, used for things that need to be instantly responsive. They won't animate and need movement defined in their behavior. Type 2 is best used for sensory behaviours.

=== Type 3 ===
Movement is jerky, happening every time the sprite animates. This is for things that need to be very responsive, but also animate. Dopefish and Mad Mushrooms use this because they must be able to react to walls and floors to avoid getting stuck. The behaviour function of these creatures defines the motion, which is why they do not move in jerks.

=== Type 4 ===
Type 4 is a rarely used case, sometimes used for things that are going to need to land on or leave the ground somehow. The flying bluebird does this for example, and it is about the only Keen 4 example.

== Change h ==
The boolean "Change h" parameter affects the action timing in some manner. It seems to be a flag telling an action to alter its timing if it is referenced as the "next action" of the previous action.

== Stick to Ground ==
The boolean "Stick to Ground" (formerly, "Change V") parameter affects the vertical movement of the object. If Stick to Ground is 1, then the sprite will move DOWNWARDS by however far it moved left or right, for each animation frame. Some objects will malfunction if they leave the ground (e.g., inchworms and arachnuts). Because slopes are always less than 45 degrees, objects will always be forced into the ground if they are moving downhill. If an object is to walk along the ground, this flag should be set to 1. If the object is airborne, the flag must be set to 0.

== Delay and Next Action ==
The "Delay" field specifies how many tics will pass before the action pointed to by the "Next action" pointer is selected. If an action has a delay of 70, that action will remain valid for one second until the next action is selected. Both fields serve no purpose for movement parameter type 2. For movement types 0, 1, and 3, the delay also regulates how often the behaviour function or the movement parameters are applied (see table above). If the next action is zero, then the sprite freezes.

== H/V Movement Amount ==
The movement offsets allow for action-defined motion. Movement offsets (here, and in general) are always in 16ths of a pixel, or 256ths of a tile. Objects have an X-Motion (-1 = left, 0 = none, 1 = right), and a Y-motion parameter (-1 = up, 0 = none, 1 = down) that is defined by the sprite behaviour, collision, and tile-checking functions. For movement parameter types 0 and 3, the H and V values are applied when the action delay timer expires. For example, an action of parameter type 0, H-offset of 128, and delay of 35 will move right or left by a half tile every half second. For movement parameter types 1 and 4, the H and V values are applied every animation frame, and scaled by the number of tics consumed during that frame (approximately 2 tics/frame on DOSBox), meaning that the action delay is irrelevant for motion and that the motion is smooth. An object with movement parameter 1 or 4 and a V-offset of 4 will move 1/4 (four 16ths) of a pixel every game tic, which is equal to 1/2 a pixel every game frame and about 17 pixels a second.

Movement can also be defined in the behaviour, collision, or tile-check functions. The offset applied in these functions is added to that defined by the action, and the net movement is applied to the object. Remember that, if the Stick-to-Ground flag is set, the vertical movement defined by either the action or a function is ignored.

== Behaviour, Collision, and Tile Checking Functions ==

These are double-word pointers to the start of a function described in detail elsewhere. Note that the behaviour function is called every frame for movement parameter types 1,2, and 4, but it is called right when the action switches to the next action for types 0 and 3. The collision function is called every frame whenever an object is in contact with another object, and the tile-collion (draw function) is called every frame when the object is on screen.

== Other Games ==
Although not part of the "Id Engine" proper, the physics and action code is shared by many games that use the Keen:Galaxy engine. BioMenace, Dangerous Dave 3 and 4, and Rescue Rover 2 all use actions. Shadow Nights, Dave 2, and Rescue Rover 1 might use actions.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy Action Parameters

2011-08-23T08:54:41Z

Lemm: more stuff added

Galaxy action parameters are integral fields within [[Patch:Galaxy actions|Galaxy actions]] that control the movement of the objects (i.e., "sprites") or the action timing. The relevant subset of action fields is tabulated below. Note that the "Next action" field is a 2-byte (near) pointer to another action, but is included here anyway for completeness' sake. Remember that the game has (at optimum speed), 35 animation frames per second, corresponding to 70 game "tics" per second (thus, one frame completes in two tics). "Calling" a function means that the function code is executed in that animation frame.

Int Description Values
Int 4: Movement parameter 0-4
Int 6: Change h 0/1
Int 8: Stick to Ground 0/1
Int 10: Delay (Anim speed) 0-0x7FFF
Int 12: H anim move amount +- any value
Int 14: V anim move amount +- any value
Int 30: Next action Valid actions

== Movement Parameter ==

The movement parameter defines how often the the [[Patch:Sprite behavior | behaviour]] function is called and how often the action movement amount offsets are applied. It takes five meaningful values (0-4) summarized below:

Movement Parm Behaviour Called... Action Movements Applied... Delay field is used?
0 Once Once Yes
1 Once Every frame Yes
2 Every frame Not applied No
3 Every frame Once Yes
4 Every frame Every frame Yes

The behaviour is called either once, right before the action changes to the next action, or on every animation frame. The action movements are applied to the object either once, when the action changes, or on every animation frame, scaled by the number of tics consumed by one animation frame (usually 2 tics/frame at optimum speed). The delay field is used, meaning it specifies the number of tics before the action is advanced to the next action, or it is unused, meaning the action repeats itself every frame.

In general, a behaviour that is called once would be used for spawning something (e.g., a slime puddle or projectile), while a behaviour called every frame would be used as a sensor. Movements applied once per action are used for jerky locomotion (pedal, or serpentine), whereas movements application every frame is used for smooth motion. Movement can also be defined in the behaviour, collision, and tile checking functions, in addition to the action movement parameters. Examples of where action parameters are found, and how they can be used are described below.

=== Type 0 ===
The bulk of sprites use type 0, meaning that the behavior is called AND the object is moved when action advances ( (i.e., when the sprite animates.) This is what makes poison slugs or arachnuts, for example, 'crawl' in jerks. If animation is often enough and speed slow enough, motion seems smooth.

=== Type 1 ===
Type 1 is similar to type 0, but movement is smoother. Here, the H/V movement offsets are applied every frame, depending on which way the berkeloid is facing. Berkeloids use this to make sure their 'floating' movement isn't jerky.

=== Type 2 ===
Type 2 actions ignore any movement and delay timers (animation speed). It is used notably for stunned falling sprites which keep falling all the time until they hit ground and move on. Airboards also use this. In other words, used for things that need to be instantly responsive. They won't animate and need movement defined in their behavior. Type 2 is best used for sensory behaviours.

=== Type 3 ===
Movement is jerky, happening every time the sprite animates. This is for things that need to be very responsive, but also animate. Dopefish and Mad Mushrooms use this because they must be able to react to walls and floors to avoid getting stuck. The behaviour function of these creatures defines the motion, which is why they do not move in jerks.

=== Type 4 ===
Type 4 is a rarely used case, sometimes used for things that are going to need to land on or leave the ground somehow. The flying bluebird does this for example, and it is about the only Keen 4 example.

== Change h ==
The boolean "Change h" parameter affects the action timing in some manner. It seems to be a flag telling an action to alter its timing if it is referenced as the "next action" of the previous action.

== Stick to Ground ==
The boolean "Stick to Ground" (formerly, "Change V") parameter affects the vertical movement of the object. If Stick to Ground is 1, then the sprite will move DOWNWARDS by however far it moved left or right, for each animation frame. Some objects will malfunction if they leave the ground (e.g., inchworms and arachnuts). Because slopes are always less than 45 degrees, objects will always be forced into the ground if they are moving downhill. If an object is to walk along the ground, this flag should be set to 1. If the object is airborne, the flag must be set to 0.

== Delay and Next Action ==
The "Delay" field specifies how many tics will pass before the action pointed to by the "Next action" pointer is selected. If an action has a delay of 70, that action will remain valid for one second until the next action is selected. Both fields serve no purpose for movement parameter type 2. For movement types 0, 1, and 3, the delay also regulates how often the behaviour function or the movement parameters are applied (see table above). If the next action is zero, then the sprite freezes.

== H/V Movement Amount ==
The movement offsets allow for action-defined motion. Movement offsets (here, and in general) are always in 16ths of a pixel, or 256ths of a tile. Objects have an X-Motion (-1 = left, 0 = none, 1 = right), and a Y-motion parameter (-1 = up, 0 = none, 1 = down) that is defined by the sprite behaviour, collision, and tile-checking functions. For movement parameter types 0 and 3, the H and V values are applied when the action delay timer expires. For example, an action of parameter type 0, H-offset of 128, and delay of 35 will move right or left by a half tile every half second. For movement parameter types 1 and 4, the H and V values are applied every animation frame, and scaled by the number of tics consumed during that frame (approximately 2 tics/frame on DOSBox), meaning that the action delay is irrelevant for motion and that the motion is smooth. An object with movement parameter 1 or 4 and a V-offset of 4 will move 1/4 (four 16ths) of a pixel every game tic, which is equal to 1/2 a pixel every game frame and about 17 pixels a second.

== Behaviour, Collision, and Tile Checking Functions ==

These are double-word pointers to the start of a function. They are described in detail elsewhere. Note that the behaviour function is called every frame for movement parameter types 1,2, and 4, but it is called right when the action switches to the next action for types 0 and 3. The collision function is called every frame whenever an object is in contact with another object, and the tile-collion (draw function) is called every frame when the object is on screen.

== Other Games ==
Although not part of the "Id Engine" proper, the physics and action code is shared by many games that use the Keen:Galaxy engine. BioMenace, Dangerous Dave 3 and 4, and Rescue Rover 2 all use actions. Shadow Nights, Dave 2, and Rescue Rover 1 might use actions.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch:Galaxy Action Parameters

2011-08-22T22:00:39Z

Lemm: Action parameter descriptions added (this will tie all the small stuff together)

Patch:Sprite-tile interaction

2011-08-22T20:16:25Z

Lemm: tile checking functions also do drawing in galaxy

The tile-checking (and/or drawing) function is a 32-bit (far) pointer to code that instructs the sprite based on its collisions with tiles (top, left, bottom, or right blocking). The tile checking function is also responsible for directing the game to draw the sprite. Unlike the sprite behaviour functions, which might be called sporadically, the tile checking function is always called, every animation frame.

Patches that affect the tile checking code itself are few and at [[Patch:Tile checking code]]. Related pages are [[Patch:Sprite behavior]] and [[Patch:Sprite collision]]. Patching tile check is simple enough, a four-byte pointer for every [[Patch:Galaxy actions|sprite action]] that you wish to change. Interestingly, sprite tile checks and drawing are rather simpler and different in Keen Vorticons, integrated with the main sprite code, and as such there are no patches for Vorticons on this page. Patches do however tend to be more difficult and only really useful when copying a value to increase the number of actions a sprite has.

= Values in games =

Keen 4:
$00000000L #Nothing
$04EC0FA8RL #Display 'Not enough memory to save game' window, restart level
$0D8F0E32RL #Keen's shot (Hit walls, floors, ceilings and go zap.)
$0E8F112FRL #Swimming Keen (Hit walls, ceilings and floor 'softly')
$09DC1795RL #Walk back and forth, turn around at walls or edges
$09DC176ERL #Sit (Ignore all tiles unless clipped to notice them)
$09DC1847RL #Crawling Poison Slug
$09DC1913RL #Used by shot sprites (Fall until hit ground)
$0B801A7BRL #Floating Keen (Ignore all tiles, but stay in one place, e.g on poles.)
$0B801AA2RL #Standing Keen
$0B801B5FRL #Walking Keen
$0B801C48RL #Jumping Keen
$0B801F81RL #Pogoing Keen
$0B802071RL #Going down poles Keen
$0FA804ECRL #Mad Mushroom (Bounce like Mushroom off floors and ceilings)
$0FA808A1RL #Walking Bird (Walk on ground)
$0FA80945RL #Landing Bird (Check for gorund, if found become walking Bird)
$0FA8097FRL #Eggshell fragment (Move until hit ground)
$0FA809B4RL #Flying Bird (Hit walls, get stuck or go to landing Bird)
$0FA80D0BRL #Flying Skypest (Bounce off stuff, land sometimes)
$108002E1RL #Cloud (Float, reverse when hitting walls)
$1080055ERL #Berkeloid flame (Fly through air, become landed flame after hitting ground)
$108005B5RL #Flaming Berkeloid (Float above ground)
$10800610RL #Berkeloid (Float above gound and 'walk' along it)
$1080097ERL #Bounder (Bounce off ground)
$10800C71RL #Lick on ground (Wait then jump)
$10800F56RL #Controllable Airboard (Ignore tiles, look for B sprites)
$11A203DERL #Jumping Smirky (Hit ceilings and stick, land on floors)
$11A205C1RL #Jumping Mimrock (Hit ceilings, walls and floors)
$11A2062ERL #Bouncing Mimrock (Hit floors)
$11A20A3CRL #Swimming Dopefish and Schoolfish (Mind walls)
$11A20CA1RL #Enemy shot (Darts, Sprite's shot; shoot into walls and vanish

Keen 5:
$00000000L #Nothing
$090B17B5RL #Solid (Default 'blocked by solid stuff collision used by many things)
$090B17DCRL #Move l/r and down slopes
$090B195ARL #Stunned
$0AAF1A9FRL #Keen sit ('Sit in air'; similar to normal Keen)
$0AAF1AC6RL #Keen (Blocked by blocking tiles, killed by deadly, etc, complex.)
$0AAF1B83RL #Keen walk
$0AAF1C6CRL #Keen in air (Fall, hit ground and walls)
$0AAF200BRL #Keen pogo (Can break fuses!)
$0AAF2145RL #Keen go down poles (If no pole left, fall)
$0CCB11A2RL #Keen's shot
$0F920119RL #Explosion fragments
$0F9200A8RL #Master teleport
$0F9216ACRL #Enemy shot
$11020188RL #Sparky
$11020679RL #Ampton walk (Check for poles and switches too)
$11020897RL #Bouncy Slicestar
$11020B2FRL #Shelley walk
$11020BA1RL #Shelley fall
$11C4090ERL #Shikadi mine
$11C40B09RL #Robo red's shoot
$11C40C03RL #Spirogrip slam
$11C40D86RL #Spindred
$11C411B0RL #Mater's shot
$11C41248RL #Master's sparks
$11C41538RL #Shikadi (Check for poles)
$11C4179FRL #Shocksund
$11C418CBRL #Shocksund jump
$11C41980RL #Shocksund's shot
$11C41AC4RL #Sphereful

Keen 6:
TODO

Keen Dreams:
TODO

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Patch talk:Galaxy actions

2011-08-22T19:46:53Z

Lemm: merge action field descriptions?

I wonder if all of the Galaxy action parameters should just have a subsection within the main "Galaxy Action" patch. Some of these parameters are very simple and it doesn't warrant a new wiki page in my opinion.
[[User:Lemm|Lemm]] 19:46, 22 August 2011 (GMT)

Treasure Eater

2011-07-14T09:29:31Z

Lemm: searching

{{Creature Infobox
| Appears = [[Keen 4]]
| Harmful = No
| Shots = 1
}}
[[Image:Gnosticene_ancient-ingame.png|frame|A Treasure Eater in [[Keen 4]]]]

The '''Treasure Eaters''' are enemies found in [[Keen 4]], in the [[Shadowlands]] of [[Gnosticus IV]].

Treasure Eaters can only be found in the [[Pyramid of the Gnosticene Ancients]]. They are large, red and quite spherical. They cannot walk and prefer to hop about. When they need to move larger distances they will teleport themselves, often with a shrill giggle. They live mostly off of [[Keen 4 Items|candy]] that they will go to any lengths to steal.

If [[Keen]] does not kill any Treasure Eaters in the Pyramid of the Gnosticene Ancients, they will end up stealing the [[Gems|green gem]] needed to rescue the [[Council Member]], and Keen will have to start the level over again.

As these creatures are not listed in the in-game help, they have also been known as Smirky (for their constant smiling and giggling) and [[Gnosticenes|Gnosticene]] Ancients (for the level name where they can be found), but [[Tom Hall]] has stated: <ref>[http://publiccommanderkeenforum.yuku.com/topic/656/t/Treasure-Eaters-and-Tom-s.html?page=2 PCKF forum post with Tom's full e-mail (yuku.com)]</ref>

{{Box|I believe they are Treasure Eaters.... I'd have to locate my original drawing... Not my best name in the series, but that's what they were there for!}}

See also [[Keen 4 Creatures|List of Keen 4 Creatures]].

== Modding info ==

Treasure eaters will only take another hop if they see four consecutive tiles to their immediate right or left that are top blocking. If they cannot make another hop twice, then they will teleport to the next piece of Candy. They will search for candy and lifewater, and if it has all been collected, then they will disappear. They always select the first piece of candy that they see in the sprite list, (which is generally the top-left most piece of candy remaining). If Keen is given the power to teleport (by patching with [[CKPatch]]) he too will steal the same candy and will disappear when it is removed. The type of sprite that Treasure Eaters seek, and the number of unavailable moves they sense before teleporting can be patched.

== References ==
<references/>

[[Category:Keen 4 creatures]]
[[Category:Creatures]]

Patch:Sprite motion parameter

2011-07-13T09:10:58Z

Lemm: explanations for types 3 and 4 were backwards

The sprite motion parameter is the name for a variable that controls three aspects of Keen Galaxy sprites. The variable may have a value between 0 and 4 inclusive. Basically it controls when various things are run.

The three variables affected are 1.) when the [[Patch:Sprite behavior|sprite behavior]] is run, 2.) When the sprite speed is run and 3.) When the [[Patch:Sprite actions|sprite action]] is run.

=== Per frame vs per action ===

How a sprite behaves varies depending on whether something is run once per action or once per game frame. There are 35 game frames in every second. How this affect the three variables above is as follows:

Motion: If motion is run once then the sprite will move in a series of jerks, like an inchworm, as all the motion is used at once. (The sprite 'jumps from position A to position B) If the motion is run every game frame, then it is redrawn 35 times a second, giving it the appearance of smooth motion. (The sprite moves from position A to 1/35th near B, then 2/35ths...)

Behavior: If the behavior is run constantly the sprite responds instantly to anything it should, such as Keen being close.This however eats up memory. Complex behaviors should be run once per action, and there are some behaviors like throwing projectiles that must be run once per action. (35 shots per second would quickly crash the game.)

Action: usually the 'animation speed' controls how long the current action lasts. If it is not used then the sprite will stay in its current action for a varying amount of time. This is useful in that a sprite can sit or fall for as long as it needs to.

=== Values ===

The five values and what they do are as follows:

0: Behavior run once, smooth movement, animation speed controls action length. Used for smoothly moving sprites like walking Keen or moving platforms.

1: Behavior and movement are run once, animation speed controls action length. Commonly used, e.g. Inchworms.

2: Behavior run once, BUT animation speed and movement speed are ignored. Used for sprites that need to sit\fall for varying amounts of time. Stunned sprites use this, allowing them to fall until they react to hitting the ground. While the action movement speed is ignored, other motion programmed in any of the sprite behaviours, if any, is smooth.

3: Behavior run continuously, motion is jerky, animation speed controls action length. This is for responsive things that mover jerkily and as such is rare. The landing blue bird in Keen 4 uses this (When close to the ground it 'jerks' down to land.)

4: Behavior run continuously, motion is smooth, animation speed controls action length. This is for responsive sprites that must move smoothly, like the Mad Mushroom (Turn to face Keen, bounce off floors)

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Tutorial|}}
{{PatchCategories|Sprite|}}

Treasure Eater

2011-07-12T11:20:48Z

Lemm: treasure eater patching info

{{Creature Infobox
| Appears = [[Keen 4]]
| Harmful = No
| Shots = 1
}}
[[Image:Gnosticene_ancient-ingame.png|frame|A Treasure Eater in [[Keen 4]]]]

The '''Treasure Eaters''' are enemies found in [[Keen 4]], in the [[Shadowlands]] of [[Gnosticus IV]].

Treasure Eaters can only be found in the [[Pyramid of the Gnosticene Ancients]]. They are large, red and quite spherical. They cannot walk and prefer to hop about. When they need to move larger distances they will teleport themselves, often with a shrill giggle. They live mostly off of [[Keen 4 Items|candy]] that they will go to any lengths to steal.

If [[Keen]] does not kill any Treasure Eaters in the Pyramid of the Gnosticene Ancients, they will end up stealing the [[Gems|green gem]] needed to rescue the [[Council Member]], and Keen will have to start the level over again.

As these creatures are not listed in the in-game help, they have also been known as Smirky (for their constant smiling and giggling) and [[Gnosticenes|Gnosticene]] Ancients (for the level name where they can be found), but [[Tom Hall]] has stated: <ref>[http://publiccommanderkeenforum.yuku.com/topic/656/t/Treasure-Eaters-and-Tom-s.html?page=2 PCKF forum post with Tom's full e-mail (yuku.com)]</ref>

{{Box|I believe they are Treasure Eaters.... I'd have to locate my original drawing... Not my best name in the series, but that's what they were there for!}}

See also [[Keen 4 Creatures|List of Keen 4 Creatures]].

== Modding info ==

Treasure eaters will only take another hop if they see four consecutive tiles to their immediate right or left that are top blocking. If they cannot make another hop twice, then they will teleport to the next piece of Candy. They will only search for candy and lifewater that is spawned in the infoplane, and if that has been collected, then they will disappear. They always select the first piece of candy that they see in the sprite list, (which is generally the top-left most piece of candy remaining). If Keen is given the power to teleport (by patching with [[CKPatch]]) he too will steal the same candy and will disappear when it is removed. The type of sprite that Treasure Eaters seek, and the number of unavailable moves they sense before teleporting can be patched.

== References ==
<references/>

[[Category:Keen 4 creatures]]
[[Category:Creatures]]

Patch:Vorticons 2

2011-03-24T09:40:49Z

Lemm: added link

The Vorticons 2 patch is a large and complex patch used to drastically alter the capabilities of the Keen Engine, including such things as sloped tiles and multiple tilesets. There are currently two versions, 320x200 and 640x400. The original patch relied on a number of external binary files to work, but it is possible to run it as a single patch.

The patch as given here is very complex and should not be modified unless you are absolutely sure of what you are doing.

The page is divided into three sections, the 320x200 patch, the 640x400 patch and c section covering compatibility with existing patches and utilities.

== Compatibility ==

The v2 patch will run only with Dosbox 0.71 and above. The dosbox.conf file must contain the line 'machine = svga_paradise' for the graphics to work. Only the latest version of [[CKPatch]] can handle the size of the patch and its format. Only [[Keengraph]] can create graphics compatible with the patch. The patch is for Keen 1 v1.31 only. There is a special utility to produce tilesets for the game; [[Dr. Kylstein's Tileset Editor]]

== 320x200 Patch ==

This is the 'standard' patch, with the same resolution as the unmodified Keen game. This has more graphics memory than the following patch and has no major flaws. It is the version recommended for use.

Due to tile patching, levels cannot be too small or the graphics will look like gibberish. A section of patchable values and effects is at the end of this patch, These can be altered or even deleted if wanted. This patch should be the last in a patch file, ensuring that it will not be overwritten by incompatible patches.

Patches that are related to or a part of this patch include [[Patch:Palette]].

<patch title="Keen 1 320x200 Vorticons 2">
#================ V2 PATCH 320x200 ======================
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#The following stuff id alterable, you can alter it if you want
#to make the game more to your liking.

#This is the color palette: 16 entries of r, g, b (each 0-63)
#This is part of several palette patches as well.
%patch $1DCB0
00 00 00 #black
00 00 42 #blue
00 42 00 #green
00 42 42 #cyan
42 00 00 #red
42 00 42 #magenta
42 21 00 #brown
42 42 42 #bright gray
21 21 21 #gray
21 21 63 #bright blue
21 63 21 #bright green
21 63 63 #bright cyan
63 21 21 #bright red
63 21 63 #pink
63 63 21 #yellow
63 63 63 #white

#Reply scrolling Apogee when 'restart demo' is selected
%patch $90D2 $01
%patch $907C $C7 $06 $58 $56 $00 $00
%patch $15CE $0003W

#Draw the Main Menu despite graphics changes
#Only change the menu size if you want to patch this
%patch $9600 $E8 $01A8W
$B8 [$000AW] $50 #menu height
$B8 [$0012W] $50 #menu width
$E8 $CAB0W $83 $C4 $04 $A1 $8282W $66 $98 $66 $A3 $AAF4W
$A1 $82F8W $66 $98 $66 $A3 $AAF8W $90
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#This stuff should NOT be tampered with. It is the main body of the patch
#and contains vital code. Leave it be.

#Set memory map to mode 00 == 0A0000h to 0BFFFFh
#only required if using the paradise machine setting
%patch $6E51 $BA $CE $03 $B0 $06 $EE $42 $EC $24 $F3 $EE $EB $15

#Lots and lots of code:
%patch $11F80 $66 $C1 $E3 $10 $66 $C1 $EB $10 $66 $33 $C9 $66 $33 $D2 $66 $B8
$00 $03 $00 $00 $66 $0F $AF $C1 $66 $05 $04 $06 $00 $00 $66 $8B
$F8 $66 $B8 $15 $00 $00 $00 $66 $0F $AF $C1 $66 $03 $C2 $67 $26
$8B $34 $43 $D1 $E6 $8B $32 $57 $E8 $1D $00 $5F $47 $47 $66 $42
$66 $83 $FA $15 $7C $DB $66 $0F $BF $06 $54 $56 $66 $03 $D8 $66
$41 $66 $83 $F9 $0E $7C $B4 $CB $06 $1E $50 $8E $06 $B2 $35 $8E
$1E $6A $83 $B8 $2E $00 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4
$03 $F8 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4
$03 $F8 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4
$03 $F8 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4 $03 $F8 $A4 $A4
$03 $F8 $A4 $A4 $03 $F8 $58 $1F $07 $C3
%patch $B7B2 $38C0W
%patch $B7AA $38C0W
%patch $6EED $A610W
%patch $6F1B $A610W
%patch $6F3C $A610W
%patch $6F5D $A610W
%patch $B8AB $A2F0W
%patch $B8B1 $2F00W
%patch $0298 $EB $28
%patch $97E5 $90 $90 $90 $90 $90 $90
%patch $9861 $90 $90 $90 $90 $90 $90
%patch $9A51 $90 $90 $90 $90 $90 $90
%patch $A5B1 $90 $90 $90 $90 $90 $90
%patch $116C0 $55 $8B $EC $83 $EC $3C $56 $57 $33 $C0 $89 $46 $FE $89 $46 $C8
$66 $0F $BF $1E $3E $82 $66 $A1 $30 $82 $66 $89 $46 $FA $66 $8B
$C8 $66 $C1 $E9 $0C $89 $4E $F8 $66 $03 $C3 $66 $A3 $30 $82 $66
$C1 $E8 $0C $89 $46 $F6 $66 $A1 $38 $82 $66 $89 $46 $F2 $66 $8B
$C8 $66 $C1 $E9 $0C $89 $4E $F0 $66 $03 $C3 $66 $A3 $38 $82 $66
$C1 $E8 $0C $89 $46 $EE $66 $A1 $2C $82 $66 $8B $C8 $66 $C1 $E8
$0C $89 $46 $EC $66 $A1 $34 $82 $66 $03 $C8 $66 $C1 $E8 $0C $89
$46 $EA $66 $8B $C1 $66 $D1 $E8 $66 $89 $46 $E6 $66 $C1 $E8 $0C
$89 $46 $E4 $83 $FB $00 $0F $84 $CC $01 $0F $8C $E6 $00 $8B $4E
$E4 $8B $46 $F0 $BA $00 $00 $E8 $7C $07 $A8 $80 $74 $2C $8B $F0
$66 $33 $D2 $8B $56 $F0 $66 $C1 $E2 $0C $66 $8B $46 $E6 $E8 $FF
$06 $66 $3B $46 $F2 $7E $13 $66 $3B $06 $38 $82 $7F $0C $66 $2B
$06 $38 $82 $66 $48 $FF $46 $C8 $EB $78 $8B $46 $EE $3B $46 $F0
$0F $84 $82 $01 $8B $7E $EC $3B $7E $EA $7F $26 $8B $46 $EE $8B
$CF $BA $00 $00 $E8 $2F $07 $A8 $80 $75 $14 $A8 $03 $74 $10 $A1
%patch $117B0 $38 $82 $40 $25 $FF $0F $F7 $D8 $66 $98 $FF $4E $C8 $EB $43 $47
$EB $D5 $8B $46 $EE $8B $4E $E4 $BA $00 $00 $E8 $08 $07 $A8 $80
$0F $84 $42 $01 $8B $F0 $66 $33 $D2 $8B $56 $EE $66 $C1 $E2 $0C
$66 $8B $46 $E6 $E8 $89 $06 $66 $3B $46 $F2 $0F $8E $27 $01 $66
$3B $06 $38 $82 $0F $8F $1E $01 $66 $2B $06 $38 $82 $66 $48 $FF
$46 $C8 $C7 $06 $42 $82 $00 $00 $01 $06 $3E $82 $66 $01 $06 $30
$82 $66 $01 $06 $38 $82 $66 $A1 $30 $82 $66 $C1 $E8 $0C $8B $46
$EC $66 $A1 $38 $82 $66 $C1 $E8 $0C $8B $46 $EA $C7 $46 $FE $02
$00 $E9 $E2 $00 $8B $4E $E4 $8B $46 $F8 $BA $02 $00 $E8 $96 $06
$A8 $80 $74 $2F $8B $F0 $66 $33 $D2 $8B $56 $F8 $66 $C1 $E2 $0C
$66 $8B $46 $E6 $E8 $19 $06 $66 $3B $46 $FA $0F $8F $B7 $00 $66
$3B $06 $30 $82 $0F $8E $AE $00 $66 $2B $06 $30 $82 $66 $83 $C0
$04 $EB $72 $8B $46 $F6 $3B $46 $F8 $0F $84 $99 $00 $8B $7E $EC
$3B $7E $EA $7F $27 $8B $46 $F6 $8B $CF $BA $02 $00 $E8 $46 $06
$A8 $80 $75 $15 $A8 $03 $74 $11 $66 $33 $C0 $8B $46 $F8 $66 $C1
%patch $118A0 $E0 $0C $66 $2B $06 $30 $82 $EB $3C $47 $EB $D4 $8B $46 $F6 $8B
$4E $E4 $BA $02 $00 $E8 $1E $06 $A8 $80 $74 $5A $8B $F0 $66 $33
$D2 $8B $56 $F6 $66 $C1 $E2 $0C $66 $8B $46 $E6 $E8 $A1 $05 $66
$3B $46 $FA $7F $41 $66 $3B $06 $30 $82 $7E $3A $66 $2B $06 $30
$82 $66 $83 $C0 $04 $C7 $06 $42 $82 $00 $00 $01 $06 $3E $82 $66
$01 $06 $30 $82 $66 $01 $06 $38 $82 $66 $A1 $30 $82 $66 $C1 $E8
$0C $8B $46 $EC $66 $A1 $38 $82 $66 $C1 $E8 $0C $8B $46 $EA $C7
$46 $FE $08 $00 $EB $00 $66 $0F $BF $1E $3C $82 $66 $A1 $2C $82
$66 $89 $46 $FA $66 $8B $C8 $66 $C1 $E9 $0C $89 $4E $F8 $66 $03
$C3 $66 $A3 $2C $82 $66 $C1 $E8 $0C $89 $46 $F6 $66 $A1 $34 $82
$66 $89 $46 $F2 $66 $8B $C8 $66 $C1 $E9 $0C $89 $4E $F0 $66 $03
$C3 $66 $A3 $34 $82 $66 $C1 $E8 $0C $89 $46 $EE $66 $8B $46 $E6
$66 $03 $C3 $66 $89 $46 $E0 $66 $C1 $E8 $0C $89 $46 $DE $66 $A1
$30 $82 $66 $C1 $E8 $0C $89 $46 $EC $66 $A1 $38 $82 $66 $C1 $E8
$0C $89 $46 $EA $66 $33 $C0 $66 $89 $46 $DA $66 $89 $46 $D6 $66
%patch $11990 $89 $46 $D2 $83 $FB $00 $0F $84 $CD $04 $0F $8C $FF $00 $8B $4E
$E4 $8B $46 $EC $BA $03 $00 $E8 $2C $05 $A8 $80 $74 $2B $8B $F0
$66 $33 $D2 $8B $56 $E4 $66 $C1 $E2 $0C $66 $A1 $30 $82 $E8 $DF
$04 $66 $3B $46 $E6 $7C $12 $66 $3B $46 $E0 $7D $0C $66 $2B $46
$E0 $66 $83 $E8 $20 $66 $89 $46 $DA $8B $46 $EE $3B $46 $F0 $74
$38 $8B $7E $EA $81 $7E $C8 $01 $00 $75 $01 $4F $3B $7E $EC $7C
$28 $8B $C7 $8B $4E $EE $BA $03 $00 $E8 $DA $04 $A8 $80 $75 $16
$A9 $03 $00 $74 $11 $A1 $34 $82 $40 $25 $FF $0F $F7 $D8 $66 $98
$66 $89 $46 $D6 $EB $40 $4F $EB $D3 $8B $4E $DE $8B $46 $EC $BA
$03 $00 $E8 $B1 $04 $A8 $80 $74 $2D $8B $F0 $66 $33 $D2 $8B $56
$DE $66 $C1 $E2 $0C $66 $A1 $30 $82 $E8 $64 $04 $66 $3B $46 $E6
$7C $12 $66 $3B $46 $E0 $7D $0C $66 $2B $46 $E0 $66 $83 $E8 $20
$66 $89 $46 $DA $EB $00 $66 $8B $46 $DA $66 $3B $46 $D6 $7C $04
$66 $8B $46 $D6 $66 $3B $46 $D2 $7C $04 $66 $8B $46 $D2 $66 $0B
$C0 $74 $27 $C7 $06 $40 $82 $00 $00 $01 $06 $3C $82 $66 $01 $06
%patch $11A80 $2C $82 $66 $01 $06 $34 $82 $66 $01 $46 $E0 $66 $8B $46 $E0 $66
$C1 $E8 $0C $8B $46 $DE $83 $4E $FE $04 $E9 $00 $01 $8B $4E $E4
$8B $46 $EC $BA $01 $00 $E8 $2D $04 $A8 $80 $74 $2B $8B $F0 $66
$33 $D2 $8B $56 $E4 $66 $C1 $E2 $0C $66 $A1 $30 $82 $E8 $E0 $03
$66 $3B $46 $E6 $7F $12 $66 $3B $46 $E0 $7C $0C $66 $2B $46 $E0
$66 $83 $C0 $20 $66 $89 $46 $DA $8B $46 $F6 $3B $46 $F8 $74 $3C
$8B $7E $EA $81 $7E $C8 $01 $00 $75 $01 $4F $3B $7E $EC $7C $2C
$8B $C7 $8B $4E $F6 $BA $01 $00 $E8 $DB $03 $A8 $80 $75 $1A $A9
$03 $00 $74 $15 $66 $33 $C0 $8B $46 $F8 $66 $C1 $E0 $0C $66 $2B
$06 $2C $82 $66 $89 $46 $D6 $EB $40 $4F $EB $CF $8B $4E $DE $8B
$46 $EC $BA $01 $00 $E8 $AE $03 $A8 $80 $74 $2D $8B $F0 $66 $33
$D2 $8B $56 $DE $66 $C1 $E2 $0C $66 $A1 $30 $82 $E8 $61 $03 $66
$3B $46 $E6 $7F $12 $66 $3B $46 $E0 $7C $0C $66 $2B $46 $E0 $66
$83 $C0 $20 $66 $89 $46 $DA $EB $00 $66 $8B $46 $DA $66 $3B $46
$D6 $7F $04 $66 $8B $46 $D6 $66 $3B $46 $D2 $7F $04 $66 $8B $46
%patch $11B70 $D2 $66 $0B $C0 $74 $27 $C7 $06 $40 $82 $00 $00 $01 $06 $3C $82
$66 $01 $06 $2C $82 $66 $01 $06 $34 $82 $66 $01 $46 $E0 $66 $8B
$46 $E0 $66 $C1 $E8 $0C $8B $46 $DE $83 $4E $FE $01 $8B $46 $E4
$3B $46 $DE $0F $85 $93 $00 $83 $7E $C8 $00 $0F $8C $B8 $02 $74
$0F $33 $D2 $8B $4E $DE $8B $46 $EA $E8 $1A $03 $8B $F0 $EB $4D
$8B $4E $DE $8B $46 $EA $33 $D2 $E8 $0B $03 $8B $F0 $A8 $80 $0F
$84 $94 $02 $66 $33 $D2 $8B $56 $DE $66 $C1 $E2 $0C $66 $A1 $38
$82 $E8 $BC $02 $83 $3E $3C $82 $00 $7C $12 $66 $3B $46 $E6 $0F
$8C $74 $02 $66 $3B $46 $E0 $0F $8F $6C $02 $EB $10 $66 $3B $46
$E6 $0F $8F $62 $02 $66 $3B $46 $E0 $0F $8C $5A $02 $66 $33 $D2
$8B $56 $EA $66 $C1 $E2 $0C $66 $8B $46 $E0 $E8 $52 $02 $66 $2B
$06 $38 $82 $66 $48 $01 $06 $3E $82 $66 $01 $06 $30 $82 $66 $01
$06 $38 $82 $83 $4E $FE $02 $E9 $2D $02 $83 $7E $C8 $00 $7F $53
$0F $8C $F6 $00 $8B $4E $E4 $8B $46 $EA $33 $D2 $E8 $87 $02 $8B
$F0 $A8 $80 $0F $84 $69 $FF $66 $33 $D2 $8B $56 $E4 $66 $C1 $E2
%patch $11C60 $0C $66 $A1 $38 $82 $E8 $38 $02 $83 $3E $3C $82 $00 $7C $12 $66
$3B $46 $E6 $0F $8C $49 $FF $66 $3B $46 $E0 $0F $8F $41 $FF $EB
$30 $66 $3B $46 $E6 $0F $8F $37 $FF $66 $3B $46 $E0 $0F $8C $2F
$FF $EB $1E $8B $46 $EA $8B $4E $E4 $33 $D2 $E8 $38 $02 $8B $1E
$3C $82 $0F $BA $E0 $06 $73 $02 $F7 $DB $83 $FB $00 $0F $8F $18
$01 $8B $46 $EA $8B $4E $DE $33 $D2 $E8 $1A $02 $A8 $80 $74 $1D
$8B $F0 $66 $33 $D2 $8B $56 $EA $66 $C1 $E2 $0C $66 $8B $46 $E0
$E8 $9D $01 $66 $2B $06 $38 $82 $66 $48 $E9 $78 $01 $8B $46 $EA
$8B $4E $DE $33 $D2 $E8 $EE $01 $A8 $80 $75 $12 $A8 $03 $74 $0E
$A1 $38 $82 $40 $25 $FF $0F $F7 $D8 $66 $98 $E9 $57 $01 $8B $46
$EA $48 $8B $4E $DE $33 $D2 $E8 $CC $01 $A8 $80 $74 $1E $8B $F0
$66 $33 $D2 $8B $56 $EA $4A $66 $C1 $E2 $0C $66 $8B $46 $E0 $E8
$4E $01 $66 $2B $06 $38 $82 $66 $48 $E9 $29 $01 $A1 $38 $82 $40
$25 $FF $0F $F7 $D8 $66 $98 $E9 $1B $01 $8B $46 $EA $40 $8B $4E
$DE $33 $D2 $E8 $90 $01 $A8 $80 $74 $1E $8B $F0 $66 $33 $D2 $8B
%patch $11D50 $56 $EA $42 $66 $C1 $E2 $0C $66 $8B $46 $E0 $E8 $12 $01 $66 $2B
$06 $38 $82 $66 $48 $E9 $ED $00 $8B $46 $EA $40 $8B $4E $DE $33
$D2 $E8 $62 $01 $A8 $80 $75 $16 $A8 $03 $74 $12 $66 $A1 $38 $82
$66 $0D $FF $0F $00 $00 $66 $2B $06 $38 $82 $E9 $C7 $00 $8B $46
$EA $8B $4E $DE $33 $D2 $E8 $3D $01 $A8 $80 $74 $1D $8B $F0 $66
$33 $D2 $8B $56 $EA $66 $C1 $E2 $0C $66 $8B $46 $E0 $E8 $C0 $00
$66 $2B $06 $38 $82 $66 $48 $E9 $9B $00 $66 $A1 $38 $82 $66 $0D
$FF $0F $00 $00 $66 $2B $06 $38 $82 $8B $46 $EA $8B $4E $DE $33
$D2 $E8 $02 $01 $A8 $80 $74 $1C $8B $F0 $66 $33 $D2 $8B $56 $EA
$66 $C1 $E2 $0C $66 $8B $46 $E0 $E8 $85 $00 $66 $2B $06 $38 $82
$66 $48 $EB $61 $8B $46 $EA $40 $8B $4E $DE $33 $D2 $E8 $D6 $00
$A8 $80 $75 $15 $A8 $03 $74 $11 $66 $A1 $38 $82 $66 $0D $FF $0F
$00 $00 $66 $2B $06 $38 $82 $EB $3C $8B $46 $EA $40 $8B $4E $DE
$33 $D2 $E8 $B1 $00 $A8 $80 $74 $1D $8B $F0 $66 $33 $D2 $8B $56
$EA $42 $66 $C1 $E2 $0C $66 $8B $46 $E0 $E8 $33 $00 $66 $2B $06
%patch $11E40 $38 $82 $66 $48 $EB $0F $66 $A1 $38 $82 $66 $0D $FF $0F $00 $00
$66 $2B $06 $38 $82 $01 $06 $3E $82 $66 $01 $06 $30 $82 $66 $01
$06 $38 $82 $83 $4E $FE $02 $8B $46 $FE $5F $5E $8B $E5 $5D $CB
$8B $CE $80 $E1 $30 $C0 $E9 $04 $66 $33 $DB $8B $DE $83 $E3 $0C
$66 $25 $FF $0F $00 $00 $0F $BA $E6 $06 $73 $06 $80 $C3 $04 $66
$F7 $D8 $66 $D3 $F8 $66 $C1 $E3 $08 $66 $03 $C3 $66 $03 $C2 $C3
$8B $CE $80 $E1 $30 $C0 $E9 $04 $66 $33 $DB $8B $DE $83 $E3 $0C
$66 $25 $FF $0F $00 $00 $0F $BA $E6 $06 $73 $03 $80 $C3 $04 $66
$C1 $E3 $08 $66 $2B $C3 $0F $BA $E6 $06 $73 $03 $66 $F7 $D8 $66
$D3 $E0 $66 $03 $C2 $C3 $0F $AF $06 $08 $6C $03 $C1 $D1 $E0 $C4
$1E $48 $6C $03 $D8 $26 $8B $07 $69 $D2 $8E $03 $03 $D0 $8B $DA
$8A $87 $38 $41 $32 $E4 $C3
%patch $2C6D $A1 $40 $82 $F7 $2E $14 $5B $01 $06 $3C $82 $A1 $42 $82 $F7 $2E
$14 $5B $01 $06 $3E $82 $2E $FF $1E $E3 $13 $C3
%patch $0676 $E8 $D9BW
%patch $182F4 "TILEHEAD.CK1" $00
%patch $13BF $8C $C8 $05 $6C $0E $2E $A3 $E5 $13 $B8 $12 $10 $B9 $08 $00 $BB
$00 $00 $1E $07 $BA $60 $AC $CD $10 $BB $18 $00 $BA $78 $AC $CD
$10 $E9 $74 $01 $00 $30 $00 $00 $C7 $06 $52 $82 $54 $40 $C7 $06
$4A $82 $00 $00 $A1 $40 $82 $A3 $4C $82 $C7 $06 $40 $82 $00 $00
$E9 $C8 $2B $C7 $06 $52 $82 $67 $38 $B8 $07 $00 $50 $E8 $E4 $AA
$44 $44 $E9 $ED $29 $56 $57 $A3 $04 $83 $BA $C4 $03 $EC $32 $E4
$50 $B0 $02 $EE $42 $EC $50 $B8 $00 $3D $BA $A4 $52 $CD $21 $8B
$D8 $B8 $00 $42 $33 $C9 $8B $16 $04 $83 $C1 $E2 $04 $CD $21 $B8
$00 $3F $B9 $10 $00 $BA $90 $82 $CD $21 $B4 $3E $CD $21 $B8 $00
$3D $BA $90 $82 $CD $21 $8B $D8 $B8 $00 $3F $B9 $40 $00 $BA $90
$82 $CD $21 $B8 $00 $42 $8B $16 $96 $82 $8B $0E $98 $82 $CD $21
$B8 $00 $3F $B9 $54 $15 $BA $1C $3A $CD $21 $B8 $00 $42 $8B $16
$9A $82 $8B $0E $9C $82 $CD $21 $B8 $00 $3F $B9 $70 $1C $BA $A8
$00 $CD $21 $B8 $00 $3F $B9 $38 $0E $BA $72 $83 $CD $21 $B8 $00
$3F $B9 $38 $0E $BA $40 $97 $CD $21 $B8 $00 $42 $8B $16 $9E $82
%patch $14AF $8B $0E $A0 $82 $CD $21 $B8 $05 $00 $BA $CE $03 $EF $06 $1E $07
$1E $33 $C9 $A1 $6A $83 $8E $D8 $B4 $01 $D2 $E4 $B0 $02 $BA $C4
$03 $EF $51 $26 $8B $16 $68 $83 $26 $8B $0E $94 $82 $B4 $3F $CD
$21 $59 $41 $80 $F9 $04 $7C $E0 $1F $07 $B4 $3E $CD $21 $B0 $02
$BA $C4 $03 $EE $58 $42 $EE $58 $4A $EE $5F $5E $C3
%patch $3B47 $90 $90 $90
%patch $3FAC $F7 $C6 $02 $00 $74 $18 $83 $3E $42 $82 $00 $7C $11 $E9 $2B $D4
%patch $3D68 $F7 $C6 $02 $00 $74 $12 $83 $3E $42 $82 $00 $7C $0B $E9 $8A $D6
%patch $1804C $00A8W $07C4W $0EE0W $15FCW $00A8W $07C4W $0EE0W $15FCW
%patch $B799 $0E
%patch $BB67 $500CW
%patch $1805C $0000W $BC3BW $BC54W $BC6FW $BC95W
%patch $45E $3A1CW
%patch $2822 $3A1CW
%patch $2841 $3A1CW
%patch $4368 $3A1CW
%patch $A719 $80 $BF $4138W $0 $90 $90
%patch $38C5 $8A $87 $4138W $24 $03 $98 $3C $01
%patch $473D $80 $BF $44C6W $0 $90 $90
%patch $495A $80 $BF $44C6W $0 $90 $90
%patch $AA1E $80 $BF $44C6W $0 $90 $90
%patch $A806 $80 $BF $4854W $0 $90 $90
%patch $382F $80 $BF $4BE2W $0 $90 $90
%patch $47B1 $80 $BF $4BE2W $0 $90 $90
%patch $49C9 $80 $BF $4BE2W $0 $90 $90
%patch $A931 $80 $BF $4BE2W $0 $90 $90
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#============= END V2 PATCH 320x200 ====================</patch>

== External Links ==
[http://files.commanderkeen.org/users/omp/v2-0.0.2.zip V2 Patch with patches included as files]

{{PatchCategories|Keen 1|}}
{{PatchCategories|Gameplay|}}

Category talk:Bio Menace patches

2011-03-18T04:06:10Z

Lemm: how much

== Relevance? ==
The editing notes for this page said that "In the future it might get relocated to the ModdingWiki" but really, do Bio Menace patches have any business being on the KeenWiki? Why wasn't this just posted on the ModdingWiki in the first place? -- Flaose
: See [http://www.keenmodding.org/viewtopic.php?t=900&postdays=0&postorder=asc&start=30 discussion on Keen:Modding] (half way down the page) - never really went anywhere but feel free to join in. The main reason being Bio Menace uses the same engine as Keen so many of the patches will be similar. I'd prefer the ModdingWiki but since the engine is the same I can see the point of putting them here too. -- [[User:Malvineous|Malvineous]] 23:04, 17 March 2011 (GMT)
:: Just how much of the commander keen source code was reused for Bio Menace? The "engine" proper (i.e., C files prefixed with ID_ in wolf3D), would have been reused, but what about the keen physics code / actor structures? Were those the same or completely new? Also, was the text screen (end of game menus, etc) parsing code reused for Bio Menace as well (this was not in any ID_ file either). [[User:Lemm|Lemm]] 04:06, 18 March 2011 (GMT)

Patch:Music

2010-12-29T17:55:40Z

Lemm: Added extra song info

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:

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

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

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

== 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 subeequent patches).

Keen 4:
<patch>
#Where music list is read from:
%patch $8CCD $96 $03 #$2F206

#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 $00 $00 #Map (Shadowlands) 0
$04 $00 #Border Village (Kick in the Pants) 1
$03 $00 #Slug Village (Slug Village) 2
$03 $00 #Perilous Pit (Slug Village) 3
$02 $00 #Cave of Descendants (Too Hot) 4
$02 $00 #Chasm of Chills (Too Hot) 5
$04 $00 #Crystalus (Kick in the Pants) 6
$03 $00 #Hiliville (Slug Village) 7
$01 $00 #Sand Yego (Eat your Veggies) 8
$01 $00 #Miragia (Eat your Veggies) 9
$01 $00 #Lifwater Oasis (Eat your Veggies) 10
$02 $00 #Pyramid of Moons (Too Hot) 11
$02 $00 #Pyramid of Shadows (Too Hot) 12
$02 $00 #Pyramid of Ancients (Too Hot) 13
$02 $00 #Pyramid of Forbidden (Too Hot) 14
$02 $00 #Isle of Tar (Too Hot) 15
$02 $00 #Isle of Fire (Too Hot) 16
$01 $00 #Well of Wishes (Eat your Veggies) 17
$03 $00 #Bwb Megarocket (Slug Village) 18
$FF $FF #High scores (No music, "Fanfare") 19

#Other music played: (Values here is number of LEVEL who's music is used)
%patch $5836 $0C $00 #Story demo (Too hot)
%patch $9CD7 $07 $00 #Ending Sequence (Slug Village)
%patch $F107 $FF $FF #Talking to Lindsey (Ancient)
%patch $F4CA $FF $FF #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>

Keen 5:
<patch>
#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 $0B $00 #Map (Omegamatic) 0
$05 $00 #Ion Ventilation System (Wednesday on the Beach) 1
$07 $00 #Security Center (Security Center) 2
$09 $00 #Defense Tunnel Vlook (Be Sphereful) 3
$0A $00 #Energy Flow Systems (Make it Tighter) 4
$09 $00 #Defense Tunnel Burrh (Be Sphereful) 5
$0A $00 #Regulation Control Center (Make it Tighter) 6
$09 $00 #Defense Tunnel Sorra (Be Sphereful) 7
$0A $00 #Neutrino Burst Injector (Make it Tighter) 8
$09 $00 #Defense Tunnel Teln (Be Sphereful) 9
$0A $00 #Brownian Motion Inducer (Make it Tighter) 10
$03 $00 #Gravitational Damping Hub (Snooping) 11
$0D $00 #Quantum Explosion Dynamo (QED) 12
$04 $00 #Korath III Base (Bagpipes) 13
$0C $00 #Ending (Fanfare)
$02 $00 #High Scores (High Scores) 15
%patch $3069C $01 $00 #Scrolling Story (Armageddon Machine)
$00 $00 #Game Over (Came In)
$08 $00 #Help (Help)

#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>

Keen 6:
<patch>
#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 $05 $00 #Map (Aliens Ate My Babysitter) 0
$03 $00 #Bloogwaters Crossing (Faster) 1
$01 $00 #Guard Post One (Brer Tar) 2
$08 $00 #First Dome of Darkness (Mamba Snake) 3
$08 $00 #Second Dome of Darkness (Mamba Snake) 4
$08 $00 #Bloogdome (Mamba Snake) 5
$07 $00 #Bloogton Manufacturing (Metal) 6
$02 $00 #Bloogton Tower (To the Future) 7
$07 $00 #Bloogfoods, Inc. (Metal) 8
$01 $00 #Guard Post 2 (Brer Tar) 9
$03 $00 #Bloogville (Faster) 10
$02 $00 #BASA (To the Future) 11
$01 $00 #Guard Post 3 (Brer Tar) 12
$04 $00 #Bloogbase Recreational District(Space Funk) 13
$04 $00 #Bloogbase Management District (Space Funk) 14
$06 $00 #Bloog Control Center (Ominous) 15
$02 $00 #Blooglab Space Station (To the Future) 16
$00 $00 #Bean-with-Bacon Megarocket (A World of Wonderment) 17
$00 $00 #High Scores (A World of Wonderment) 18

#Other music played:
%patch $563F $0D $00 #Star wars text (Space funk)
%patch $E33C $01 $00 #Molly ending (Faster)

#Index of first music chunk within audio chunks:
%patch $8AC0 $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>

== Other ==

Keen 4:
<patch>
#Insuff mem message:
%patch $8D30 $EC $06 #Read from
%patch $2F55C "Insufficient memory" $0A
"for background music!" $00
</patch>

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

Vorticon Mods

2010-09-01T01:25:41Z

Lemm: Added Keen1 640x480 redux

This is an alphabetical list of all Keen: Vorticons mods, one-level mods and level packs ever made for Keen. It also includes some in-progress mods.

*Dates format: year-month-day (the release date can be determined by looking at the latest date on the game files)

*Please click on the triangles to sort by different categories. i.e. if you click first on "Modder(s)" then on "Mod of", you will get a list that is sorted by which game was modded, and further sorted by modder name. Refresh the page to reset all sort settings.

*'''ATTENTION:''' The downloads for Keen 2 and 3 mods will not include the Keen2 or Keen3 executable (It's still not free to distribute), you will need to put your own executable in the mod directory and unpack it with [http://www.shikadi.net/wiki/files/Mods/UNLZEXE.zip Unlzexe]

{|class="wikitable sortable" border="1" cellpadding="1" cellspacing="0" style="font-size: 90%; border:1px solid gray; border-collapse: collapse; text-align: center; width: 100%;"
|- style="background: #ececec"
! Title
! Download(s)
! Release date
! Modder(s)
! Mod of
! # of levels
! Protagonist
! Notes
|-
|[[A Christmas Mod]]
|[http://www.tl-dr.org/downloads/keen/mods/christmas1.zip full]
|2007-12-22
|[[User:Levellass|Levellass]]
|Keen 1
|1
|Tzen
|
|-
|A Christmas Mod Mk II: [[Merry Keenmas]]
|[http://www.tl-dr.org/downloads/keen/mods/christmas2.rar full]
|2006-01-06
|[[Levellord]]
|Keen 2
|16
|Keen
|graphical remake of Keen 2
|-
|[[A New Dope]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/NewDope.zip full]
|2007-03-14
|[[User:KeenRush|KeenRush]]
|Keen 3
|16
|Keen
|
|-
|[[A Sham on Inishmort]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Inishmort.zip full]
|2005-08-17
|[[User:Benvolio|Benvolio]]
|Keen 1
|10
|Keen
|
|-
|[[A Very Keen Christmas]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenChristmas.zip full]
|2005-02-08
|[[User:Allstories|Allstories]]
|Keen 1
|16
|Keen
|graphical remake of Keen 1
|-
|[[Aliens vs. Keen]]
|[http://levellord.toxicsheep.com/AliensvsKeen.zip full] [http://www.tl-dr.org/downloads/keen/mods/AvKDemo2.rar demo 2] [http://dosclassics.com/download/341 demo 1]
|2006-06-07 2005-12-18 2005
|DivoKeen [[Levellord]] et al.
|Keen 1
|12
|Keen
|first 2 demos by DivoKeen, finished by Levellord
|-
|[[Ally's Mod]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Ally1.zip full]
|2009-07-24
|[[User:Fleexy|Fleexy]] Ally
|Keen 1
|4
|Keen
|
|-
|[[Ally's Mod II]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Ally2.zip full]
|2009-08-01
|[[User:Fleexy|Fleexy]] Ally
|Keen 2
|2
|Keen
|
|-
|[[Ally's Mod III]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Ally3.zip full]
|2009-08-12
|[[User:Fleexy|Fleexy]] Ally
|Keen 3
|3
|Keen
|
|-
|[[Armageddon 2: Pluto Burns]]
|[http://levellord.toxicsheep.com/A-II-PB.zip demo]
|2005-08-29
|[[User:Najawa|Najawa]]
|Keen 1
|8
|Keen
|abandoned
|-
|[[Bad Dreams]]
|[http://dosclassics.com/download/128 full]
|2004 
|[[Levellord]]
|Keen 1
|14
|Keen
|There is also a "[http://www.tl-dr.org/downloads/keen/mods/Bad%20Dreams%204%20Spleen.zip Spleen's Birthday Edition]" of this
|-
|[[Bazooka Wowbagger]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Wowbagger.zip full]
|2003-05-18
|Paperface
|Keen 1
|12
|Bazooka Wowbagger
|
|-
|[[Benvolio's Puzzle Level]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/PuzzleLevel.zip full]
|2005-09-01
|[[User:Benvolio|Benvolio]]
|Keen 1
|1
|Keen
|
|-
|[[The Adventures of Bunny Basher|Bunny Basher 1]]
|[http://dosclassics.com/download/313 full]
|2004-11-21
|[[User:Benvolio|Benvolio]]
|Keen 1
|16
|Bunny Basher
|
|-
|[[Bunny Basher 2]]
|[http://www.maguidhir.com/benvolio/ full]
|2006-01-22
|[[User:Benvolio|Benvolio]]
|Keen 1
|16
|Bunny Basher
|in Irish language
|-
|[[CGA Keen Episode 1]]
|[http://www.dosclassics.com/download/324 demo]
|2005-01-29
|Quirky Moron
|Keen 1
|2
|Keen
|abandoned
|-
|[[Christmas Special 2004]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Christmas2004.zip full]
|2005-01-02
|[[Levellord]] [[User:Benvolio|Benvolio]]
|Keen 1
|16
|Keen
|
|-
|[[Comrade Keen]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/ComradeKeen.zip demo]
|2005-07-07
|[[User:StupidBunny|Stupid Bunny]]
|Keen 1
|8
|Keen
|
|-
|[[The_Clones_of_Evil_1|Clones of Evil 1: The Galaxy of M]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Clones1.zip full]
|2005-07-19
|[[User:Genius314|Genius314]]
|Keen 1
|16
|Keen
|
|-
|[[The_Clones_of_Evil_2|Clones of Evil 2: Mort Times a Million]]
|n/a
|n/a
|[[User:Genius314|Genius314]]
|Keen 2
|n/a
|Keen
|
|-
|[[Clouds Unseen|Clouds Unseen]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/CloudsUnseen.zip normal] [http://www.shikadi.net/wiki/files/Mods/Keen1/CloudsUnseenGreen.zip verdant]
|2010-05-20
|Stupid Bunny
|Keen 1
|11
|Character
|First mod in B/W; Easy and normal version available
|-
|[[Dangerous Dave in Copyright Infringement]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Infringement.zip full]
|2003-08
|[[User:Flaose|Flaose]]
|Keen 1
|1
|Dangerous Dave
|
|-
|[[Dangerous Keen in The Haunted Mansion]]
|[http://dosclassics.com/download/107 full]
|
|[[Levellord]]
|Keen 1
|
|Keen
|
|-
|[[Daniel's Keen Mod]]
|[http://www.tl-dr.org/downloads/keen/mods/Daniel%27s_Keen_MOD.zip beta]
|2003-10-22
|Dagneilius
|Keen 1
|16
|Keen
|abandoned
|-
|[[Death to the Vorticons]]
|[http://www.tl-dr.org/downloads/keen/mods/dttv1.zip full]
|2008-08-26
|[[User:Shikadi|shikadi]]
|Keen 3
|16
|Keen
|half mod, half levelpack
|-
|[[Death to the Vorticons 2]]
|[http://www.tl-dr.org/downloads/keen/mods/dttv2.rar full]
|2009-02-07
|[[User:Shikadi|shikadi]]
|Keen 2
|16
|Keen
|
|-
|[[Death to the Vorticons 3]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Dttv3.zip full]
|2009-03-27
|[[User:Shikadi|shikadi]]
|Keen 3
|16
|Keen
|
|-
|[[Kidnapped Keen|Decree of the Skree 1: Kidnapped Keen]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KidnappedKeen.zip full]
|2004-08-25
|[[User:Ceilick|Ceilick]]
|Keen 1
|16
|Keen & Norp
|
|-
|[[Zapping the Zot|Decree of the Skree 2: Zapping the Zot]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Skree2.zip full]
|2004-11-26
|[[User:Ceilick|Ceilick]]
|Keen 2
|16
|Keen
|
|-
|[[Return of the Guardians|Decree of the Skree 3: Return of the Guardians]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Skree3.zip full]
|2005-03-08
|[[User:Ceilick|Ceilick]]
|Keen 3
|16
|Keen
|
|-
|[[The Four Golden Crystals]]
|[http://dosclassics.com/download/4 full]
|2003-01
|Unfleexable
|Keen 1
|
|Keen
|
|-
|[[Generic Mod I]]
|[http://www.tl-dr.org/downloads/keen/mods/Generic1.zip full]
|2005-03-14
|[[Levellord]]
|Keen 1
|1
|Keen
|
|-
|[[Generic Mod II]] (Jetboy)
|[http://www.keeniverse.net/m.php?id=54 full]
|2005-03-15
|[[Levellord]]
|Keen 2
|1
|Jetboy
|
|-
|[[Generic Mod III]]
|[http://www.tl-dr.org/downloads/keen/mods/Generic3.zip full]
|2005-03-28
|[[Levellord]]
|Keen 3
|1
|Xky Rauh
|
|-
|[[The Grand Intellect: Doomship Dilemma]]
|[http://levellord.toxicsheep.com/MORT.zip full] [http://dosclassics.com/download/117 beta 2] [http://dosclassics.com/download/116 beta 1]
|2009-07-15
|Dr. Villain [[User:Levellass|Levellass]] et al.
|Keen 1
|13
|Mortimer McMire
|
|-
|[[Halloween Horrors]]
|[http://www.tl-dr.org/downloads/keen/mods/Halloween.zip full]
|2006-11-26
|[[Levellord]] [[User:Benvolio|Benvolio]]
|Keen 1
|14
|Keen
|
|-
|[[Harvey's Mod]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Harvey1.zip full]
|2005-09-04
|Harvey [[Levellord]]
|Keen 1
|16
|Keen
|
|-
|[[Harvey's Mod 2]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Harvey2.zip full]
|2007-12-03
|Harvey [[Levellord]]
|Keen 2
|13
|Keen
|
|-
|[[Hiding from the Sky]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenK.zip full]
|2005-01-23
|Karz
|Keen 1
|17
|Keen
|
|-
|[[How the Vorticon Stole Christmas]] (Gorti Vrinch)
|[http://www.tl-dr.org/downloads/keen/mods/gortivrinch-se.zip full (special edition)]
|2008-12-20
|[[User:Stealthy71088|Stealthy71088]]
|Keen 1
|4
|Gorti Vrinch
|
|-
|[[The Ian Burton Adventure]]
|n/a
|n/a
|[[User:Zero X. Diamond|Zero X. Diamond]]
|Keen 1
|
|Ian Burton
|abandoned
|-
|[[Crash on Gobo III|Invasion of the Yorps 1: Crash on Gobo III]]
|[http://dosclassics.com/download/5 full]
|2002-09-24
|[[User:Ceilick|Ceilick]]
|Keen 1
|10
|Keen
|
|-
|[[Crash on Gobo III#Remastered Version|Invasion of the Yorps 1: Crash on Gobo III Remastered]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Gobo3se.zip full]
|2003-03-15
|Unfleexable
|Keen 1
|10
|Keen
|slightly modified version of [[Crash on Gobo III]]
|-
|[[Planet Destruction|Invasion of the Yorps 2: Planet Destruction]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/PD.zip full]
|2003-01
|[[User:Ceilick|Ceilick]]
|Keen 2
|16
|Keen
|
|-
|[[Tribulation of the Yorps|Invasion of the Yorps 3: Tribulation of the Yorps]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Tribulation.zip full]
|2009-08-30
|[[User:Tulip|Tulip]] et al.
|Keen 3
|16
|Keen
|
|-
|[[Jetboy Remake]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Jetboy.zip full]
|2005-02-13
|[[Levellord]]
|Keen 2
|16
|Jetboy
|original keen 2 levels, changed physics for player
|-
|[[Keen -6]]
|[http://home.mchsi.com/~bootsisbig/keen-6.zip full]
|2009-08-08
|[[User:Fleexy|Fleexy]]
|Keen 1
|16
|Keen
|
|-
|[[Keen 0]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Keen0.zip full] [http://www.shikadi.net/wiki/files/Mods/Keen1/Keen0Fools.zip weird edition]
|2004-02-26
|[[User:EricMushroomWilson|ElecDude33]]
|Keen 1
|16
|Keen
|
|-
|[[Keen 1 640x480 Redux]]
|[http://files.commanderkeen.org/users/omp/keen12h.zip full]
|2010-08-17
|[[User:Lemm]]
|Keen 1
|16
|Keen
|Graphics unchanged; Game runs at 640x480 in Dosbox emulating Paradise PVGA1A SVGA
|-
|[[Keenbot]]
|[http://dosclassics.com/download/120 beta]
|
|Victor4k
|Keen 1
|
|Keenbot
|
|-
|[[XkyKeen3|Keen Dash]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/KeenDash.zip full]
|2004-10-22
|[[User:Xky Rauh|Xky Rauh]]
|Keen 3
|16
|Keen
|
|-
|[[Keen in Mineepleo]]
|[http://www.mediafire.com/?tnuuwaoscmv demo]
|2009-03-14
|Harvey
|Keen 1
|
|Keen
|
|-
|[[XkyKeen2|Keen Null]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/KeenNull.zip full]
|2004-03-11
|[[User:Xky Rauh|Xky Rauh]]
|Keen 2
|16
|Keen
|
|-
|[[Keen S]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenS.zip full]
|2010-03-13
|[[User:Shikadi|Shikadi]]
|Keen 1
|16
|Keen
|
|-
|[[Keen Smile]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Smile.zip full]
|2005-01-07
|[[User:KeenRush|KeenRush]]
|Keen 2
|16
|Keen
|
|-
|[[Keen Universe: Aliens Ate my Homework]]
|[http://www.freewebs.com/yahooseliteleague/Universe1.zip full]
|
|[[User:Stealthy71088|Stealthy71088]]
|Keen 1
|16
|Keen
|
|-
|[[KeenWarp Part One]]
|n/a
|n/a
|[[User:Freeyorp101|Freeyorp101]]
|Keen 1
|
|Keen
|abandoned
|-
|[[Keen Q]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/KeenQ.zip full]
|2007-11-09
|Joriz::
|Keen 2
|16
|Keen
|
|-
|[[XkyKeen1|Keen X]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenX.zip full]
|2002-06-30
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|18
|Keen
|2nd-ever Keen mod
|-
|[[Keen Y]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenY.zip full] [http://www.tl-dr.org/downloads/keen/mods/keenybeta.zip beta]
|2003-06-19
|Grelphy
|Keen 1
|21
|Keen
|
|-
|[[Keen Z]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenZ.zip full]
|2009-01-30
|[[User:Ceilick|Ceilick]] [[User:KeenRush|KeenRush]]
|Keen 1
|16
|Keen
|
|-
|[[The Last Moon]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Lastmoon.zip full]
|2004-07-25
|[[User:Allstories|Allstories]]
|Keen 1
|12
|Keen
|
|-
|[[Lego Keen]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Legokeen.zip full]
|2003-12-12
|Ilsoap
|Keen 1
|17
|Lego Keen
|
|-
|[[Lord of the Rings: The Shard of Narsil]]
|n/a
|2005-11-24
|[[User:Najawa|Najawa]]
|Keen 1
|
|
|
|-
|[[Marooned on Mars Part II]]
|[http://www.tl-dr.org/downloads/keen/mods/keen-1a.zip full]
|2003-09-02
|Matze
|Keen 1
|17
|Keen
|Matze considers it a levelpack with modified graphics
|-
|[[OrbKeen1|Monky Business: An Essence of Mayhem]]
|[http://dosclassics.com/download/121 beta]
|2004-08
|[[User:Commander Spleen|Commander Spleen]]
|Keen 1
|
|Keen
|
|-
|[[Musical Keen]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/MusicalKeen.zip full]
|2005-07-26
|[[User:Benvolio|Benvolio]]
|Keen 1
|17
|Keen
|
|-
|[[Norp the Yorp 1|Norp the Yorp 1: Inside Mortimer's Computer]]
|[http://dosclassics.com/download/7 full]
|2002-08-31
|[[Xtraverse]]
|Keen 1
|16
|Norp
|
|-
|[[Norp the Yorp 2|Norp the Yorp 2: Diffusion]]
|[http://www.tl-dr.org/downloads/keen/mods/n2.zip full]
|2002
|[[Xtraverse]]
|Keen 2
|16
|Norp
|
|-
|[[Norp the Yorp 3|Norp the Yorp 3: Brain Damage]]
|[http://www.tl-dr.org/downloads/keen/mods/norp3.zip full]
|
|[[Xtraverse]]
|Keen 3
|16
|Norp
|
|-
|[[Norp the Yorp 3.5|Norp the Yorp 3.5: The Maze of Doom]]
|[http://www.tl-dr.org/downloads/keen/mods/norpmaze.zip full]
|2005-03-23
|[[Xtraverse]]
|Keen 1
|1
|Norp
|
|-
|[[Onward: Silcar 1: Nightmare Before Teatime]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Silcar1.zip full]
|2008-06-22
|[[User:Tulip|Tulip]]
|Keen 1
|16
|Keen
|
|-
|[[Onward: Silcar 2: Flee from Fleet]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Silcar2.zip full]
|2008-08-03
|[[User:Tulip|Tulip]]
|Keen 2
|16
|Keen
|
|-
|[[Onward: Silcar 3: The Evil that Meets the Eye]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Silcar3.zip full]
|2008-09-15
|[[User:Tulip|Tulip]]
|Keen 3
|16
|Keen
|
|-
|[[Onward: Silcar 4: The Civilization Inside]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Silcar4.zip full]
|2009-03-14
|[[User:Tulip|Tulip]]
|Keen 1
|16
|Keen
|
|-
|[[The Adventures of The Oracle Janitor|Oracle Janitor 1]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Oj1.zip full]
|2005-01-27
|[[User:Ceilick|Ceilick]]
|Keen 1
|1
|Oracle Janitor
|
|-
|[[Oracle Janitor 2|Oracle Janitor 2: Mystery of the Monastery]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Oj2.zip full]
|2005-03-13
|[[User:Ceilick|Ceilick]]
|Keen 2
|1
|Oracle Janitor
|
|-
|[[Oracle Janitor 3|Oracle Janitor 3: Space Pirate Trouble]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Oj3.zip full]
|2005-08-03
|[[User:Ceilick|Ceilick]]
|Keen 3
|1
|Oracle Janitor
|
|-
|[[Patchwork Mod I]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Patchwork1.zip full]
|2004-06-14
|Keen community
|Keen 1
|16
|Keen
|
|-
|[[Patchwork Mod II]]
|[http://www.keeniverse.net/m.php?id=57 full]
|2005-06-29
|Keen community
|Keen 2
|22
|Keen
|
|-
|[[Patchwork Mod III]]
|[http://levellord.toxicsheep.com/PM3.zip full]
|2008-10-29
|Keen community
|Keen 3
|17
|Keen
|
|-
|[[The Perilous Pursuit]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Pursuit.zip full]
|2005-01-24
|[[User:Ceilick|Ceilick]] [[User:Commander Spleen|Commander Spleen]]
|Keen 1
|16
|Keen
|
|-
|[[Retrosis]]
|[http://www.jimage.org/keen/Retrosis00.zip Demo]
|2010-03-14
|[[User:Commander Spleen|Commander Spleen]]
|Keen 1
|9
|Pogo with an Eye
|Work in progress
|-
|[[Return of the Shikadi: Lost in the Shadows]]
|n/a
|n/a
|[[User:Shadow Master|Shadow Master]]
|Keen 1
|
|Keen
|
|-
|[[Return of the Shikadi: The Destructor]]
|n/a
|n/a
|[[User:Shadow Master|Shadow Master]]
|Keen 2
|
|Keen
|
|-
|[[Vanished To Venus|Revenge of the Shikadi 1: Vanished to Venus]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Venus.zip full]
|2004-08-30
|[[User:Benvolio|Benvolio]]
|Keen 1
|17
|Keen
|
|-
|[[Stopping the Skypest|Revenge of the Shikadi 2: Stopping the Skypest]]
|[http://www.tl-dr.org/downloads/keen/mods/benvolio_skypest.zip full]
|2004-08-30
|[[User:Benvolio|Benvolio]]
|Keen 1
|17
|Keen
|
|-
|[[Exiting Epsilon|Revenge of the Shikadi 3: Exiting Epsilon]]
|[http://www.tl-dr.org/downloads/keen/mods/benvolio_epsilon.zip full]
|2004-08-30
|[[User:Benvolio|Benvolio]]
|Keen 2
|23
|Keen
|
|-
|[[The Ripped Mod]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Ripped.zip full]
|2005-03-26
|[[Levellord]] et al.
|Keen 1
|16
|Xky Rauh
|slightly edited Keen 1 levels
|-
|[[Robot Rebellion]]
|[http://dosclassics.com/download/108 full]
|2004-03-13
|[[User:Multimania|Multimania]]
|Keen 1
|16
|Keen
|
|-
|[[Rorie's Birthday Mod]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Rorie.zip full]
|2004-10-20
|[[Levellord]]
|Keen 1
|16
|George W. Bush
|slightly edited Keen 1 levels
|-
|[[The Search for the Sentinel]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Sentinel.zip full]
|2004-08-08
|Kohntarkosz
|Keen 1
|12
|Keen
|
|-
|[[ShadowKeen1|Shadow Keen 1]]
|[http://www.keeniverse.net/m.php?id=16 full v2] [http://www.dosclassics.com/download/106 full v1]
|2004-02-06
|[[Levellord]]
|Keen 1
|32
|Keen
|
|-
|[[ShadowKeen2|Shadow Keen 2]]
|[http://www.tl-dr.org/downloads/keen/mods/Shadow%20Keen%202.zip full]
|2004-07-17
|[[Levellord]]
|Keen 2
|39
|Keen
|
|-
|[[ShadowKeen3|Shadow Keen 3]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Shadowkeen3.zip full]
|2004-10-07
|[[Levellord]]
|Keen 3
|16
|Keen
|
|-
|[[Story Land]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Storyland.zip full]
|2005-09-03
|[[User:Ceilick|Ceilick]]
|Keen 1
|16
|Keen
|
|-
|[[Commander Keen +: Printed to Pluto]]
|In progress
|No release data
|[[User:Szemigi|Szemigi]]
|Keen 1
|16
|Keen
|
|-
|[[Thwarting Mort]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/ThwartingMort.zip full]
|2005-01-08
|[[User:Benvolio|Benvolio]]
|Keen 1
|9
|Keen
|
|-
|[[Tower Trouble]]
|n/a
|n/a
|[[User:Stealthy71088|Stealthy71088]]
|Keen 3
|
|Keen
|
|-
|[[Trapped Keen|Trapped Keen (inside his Gameboy)]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/TrappedKeen.zip full]
|2010-08-25
|[[User:Shikadi|shikadi]]
|Keen 3
|
|Keen
|
|-
|[[Vox 1]]
|[http://www.tl-dr.org/downloads/keen/mods/vox1.zip beta]
|2008-07-15
|Grelphy
|Keen 1
|20
|Keen
|
|-
|[[Vox 2]]
|[http://www.tl-dr.org/downloads/keen/mods/vox2.zip beta]
|2008-07-15
|Grelphy
|Keen 3
|16
|Keen
|
|-
|[[Vox 3]]
|[http://www.tl-dr.org/downloads/keen/mods/vox3.zip beta]
|2008-07-15
|Grelphy
|Keen 2
|16
|Keen
|
|-
|[[Xky's One Level Mod]]
|[http://www.keeniverse.net/m.php?id=48 full]
|2005-03-13
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|1
|Keen
|
|-
|[[Yorphius II]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Yorphius.zip full] [http://www.tl-dr.org/downloads/keen/mods/beta.zip beta]
|2002-06-25
|[[User:KeenRush|KeenRush]]
|Keen 1
|16
|Keen
|the first-ever mod
|-
|[[Zelda II]]
|[http://dosclassics.com/download/111 full]
|2004-01-22
|CheesyDave
|Keen 1
|
|Link
|remake of the classic NES Zelda game
|}

=== Level Packs ===

{|class="wikitable sortable" border="1" cellpadding="1" cellspacing="0" style="font-size: 90%; border:1px solid gray; border-collapse: collapse; text-align: center; width: 100%;"
|- style="background: #ececec"
! Title
! Download(s)
! Release date
! Builder(s)
! Pack of
! # of levels
! Notes

|-
|[[Airefresco's Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/Airefresco1.zip full]
|1999-06-18
|Airefresco
|Keen 1
|7
|
|-
|[[A.R.'s Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/ARpack.zip full]
|1999-03-07
|A.R.
|Keen 1
|6
|
|-
|[[XkyKeen1#Level pack|Community Keen X Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/Xpackr2.zip release 2]
|2010-03-14
|Keen Community
|Keen X
|10
|
|-
|[[Community Smile Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/PCKFSmilePack.zip full]
|2009-08-30
|Keen Community
|Episode Smile
|13
|
|-
|[[Dark Side of Mars]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/DarkSideofMars.zip full]
|1999-11-22
|MRC Marky
|Keen 1
|8
|
|-
|[[Dungeon of Mystery]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/DungeonofMystery.zip full]
|2003-12-15
|Perry Scanlon
|Keen 1
|2
|
|-
|[[Extreme Keen]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/ExtremeKeen.zip full]
|2003-03-01
|Perry Scanlon
|Keen 1
|8
|
|-
|[[I Am Frozen]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/IAmFrozen.zip full]
|2002-05-08
|Valerio
|Keen 1
|1
|
|-
|[[The Ice Factory]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/Icefactory.zip full]
|1998-01-14
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|1
|
|-
|[[Ice Level]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/Icelevel.zip full]
|1999-04-18
|Neil McRae
|Keen 1
|15
|
|-
|[[Ilsoap's Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/Ilsoappack.zip full v3]
|2002-06-18
|Ilsoap
|Keen 1
|7
|
|-
|[[Keen 1 BwB Level]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/FlaoseBWBLevel.zip full]
|1999-01-20
|[[User:Flaose|Flaose]]
|Keen 1
|1
|
|-
|[[Keen 1 Level Competition Level Pack (January 2007)|Keen 1 Competition Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/K1Competition.zip full]
|2007-01-01
|Keen Community
|Keen 1
|16
|
|-
|[[Keen 2 Competition Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen2/K2Competition.zip full]
|2007-03-17
|Keen Community
|Keen 2
|16
|
|-
|[[Keen Armageddon]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/KeenArmageddon.zip full]
|1999-04-21
|Adam
|Keen 1
|16
|
|-
|[[KMO Default Levels]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/KMOLevels.zip full]
|1999-02-13
|Peder Johnson
|Keen 1
|8
|
|-
|[[Martian Building and Skyscraper]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/Grelphy1.zip full]
|2003-06-04
|Grelphy
|Keen 1
|2
|
|-
|[[Return on Mars]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/ReturnonMars.zip full]
|1997-01-01
|Benoit Rouleau
|Keen 1
|14
|
|-
|[[Twin Towers]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/TwinTowers.zip full]
|2000-06-27
|AlienKillerXX
|Keen 1
|1
|
|-
|[[XkyKeen1#Level pack|Xky1tuned]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/Xky1tuned.zip full]
|2005-08-08
|[[User:KeenRush|KeenRush]]
|Keen X
|16
|
|-
|[[Xky's Mega Level]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/XkyMegalevel.zip full]
|1999-01-24
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|1
|
|-
|[[XkyKeen2#Level Pack|XkyKeen 2 Competition Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/Xky2Community.zip full]
|2008-04
|Keen Community
|Keen Null
|16
|
|-
|[[Yorphius II#Level pack|Yorphius II Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/YorphiusIIPack.zip full]
|2007-03-19
|[[User:Stealthy71088|Stealthy71088]] [[User:Xky Rauh|Xky Rauh]] [[User:Levellass|Levellass]]
|Yorphius II
|16
|
|}

=== Skin mods ===

{|class="wikitable sortable" border="1" cellpadding="1" cellspacing="0" style="font-size: 90%; border:1px solid gray; border-collapse: collapse; text-align: center; width: 100%;"
|- style="background: #ececec"
! Title
! Download(s)
! Release date
! Skin's creator(s)
! Mod
! Note(s)

|-
|[[Cybernetic Dream]]
|[http://dosclassics.com/download/207/dl full]
|2004-10-04
|Cybernetic Dream
|Keen 3
|
|}

==External links==
*[http://www.keeniverse.net/m.php The Garg's Mod Maze]
*Beyond the Pogo: [http://www.dosclassics.com/downloads.php?cat=0&subcat=4 Mods], [http://www.dosclassics.com/downloads.php?cat=0&subcat=5 Levelpacks]
*the bipship: [http://www.bipship.com/mods Mods], [http://www.bipship.com/levelpacks Levelpacks]

[[Category:Mods| ]]

User talk:Lemm

2010-08-02T21:10:07Z

Lemm: ..

Hi Lemm, and welcome to the KeenWiki. I'm Xterra, a veteran user here. I hop eyou enjoy and contribute to this wiki, and also- that's quite a job you have there- patching plant DNA? Wow....-[[User:Xterra1|Xt]][[User talk:Xterra1|er]][[Special:Contributions/Xterra1|r]][[Special:Random|a1]] 21:24, 1 August 2010 (GMT)

PS- here's how to sign and time comments (not trying to be condescending). Simply put four tildes, like this:

<nowiki>~~~~</nowiki>

When you edit this page to reply, you'll notice the four tildes are surounded by "nowiki" code. That tells the wiki to not format that text automatically. [[User:Xterra1|Xt]][[User talk:Xterra1|er]][[Special:Contributions/Xterra1|r]][[Special:Random|a1]]

:: Okay. I knew how to sign comments, but I forget to do so often enough that it would appear otherwise. I Should probably go look at the mediawiki doc one of these days...

[[User:Lemm|Lemm]] 21:10, 2 August 2010 (GMT)

User:Lemm

2010-07-29T14:25:07Z

Lemm: Made User Page

I am Lemm, patcher of Keen.

In real life, I patch plant DNA for the purposes of protein production. Hopefully I will retire on a pile of cash when I am 40.

Started doing this in July 2009 because I wanted to learn x86 assembly (for whatever reason) and make games. Since I've played Keen on and off since I was 3, I figured Keen modding would be a good start. I've done my fair share of reversing the vorticons code. This has led to some pretty nifty patches (check 'em on Keen:Modding)!

Patch talk:Game stats

2010-07-15T04:57:20Z

Lemm: reply

In vorticons, these "item bytes" are the save file (this portion of the game's memory gets written to the disk).
[[User:Lemm|Lemm]] 01:17, 14 July 2010 (GMT)

--Indeed they are, should we add that to the page? There's even a direct correlation between the 'value' and where it ends up in the saved game file. (As you'd expect.) --[[User:Levellass|Levellass]] 02:44, 14 July 2010 (GMT)

--Yes, I think it would be a good idea to rename the topic from "item bytes" into something more general like "game profile" or "game status" or whatever. Then you could have the vorticons save game format at the top of the page and copy the save game format notes page from levellord.rewound.net. (There's also a couple of corrections that I should make to those notes) [[User:Lemm|Lemm]] 03:14, 15 July 2010 (GMT)

--Ok, so what kind of name are we considering for the page here? 'Game stats' sounds good to me. We know roughly both the Galaxy and Vorticons savegame format, so I guess you'd want those in the page too, though I'm not sure they should be at the top of the page, mostly this page will be linked to relating to patches for the tables of values, perhaps the format would be better at the bottom of the page, with a note about how the tables map onto them? --[[User:Levellass|Levellass]] 04:02, 15 July 2010 (GMT)

--Game stats sounds good, there could be a short intro as you have now. I would say divide the rest of the page in half and put all vorticons stuff at the top and all galaxy stuff at the bottom, and then you can have the save game file description at the bottom of each half. [[User:Lemm|Lemm]] 04:57, 15 July 2010 (GMT)

Patch:Jump conditions

2010-07-15T03:18:35Z

Lemm: added link

Jump conditions are conditions required in a patch for a 'choice' to be made, such as whether or not to display a graphic or to exit a level or add points. They are very important in the Keen executable, but rarely patched. The general format is a value, followed by a 'condition' followed by the number of bytes to jump. Any or all of these may be in a patch. They are the equivalent of the BASIC 'IF... THEN' command. As an example, the following patch changes the BWB level in Keen 4. (The level that can be played infinitely many times, unlike other levels which get marked as done.):

#BwB level:
%patch $60FD $11 $77 $5B #Level $xx and above

The various kinds of jump are as follows. They will be explained gradually.

$xx $72 $yy JB: Jump if below
$xx $73 $yy JAE: Jump if above or equal
$xx $74 $yy JE: Jump if equal
$xx $76 $yy JBE: Jump if below or equal
$xx $77 $yy JA: Jump if above

$xx $7C $yy JL: Jump if less
$xx $7D $yy JGE: Jump if greater or equal
$xx $7E $yy JLE: Jump if less or equal
$xx $7F $yy JG: Jump if greater
$xx $75 $yy JNE: Jump if not equal

$EB $yy JMP: Jump short
$E9 $yy $yy JMP: Jump near

$E8 $yy $yy CALL: Call near
$9A $yyyyyyyyRL CALL FAR: Call far; address is absolute

Our example patch checks the number of the level Keen has just exited. IF the number is above ($77) 17 ($11) THEN it jumps 91 ($5B) bytes ahead in the code. These 91 bytes mark a level as done, so in this case, any level above 17 Keen enters will not be marked done when he exits, and can be played again as many times as he likes.

The 'distance' jumped is measured from the byte AFTER the amount jumped. So our example patch jumps to $615B. ($6100 + $5B) The jump is thus 'relative', though 'call far' is 'absolute' (See below.)

== Above\below vs more\less ==

Notice there are two sets of jumps that seem to do the same thing. This is because Keen uses two types of values (integers); signed and unsigned. Signed integers can be negative ($FF = -1, $F0 = -16...) whereas unsigned integers can't. ($FF = 255 $F0 = 240). This doesn't usually have too much of an effect on patches, as most use small positive values, which are the same in both systems, but it can affect more complex patches. (Specifically a 1-byte value of $80 or a 2-byte value of $8000 or more becomes negative if it is signed, causing problems if you're not careful.)

The two sets of jumps thus treat certain values differently, depending on which is used. ($FF is smaller than 0 if signed (-1), but bigger than 0 if unsigned (255)) The greater/less jumps are for signed integers (-32768 to 32767 in the case of a 16-bit integer), while the above/below jumps are for unsigned integers (0 to 65535)

== Conditions ==

Most jumps have conditions, that is, they check something before jumping. Some do not. Specifically the 'jump short', 'jump near' and both the 'calls' don't check anything. When they are encountered something ALWAYS happens. This can be seen in some patches. As an example, if we wanted ALL levels to be infinitely replayable we would simply change our example patch to:

#ALL levels are BWB-type levels:
%patch $60FD $11 $EB $5B

You will notice that some of the 'jumps' have a TWO-byte jump distance, whereas most have just one. You may also wonder why a program needs mandatory jumps, if some code is always going to be skipped, why have it in there in the first place?

There are a number of reasons, based on the slightly odd way the jumps work. You will notice that ALL of the 'conditional jumps' have only one-byte jump distances. This means they longest they can jump is 255 bytes ($FF) But what if you want to skip more code than that? In general a conditional jump AND a mandatory jump are used. Consider the hypothetical patch below:

%patch $ABCD $04 $74 $03 $E9 $80 $02

Here if some value is equal to four, a jump itself is jumped. Another way to look at this is 'If a value is NOT equal to four, jump $0208' This lets a programmer make 'big conditional jumps', with the annoying side-effect of the jump being 'reversed' A lot of these tend to turn up, meaning that an unwary patcher may be dealing with a patch that does the opposite of what he thinks it does. It thus pays to pay special attention to what an example patch does before changing it.

Another trick that can be used is to remove an existing jump entirely; this is usually done by replacing the jump and jump distance by $90. In our example patch, if we wanted to make all levels completable we would use this patch:

#NO levels are BWB-type levels:
%patch $60FD $11 $90 $90

Here the jump has been eliminated, no matter what level Keen exits, no code will be skipped. This too will often be seen in patches and can be done with any jump. For 'call near' and 'jump near' we would need three bytes of $90 to properly remove the jump and for 'call far', FIVE bytes. (It is also worth noting that a one-byte value of say $06 is a two-byte value of $06 $00 or $0006W when patching.)

== Calls ==

The last two 'jumps' in the list are not jumps at all, but 'calls'; they are always executed when encountered and are the equivalent of GOSUB and SUB in BASIC. (That is the program will go to where it is directed, do something, then return.) The 'call near' is similar to 'jump near', but is much more common and is often used to jump backwards in the code. (The jump distance is signed,.) The 'call far' is more complex.

Call far goes to an absolute address in the UNPATCHED, UNLZEXE'd code. Its' address is considered to have two parts, a 'segment' and an 'offset', each two bytes long. The actual location in the code is [segment * 256] + [offset] This is done because executables require addresses of more than 2 bytes and, for simplicity, they are divided into segments of varying lengths.

Because of the way CKPatch works, call far patches can be done in a number of ways. The first thing to note is that because the code is patched into memory, all the addresses in it are addresses in memory, and thus change. CKPatch automatically alters unpatched call far values to work with this, by adding another value, z, to the segment locations. However it doesn't do this to normal patches, meaning that for some time it was impossible to patch call far, as z is different each time CKPatch is run. However it is now possible for the Galaxy series to use 'relative word' and 'relative long' patches, RW and RL. The patch $12 $34 $56 $78 can thus be presented as $3412W $7856RW or $78563412RL, indicating to CKPatch that the patch is 'relative' and should be adjusted when patching into memory.

== Links ==

[http://www.arl.wustl.edu/~lockwood/class/cs306/books/artofasm/Chapter_6/CH06-5.html] - More information on x86 assembly program control flow instructions.

{{PatchCategories|Tutorial|}}

Patch talk:Game stats

2010-07-15T03:14:11Z

Lemm: reply

Patch talk:Game stats

2010-07-14T01:17:24Z

Lemm: save file

In vorticons, these "item bytes" are the save file (this portion of the game's memory gets written to the disk).
[[User:Lemm|Lemm]] 01:17, 14 July 2010 (GMT)

Patch:Text patches

2010-06-25T16:41:09Z

Lemm: ..

This is a page explaining how text patches work. For more specific patches, such as the About Id text, see the relevant patch page (E.g [[Patch:About Id]]. Specific examples include [[Patch:End text]], [[Patch:Help text]], [[Patch:Story text]]and [[Patch:Ordering info]].

A text patch is a patch that involves changing a string of text in the Keen executable. They differ from other patches in that machine instructions are not being altered, but textual data instead. A text patch has two patchable parts, the text itself, and the reference (or pointer) to the text. Text strings are stored in a region of the keen executable known as the "data segment." The reference to the text, or "pointer," is part of the actual game code, located in a separate segment. The location of the data segment for each Keen game is listed below:

Keen 1: $13050
Keen 2: $17780
Keen 3: $19820
Keen 4: $2EE70
Keen 5: $30340
Keen 6: $30D30
Keen D: $23A70

An example text patch is given below. It patches the name of the saved game files in Keen 3. (The '?' is replaced by the game number, e.g SAVED3.CK3) The first pair of patches changes the actual text in the executable. The second pair changes the values of the pointers. Notice that the two pointers are NOT the absolute location of the text from the beginning of the executable, but that location minus the data segment start (e.g. second patch: $1CA35 - $19820 = $3215).

#Patch the text
%patch $1CA28 "SAVED?." $00 #load game from this filename
%patch $1CA35 "SAVED?." $00 #save game to this filename

#Patch Keen 3 saved game filename
%patch $A2BD $08 $32 #Save game to
%patch $A44D $15 $32 #Load game from

Notice that the string is null-terminated ($00), that is, the byte $00 denotes the end of a string. Also note that a string patched to be longer than the original may overwrite other data in the executible. What this means for our example patch is that we can have some text shorter or the same length as the original. Thus 'SAVE?.' or 'GAME?.' are both ok, but 'SAVEGAME?.' is not. (In fact you will notice that these two pieces of text are almost right after each other.)

The 'newline' character, $0A, means 'go down a line' and is used in longer text patches. While some patches (Simple patches like the above or the [[Patch:Story text]] patch) don't need these, many do. As an example, this is some cheat text from Keen 4, as it is stored in the executable:

#Keen 4 cheat text:
%patch $2F435 "Cheat Option!" $0A $0A
"You just got all" $0A
"the keys, 99 shots," $0A
"and an extra keen!" $00

Here each line ends with $0A, so that the next line starts one line lower. Finally the text is ended with $00. The text has been arranged so this can be seen.

The restrictions on space and format can be annoying and at present there is only two programs that can partially automate some text patches. ([[Startext]] and [[Patchatron]]) It is possible, with some skill, to rearrange text patches to allow yourself more space when patching. (By overwriting useless text or spare space for example.)

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

Patch:Text patches

2010-06-25T16:39:44Z

Lemm: rewrote some stuff

This is a page explaining how text patches work. For more specific patches, such as the About Id text, see the relevant patch page (E.g [[Patch:About Id]]. Specific examples include [[Patch:End text]], [[Patch:Help text]], [[Patch:Story text]]and [[Patch:Ordering info]].

A text patch is a patch that involves changing a string of text in the Keen executable. They differ from other patches in that machine instructions are not being altered, but textual data instead. A text patch has two patchable parts, the text itself, and the reference (or pointer) to the text. Text strings are stored in a region of the keen executable known as the "data segment." The reference to the text, or "pointer," is part of the actual game code, located in a separate segment. The location of the data segment for each Keen game is listed below:

Keen 1: $13050
Keen 2: $17780
Keen 3: $19820
Keen 4: $2EE70
Keen 5: $30340
Keen 6: $30D30
Keen D: $23A70

An example text patch is given below. It patches the name of the saved game files in Keen 3. (The '?' is replaced by the game number, e.g SAVED3.CK3) The first pair of patches changes the actual text in the executable. The second pair changes the values of the pointers. Notice that the two pointers are NOT the location of the text, but the location minus the data segment start (e.g. second patch: $1CA35 - $19820 = $3215).

#Patch the text
%patch $1CA28 "SAVED?." $00 #load game from this filename
%patch $1CA35 "SAVED?." $00 #save game to this filename

#Patch Keen 3 saved game filename
%patch $A2BD $08 $32 #Save game to
%patch $A44D $15 $32 #Load game from

Notice that the string is null-terminated ($00), that is, the byte $00 denotes the end of a string. Also note that a string patched to be longer than the original may overwrite other data in the executible. What this means for our example patch is that we can have some text shorter or the same length as the original. Thus 'SAVE?.' or 'GAME?.' are both ok, but 'SAVEGAME?.' is not. (In fact you will notice that these two pieces of text are almost right after each other.)

The 'newline' character, $0A, means 'go down a line' and is used in longer text patches. While some patches (Simple patches like the above or the [[Patch:Story text]] patch) don't need these, many do. As an example, this is some cheat text from Keen 4, as it is stored in the executable:

#Keen 4 cheat text:
%patch $2F435 "Cheat Option!" $0A $0A
"You just got all" $0A
"the keys, 99 shots," $0A
"and an extra keen!" $00

Here each line ends with $0A, so that the next line starts one line lower. Finally the text is ended with $00. The text has been arranged so this can be seen.

The restrictions on space and format can be annoying and at present there is only two programs that can partially automate some text patches. ([[Startext]] and [[Patchatron]]) It is possible, with some skill, to rearrange text patches to allow yourself more space when patching. (By overwriting useless text or spare space for example.)

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

Talk:Das Viva

2010-05-11T01:19:41Z

Lemm: Created page with 'Download link broken ~~~~'

Download link broken
[[User:Lemm|Lemm]] 01:19, 11 May 2010 (GMT)