KeenWiki - User contributions [en-gb]

User:Fleexy

2024-11-22T22:15:36Z

Fleexy: revert MyMods

Hi there! I'm Fleexy, host of the Keen forums and creator of the Galaxy/Dreams editor '''[[Abiathar]]'''. You might also like to check out my [[Fleex_&_Markeen's_Keen_5_Level_Pack|Keen 5 level pack]] based on Markeen random generation.

User:Fleexy

2022-02-09T16:31:53Z

Fleexy: add Keen 5 level pack

Fleex & Markeen's Keen 5 Level Pack

2022-02-09T16:28:28Z

Fleexy: correct level count and tweak phrasing

{{Stub}}
{{Mod Infobox
| Episode = 5
| Authors = [[User:Fleexy|Fleexy]]
| Status = Complete
| ReleaseDate = 2022-01-01
| Discussion = [https://pckf.com/viewtopic.php?t=12694 PCKF]
| Homepage =
| Levels = 12
| SecretLevels = 0
| NewGameplay = No
| NewGfx = No
| NewLevels = Yes
| NewSfx = No
| NewMusic = No
| LatestDownloadURL = https://files.shikadi.net/keenwiki/Packs/Keen5/l.fleex_&_markeen's_keen_5_level_pack.k5.2022-01-01.zip
| Download =
}}
'''Fleex & Markeen's Keen 5 Level Pack''' is a levelpack created by [[user:Fleexy|Fleex]]. This mod is notable for being based on a tool called [[Markeen]], also by Fleex, which automatically generates random level map structures. Based on the [[Keen_5_Levels|Keen 5 originals]] these raw generated levels have only the foreground layer populated. These levels were then made playable and visually reasonable by Fleex. Care was taken to adhere to the artificially generated specifications as far as possible.

== Example of a randomly generated structure by Markeen ==
The first level map, as seen below, shows the original output of Markeen. The second image represents the finished level design polished by Fleex.

<gallery widths=380px heights=100px>
File:Fleex & Markeen's Keen 5 Level Pack - Level 01 alpha.png | Original output of Markeen
File:Fleex & Markeen's Keen 5 Level Pack - Level 01.png | Overhauled update by Fleex
</gallery>

==Levels==
{{ModLevelList}}

== Technical Information ==

*Utilities used: [[Abiathar]], [[CKPatch]], [[Markeen]]

Patch:Shikadi Mine

2021-12-30T02:44:37Z

Fleexy: add Sprite Activity patch

[[Shikadi Mine]]s are oblong black enemies found in [[Keen 5]]. They are notable for being indestructible and following Keen, detonating when close enough to produce a hail of fragments. Mine also relate to the [[Patch:Quantum Explosion Dynamo (Sprite)|Q.E.D]], as a Shikadi Mine fragment is needed to break it and win the game.

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

Shikadi Mines use sprite type 10 which is used only by the Shikadi Mine and doesn't affect anything else. Their fragments use a different and as yet unknown sprite type.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Shikadi Mine's sprite type
%patch $11C56 $0A #Mines placed in level</syntaxhighlight>

= [[Patch:Galaxy_Sprite_Parameters#Sprite_activity|Sprite Activity]] =

Shikadi Mines have sprite activity 1, being active only when on screen.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Shikadi Mine's sprite activity
%patch $11C5B $01 #Normal activity</syntaxhighlight>

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

The Shikadi Mine is placed in the level changing directions, which is uses to immediately track Keen. It will then go to sitting. When sitting its next action is determined in its code, not action and occurs after a pause. After sitting it goes to its movement sequence, which will go to its direction changing action again.

The Mine will detonate under three circumstances, Keen is close vertically, Keen is close horizontally, or Keen touches the Shikadi Mine. (The third condition is used when the Shikadi Mine is not actively detecting Keen, such as when it is changing direction.) A detonating Mine produces six fragments that move away as speed. The detonation sequence is six actions long. Shikadi Mine fragments quickly vanish.

Actions:
$2608W #Shikadi Mine sit
$2626W #Shikadi Mine move
$2644W #Shikadi Mine change direction
$2662W #Shikadi Mine detonate 1
$2680W #Shikadi Mine detonate 2
$269EW #Shikadi Mine detonate 3
$26BCW #Shikadi Mine detonate 4
$26DAW #Shikadi Mine detonate 5
$26F8W #Shikadi Mine detonate 6
$2716W #Shikadi Mine fragments

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Spawn Mine
%patch $11C82 {$2644W} #Shikadi Mine change direction

#After sitting
%patch $1205B {$2626W} #Mine move

#While sitting
%patch $32964 {$0000W} #Nothing

#While moving
%patch $32982 {$2644W} #Shikadi Mine change direction

#While changing direction
%patch $329A0 {$2608W} #Shikadi Mine sit

#When in-range
%patch $11FF5 {$2662W} #Mine detonate (Touches Keen)
%patch $12187 {$2662W} #Shikadi Mine detonate (When near Keen vertically)
%patch $122A6 {$2662W} #Shikadi Mine detonate (When near Keen horizontally)

#Spawn fragment when detonating
%patch $1240C {$2716W} #Shikadi Mine fragments (When Mine explodes)
%patch $1244F {$2716W} #Shikadi Mine fragments (When Mine explodes)
%patch $12490 {$2716W} #Shikadi Mine fragments (When Mine explodes)
%patch $124D6 {$2716W} #Shikadi Mine fragments (When Mine explodes)
%patch $12509 {$2716W} #Shikadi Mine fragments (When Mine explodes)
%patch $1253F {$2716W} #Shikadi Mine fragments (When Mine explodes)

#While detonating
%patch $329BE {$2680W} #Shikadi Mine detonate
%patch $329DC {$269EW} #Shikadi Mine detonate
%patch $329FA {$26BCW} #Shikadi Mine detonate
%patch $32A18 {$26DAW} #Shikadi Mine detonate
%patch $32A36 {$26F8W} #Shikadi Mine detonate
%patch $32A54 {$0000W} #Shikadi Mine detonate

#Fragment behavior
%patch $32A72 {$0000W} #Shikadi Mine fragments</syntaxhighlight>

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

The Shikadi Mine has four behaviors. The first is sitting; this is used only when the Shikadi Mine is sitting. The second behavior is used by the moving Shikadi Mine only and moves the Shikadi Mine through the air. The third is used when changing directions to get closer to Keen. Finally the fourth destroys the Shikadi Mine and produces its fragments. This is used by the fourth frame of the detonating Shikadi Mine only. Finally the Shikadi Mine fragments themselves use a generic 'fall through the air' behavior.

Behaviors:
$11C4036ARL #Shikadi Mine sit
$11C40507RL #Shikadi Mine move
$11C40626RL #Shikadi Mine change directions
$11C40783RL #Shikadi Mine explode

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Shikadi Mine sit
%patch $32958 $11C4036ARL #Shikadi Mine sit

#Shikadi Mine move
%patch $32976 $11C40507RL #Shikadi Mine move

#Shikadi Mine
%patch $32994 $11C40626RL #Shikadi Mine change directions

#Shikadi Mine explode
%patch $329B2 $00000000L #Nothing (Warning animations)
%patch $329D0 $00000000L #Nothing
%patch $329EE $00000000L #Nothing
%patch $32A0C $11C40783RL #Shikadi Mine explode
%patch $32A2A $00000000L #Nothing
%patch $32A48 $00000000L #Nothing

#Fragments
%patch $32A66 $090B1710RL #Fall</syntaxhighlight>

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

The Shikadi Mine can move in four directions to chase Keen. These consist of a pair of directions, one vertical, one horizontal. At least ONE must be zero in each direction or problems occur. Reversing all of the direction pairs will make the Mine avoid Keen, reversing only the first (Or second) two pairs will make the Mine's movements rather random and hard to predict.

=== Keen seeking ===
<syntaxhighlight lang="asm">
#Seek Keen up
%patch $11D84 $0000W #Horizontal
%patch $11D89 $FFFFW #Vertical

#Seek Keen right
%patch $11DB1 $0001W #Horizontal
%patch $11DB6 $0000W #Vertical

#Seek Keen down
%patch $11DDD $0000W #Horizontal
%patch $11DE2 $0001W #Vertical

#Seek Keen left
%patch $11DDD $0000W #Horizontal
%patch $11DE2 $0001W #Vertical</syntaxhighlight>

== No fragments when Mine explodes ==

This patch makes the Shikadi Mine simply vanish when detonating, no Shikadi Mine fragments are produced.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#No fragments when Shikadi Mine explodes
%patch $12406 $5E $5D $CB</syntaxhighlight>

= [[Patch:Sprite speed|Speed]] =

The Shikadi Mine's speeds are set in its code and cannot yet be patched. Its animation motion is unused. See also the 'seek Keen' section above for what makes the Mine chase Keen.

=== Animation motion ===
<syntaxhighlight lang="asm">
#Shikadi Mine sit
%patch $32954 [$0000W $0000W]

#Shikadi Mine move
%patch $32972 [$0000W $0000W]

#Shikadi Mine change directions
%patch $32990 [$0000W $0000W]

#Shikadi Mine detonate
%patch $329AE [$0000W $0000W]
%patch $329CC [$0000W $0000W]
%patch $329EA [$0000W $0000W]
%patch $32A08 [$0000W $0000W]
%patch $32A26 [$0000W $0000W]
%patch $32A44 [$0000W $0000W]

#Fragments
%patch $32A62 [$0000W $0000W]</syntaxhighlight>

== Stop Mine moving ==

This patch makes the Mine sit perfectly still at all times.

=== Stop Mine moving ===
<syntaxhighlight lang="asm">
#Stop Mine moving
%patch $11D1B $90 $90</syntaxhighlight>

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

The Mine's collision is quite simple and it what lets it explode if Keen touches it quickly. If its collision is removed or replaced with a generic lethal one it is less dangerous.

== Collision values ==

The Shikadi Mine uses its own special collision for everything except after it has exploded, when it uses a generic 'kill Keen and block his shots' collision. Notice however that the Shikadi Mine fragments have their own special collision, one that can destroy the [[Patch:Quantum Explosion Dynamo (Sprite)|Q.E.D]] and win the game. If this is changed the game may become unwinnable.

=== Keen 5 collision values ===
<syntaxhighlight lang="asm">
#Shikadi Mine sit
%patch $3295C $11C4043ERL #Shikadi mine

#Shikadi Mine move
%patch $3297A $11C4043ERL #Shikadi mine

#Shikadi Mine change direction
%patch $32998 $11C4043ERL #Shikadi mine

#Shikadi Mine explode
%patch $329B6 $11C4043ERL #Shikadi mine
%patch $329D4 $11C4043ERL #Shikadi mine
%patch $329F2 $11C4043ERL #Shikadi mine
%patch $32A10 $11C4043ERL #Shikadi mine (Explodes here)
%patch $32A2E $11C40D61RL #Kill and block shots
%patch $32A4C $11C40D61RL #Kill and block shots

#Shikadi Mine fragments
%patch $32A6A $11C40456RL #Shikadi mine fragments (Destroys Q.E.D)</syntaxhighlight>

== Collision codes ==

The only thing that the moving Shikadi Mine reacts to is Keen's shot, destroying it. (The Mine is actually safe to touch until its detonation sequence.)

The exploding Mine is similar except it reacts also to Keen, killing him on contact.

=== Moving Mine collision ===
<syntaxhighlight lang="asm">
#Moving Mine collision code
%patch $1207E $55 $8B $EC $56 $8B $76 $08 $83 $3C [$03] {$75} $09 $56 $9A $0CCB10B3RL
$83 $C4 $02 $5E $5D $CB</syntaxhighlight>

=== Exploding Mine collision ===
<syntaxhighlight lang="asm">
#Exploding Mine collision code
%patch $129A1 $55 $8B $EC $56 $8B $76 $08 $83 $3C [$03] {$75} $0C $56 $9A $0CCB10B3RL
$83 $C4 $02 $5E $5D $CB $83 $3C [$02] {$75} $05 $9A $0AAF1517RL
$5E $5D $CB</syntaxhighlight>

=== Mine Fragment collision code ===

This is the Shikadi Mine Fragment's collision, it wins the game. On the first line Keen's shot is checked for; if found the Fragment blocks it. On the third line Keen is searched for, if found the 'kill Keen' code is run.

On the fourth line the QED's type is checked for. If a Fragment hits the QED it will win the game (Or if not in the QED level, smash a fuse and win the level.) The first few lines produce four smashed fuse sprites at different locations in a square pattern.

On line 8 the QED's tiles are replaced in two chunks. Each calls a 2x4 chunk of tiles copied from 0x0 and 0x4 placed at Bx10 and Dx10 in the level. After that the QED sprite is erased and the 'Fuse\QED bust' code called to win the level or game.

=== Mine Fragment Collision ===
<syntaxhighlight lang="asm">
#Mine fragment collision
%patch $12096 $55 $8B $EC $56 $8B $76 $08 $83 $3C [$03] {$75} $0C $56 $9A $0CCB10B3RL
$83 $C4 $02 $5E $5D $CB
$83 $3C [$02] {$75} $08 $9A $0AAF1517RL $5E $5D $CB
$83 $3C [$19] {$74} $03 $E9 $0081W $FF $74 [$2E]
$FF $74 [$2C] $9A $0F920628RL $83 $C4 $04 $FF $74 [$2E] $FF $74
[$30] $9A $0F920628RL $83 $C4 $04 $FF $74 [$32] $FF $74 [$2C] $9A
$0F920628RL $83 $C4 $04 $FF $74 [$32] $FF $74 [$30] $9A $0F920628RL
$83 $C4 $04 $B8 [$0002W] $50 $B8 [$0004W] $50 $B8 [$000BW]
$50 $B8 [$0010W] $50 $33 $C0 $50 $50 $9A $174E0D75RL $83 $C4
$0C $B8 [$0002W] $50 $B8 [$0004W] $50 $B8 [$000DW] $50 $B8 [$0010W]
$50 $33 $C0 $50 $B8 [$0004W] $50 $9A $174E0D75RL $83 $C4 $0C
$9A $0F920677RL $56 $9A $06B91E47RL $83 $C4 $02 $5E $5D
$CB</syntaxhighlight>

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

The Shikadi Mine's animations are simple, yet complex. The Mine itself is a single animation for all of its actions until it detonates. Then it uses two different animations as it prepares to explode followed by two more ''as'' it explodes. Mine fragments use a single animation. The animation speeds of the detonation sequence control how long Keen has to escape a detonating Mine.

The Mine's eye is a secondary animation and it works in a poorly understood manner. See the 'sprite positioning' section below.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Cache
%patch $31A38 [$017AW] #Mine cache start
%patch $31A8C [$0180W] #Cache end

#Shikadi Mine eye animation:
%patch $1257A [$017BW]

#Shikadi mine sit
%patch $32948 $017AW $017AW #Shikadi mine
%patch $32952 $0008W #Reaction speed

#Shikadi mine move
%patch $32966 $017AW $017AW #Shikadi mine
%patch $32970 $0000W #Wait

#Shikadi mine change directions
%patch $32984 $017AW $017AW #Shikadi mine
%patch $3298E $0000W #Wait

#Shikadi mine explode
%patch $329A2 $017CW $017CW
%patch $329AC $000AW #Animation speed
%patch $329C0 $017DW $017DW
%patch $329CA $000AW #Animation speed
%patch $329DE $017CW $017CW
%patch $329E8 $000AW #Animation speed
%patch $329FC $017DW $017DW
%patch $32A06 $000AW #Animation speed
%patch $32A1A $017EW $017EW #Shikadi mine explodes here
%patch $32A24 $0014W #Animation speed
%patch $32A38 $017FW $017FW
%patch $32A42 $0014W #Animation speed

#Mine fragments
%patch $32A56 $0180W $0180W
%patch $32A60 $0008W #Animation speed</syntaxhighlight>

== Only the Mine's eye appears ==

This patch removes the 'primary' Mine animations, leaving only the Mine's eye animation. It may cause some problems. Notice also that the Mine's primary animation still matters, it must be cached and determines the eye positions (See section below.) Setting it to say, Keen's standing frame works well.

=== Only the Mine's eye appears ===
<syntaxhighlight lang="asm">
#Only the Mine's eye appears
%patch $12562 $75</syntaxhighlight>

== Exploding Mine leaves empty Mine animation behind ==

This patch makes it such that when the Mine explodes, its explosion frames appear behind an eyeless moving Mine frame, which is left suspended in the air after the Mine has exploded, unmoving and inactive. (Not deadly.) It may have unusual side effects.

=== Exploding Mine leaves empty Mine animation behind ===
<syntaxhighlight lang="asm">
#Exploding Mine leaves empty Mine animation behind
%patch $12567 $00</syntaxhighlight>

== Mine's eye remains after it explodes ==

This patch is similar to the above, except it is the Mine's eye that is left behind after it explodes.

=== Mine's eye remains after it explodes ===
<syntaxhighlight lang="asm">
#Mine's eye remains after it explodes
%patch $1218F $90 $90 $90 $90 $90
%patch $122AE $90 $90 $90 $90 $90</syntaxhighlight>

== Don't show Mine's eye ==

This patch removes the Mine's eye. Alternatively the Mine's tile interactions can be changed to $090B17B5RL, freeing up $1254E-$1259B.

=== Don't show Mine's eye ===
<syntaxhighlight lang="asm">
#Don't show Mine's eye
%patch $12572 $5E $5D $CB</syntaxhighlight>

= [[Patch:Sprite Sounds|Sounds]] =

The Shikadi Mine makes two identical sounds, the first when Keen triggers its exploding and the second when it actually detonates. If the player listens carefully he can hear this '1-2' pattern. It is possible that the developers intended to have the Mine make an 'activated' sound to warn the player before detonating.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Shikadi Mine explode sounds
%patch $11FE7 $05 #When activated
%patch $123CB $05 #When exploding

#Don't play Shikadi Mine explode sounds
%patch $11FE6 $EB $0A #When activated
%patch $123CA $EB $0A #When exploding</syntaxhighlight>

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

The Mine spawns 15 pixels higher than where it is placed. This is important as it 'aligns' the Mine with tiles so that it can seek Keen correctly. If it is otherwise the Mine will need to 'correct' itself when placed, which takes time.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Spawn height
%patch $11C72 $FF0FW #15 pixels up</syntaxhighlight>

== Mine's eye positions ==

The Mine's eye's position is important. There are several positions that the eye sits in when the Mine is moving in various directions (Or turning.) While the eye is moving between positions the Mine cannot move, if something is patched wrong and the eye cannot move to a position, the Mine will freeze.

The main thing to remember is that there are two sets of three positions, left-mid-right and up-mid-down. The middle value of both these triplets ''must be the the exact mid value of the two other values.'' These mid values ''must'' then be used for the horizontal and vertical turning positions respectively. (and should, but not must, be used for the initial eye positions.)

An example triplet is the left-mid-right triplet. ($0050 + $0150) / 2 = $00D0. The positions are from the top left of the Mine's primary animation, in pixels. The less an eye moves, the faster the Mine turns. It is often simple to simply halve, double, add $10 to all values instead of starting from scratch when altering eye movement amounts.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Initial: (Don't actually have to be midpoints, but are by default)
%patch $11C7A [$0100W] #Horizontal (Is l/r midpoint)
%patch $11C7F [$00D0W] #Vertical (Is u/d midpoint)

#Turning (Eye moves here before moving to new position, must be midpoints)
%patch $121A3 [$0100W] #Horizontal (Is l/r midpoint)
%patch $121A8 [$00D0W] #Vertical (Is u/d midpoint)

#When chasing Keen horizontally
%patch $122D5 [$0080W] #Moving left
%patch $122DA [$0100W] #Midpoint, l/r
%patch $122DF [$0180W] #Moving right

#When chasing Keen vertically
%patch $122F7 [$0050W] #Moving up
%patch $122FE [$00D0W] #Midpoint, u/d
%patch $12305 [$0150W] #Moving down</syntaxhighlight>

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

The Shikadi Mine has three tile collisions, The main collision is used for the Mine sitting, moving and turning. This is responsible for drawing its eye. When detonating it uses a generic 'blocked by solid tiles' collision. Finally the Mine fragments have their own special collision allowing them to bounce off of solid tiles.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Shikadi Mine sit
%patch $32960 $11C4090ERL #Shikadi Mine

#Shikadi Mine move
%patch $3297E $11C4090ERL #Shikadi Mine

#Shikadi Mine changing direction
%patch $3299C $11C4090ERL #Shikadi Mine

#Detonate
%patch $329BA $090B17B5RL #Solid
%patch $329D8 $090B17B5RL #Solid
%patch $329F6 $090B17B5RL #Solid
%patch $32A14 $090B17B5RL #Solid
%patch $32A32 $090B17B5RL #Solid
%patch $32A50 $090B17B5RL #Solid

#Fragments
%patch $32A6E $0F920119RL #Explosion fragments</syntaxhighlight>

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

The Mine uses type 2 for all its moving actions, since it must respond instantly to Keen and move smoothly. This is used by the Mine fragments as well. The exploding Mine uses type 0, since all it has to do is sit there.

=== Keen 5 Motion ===
<syntaxhighlight lang="asm">
#Shikadi Mine sit
%patch $3294C [$0002W]

#Shikadi Mine move
%patch $3296A [$0002W]

#Shikadi Mine change direction
%patch $32988 [$0002W]

#Shikadi Mine explode
%patch $329A6 [$0000W]
%patch $329C4 [$0000W]
%patch $329E2 [$0000W]
%patch $32A00 [$0000W]
%patch $32A1E [$0000W]
%patch $32A3C [$0000W]

#Shikadi Mine Fragments
%patch $32A5A [$0002W]</syntaxhighlight>

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

The Shikadi Mine uses values of 0 for both these parameters as it does not need either of them.

=== Keen 5 Change Motion ===
<syntaxhighlight lang="asm">
#Shikadi Mine sit
%patch $3294E $0000W $0000W

#Shikadi Mine move
%patch $3296C $0000W $0000W

#Shikadi Mine change direction
%patch $3298A $0000W $0000W

#Shikadi Mine explode
%patch $329A8 $0000W $0000W
%patch $329C6 $0000W $0000W
%patch $329E4 $0000W $0000W
%patch $32A02 $0000W $0000W
%patch $32A20 $0000W $0000W
%patch $32A3E $0000W $0000W

#Shikadi Mine Fragments
%patch $32A5C $0000W $0000W</syntaxhighlight>

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

Only partial spawning code is available for the Mine. Notice there are three types of Mine, one for each difficulty. The cache is set in <tt>$C7 $06 $C28BW $0001W</tt>.

The last blue highlighted value is the [[Patch:Sprite actions|sprite action]] the sprite uses as it proceeds to act in-level. <tt>$C7 $47 $02 $xxxxW</tt> sets the [[Patch:Sprite Activity Variable|sprite activity]], <tt>$C7 $47 $06 $xxxxW</tt> sets the [[Patch:Sprite clipping and foreground|clipping,]] <tt>$C7 $07 $xxxxW</tt> sets the [[Patch:Sprite type|sprite type,]] Finally <tt>$D3 $E0 $05 $xxxxW</tt> is how far down (Or more usually ''up'') the sprite is spawned from where it is placed. This is necessary for sprites that walk on the ground as they can only be placed in the level at multiples of 16 pixels high while their actual height can be anything.

The Mine is unusual in that after it is spawned there is code that sets up its initial direction and eye position, in effect initializing it to move.

=== Keen 5 ===
<syntaxhighlight lang="asm">
#Location of initiation code
%patch $F4D2 [$21CW] #Easy Mine (At $EF6C)
%patch $F4D4 [$212W] #Normal Mine (At $EF62)
%patch $F4D6 [$208W] #Hard Mine (At $EF58)

#Mine Initiation code
%patch $EF58 $83 $3E {$6F6CW} [$03] {$7D} $03 $E9 $0445W $83 $3E {$6F6CW} [$02] {$7D}
$03 $E9 $043BW $57 $56 $9A $11C40001RL $83 $C4 $04 $C7 $06
$C28BW $0001W $E9 $0428W

#Mine spawning code
%patch $11C41 $55 $8B $EC $56 $33 $C0 $50 $9A $06B91DCDRL $83 $C4 $02 $8B
$1E $40 $9E $C7 $07 [$000AW] $C7 $47 $02 [$0001W] $C7 $47 $06 [$0000W]
$8B $46 $06 $B1 $08 $D3 $E0 $89 $47 $0A $8B $46 $08 $D3 $E0
$05 [$FF0FW] $89 $47 $0C $C7 $47 $40 [$0100W] $C7 $47 $42 [$00D0W]
$B8 [$2644W] $50 $53 $9A $090B11C4RL $83 $C4 $04 $8B $1E $40
$9E $C7 $47 $16 [$0100W] $33 $F6 $EB $12 $56 $FF $36 $40 $9E $90
$0E $E8 $0095W $83 $C4 $04 $0B $C0 $75 $06 $46 $83 $FE $03 $7E
$E9 $5E $5D $CB</syntaxhighlight>

= Walk: Bad dir =

This error occurs when a Mine moves in an 'incorrect' direction. This should only occur if the default Shikadi Mine code has been tampered with somehow or another patch is massively incorrect. It causes the game to cash with an error message.

=== Shikadi Mine error ===
<syntaxhighlight lang="asm">
#Keen 5 :
%patch $11E23 [$31A4W] #Text called from
%patch $334E4 "Walk: Bad dir" $00</syntaxhighlight>

{{PatchCategories|Keen 5|}}
{{PatchCategories|Sprite|}}

User:Fleexy

2021-10-10T13:42:03Z

Fleexy: remove MyMods to focus on my recent/high-quality contributions

Hi there! I'm Fleexy, host of the Keen forums and creator of the Galaxy/Dreams editor '''[[Abiathar]]'''—check it out!

TliExtend

2018-04-15T18:47:36Z

Fleexy: grammar, removed outdated note

<onlyinclude>{{Tool Infobox|{{{1|}}}
| TitleImage = Abiathar.png
| InitialDeveloper =
| Developers = [[User:Fleexy|Fleexy (Ben Nordick)]]
| InitialRelease = 2015-06-25
| LatestUpdate = 2015-09-03
| Status = Beta
| ProgrammingLanguage =
| Platform = CLI
| License = Copyright © 2015 by Ben Nordick. All Rights Reserved.
| Type = Tileinfo Extender
| Engine = Keen:Galaxy, Keen:Dreams, Bio Menance
| Homepage = https://abiathar.keenmodding.org
| Discussion =
| LatestDownloadURL = https://abiathar.keenmodding.org/TliExtend.exe TliExtend v.2
| Download = [http://www.shikadi.net/wiki/files/tools/t.tliextend_v.2.fleexy.2015-09-03.zip Mirror Download]
}}</onlyinclude>

'''TliExtend''' is a command line based tileinfo extension utility for the level editor [[Abiathar]]. It was built by [[User:Fleexy|Fleex]] to fix the tileinfo file after the respective tilesets were resized. This tool comes in handy especially when working on a source code-based mod.

== About ==

The tileinfo format is planar, so the information for each tile is spread out all over the file, and at offsets determined by the number of tiles in the file. Therefore, it can't just be extended by writing a bunch of zeros at the end; the spaces for the new tiles have to be inserted throughout the file. That would, of course, be very painful to do by hand in a hex editor.

== Features ==

* Built-in help (try invoking it without any arguments)
* Can remove (truncate) tiles, and will ask for confirmation before doing so
* Supports merged maphead/tileinfo files with an optional argument

== Usage ==

The syntax of <tt>TliExtend</tt> is fairly simple; it takes six or seven command-line arguments, in this order:

* existing tileinfo file name
* current number of background tiles
* current number of foreground tiles
* output tileinfo file name
* new number of background tiles
* new number of foreground tiles
* optionally, length of non-tileinfo (MAPHEAD) data in the existing file

'''Note''': 
This build requires <tt>FMod.dll</tt>, which is included with Abiathar.

== See also ==

{|
|-
|Needed Level Editor:
|[[Abiathar]]
|-
|List of Galaxy Tools:
|[[Galaxy_Tools|Modding tools]]
|}

== External Links ==

* [https://fleexlab.blogspot.de/2015/09/tliextend-2.html Development blog]

[[Category:Modding Tools (Galaxy)]]
[[Category:Level Editors (Galaxy)]]

User:Fleexy

2017-11-19T18:01:18Z

Fleexy: host of the forums

Hi there! I'm Fleexy, host of the Keen forums and creator of the Galaxy/Dreams editor '''[[Abiathar]]''' - check it out!

Abiathar

2017-06-01T23:06:53Z

Fleexy: slight terminology adjustments

<onlyinclude>{{Tool Infobox|{{{1|}}}
| TitleImage = Abiathar.png
| InitialDeveloper =
| Developers = [[User:Fleexy|Fleexy (Ben Nordick)]]
| InitialRelease = 2014-03-14
| LatestUpdate = 2017-03-24
| Status = Finished
| ProgrammingLanguage =
| Platform = Windows XP, 7-10
(Linux via Wine+Mono/ Wine+.NET !unstable)
| License = Copyright © 2014 by Ben Nordick. All Rights Reserved.
| Type = Level Editor
| Engine = Keen:Galaxy, Keen:Dreams, Bio Menance
| Homepage = https://abiathar.keenmodding.org
| Discussion = [https://pckf.rigeltechnical.com/viewtopic.php?t=3023 PCKF Discussion Thread]
| LatestDownloadURL = https://abiathar.keenmodding.org/update/v2.8.8/Abiathar.zip Abiathar 2.8.8
| Download = [http://www.shikadi.net/wiki/files/tools/t.abiathar_updater.fleexy.2014-06-08.zip Update client]
}}</onlyinclude>

'''Abiathar''' is a Windows-based [[Galaxy_Tools#Level_Editors|level and tileinfo editor]] for [[Keen Dreams]] and [[Keen Galaxy]]. It was developed by [[User:Fleexy|Fleexy]] starting on January 10, 2014 and publicly released on [[Keen Day]] 2014. It continues to be updated and altered semi frequently, as new features and functionality are added. Abiathar is very similar to [[The Omegamatic|The Omegamatic/Tom]] editor but contains many additional features.

== Innovations and Improvements ==
This lists only the additional features to the already seen features in other level editors (like [[TED5]], [[Keen: Next]], [[The Photachyon Transceiver]], [[The Omegamatic]])

=== Features ===
[[Image:Abiathar6.png|thumb|400px|'''Abiathar''' with some possible features shown.]]
*Internally stored default resources
*Tileinfo editing
*Tileinfo overlay
*Direct EGA graphics reading (no external exported graphics needed)
*Conglomerate file handling
*Inspectors (e.g.: crash, bugs)
*Sound management (adding IMF tracks, editing sounds, setting level songs)
*Automatic patch/batch generation
*Combinable infoplane
*Custom, separate infoplane icons
*Single-level export/import
*Customizable config file settings
*Extension API
*Auto-updater

=== Tools ===
*Path Plotter
*Tile Instance Remapper
*Tile Tweaker
*Freeform Tile Placer
*Row/Column Adjuster

== Usage ==
With the download comes a [https://docs.google.com/viewer?url=https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharHelp.pdf Documentation/Help file] which is strongly recommended. It contains advanced information this wiki entry cannot match.
The Author also uploaded a [https://www.youtube.com/playlist?list=PL-BuW7CehquocWygorgyo5YjJwiK5-kyn video tutorial] where most of the basic features are examined.
[[Image:Abiathar-Wizard.png|thumb|250px|'''Abiathar''' Project Wizard.]]

=== Setting up Abiathar ===
To get started open up Abiathar with the defaults. Go to <code>File</code>, <code>New</code>, a Project Wizard appears. This wizard will walk you through the creation of your dependency file (project). Select your episode from the drop-down in the upper right, check all the boxes (those are what tell it to use defaults), set the tileinfo drop-down to one that either dumps or reads from memory, and click <code>Finish</code>. Abiathar will now become usable for editing.

=== Navigation through Abiathar ===
In Abiathar one can move throughout the level with the help of the keyboard and the scroll wheel.
{|
|-
|Keyboard
|<code>Arrow keys</code> move the viewer 1 tile Holding <code>Control</code> changes the offset to 5 Holding <code>Shift</code> multiplies the offset by 3 Pressing <code>Backspace</code> moves back to the upper left
|-
|Scroll wheel
|Each notch of the wheel moves 2 tiles vertically Holding <code>Control</code> makes it move horizontally
|-
|Zoom
|The zoom controls can be found under the <code>View menu</code> or by using the <code>+</code> and <code>–</code> numpad keys.
|}

=== Common Tasks ===
[[Image:Abiathar4.png|thumb|400px|'''Abiathar''' with all planes activated.]]
This section guides only through the most frequently used features.

==== Tile Palette ====
The tile palette can be called either with the <code>Tileset menu</code> or by pressing the appropriate <code>number key</code> after pressing <code>Space</code>, which switches to the tile palette view: <code>1</code> calls the background set, <code>2</code> calls the foreground set, <code>3</code> calls the set of infoplane pseudo-tiles.
 Simply click a tile to copy it to the respective bay. When finished, press <code>Space</code> to return to your level. If you do not want to press Space to access the palettes, you may at any time press:
 <code>7</code> to open the background palette, <code>8</code> for the foreground, or <code>9</code> for the infoplane.

==== Plane States ====
[[Image:Abiathar3.png|thumb|400px|'''Abiathar''': Background plane ''activated'', Foreground plane ''hidden'', Infoplane ''locked'' .]]
Editing with all planes active all the time would be very difficult. To help you see and change only what you want to, Abiathar has several systems to control the status of the planes. Each of the three planes can hold one of three states:
{|
|-
|<code>Active</code>
|visible and editable (default)
|-
|<code>Locked</code>
|only visible
|-
|<code>Hidden</code>
|not visible or editable
|}

These can be controlled in several ways. The <code>Plane</code> menu provides fine-adjustment tools and commands to modify the state of multiple or all the planes at once.
While viewing a level, the <code>1</code>-<code>3</code> keys control editibility for the respective plane, while the <code>4</code>-<code>6</code> keys control visibility. For example, the <code>2</code> key toggles the foreground plane between <code>Active</code> and <code>Locked</code>, while the <code>4</code> key toggles it between <code>Active</code> and <code>Hidden</code>.
The labels in the selected tile bay that display the plane states can also change them. Right-click one to make it less active (active will become locked, locked will become hidden) or left-click to make it more active (hidden will become locked, locked will become active).

==== Undo & Redo ====
Undo and Redo can be found under the <code>Edit menu</code> or pressing <code>Z</code> instead. The undo/redo action stack is preserved until the file is saved or closed.

==== Level Operations ====
[[Image:Abiathar7.png|thumb|400px|'''Abiathar''': Link and tile properties overlays are activated]]
Level Operations can be accessed from the <code>Level menu</code>, above the levels list. Adding a level is done with <code>Level</code> → <code>Add</code>. If one changes the suggested ID to one that is in-use, a warning will pop up before overwriting. The <code>Automatic edge</code> check box will cause Abiathar to automatically fill in the boundary. 
Even after a level is created, its dimensions can be changed or an automatic border can be added using the using the <code>Level</code> → <code>Properties</code> dialog. It is also possible to duplicate levels into a new slot with <code>Level</code> → <code>Copy</code>.

==== Overlays ====
All overlays can be found under the <code>View menu</code> section.

{|
|<code>Grid</code>
|separating the tiles (it is automatically adjusted for changes in zoom level)
|-
|<code>Links</code>
|overlay processes unknown infoplane values and renders graphical links instead of infoplane
|-
|<code>Tile Properties</code>
|displays foreground tile properties even in the selected tile bay and tile palette
|}
 
 
=== Playing edited Levels ===
[[Image:Abiathar-Patches.png|thumb|380px|'''Abiathar''' inserting Patches.]]
Once some work has been done on a level set, it is advisable to test them in-game. This, and the final publication of the mod, require the use of <tt>CKPatch</tt> to patch the <tt>maphead</tt> (and, if they exist, <tt>mapdict</tt> and
<tt>tileinfo</tt>) back into the game to read the modified <tt>gamemaps</tt> file.

Other custom patches that are not automatically generated by Abiathar, can be transfered to the <code>Patches</code> store found under <code>Edit</code>. Therefor all things which are listed the text field above need to be remove from the custom patches. Now Abiathar will integrated them into the generated patch file. Once confirmed that, the appropriate <tt>patch</tt>, <tt>batch</tt>, and <tt>patcher</tt> program files will be created in the dependency file’s directory. The now created <tt>play.bat</tt> launcher file needs to be run instead of the original Keen executable.
[[Image:Abiathar-Files.png|thumb|280px|'''Abiathar''' creates and saves <tt>CK*PATCH.EXE abiathar.pat, play.bat</tt>.]]

iD Software used a self-extracting compression format called LZEXE on the program to make it smaller, thereby fitting it on a floppy disk. Before <tt>CKPatch</tt> can work, the Keen executable must be decompressed. Abiathar contains <tt>[[UNLZEXE]]</tt>, a program to reverse the compression. Choose <code>Un-LZ EXE</code> under <code>File</code> and open the Keen executable. If it was <tt>LZ-compressed</tt> Abiathar will decompress it.

=== Files and Storage ===
To storage modifications press <code>Save</code> under <code>File</code>. The first time doing this, one popup box will appeare, asking where to store the
dependency file. The level set's settings will be written to an <tt>*.adeps</tt> file, which only contain references and pointers to the real resources files, but don’t store any level data on their own. They are automatically saved as the names beforehand specified in the New Project Wizard. 
Closing Abiathar for the first time, quite a few settings will get saved to the <tt>editor.aconf</tt> config file. Those settings are loaded when Abiathar starts.

== See also ==
{|
|-
|former Level Editors: 
|[[TED5]], [[Keen: Next]], [[The Photachyon Transceiver]], [[The Omegamatic]]
|-
|List of Galaxy Tools:
|[[Galaxy_Tools|Modding tools]]
|-
|Modding Tutorials: 
|[[Keen Galaxy Modding Tutorial (by Ceilick)]], [[Keen Galaxy Modding Tutorial (by Levellass)]], [http://stefan.lohner-net.de/keen_modding/tutorial/ Keen Galaxy Modding Tutorial (by TheMagician)]
|-
|Patching Tutorial:
|[[Patching Tutorial (by Levellass)]]
|}

== External Links ==
* [https://docs.google.com/viewer?url=https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharHelp.pdf Abiathar Help File]
* [https://www.youtube.com/playlist?list=PL-BuW7CehquocWygorgyo5YjJwiK5-kyn Abiathar Video Tutorial]
* [https://pckf.rigeltechnical.com/viewtopic.php?t=3023 Abiathar Forum Thread]
* [https://pckf.rigeltechnical.com/viewtopic.php?t=3228 Abiathar Operating System]
* [http://fleex255.github.io/Abiathar-Online/start.html Abiathar Online (web-based)]


[[Category:Modding Tools (Galaxy)]]
[[Category:Level Editors (Galaxy)]]

Patch:Korath

2016-06-03T00:47:14Z

Fleexy: /* Vertical position of Korath base */ Patch for level name change's cutoff

Korath is the secret level in [[Keen 5]] in the lower right half of the map. One can get to it by using the teleporter in the [[Gravitational Damping Hub]]. For patches relating to the small korath sprite see [[Patch:Korath (Sprite)]].

There is also text for when Keen returns to the map, but is 'on Korath'

= Level name and entry text =

This is the name of the Korath level and its entry text. Note that when exiting the level Keen gets a different message than the one he usually gets when returning to the map. This is controlled by Keen's vertical position on the map. (See below.)

<patch title="Keen 5">
#Level name
%patch $201C0 "Korath III Base" $00

#Level entry text
%patch $20470 "Keen faces danger" $0A
"in the secret $0A
"Korath III Base" $00

#Used when Keen exits Korath level
%patch $6214 [$0223W] #Text called from
%patch $30563 "Keen steps out" $0A
"onto Korath III" $00</patch>

== Vertical position of Korath base ==

If Keen is vertically lower on the map than 100 tiles he will see a different message when returning to the map and a different level name in the status screen. By default, the alternate values are displayed when his position is below 100 ($64). (See also [[Patch:Jump conditions]].)

<patch title="Keen 5">
#Vertical position of Korath base
%patch $6210 [$64] {$76} #Returning to map
%patch $7CE8 [$64] {$76} #Level name</patch>

= Korath fuse =

To get the special ending, the game checks the "completed" value for the Korath level. If it is 15 (special fuse value), then it plays the special ending, otherwise the normal one. In the patches below, 0 is incomplete and 1 is normal complete. It pays off to know something about [[Patch:Jump conditions]].

<patch title="Keen 5">
#Korath level
%patch $EC31 $36 #Level 13 (28 + (2 * 13) = 36</patch>

== Get special ending by just completing Korath level ==

This patch alters things so that the special ending of the game plays if the player has completed the Korath level in nay way, wither by breaking the fuse or just exiting.

<patch title="Keen 5">
#You get the Korath fuse ending just for completing Korath, fuse or not
%patch $EC33 [$01] $72
%patch $EC31 $36 #Level 13 (28 + (2 * 13) = 36)</patch>

The Korath fuse is also special. It can only be broken with a very high pogo jump, that is, only on easy by default. The only way to fix this is to alter the fuse to not be special, or to alter Keen's pogo height so that it is the same on all three difficulties.

== Level Korath fuse message appears in ==

The level that the Korath fuse text appears in is separate from that checked for the game ending, though by default they are the same.

<patch title="Keen 5">
#Level that causes Korath text to be read:
%patch $F8AC [$0D] {$75}</patch>

{{PatchCategories|Keen 5|}}
{{PatchCategories|Text|}}
{{PatchCategories|Tiles|}}

Magic Eyeball

2015-03-29T18:04:39Z

Fleexy: Corrected point value

{{Stub}}

{{Item Infobox
| Appears = [[Keen Dreams]]
| Points = 10000
| Ammo = 8
| Life = Yes, 3
}}

The '''Magic Eyeball''' is an item found twice in [[Keen Dreams]]. It gives three extra lives and eight [[Flower Power]]s. It is the single rarest item, and its appearance in [[Tuberia]] is anomalous; it is not known what it is, where it came from, or what it does. It can only be assumed that, since Tuberia is a dream world, strange things may appear in it.

It can be found in a chamber of [[Melon Mines]] filled with [[Tomatooth]], and also hidden underground close to a water current in [[Spud City]].

[[Category:Items]]
[[Category:Keen Dreams items]]
[[Category:Weapons]]

Patch:Music

2014-08-13T19:47:57Z

Fleexy: /* Keen Galaxy Level songs */ Added music table length patch for Keen 6

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]] or [[Patch:Computer_Wrist#Play_music_in_help|computer wrist]], see the pages for details.

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

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

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

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

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

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

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

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

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

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

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

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

<patch title="Keen 6">
%patch $8A88 $14 #Total number of level entries

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

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

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

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

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

== Music and extra levels ==

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

== Create a secondary song list ==

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

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

<patch title="New song list">
#Disable EGAGRAPH check (Frees 389 bytes at $3CF6)
%patch $3CE5 $90 $90

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

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

<patch title="Optional uses of new Keen 4 song list">
#Use new list in story demo
%patch $5835 $B8 [$0001W] $50 $9A $037D0526RL

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

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

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

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

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

== Insufficient Memory to play music error ==

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

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

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

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

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

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

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

<patch title="Insufficient memory to play music">
#Keen 4 :
#Insufficient memory to play music window
%patch $8D30 [$06ECW] #Text called from
%patch $2F55C "Insufficient memory" $0A
"for background music!" $00

#Keen 5 :
#Insufficient memory to play music window
%patch $8CA2 [$065EW] #Text called from
%patch $3099E "Insufficient memory" $0A
"for background music!" $00

#Keen 6 :
#Insufficient memory to play music window
%patch $8B0A [$0656W] #Text called from
%patch $31386 "Insufficient memory" $0A
"for background music!" $00</patch>

== Don't play music ==

These patches remove music from playing or changing in given situations. For disabling music in a level the best option is to create an 'empty' song with no sound and use that as the level music.

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

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

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

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

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

Abiathar

2014-08-04T14:02:26Z

Fleexy: Added v2.0 links (not local because it won't let me upload non-images)

{{Stub}}
[[Image:Abiathar.png|thumb|320px|'''Abiathar''', displaying tile properties on the [[Keen 4]] world map.]]
Abiathar is a Windows-based level and tileinfo editor for Keen Dreams and Keen Galaxy. It was developed by Fleexy starting on January 10, 2014 and publicly released on Keen Day 2014.

== Download ==
* [https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharUpdater.exe Update client] (downloads newest version)

'''Newest standalone version:'''
* [https://dl.dropboxusercontent.com/u/3771470/Abiathar/v2.0/Abiathar.zip Version 2.0]

'''Earlier versions:'''
* [http://www.shikadi.net/wiki/files/tools/abiathar_v1.4.zip Version 1.4]
* [http://www.shikadi.net/wiki/files/tools/abiathar_v1.3.2.zip Version 1.3.2]
* [http://www.shikadi.net/wiki/files/tools/abiathar_v1.0.zip Version 1.0]

[[Category:Modding Tools (Galaxy)]]
[[Category:Level Editors (Galaxy)]]

Talk:The Melon Mines

2014-06-06T17:24:01Z

Fleexy: Asked about wrong infobox FP

The image extends out of the infobox and into the text (in front in IE, behind in FF). Is there any way of fixin this? -- [[User:DHeadshot|DHeadshot]] 10:22, 17 December 2009 (GMT)

The infobox states that 33 Flower Power are present, but [[Abiathar]] (versions v1.3.2 and unreleased v1.4) counts 53. Could someone verify this before I update the infobox or start ripping apart the Abiathar default configuration? [[User:Fleexy|Fleexy]] ([[User talk:Fleexy|talk]]) 17:24, 6 June 2014 (GMT)

Keen Galaxy Modding Tutorial (patch based)

2014-05-14T13:59:32Z

Fleexy: /* General Level Editing Issues */ Added note about Abiathar

This tutorial aims to teach Keen Galaxy modding (Keen episodes 4, 5, and 6) to people who don't know the first thing about modding, but even the experienced modder should find this information as a good reference tool. Keen 4 will be used for specific examples, but if you are modding keen 5 or 6, you should be able to follow along.

= Setting Up Files and Folders =
Download my [https://dl.dropbox.com/u/3654819/Keen/Keen%20Galaxy%20Modding%20Package.zip Keen Galaxy Modding Package].

Alternatively, you can also manually create this package:

Create your base folder called "Keen Modding" on your desktop. In this folder you'll want to create two subfolders: "Keen4mod" and "Tools". In your "Keen4mod" folder, create a folder called "BMP".

Copy all your Keen 4 game files into the folder "Keen4mod".

* '''Note''': It is very important that you use the right version of the episode you wish to mod. Make sure they are the correct versions: Keen 4 v1.4, keen 5 v1.4, and keen 6 v1.4.

== Tool Downloads ==
These are the tools you will need in order to mod Keen's 4, 5, and 6 and included in the modding package. If you wish to download them individually:

* [http://files.keenmodding.org/modkeen2.zip Download Modkeen]
* [http://files.keenmodding.org/ckpatch-0.10.0.zip Download CkPatch]
* [http://files.commanderkeen.org/users/ceilick/UNLZEXE.EXE Download Unlzexe]
* [http://sourceforge.net/projects/clonekeenplus/files/Tools/unlzexe/win32/unlzexe081.zip/download Download Unlzexe (64 bit version)]
* [http://files.commanderkeen.org/users/mink/CkD456Tli(v3.3).zip Download CkD456tli]
* [http://files.commanderkeen.org/users/leandro/keenscr.zip Download KeenScr]
* [http://levellord.rewound.net/KEENWAVE.zip Download Keenwave]
* [http://levellord.rewound.net/STARTEXT.zip Download Startext]
* [http://winwolf3d.dugtrio17.com/download/IMFCreator Download IMF Creator]
* [http://winwolf3d.dugtrio17.com/download/WDC Download WDC]

* '''Note''': Depending on your computer's operating system you may need CWSDPMI.EXE to run modkeen and other modding programs. If your receive an error in later steps asking for this file, get it here:

* [http://www.delorie.com/djgpp/dl/ofc/simtel/v2misc/csdpmi5b.zip/BIN/CWSDPMI.EXE Download CWSDPMI.EXE]

=== Level Editors ===
You will need one of the four existing level editors: [[Keen: Next (level editor)|Keen Next]] (K:N), [[TED5]], [[The Photachyon Tranceiver]] (TPT), or [[The Omegamatic]] (TOM). This tutorial does not include instructions for The Photachyon Tranceiver since it is in many ways a windows based Ted5. I personally recommend The Omegamatic. All of these editors are included in my modding package.

* [http://files.commanderkeen.org/users/ceilick/TED5.zip Download TED5]
* [http://www.bipship.com/downloads/tpt3.zip Download The Photachyon Tranceiver]
* [http://files.commanderkeen.org/users/ceilick/KeenNextEditor.zip Download Keen: Next]
* [http://0x27.com/downloads/tom.zip Download The Omegamatic]
* [https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharUpdater.exe Download Abiathar (updater/downloader)]

=== Drawing Tools ===
One of the simplest tools for modifying Keen graphics is MS Paint. However, only the versions of MS Paint prior to Windows 7 will function with the Keen palette correctly.

* [http://sagorpirbd.deviantart.com/art/Win-7-MS-Paint-dll-XP-English-122788536 Old MSPaint]

Some modders use programs such as GIMP or PhotoShop.

= Setting Up Files and Folders (Continued) =

Unzip the tools in your tool folder. Copy the following files into your "Keen4mod" folder:
* modkeen.exe
* unlzexe.exe
* ck4patch.exe (Keen 5 requires 'ck5patch.exe', Keen 6 'ck6patch.exe')

Once these files are in place, Unlzexe your Keen4.exe by dragging and dropping the file onto Unlzexe.exe. A window may flash on the screen when you do so.

* '''Note''': If you are using the 64 bit version of Unlzexe, this will create a “Keen4.exenew”. You will then need to delete the old “Keen4.exe” and rename “Keen4.exenew” to “Keen4.exe”.

Open a command prompt. If you are unfamiliar with this process: go to your computer's start button, and either click 'run', or in the search field type 'run' and click the first result. In the run box, type 'cmd'. Now you have a command prompt open.

You'll see something like
C:\Users\UserName>

Type:

cd desktop\Keen Modding\My Mod

Press enter, then:

modkeen -episode=4 -export -bmpdir="BMP"

If all goes well, you should see a list of everything modkeen has exported followed by the word "Done!"

* '''Note''': If you are using a 64 bit version of windows modkeen may not run through the command prompt. You can run it instead by dropping modkeen.exe onto dosbox.exe and then typing: modkeen -episode=4 -export -bmpdir="graphics"

= Editing Graphics and Text =
To begin editing the graphics and most text found in the game, go to your "BMP" folder. You'll see a lot of images there as well some some text files and some other files.

== Graphics ==
You can edit any of these images how you want, but keep some things in mind:

* You need to use the original keen colors. This is easy to do if you just edit the images with MSpaint.
** '''Note''': Windows 7 users will need to download the old version of mspaint.

* On sprite images, you'll see three frames: the image against a black background, a black outline on a white background, and a red box on a grey background. The first image is where the sprite is drawn. The second is used to show what parts of the original image are going to be shown in-game. The last box is used for hitbox measurement, although it doesn't directly affect hitbox size (the 4sprites.txt determines this, see the 'hitboxes' section below).

* In the foreground tileset (4til0001) you'll see a similar black and white duplicate section on the right side. This is also used to show what parts of the tiles are going to be shown in-game.

* The height and width of images must be multiples of 8 (although some of the original images do not follow this rule).

* Changing the size of an enemy will affect how it spawns and the 'hitbox' area it uses to interact with the environment and with keen.

* You cannot change the size of the tilesets.

* Tiles are made up of a 16 by 16 area of pixels.

* The image that displays in the scrolling story (for Keen 4 this is 4bmp0102.bmp) is limited in palette colors. The colors availible can be changed with patching.

=== Hitboxes ===
In keen galaxy, hitboxes are invisible rectangular areas used for telling a sprite how to interact with the environment or with Keen. For a point item, the hitbox is the area keen must touch to collect the item. For an enemy, it is the area of the enemy that will touch the ground and touch keen. For Keen himself, its the area he can interact with platforms, enemies, and other objects.

To edit the hitboxes, open 4sprites.txt. This can be a complex, difficult process that often falls to trial and error.

We'll use Keen's left facing standing frame as an example. The image name for this is 4spr0006. So in 4sprites.txt, look for item 6. It will look like this:

6: [4, 0, 19, 31], [0, 0], 4.

The first set of brackets controls the hitbox. The first set of numbers are x and y coordinates for the top left corner of the image. These are measured from the top left of the image (4 pixels across and 0 down). The next coordinates are for the bottom right of the hitbox. These are also measured from the top left corner of the image (19 pixels across and 31 down). Notice that even though the image is actually 32 pixels high, the hitbox is designed to be 1 pixel away from the bottom. This is important for any sprite that needs to move on a platform.

The second set of brackets are coordinates that have to do with where a sprite image appears ingame relative to where it is placed in the level editor. In the example of the Keen sprite, these are 0,0. Its usually easiest to leave these at 0,0, but if you use a sprite that changes frame size over the course of its animation, or a sprite intended to float above the ground, you may want to experiment with this. The first value is an X coordinate and will determine how far to the right or left the sprite is placed. The second value is a Y coordinate which determines how far up or down the sprite is placed.

'''Note''': If you've modded an enemy and it is stuck in the ground or in the air, you'll want to edit the Y value to bring the hitbox even with the ground.

The last value is not a coordinate but has to do with animation frame rate. In the example of Keen, this value is 4. This value varies from 1, 2, and 4.This determines how 'smooth' the frames in a series animate, 4 being the smoothest, 2 medium, and 1 low. The smoother the animation, the more memory will be used in the level.
'''Note''': Use the 4 value sparingly to avoid memory issues and game crashes.

== Texts ==
You'll find a number of text files in your BMP folder. You can edit these with notepad or a similar application. These files include the help sections, the story, and the end-game story. These files employ a formatting code:

* ^P means "new page"

* ^G followed by a series of numbers is for a graphic image. The first two numbers are x and y coordinates for where the image will be located. The last number specifies the image used. These images numbers don't match up with the image numbers in your graphics folder, so you'll want to do some experimenting to get the right one.

There are specific codes for changing the color of text, but this list is not yet included in this tutorial.

There is also a specific code for creating 'timed' images which will animate based on a timer, but this is not yet included in this tutorial.

= Importing Graphics and Texts =
To import your graphics, go back to your command prompt and type in the same address as previously, but you'll change the command to import this time:

modkeen -episode=4 -import -bmpdir="BMP"

'''Note''': You may need to drag and drop modkeen onto dosbox and then type this command.

If you get the done message, you've imported successfully, however, you can't try out your new graphics until after creating a patch file and corresponding batch file, which is explained in the next section.

= Patch File and Batch File =

Your patch file is used to access all the edited content in your mod. It's what allows you to have new graphics, new tile properties, new levels, new music, new text, new enemy behaviors, etc. It also allows you to change the 'rules' of the game in certain ways (although there are limitations).

If you look in your "keen4mod" folder, you will notice that Modkeen has generated a patch file for you called "keen4.pat". You will want to rename this so that it isn't overwritten in the future. Locate Keen4.pat and rename it to something like "mymod.pat".

You can also create a patch file from scratch. To do this, create a new .txt file called "mymod". Open the file and save as "mymod.pat" and make sure you select "all files" in the "Save as type" section. You should now have a "mymod.pat" file.

Your batch file is what you'll use from now on to play your mod. To create a batch file, first create a new text document and name it whatever you want. In this example we'll use "Play". In the text file, type: ck4patch mymod.pat

Now, go to 'file' and save as "Play.bat" and make sure you select "all files" in the "Save as type" section.

Run "Play.bat" to make sure your mod is working. If you see your modified graphics and/or texts, it works!

== Patching Basics ==
After you've made sure Play.bat runs fine, open up mymod.pat with a text editor.

You should see:

ext ck4
version 1.4
# Load the modified graphics
%egahead EGAHEAD.CK4
%end

Here's what each line means:

* The first two lines mark the beginning of your patch file.

* The # symbol indicates a comment. Any line preceded by a # will be skipped over and allows you to include notes in your patch file.

* %egahead EGAHEAD.CK4 is what tells the game to use your new graphics.

* %end will mark the end of your patch file. Anything that appears after this will not be read by the game, so make sure that any patches you add to this file are included before this line.

You can find all kinds of patches on the [http://www.keenmodding.org/ Keen Modding Forum] as well as make specific requests. Additionally, your can run [[The Neural Stunner]] to generate some easy patches, or dig through the patch files of existing mods.

Here's an example patch that makes bounders unkillable:

%patch $11166 $12 $2F

Now add it to the patch file and also add a comment explaining what it does.

%ext ck4
%version 1.4
# Load the modified graphics
%egahead EGAHEAD.CK4
#Make bounders unkillable
%patch $11166 $12 $2F
%end

Now save your patch file and run Play.bat. Bounders should now be unkillable!

= Tile Properties =
Go to your "Tools" folder and go into your ckD456tli folder. Copy the Keen4.tli file into your "keen4mod" folder. Then go to your patchfile and add the patch that corresponds to your modded episode below:

%patchfile $249C2 keen4.tli
%patchfile $25B22 keen5.tli
%patchfile $25212 keen6.tli

Now run CkD456tli. The first item the program asks you for is the file which you just copied to your "keen4mod" folder. Locate and select it. Next, go into the BMP folder and select the background tileset, and after that select the foreground tileset.

You're now in the editing menu.

On the left side you can see the background tiles. The properties in that tileset are limited: either a tile can animate or have no properties. If a tile animates, the next tile in the animation sequence is outlined in a double red border. Note that tiles can only animate up to 128 tiles before or after any given tile, so try to keep tiles that animate near each other.

To animate a tile, select the first tile in the animation sequence. Next, right click the tile that should appear next in the sequence. Now left click that new tile and select the tile it will animate to next. Make sure the last tile in this sequence animates back to the original tile. Now go back and add animation times to each tile. By moving the scrollbar, you can change the amount of time spent on the tile while animating (0 to 255 time units).

If a tile animates that you don't want to animate, right click the original tile. You will need to repeat this step for each tile in the animation sequence.

* '''Note''': Reducing the scroll bar to zero will NOT prevent the tile from animating and will instead cause the game to crash

* '''Note''': After disabling a tile from animating, it is not necessary to reduce its value in the scroll bar to zero, although this is recommended to avoid future errors when editing.

On the right side is the foreground tiles. For foreground tiles, you can also edit the animation properties (and they work the same way), but there are several other properties you can edit as well. Above the enlarged pictures of the tile and its mask is a dropdown menu where you can select the properties of the top of the tile. Similarly, the dropdown menu below lets you select the properties of the bottom of the tile. Pushing in the buttons on either side signify that Keen (and other sprites) cannot enter the tile from that side, making it solid. (Note that these are almost always set or cleared together. One-way tiles do not work as well in Keens 4, 5, and 6 as they do in Keens 1, 2, and 3). Off to the right is another dropdown menu, which lets you change special properties of the tile. Lastly, when the "FRONT" button is pushed in, it means that the tile appears in front of Keen and other sprites rather than behind them.

* '''Note''': There are some exceptions where foreground tiles that animate have their animation value set to zero. This includes: Key-gem doors and and flag holders.

When you're finished editing, click save.

= Level Editing =
Before getting into special instructions for each editor, some general knowledge about how Keen Galaxy levels work is needed.

Keen 4, 5, and 6 levels consist of three layers of tiles: the background, foreground, and info layers. The background is just there to add color to the scene; Keen and the enemies don't interact with it. The foreground layer contains tiles that Keen interacts with: platforms, point items, doors, secret passages, and so on (note that many tiles in the foreground layer actually appear behind Keen, but they are not considered 'background tiles'). Finally, the info layer contains information about sprites and special features such as switches, doors, bridges and so on. When level editing, you will generally work with only one layer at a time, although all three may be visible at once (layers can be toggled).

In keen 4, 5, and 6, the world map is built primarily from background tiles which do no have solid properties. Instead, special 'invisible' tiles are placed from the foreground tilset on the world map to block Keen's path. These can be difficult to figure out. Check tile properties with ckD456tli to figure out what is what and then edit the invisible tiles to have visual cues for placement (they can be made invisible again later). Alternatively, you can use foreground tiles to build the world map (although this will use more memory).

Keen Galaxy levels have a rectangular border of 2 tiles. Borders should be filled with solid tiles with some exceptions. To create a level exit, leave the border empty where you want Keen to exit. Keen cannot exit out the top or bottom of the screen (Keen will die on the screen bottom and Keen will glitch on the screen top).

Point items can be placed as both sprites or as tiles. It is important to place as many point items as tiles as possible to avoid memory issues. A good rule of thumb is to only place sprite items on foreground tiles.

Included below are general instructions for Ted5 (Sections written by Levellass and Adurdin, edited by Ceilick), Keen: Next (Written by Ceilick), and The Omegamatic (Written by Mink and edited by Ceilick).

== Ted5 ==
=== Setting up Ted5 ===
Download and unzip ted5 into your "keen4mod" folder.

1. Look for the file Egahead.ck4. Rename this file Egahead.ren.

2. Run Tedsetup.

3. Tedsetup will generate a new Egahead.ck4. Delete this file. Now Rename Egahead.ren to Egahead.ck4.

This is the only time you will need to run tedsetup and follow the above steps.

You will probably need dosbox to run Ted5. Just drag and drop the ted5.exe onto your dosbox icon.

=== The Interface ===
After dismissing the welcome screen, the first thing you will want to do is press F9, or click the "?" tab and select "Video Mode Switch". That will cause TED to run in 640x480 mode, giving you more space to work with. You can switch to the low resolution mode again anytime you want to make sure how much of the level is going to be displayed on the in-game screen at once.

At the bottom of the screen, you will see the Info Bar. From the far left to right, it displays:

* Selected Background tile.
* Selected Foreground tile.
* Selected Sprite Icon.

These items display the icon as a graphic, followed by the tile number in hexadecimal (like $00AE) and decimal (174). Clicking on any of them will bring up the tiles palette so you can select a new one.

Next appears the name of the level. This name is used only in Ted5, it does not affect the level name in-game.

Next appears: Active layers (B, F, I)
* B: Background Tiles
* F: Foreground Tiles
* I: Sprite Icon, door/switch coordinates

The letter indicates the layer where you will be adding new tiles to. You can select more than one and the selected tiles will all be placed, however, it is recommended that you work only one layer at a time.

Next appears: Visible layers (b, f, i)
This tells you which layers are being toggled. You can toggle layers with the hotkeys 4, 5, and 6.

When a layer is turned off you cannot place items in it by mistake. This allows you
to take a closer look at a specific layer to make sure everything is placed correctly.

Lastly, on the bottom far right: Cursor location (X, Y)
This gives you the tile coordinates at a specific spot on the map. This will also be given in both decimal and hexadecimal numbers. You will need those numbers in order to have switch that activate lifts, doors leading to other places, toggling bridges, and more.

=== Editing ===

By default, TED5 will load the world map for the game. In order to switch to another map, you will need to click the File menu and select Edit New Map. You will then be able to select any of the maps in the game. For this example, pick Slug Village.

You can use the arrow keys to scroll the level around.

You can toggle which type of tile to place (background, foreground, sprite icon) by pressing the 1, 2 or 3 keys. Note for each type of tile, you will need to press the number key to activate it and the same key again to deactivate it before using a different tile type.

Adding new tiles to the level is as simple left-clicking. The currently selected tiles will be placed in all active layers. You can select tiles in three ways: Clicking the tile icon to the left of the Info Bar, pressing the space bar to bring up the tile set, or right-clicking an existing tile.

Right-clicking an existing tile will switch all the active tiles to the ones in the active layers. This means, if you only have the Icon layer active, right-clicking a tile with a slug will only select the slug; while if you have all three layers active, it will select the slug, the Foreground tile, and the Background tile at that location.

Once you have a basic level made, you'll want to add more advanced features like moving platforms, switches, bridges, doors, and so on. These are all done with links in the sprite icon layer.

A simple moving platform in Keen 4 can be placed by putting a moving platform icon with a red arrow in the desired spot. To stop the platform moving off the edge of the screen however, you'll need to put some blocking tiles in its path: these icons look like a "B" in a square. Put one blocking tile to each side (for a horizontally-moving platform) or above and below (for a vertically-moving platform). A collapsing platform (the one with a yellow triangle below) only needs a single blocking tile beneath it. In Keen 5 and Keen 6, the platforms with green arrows (known as Goplats) need a path made of the yellow arrow icons to follow.

Often you want the player to have to turn a platform on with a switch. To do this, you need to place another blocking tile in the way of the platform between the other two. Make a note of the hexadecimal values of the location of the tile (the X and Y values beginning with $ at the right-hand side of the status bar). Now place a switch in an appropriate place, and link it to the blocking tile: Choose Misc, New INFOPLANE Value or press Enter, and type in a $ followed by the last two digits of the X and Y values you wrote down. Then click on the switch; this will place the link in the info plane, which will be shown as four digits. The switch will now turn the blocking tile off, to activate the platform.

When working on your world map, you'll want to use the infoplane to specify what levels your entrances will lead to. To do this, go to Misc, New INFOPLANE Value, and type in a $ followed by one of the following: $C0xx is a link to level where xx is the level number in hexadecimal, not decimal), $D0xx overlays blocking tiles that will be removed upon completion of the level (think the gates for border village and slug village), and $F0xx is for the flag holder which corresponds to the level. After entering your chosen value, you can then edit the info plane by left clicking.

In the same way, you can link a switch to a bridge (link to the left-hand edge of the bridge), a gem-holder to a closed door (link to the top of the door), and a walk-in doorway to the place you walk out (link to where you want Keen's feet to end up after he enters the doorway). Note that if you create a link from a switch to a square with nothing in the info plane, that switch will turn a blocking tile on; also that you need to use a particular tile to make a walk-in door (find out by looking at an existing level).

Another feature which makes Keen levels exciting is secret passages. Some foreground tiles allow Keen to walk behind them-these are suitable for secret passages. However, identifying which ones are like this and which ones are solid is difficult: I suggest examining some of the original levels and noting down the tile numbers of the "secret passage" tiles to keep track of them. When putting point items in a secret passage, you must use icons for them, rather than their foreground tiles. I suggest that you only place the "walk-behind" tiles in secret passages once the level is completed, so that while editing you can keep track of them more easily.

Finally, some Keen levels have separate areas that act like independent mini-levels (the Pyramid of the Forbidden is a good example of this). You can place scroll blocks in the info layer to mark horizontal and vertical edges between these areas. The scroll blocks look like horizontal and vertical blue lines with small white stripes; I suggest examining existing levels to see how they are
used before placing them in your own levels.

=== Saving ===
You can save your map at any time by going to the File menu and selecting Save Map; however, in order to actually play the level, you will need to Carmacize Maps. While ted5 has an option to do this, it takes too long to do so. The easiest method is to download InstantCarma and unzip the files into the folder with your maps. After you save your map in ted5, just run InstantCarma.

TEDSETUP creates an extra batch file (Go4.bat) and patch file (Patch4.pat) which you do not need if you open your existing patch file and add the line:

%maphead maphead.ck4

You only need to add this to your patch file once. Then just run your batch file to try your level!

=== Other Ted5 Features ===

Grid Mode toggles the showing of a grid on the current level. This can help with placing tiles in the right positions. Turn this on or off from the Mode menu or by pressing G.

Block Fill mode quickly fills a rectangular area with the currently selected tiles. Choose it from the Mode menu or press B, and click the left mouse button on the desired top-left corner, and the right button on the bottom-right corner, then press Enter to fill the area.

Flood Fill mode will fill an area of one tile with the currently selected tiles. Choose it from the Mode menu or press F, then click in the desired location to fill.

Copy Mode (also on the Mode menu, or press C) lets you select a rectangular set of tiles to copy so that you can duplicate them in another region easily. Select the area as for Block Fill mode, then press Enter.

Paste Mode (you know where to find it) allows you to paste one or more copies of the tiles chosen with Copy Mode. Click with the left mouse button to place a copy. You can use the Paste Overlay option (on the Mode menu, or press F3) to toggle pasting of empty tiles. The Snap-Paste option (press S) toggles pasting copies just anywhere, or in a tessellated pattern. This is especially useful for
filling in the background of a level.

You can change the size of a level with the "Change MAP Edges" option on the Edit menu. Select the edge you want to change, and enter a positive or negative number to add or remove rows from that edge.

== Keen:Next ==

=== Setting Up ===
Go to the keen 4 folder in Keen next and copy the tiles4.png file. Paste this into your "keen4mod" folder.

Edit tiles4.png to include your edited graphics. Be sure to save the file as .png.

Go to your Keen:Next folder and run the kmaps application. You may get an error message after running this, but this is not a problem, just click ok.

When the editor opens, the first thing to do is go up to 'file' then 'new'. A 'project properties' window will appear. Give your project a title (it doesn't matter what you name it) and then check the "keen project" box. We'll be using Keen4, which is the default setting. If you're planning to edit keen 5 or 6, just make sure to select those in the box next to "keen project". Next we need to choose the tileset. In the image file section, go to 'browse' and select the tileset you want to use (in this case, tiles4.png). After all this, click 'ok'.

* '''Note''': you will have to do this each time you open the editor.

Before editing levels, you must extract them in a way that Keen: Next can read them. Go to 'file', then 'create keen files'. Browse to your "keen4mod" folder and select keen4.exe. Your keen map files should now be created.

* '''Note''': this will not work if you have run tedsetup.

* '''Note''': You only have to do this once.

=== The Interface and Tools ===
The tiles should load on the right side of editor menu. You can adjust the tile menu width with the mouse by selecting the left edge. You can scroll between the background and foreground tiles.

In the upper left is a toolbar. The default tile tool is the pencil/paintbrush. You can click and place or click and drag to place tiles.

There is also a water dropper tool. This is useful for selecting a tile currently on the map instead of looking for it in the tileset.

* '''Note''': the water dropper will 'pick up' the tile from the tileset you're currently in; if you currently have a background tile selected and use the water dropper, it will pick up the background tile on the map. If you want a foreground tile, scroll down in the tileset on the right and select one of the foreground tiles, then use the water dropper on the map.

I do not recommend using the paint can tool, since it is very buggy.

The next tool can be used for selecting
a rectangular area of the map. This is useful for cutting a piece of the level and pasting it elsewhere (you will need to do this twice if you want to cut and paste both the background and foreground). You can also create stamps this way. Just select an area and go to "selection" and then "create brush". A stamp of the area will now appear on the left.

You can create stamps of a large area of tiles from the tileset also. To do this, click the top left corner of the area of tiles you want in the tileset. Then go to the bottom right corner of that area, while holding shift, and select that tile. Doing this successfully will result in the stamp image appearing on the left side of the editor. You can now use the paintbrush tool to place this stamp, and you can reselect this stamp at any time you're editing.

The next tool looks like a little cog. This is used for placing doors, level entrances, switches, and key-gem holders.

The last important tool has an icon that looks like an arachnut. Click this to bring up the sprite menu. This is used for placing enemies, points, and some other things. To switch back to tiles from sprites, click the little black square icon to the left of the arachnut icon you used to get to the sprite menu.

In addition to the tools, you can toggle the layers used in editing with the 'view' tab and checking/unchecking layer 1 and layer 2. Make sure that, in the "view" section, you have 'fade unused layers' unchecked. This makes level viewing easier.

* '''Note''': This is the buggiest part of Keen:Next and if you frequently toggle layers, glitches can ruin a lot of work put into a level. Its usually best to leave both layers visible, or save your progress before toggling layers and then reload Keen: Next as soon as you finish the work that required toggling them.

=== Editing ===
To begin editing, first load a map. Go to 'file', then 'Import Keen Map'. In your "keen4mod" folder, select 'maphead.ck4'. You should now be presented with a 'map select' box. Choose the level you'd like to edit. Let's start with the shadowlands.

The shadowlands map should now be loaded in the main editing area. You'll notice little white icons that look like this (!). These are the level sprites. To place these, use the little cog tool up in the upper left (next to the rectangular area selector). When this tool is used to click the map, you'll get an 'info plane' box asking for an x and y coordinate.

On the world map, this is how the coordinates work:
The x coordinate determines what kind of sprite is used. An X of 192 designates the sprite as a level entrance. Note: you cannot place a level entrance on a tile that appears over keen or on an animating tile.

An x of 208 is a level block (like those used in the slug village); this sprite does not actually block keen, but is placed over a foreground tile that does. When the level is beaten, this info number removes the foreground tile.

An x value of 240 is for the flag holders.

Y coordinates only designate what level the sprite is associated with. A Y of 1 will designate the level as level 1.

To place sprites (enemies) in a level, go to the tools menu and click the little icon that looks like an arachnut. The sprite menu should appear in place of the tileset. To place a sprite, make sure you have the paintbrush icon selected, then click the sprite you want to place. To switch back to tiles from sprites, click the little black square icon to the left of the arachnut icon you used to get to the sprite menu.

* '''Note''': some enemies appear more than once in the sprite menu; this is for enemies that appear on easy, moderate, and hard. You can see little numbers that designate this, but a general rule is that the order they appear in on the menu matches the easy/medium/harder order.

To place a keygem holder, first place the foreground keygem holder tile somewhere on the map (it can be anywhere). Next place a door (these are also foreground tiles) somewhere (anywhere). When making the door, there are three door tiles: a bottom, middle, and top. If you're making a door more than three tiles high, use the middle door piece for additional height. Using your mouse, hold it over the top tile of the door. In the lower left side of the editor, you'll notice that the map coordinates for this tile appear. Memorize or write these down. Now select the cog tool and then click your keygem holder. Enter in the coordinates for your door. You've now got a working door.

To place doors that Keen can enter, first place two sets of door tiles on the map. Now you must determine the coordinates. Go to one of your doors and hold the mouse over the tile below the bottom left door tile (not on the bottom left door tile or keen will drop out of the air). Check the coordinates. Then go to the door you want to connect to this spot and use the cog tool and click the lower left door tile (the lower left door tile, not the one below it). Enter in the coordinates. Do the same for the bottom right door tile. Now this door is connected to the other, but you also need to check the coordinates at this door and add them to the tiles of the other door.

To create a working switch, use the cog tool on a switch and use the coordinates for the thing you want the switch to affect. For a bridge, get the coordinates of the top left bridge tile and put this in the info box for the switch. For goplats (moving platforms), get the coordinates of a B sprite (these are sprites which goplats bounce off and then go in the other direction). The switch will remove that sprite so the goplat can move.

To resize a map, go to "edit" and "Resize map". Then select the new level boundaries and the side of the level which should be expanded or shrunk.

Keen: Next has an infinite undo button. Just go to "Edit" and click "Undo".

* '''Note''': Undo will work for everything except changes to the level boundaries. Make sure you save before changing level boundaries!

=== Saving ===
When you're ready to save, go to 'file', then 'export keen map', then select 'maphead.ck4', click yes, and reselect the level you want to save over and click ok.

* '''Note''': if you like, You can rename the level here before you click ok. The name you choose will only appear in the editor, however, and not in the in-game text.

* '''Note''': Do not click 'save' or 'save as'. These options do not actually save the level to the game, but as files only Keen: Next can read. Additionally, saving levels in this manner can cause Keen: Next to crash.

After saving you can test your levels by adding this to your patch file:

%maphead maphead.ck4
%gamemaps editmaps.ck4

Then run your batch file and you're all set.

== The Omegamatic ==
===Setting Up===
Run tom.exe and select the gamemaps.ck4 file. You will then need to select your tilesets which you exported modkeen: 4til0000 and 4til0001. After selecting these, if all goes well, the world map will open in TOM.

===The Interface and Tools===
Tom features two different level editing styles: Ted5 and Keen:Next. I highly recommend Keen:Next Mode and will only cover it in this tutorial. To activate this go to settings and click "Keen:Next Mode". You will now see the tileset on the right side of the TOM window.

In the bottom left of the window you will see three different boxes. These boxes display the tile you pick from the tileset on the right of the window. Each box displays from one of the three layers used in Keen:Galaxy: background tiles, foreground tiles, and sprite icons. To change which tileset to work with, use the hotkeys 1, 2, and 3 to switch between the layers.

To place a tile simply select the tile from the tileset with the left mouse button and click on the level where you want to place it with the left mouse button. You can also right click a tile from the level to make it the active tile for placing, just like a water dropper tool. To erase a tile you will need to right click an empty space in the level, which makes an empty tile the active tile, and then left click what you want to erase.

If you want to select an area of tiles from within a level, press C and left click a corner of the area you want to select. You should then left click the opposite corner of the area you want to select. The selected area will have it's colors inverted until you select the size of the area. You can then press P to paste the area you selected.

If you want to select an area of tiles from the tileset, left click the top left tile of the area you want to select. Then, while holding shift, left click the bottom right tile of the area you want to select. Release shift and then you should be able to place the selected area in the level by left clicking.

You can scroll around the level with your mouse wheel or with the arrow keys. You can zoom in and out in the "View" tab. You can also toggle on and off which layers can be seen with the hotkeys 4, 5, and 6.

To change the level you are editing go to "Levels" and select the level you want to edit. You can rename levels by going to "File" and then "Rename This Level".

You can resize a level by going to "Tools" and selecting either: Insert Row, Delete Row, Insert Column, or Delete Column. After selecting on of these move your mouse around the level and you will see a highlighted area which will be affected by whichever option was chosen. To disable any of these level adjustments just go back to "Tools" and uncheck it.

When working on your world map, you'll want to use sprites to specify what levels your entrances will lead to. To do this, first press 3 to activate the sprite icon layer. Press enter once and a message box will come up with an infoplane number in hexideciaml. Remove the number indicate and type one of the following: C0xx makes a level entrance where xx is the level number in hexadecimal, not decimal), D0xx overlays blocking tiles that will be removed upon completion of the level (think the gates for border village and slug village), and F0xx is for the flag holder which corresponds to the level. After entering your chosen value, you can then place the level entrance, gate, or flag sprite by left clicking.

===Sprites and Enemies===
To place sprites and enemies in a level, press 3 to bring up the sprite tileset. You can place sprites like you would normally place a tile. Some enemies appear more than once in the sprite menu; this is for enemies that appear on easy, moderate, and hard. You can see little numbers that designate this, but a general rule is that the order they appear in on the menu matches the easy/medium/harder order. Sometimes there is a blank space before or after the order of sprites. For example, the blue bird from keen 4 doesn't have a sprite icon for easy mode, however, it does have a blank tile where the easy mode icon would normally go. This blank tile can be placed to place a blue bird on easy. This works similarly for other enemies in this situation.

===Secret Passages===
Some foreground tiles have properties that allow Keen to walk behind them; these are secret passages. To make these you will need to identify which tiles have the correct foreground but not blocking properties. I suggest examining some of the original levels and noting down which tiles are used for the secret passages. You can also identify them with the CKD456tli utility. When putting point items in a secret passage, you must use points from the sprite list rather than the foreground tile points.

===Moving Platforms===
A simple moving platform in Keen 4 can be placed by putting a moving platform sprite icon with a red arrow in the desired spot. To stop the platform moving off the edge of the screen however, you'll need to put some blocking tiles in its path: these icons look like a "B" in a square. Put one blocking tile to each side (for a horizontally-moving platform) or above and below (for a vertically-moving platform). A falling platform (the one with a yellow triangle below) only needs a single blocking tile beneath it. In Keen 5 and Keen 6, the platforms with green arrows (known as Goplats) need a path made of the yellow arrow icons to follow.

===Switches for goplats===
Often you want the player to have to turn a platform on with a switch. To do this you will need to place another blocking tile in the way of the platform between the other two. After placing the blocking tile, hold the mouse over it and press enter two times. This will give you the hexidecimal coordinates which you will place on the corresponding switch. The switch will now turn the blocking tile off thus activating the platform.

===Switches for bridges===
To create a switch for bridges, first build the bridge using the bridge tiles. Then hold your mouse over the top left tile of the bridge and press enter twice to get the hexidecimal sprite value. Place this sprite on the switch you want to activate the bridge with. If you want the bridge to begin already opened, you will need to locate the invisible bridge tiles and place these where the bridge will be located, otherwise no bridge will appear. To find these either locate them in existing levels with open bridges or use ckd456tli.

===Key Gem Doors===
To place a keygem holder, first place the foreground keygem holder tile somewhere on the map (it can be anywhere). Next place a door (these are also foreground tiles) somewhere (anywhere). When making the door, there are three door tiles: a bottom, middle, and top. If you're making a door more than three tiles high, use the middle door piece for additional height. Using your mouse, hold it over the top tile of the door and press enter twice. Place the sprite that this gives you on the gem holder.

===Doors===
To place doors that Keen can enter, first place two sets of door tiles on the map. Then hold the mouse over bottom left or right of the first door and press enter twice. This gives you a sprite which you should place on the bottom of the second door you want connected to the first door. After placing the sprites at the bottom of the second door, you will need to press enter twice at the bottom of this second door and place the sprites on the first door in the same way.

===Scroll Blocks===
Some Keen levels have separate areas that act like independent mini-levels (the Pyramid of the Forbidden is a good example of this). You can place scroll blocks from the sprite menu to mark horizontal and vertical edges between these areas. The scroll blocks look like horizontal and vertical blue lines with small white stripes; I suggest examining existing levels to see how they are used before placing them in your own levels.

===Saving===
To save your progress go to "File" and then "Save all Levels". This will immediately save all your levels.

===Testing===
After saving you can test your levels by adding this to your patch file:

%maphead maphead.ck4

Then run your batch file.

== Abiathar ==

See Fleexy's [https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharHelp.pdf official manual] or [https://www.youtube.com/playlist?list=PL-BuW7CehquoCH_yGXeQqTIXQMY7sUm-u video tutorial playlist].

== General Level Editing Issues ==
If there are too many sprites in a level you will get the error 'No space left in objarray'; the game has run out of memory to store sprites. This usually occurs at the level start. To fix this, remove sprites from your level. When placing sprites, keep in mind that the more variety of enemies you use, the more memory is used up and the larger the sprite and the more frames it has, the more memory it uses. Also, when trying to save memory, check your points items: these exist both as tiles and sprites (try to use tile points whenever possible).

If you have too many different types of tiles (Background and foreground) then you will get the error 'No space left in tilearray'; this means that the game does not have enough memory to store all your different tile types. Foreground tiles use 8x the memory of background tiles. You shouldn't have more than about 400 tile types total (Background and foreground) in a level, usually 100 back and 300 fore. Additionally, animating tiles with many frames can increase your tile count drastically.

* '''Note''': I have never had this error before and imagine it would be difficult to attain, so don't be worried about using too much until you get this error.

You cannot have more than 20 actively animating tiles on-screen at any one time, this includes item tiles. This will cause an anim tile error. (Not enough memory to animate all these tiles.)

Note: This was a major problem in designing the Lava Falls in [[Dead in the Desert]], so be careful when it comes to animating tiles.

If a level is 'too large' for its music file, the error 'Not enough memory to play background music!' will occur. This is an indication of either large levels or large music files. To reduce this error, either make your level smaller or change the music to a smaller file.

If you see static gibberish instead of an animation while testing your level, then you have placed an animating background over an animating foreground. For memory reasons this is not allowed. Similarly, a sprite cannot be placed on top of an animating tile. This will crash the game.

All of these problems and more can be detected with the [[Abiathar]] Level Inspector tool or the inspection mode (press I) of the Tile Property Modifier. It also provides exact points in the level where errors and possible issues appear so that you do not have to launch the game repeatedly to fix bugs.

= Music and Sounds=
Copy Keenwave.exe into your "keen4mod" folder. Run Keenwave and it will generate an IDWAVE text file. Create a folder called "sounds". Open IDwave.txt and add this line:

-episode=4 -export=raw -snddir="sounds"

Run Keenwave by dragging and dropping it onto dosbox.

Now look in your sounds folder. Here you will see a number of sound files and a few music files (IMF files) at the bottom. To change these, just replace the sounds with new file (they must be the same format, for music this is IMF). Sound effects can be created and modified using WDC. You can create IMF files by converting midi files with IMF Creator.

After changing the sounds or songs, go back to IDWAVE.txt and change the command to:

-episode=4 -import=raw -snddir="sounds"

Run Keenwave.

Now open your patch file and include the lines that apply to the episode you're modding:

#Keenwave patch file; Patch sounds Keen 4:
%patchfile $20DF0 AUDIOHED.CK4 #Audio header
%patchfile $354F6 AUDIODCT.CK4 #Audio dictionary

#Keenwave patch file; Patch sounds Keen 5:
%patchfile $21C80 AUDIOHED.CK5 #Audio header
%patchfile $35EC4 AUDIODCT.CK5 #Audio dictionary

#Keenwave patch file; Patch sounds Keen 6:
%patchfile $20C50 "AUDIOHED.CK6" #Audio header
%patchfile $36EEE "AUDIODCT.CK6" #Audio dictionary

== Creating and Editing Sound Effects ==

Begin by installing WDC to your tools folder. Once this is commplete, go to the new WDC folder and create three new folders inside: "Keen4input", "Keen4output", and "KeenSounds". You should then copy a clean version of Keen 4 into the "Keen4input folder", specfically the files: Audio.ck4, Egagraph.ck4, Gamemaps.ck4, and Keen4e.exe.

'''Note:''' Make sure this version of the keen4e.exe has NOT been unlzexed.

Now run WDC.exe. After is loads, go to "File" then "New Project". WDC will then ask you to name the project and save the project file; name it "keen4project" and save it to you WDC folder.

WDC will then bring up a window with several options. Under "Base Data Folder" select your folder "keen4input". You will then get a "no map code file" alert. When this occurs, select "User Other" and then select "blank.wmc". Under "Output Folder" select your folder "keen4output". On the left side you will see a small menu, select "Other Options" and then check the box for "Use Tile16s for maps, if they exist".

You should now see the Keen 4 world map. You'll be using only one part of WDC, however, so go to "View" and select either "PC Sounds" or "Adlib Sounds".

WDC will then load the list of sounds for that category. You can sample each sound by clicking it. Playback controls are located in the upper right. To edit a sound, click the small hammer icon in the lower right. WDC will then ask you where you want to save the file. Navigate to your "keensounds" folder. Name the sound in such a way that you can remember what it is: "slugslime", "jump", "item" etc.

WDC will then load it's sound editor. There are various tabs for effecting how the sound is played, and the main area allows you to use your mouse and 'draw' the sound. Sound editing is a complex task and the only real advice I can offer is to just play around in the editor and save sounds that you find good or interesting.

After you've saved some sounds, you'll want to swap these into your mod. To do so you'll first need to locate the original sound file you want to replace in the "sounds" folder you created when setting up Keenwave. You can do this by listening and finding the sound you want to replace in WDC and then locating the corresponding number in the sounds folder. This is easy for PC speaker sounds, but since Keenwave doesn't seperate the PC speaker sounds from the adlib, you'll have to locate the last PC Speaker sound and then begin counting again from 1 in order to match the adlib sound list in WDC to that in your sounds folder.

When you've located the original sound you want to swap out, copy it's name to your new sound and then replace the file. Then run Keenwave to import your new sound effect.

== Working with the IMF Format ==
In IMFCreator, go to the "options" menu and set the tics/sec to 560. This will make your songs convert at the correct tempo.

The following, excluding the tip from thehackercat, is written by Mr. M for PCKF/KeenModding:

Compose your music using your choice of software. As long as it outputs standard General MIDI files, you should be good to go.

Please read and get an understanding of the [http://www.shikadi.net/moddingwiki/IMF_Format IMF specs].

Tip From Thehackercat:
For those of you using a sheet-music editor such as Finale: You may write two or more parts for one instrument. Keep inside the required 4-note polyphony, but don't be shy about using layered parts and chords, especially on piano staves.

Tips From Mr. M:

(1) IMFCreator seems to interpret MIDI note velocities. If your instrument track is too quiet *and* it is set to maximum volume, try manually adjusting the note velocites to be higher. I know that FLStudio is capable of doing this; I'm sure other studio software packages are capable of this, too. If the volume of the track is too loud after making your note velocities higher, turn down the volume of that track.

(2) Keep percussion parts as simple as possible. It impedes the maximum polyphony limits that can be utilized by other parts. Simply put, you can write more complex parts that use this structure:

[SIMPLE/NO PERCUSSION]+[BASS LINE]+[CHORDS]+[CHORDS?]+[LEAD]

The number of dropped notes, if any, in IMFCreater is almost unnoticeable if you adhere to this formula. I've been able to push the IMF format to it's limits by doing this.

As Thehackercat stated, don't be shy about using chords and complex structures -- especially if your percussion line is nonexistent or very simple.

(3) Try not to use too many midi tracks, *especially* if they are all simultaneous. Too many midi tracks results in dropped notes (ie- parts drop out randomly *and* inconsistently), and songs that exceed the filesize limits. I personally only need 4-8 tracks, counting percussion, to acheive the sound that I get in my work.

(4) On the subject of percussion: To circumvent the polyphony limit that gets imposed when you use percussion parts, try using normal instruments played outside their normal range. Then in IMFCreator, tweak the patches you used by adjusting all the possible paramaters until you acheive the desired percussive sound. It may not work all the time, but it should do the trick in most cases. (Credit for this tip goes to [[Bobby Prince]])

(5) On the topic of modding instrument patches: Don't be afraid to tweak patches! It's under the 'EDIT' -> 'Instrument' (or press CTRL+I) menu. You can edit how all the instruments sound. All of them {including percussion). Distortion guitar not distorted enough? No problem. Pad not airy enough for you? Bass drum not punchy enough, or the hi-hat not sharp enough for you? No problems there. See the help menus for the specifics of how the patch parameters are edited.

When I do this, I make a patch set for each specific song. When you close the instrument editor, you are prompted to save changes. Do so, and save the .OP2 file that is generated as something *other* than GENMIDI.OP2 (I like to save it by song title for easy reference). Keep the original GENMIDI.OP2 file as a base set.

After you've tweaked the patches to your liking and saved your new .OP2 file, stop any playback of the song you're previewing. Under 'OPTIONS' and 'OP2 File:' you can choose the OP2 file that has the modded patches you created. Press play and listen to your new instruments!

* '''Note''': After editing an .OP2 file/patch set, you MUST stop and re-start playback of your song for the changes to take effect

(6) Be careful with pitchbends in your music. IMFCreator tends to overexaggerate them if the pitchbend scale and thresholds arent set properly. There's no ONE configuration for them; best bet is to tinker with them until you get a desireable sound. Remember: Lower numbers mean higher pitchbend scale!

As with editing the patch set, you MUST stop and re-start playback of your song for the changes to take effect.

= Loading Window =
Go to your graphics folder and look for the file 4msc0000.bin. Copy this to your keenscr folder.

Go to commander prompt and navigate to your keenscr folder and then type:

keenscr load

TheDraw will immediately start editing the screen, with the filename keenscr.bin.

Alt+H will display the help screen with all the commands that TheDraw supports; however, its basic use is extremely simple. Use the arrow keys or mouse to select where you want to enter text, then type it in. By default, it uses bright white color over black color; you can copy a color straight from the screen by placing the cursor over any character and pressing Alt+U, and it will use that color as you type.

You can use Alt+M to enter drawing mode, where you can use the cursor keys or the mouse to draw on the screen; you should enable Draw mode with the cursor in the place where you want to start drawing, as it will start immediately. Alt+F1 to Alt+F4 will give you different line styles for Draw mode.

Once you are done editing the screen, you can save it by pressing Alt+S. TheDraw will ask which format to save it in; press B to select Binary, and enter the filename keenscr.bin. It's important that you keep this filename (overwriting the existing one). After you exit TheDraw and KeenScr notifies you that the file has been updated.

Then you must copy 4msc0000.bin back into your graphics folder. Import using modkeen. You must also copy ck4load into your "mymod" folder.

Edit your patch file to include the patch for the respective episode:

%patchfile $1fe47 ck4load.bin
%patchfile $20cd7 ck5load.bin
%patchfile $1fca7 ck6load.bin

You can also edit the exit screen by going to the command prompt and typing: keenscr 4

When you're done, save it as keenscr.bin overwriting the generated file. You must save it in Binary format when TheDraw asks.

Then you must copy 4msc0000.bin back into your graphics folder. Import using modkeen.

= Scrolling Text =
Run Startext. The controls are listed. Select your episode of choice and then select edit scrolling story. Type your story as you want it, making sure not to go over the space limit or under it (the original story will appear at the bottom of your story if you do). Press enter.

Copy story.ck4 into your "mymods" folder.

Edit your patch file to include one of the following:

%patchfile $1EE40 "STORY.CK4"
%patchfile $1FDE0 "STORY.CK5"
%patchfile $1ED50 "STORY.CK6"

= Credits For This Tutorial =
* Written and Assembled by [[User:Ceilick|Ceilick]]
* Selections of [[User:Levellass|Levellass']] [[TED5|TED5 Tutorial]]
* Selections of [[Andrew Durdin|Andrew Durdin's]] [http://www.dosclassics.com/ckn/newsletter/issues/2002-03-01.txt|TED5 Tutorial]
* Selections of [[User:CK Guy|CK Guy's]] ck456tli readme
* Selections of [[User:Mink|Mink's]] The Omegamatic readme
* Selections of [[User:Leandrotlz|Leandrotlz's]] [[TheDraw|The Draw/Keenscr tutorial]]
* [[User:Shadow Master|Shadowmaster's]] [http://www.keenmodding.org/viewtopic.php?t=899 findings] for getting ted5 to work with modkeen 2.0
* [[User:Mr.M|_mr_m_'s]] IMF guide

[[Category:Tutorials]]"

Keen Galaxy Modding Tutorial (patch based)

2014-05-09T00:58:04Z

Fleexy: /* Level Editing */ Added Abiathar links

This tutorial aims to teach Keen Galaxy modding (Keen episodes 4, 5, and 6) to people who don't know the first thing about modding, but even the experienced modder should find this information as a good reference tool. Keen 4 will be used for specific examples, but if you are modding keen 5 or 6, you should be able to follow along.

= Setting Up Files and Folders =
Download my [https://dl.dropbox.com/u/3654819/Keen/Keen%20Galaxy%20Modding%20Package.zip Keen Galaxy Modding Package].

Alternatively, you can also manually create this package:

Create your base folder called "Keen Modding" on your desktop. In this folder you'll want to create two subfolders: "Keen4mod" and "Tools". In your "Keen4mod" folder, create a folder called "BMP".

Copy all your Keen 4 game files into the folder "Keen4mod".

* '''Note''': It is very important that you use the right version of the episode you wish to mod. Make sure they are the correct versions: Keen 4 v1.4, keen 5 v1.4, and keen 6 v1.4.

== Tool Downloads ==
These are the tools you will need in order to mod Keen's 4, 5, and 6 and included in the modding package. If you wish to download them individually:

* [http://files.keenmodding.org/modkeen2.zip Download Modkeen]
* [http://files.keenmodding.org/ckpatch-0.10.0.zip Download CkPatch]
* [http://files.commanderkeen.org/users/ceilick/UNLZEXE.EXE Download Unlzexe]
* [http://sourceforge.net/projects/clonekeenplus/files/Tools/unlzexe/win32/unlzexe081.zip/download Download Unlzexe (64 bit version)]
* [http://files.commanderkeen.org/users/mink/CkD456Tli(v3.3).zip Download CkD456tli]
* [http://files.commanderkeen.org/users/leandro/keenscr.zip Download KeenScr]
* [http://levellord.rewound.net/KEENWAVE.zip Download Keenwave]
* [http://levellord.rewound.net/STARTEXT.zip Download Startext]
* [http://winwolf3d.dugtrio17.com/download/IMFCreator Download IMF Creator]
* [http://winwolf3d.dugtrio17.com/download/WDC Download WDC]

* '''Note''': Depending on your computer's operating system you may need CWSDPMI.EXE to run modkeen and other modding programs. If your receive an error in later steps asking for this file, get it here:

* [http://www.delorie.com/djgpp/dl/ofc/simtel/v2misc/csdpmi5b.zip/BIN/CWSDPMI.EXE Download CWSDPMI.EXE]

=== Level Editors ===
You will need one of the four existing level editors: [[Keen: Next (level editor)|Keen Next]] (K:N), [[TED5]], [[The Photachyon Tranceiver]] (TPT), or [[The Omegamatic]] (TOM). This tutorial does not include instructions for The Photachyon Tranceiver since it is in many ways a windows based Ted5. I personally recommend The Omegamatic. All of these editors are included in my modding package.

* [http://files.commanderkeen.org/users/ceilick/TED5.zip Download TED5]
* [http://www.bipship.com/downloads/tpt3.zip Download The Photachyon Tranceiver]
* [http://files.commanderkeen.org/users/ceilick/KeenNextEditor.zip Download Keen: Next]
* [http://0x27.com/downloads/tom.zip Download The Omegamatic]
* [https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharUpdater.exe Download Abiathar (updater/downloader)]

=== Drawing Tools ===
One of the simplest tools for modifying Keen graphics is MS Paint. However, only the versions of MS Paint prior to Windows 7 will function with the Keen palette correctly.

* [http://sagorpirbd.deviantart.com/art/Win-7-MS-Paint-dll-XP-English-122788536 Old MSPaint]

Some modders use programs such as GIMP or PhotoShop.

= Setting Up Files and Folders (Continued) =

Unzip the tools in your tool folder. Copy the following files into your "Keen4mod" folder:
* modkeen.exe
* unlzexe.exe
* ck4patch.exe (Keen 5 requires 'ck5patch.exe', Keen 6 'ck6patch.exe')

Once these files are in place, Unlzexe your Keen4.exe by dragging and dropping the file onto Unlzexe.exe. A window may flash on the screen when you do so.

* '''Note''': If you are using the 64 bit version of Unlzexe, this will create a “Keen4.exenew”. You will then need to delete the old “Keen4.exe” and rename “Keen4.exenew” to “Keen4.exe”.

Open a command prompt. If you are unfamiliar with this process: go to your computer's start button, and either click 'run', or in the search field type 'run' and click the first result. In the run box, type 'cmd'. Now you have a command prompt open.

You'll see something like
C:\Users\UserName>

Type:

cd desktop\Keen Modding\My Mod

Press enter, then:

modkeen -episode=4 -export -bmpdir="BMP"

If all goes well, you should see a list of everything modkeen has exported followed by the word "Done!"

* '''Note''': If you are using a 64 bit version of windows modkeen may not run through the command prompt. You can run it instead by dropping modkeen.exe onto dosbox.exe and then typing: modkeen -episode=4 -export -bmpdir="graphics"

= Editing Graphics and Text =
To begin editing the graphics and most text found in the game, go to your "BMP" folder. You'll see a lot of images there as well some some text files and some other files.

== Graphics ==
You can edit any of these images how you want, but keep some things in mind:

* You need to use the original keen colors. This is easy to do if you just edit the images with MSpaint.
** '''Note''': Windows 7 users will need to download the old version of mspaint.

* On sprite images, you'll see three frames: the image against a black background, a black outline on a white background, and a red box on a grey background. The first image is where the sprite is drawn. The second is used to show what parts of the original image are going to be shown in-game. The last box is used for hitbox measurement, although it doesn't directly affect hitbox size (the 4sprites.txt determines this, see the 'hitboxes' section below).

* In the foreground tileset (4til0001) you'll see a similar black and white duplicate section on the right side. This is also used to show what parts of the tiles are going to be shown in-game.

* The height and width of images must be multiples of 8 (although some of the original images do not follow this rule).

* Changing the size of an enemy will affect how it spawns and the 'hitbox' area it uses to interact with the environment and with keen.

* You cannot change the size of the tilesets.

* Tiles are made up of a 16 by 16 area of pixels.

* The image that displays in the scrolling story (for Keen 4 this is 4bmp0102.bmp) is limited in palette colors. The colors availible can be changed with patching.

=== Hitboxes ===
In keen galaxy, hitboxes are invisible rectangular areas used for telling a sprite how to interact with the environment or with Keen. For a point item, the hitbox is the area keen must touch to collect the item. For an enemy, it is the area of the enemy that will touch the ground and touch keen. For Keen himself, its the area he can interact with platforms, enemies, and other objects.

To edit the hitboxes, open 4sprites.txt. This can be a complex, difficult process that often falls to trial and error.

We'll use Keen's left facing standing frame as an example. The image name for this is 4spr0006. So in 4sprites.txt, look for item 6. It will look like this:

6: [4, 0, 19, 31], [0, 0], 4.

The first set of brackets controls the hitbox. The first set of numbers are x and y coordinates for the top left corner of the image. These are measured from the top left of the image (4 pixels across and 0 down). The next coordinates are for the bottom right of the hitbox. These are also measured from the top left corner of the image (19 pixels across and 31 down). Notice that even though the image is actually 32 pixels high, the hitbox is designed to be 1 pixel away from the bottom. This is important for any sprite that needs to move on a platform.

The second set of brackets are coordinates that have to do with where a sprite image appears ingame relative to where it is placed in the level editor. In the example of the Keen sprite, these are 0,0. Its usually easiest to leave these at 0,0, but if you use a sprite that changes frame size over the course of its animation, or a sprite intended to float above the ground, you may want to experiment with this. The first value is an X coordinate and will determine how far to the right or left the sprite is placed. The second value is a Y coordinate which determines how far up or down the sprite is placed.

'''Note''': If you've modded an enemy and it is stuck in the ground or in the air, you'll want to edit the Y value to bring the hitbox even with the ground.

The last value is not a coordinate but has to do with animation frame rate. In the example of Keen, this value is 4. This value varies from 1, 2, and 4.This determines how 'smooth' the frames in a series animate, 4 being the smoothest, 2 medium, and 1 low. The smoother the animation, the more memory will be used in the level.
'''Note''': Use the 4 value sparingly to avoid memory issues and game crashes.

== Texts ==
You'll find a number of text files in your BMP folder. You can edit these with notepad or a similar application. These files include the help sections, the story, and the end-game story. These files employ a formatting code:

* ^P means "new page"

* ^G followed by a series of numbers is for a graphic image. The first two numbers are x and y coordinates for where the image will be located. The last number specifies the image used. These images numbers don't match up with the image numbers in your graphics folder, so you'll want to do some experimenting to get the right one.

There are specific codes for changing the color of text, but this list is not yet included in this tutorial.

There is also a specific code for creating 'timed' images which will animate based on a timer, but this is not yet included in this tutorial.

= Importing Graphics and Texts =
To import your graphics, go back to your command prompt and type in the same address as previously, but you'll change the command to import this time:

modkeen -episode=4 -import -bmpdir="BMP"

'''Note''': You may need to drag and drop modkeen onto dosbox and then type this command.

If you get the done message, you've imported successfully, however, you can't try out your new graphics until after creating a patch file and corresponding batch file, which is explained in the next section.

= Patch File and Batch File =

Your patch file is used to access all the edited content in your mod. It's what allows you to have new graphics, new tile properties, new levels, new music, new text, new enemy behaviors, etc. It also allows you to change the 'rules' of the game in certain ways (although there are limitations).

If you look in your "keen4mod" folder, you will notice that Modkeen has generated a patch file for you called "keen4.pat". You will want to rename this so that it isn't overwritten in the future. Locate Keen4.pat and rename it to something like "mymod.pat".

You can also create a patch file from scratch. To do this, create a new .txt file called "mymod". Open the file and save as "mymod.pat" and make sure you select "all files" in the "Save as type" section. You should now have a "mymod.pat" file.

Your batch file is what you'll use from now on to play your mod. To create a batch file, first create a new text document and name it whatever you want. In this example we'll use "Play". In the text file, type: ck4patch mymod.pat

Now, go to 'file' and save as "Play.bat" and make sure you select "all files" in the "Save as type" section.

Run "Play.bat" to make sure your mod is working. If you see your modified graphics and/or texts, it works!

== Patching Basics ==
After you've made sure Play.bat runs fine, open up mymod.pat with a text editor.

You should see:

ext ck4
version 1.4
# Load the modified graphics
%egahead EGAHEAD.CK4
%end

Here's what each line means:

* The first two lines mark the beginning of your patch file.

* The # symbol indicates a comment. Any line preceded by a # will be skipped over and allows you to include notes in your patch file.

* %egahead EGAHEAD.CK4 is what tells the game to use your new graphics.

* %end will mark the end of your patch file. Anything that appears after this will not be read by the game, so make sure that any patches you add to this file are included before this line.

You can find all kinds of patches on the [http://www.keenmodding.org/ Keen Modding Forum] as well as make specific requests. Additionally, your can run [[The Neural Stunner]] to generate some easy patches, or dig through the patch files of existing mods.

Here's an example patch that makes bounders unkillable:

%patch $11166 $12 $2F

Now add it to the patch file and also add a comment explaining what it does.

%ext ck4
%version 1.4
# Load the modified graphics
%egahead EGAHEAD.CK4
#Make bounders unkillable
%patch $11166 $12 $2F
%end

Now save your patch file and run Play.bat. Bounders should now be unkillable!

= Tile Properties =
Go to your "Tools" folder and go into your ckD456tli folder. Copy the Keen4.tli file into your "keen4mod" folder. Then go to your patchfile and add the patch that corresponds to your modded episode below:

%patchfile $249C2 keen4.tli
%patchfile $25B22 keen5.tli
%patchfile $25212 keen6.tli

Now run CkD456tli. The first item the program asks you for is the file which you just copied to your "keen4mod" folder. Locate and select it. Next, go into the BMP folder and select the background tileset, and after that select the foreground tileset.

You're now in the editing menu.

On the left side you can see the background tiles. The properties in that tileset are limited: either a tile can animate or have no properties. If a tile animates, the next tile in the animation sequence is outlined in a double red border. Note that tiles can only animate up to 128 tiles before or after any given tile, so try to keep tiles that animate near each other.

To animate a tile, select the first tile in the animation sequence. Next, right click the tile that should appear next in the sequence. Now left click that new tile and select the tile it will animate to next. Make sure the last tile in this sequence animates back to the original tile. Now go back and add animation times to each tile. By moving the scrollbar, you can change the amount of time spent on the tile while animating (0 to 255 time units).

If a tile animates that you don't want to animate, right click the original tile. You will need to repeat this step for each tile in the animation sequence.

* '''Note''': Reducing the scroll bar to zero will NOT prevent the tile from animating and will instead cause the game to crash

* '''Note''': After disabling a tile from animating, it is not necessary to reduce its value in the scroll bar to zero, although this is recommended to avoid future errors when editing.

On the right side is the foreground tiles. For foreground tiles, you can also edit the animation properties (and they work the same way), but there are several other properties you can edit as well. Above the enlarged pictures of the tile and its mask is a dropdown menu where you can select the properties of the top of the tile. Similarly, the dropdown menu below lets you select the properties of the bottom of the tile. Pushing in the buttons on either side signify that Keen (and other sprites) cannot enter the tile from that side, making it solid. (Note that these are almost always set or cleared together. One-way tiles do not work as well in Keens 4, 5, and 6 as they do in Keens 1, 2, and 3). Off to the right is another dropdown menu, which lets you change special properties of the tile. Lastly, when the "FRONT" button is pushed in, it means that the tile appears in front of Keen and other sprites rather than behind them.

* '''Note''': There are some exceptions where foreground tiles that animate have their animation value set to zero. This includes: Key-gem doors and and flag holders.

When you're finished editing, click save.

= Level Editing =
Before getting into special instructions for each editor, some general knowledge about how Keen Galaxy levels work is needed.

Keen 4, 5, and 6 levels consist of three layers of tiles: the background, foreground, and info layers. The background is just there to add color to the scene; Keen and the enemies don't interact with it. The foreground layer contains tiles that Keen interacts with: platforms, point items, doors, secret passages, and so on (note that many tiles in the foreground layer actually appear behind Keen, but they are not considered 'background tiles'). Finally, the info layer contains information about sprites and special features such as switches, doors, bridges and so on. When level editing, you will generally work with only one layer at a time, although all three may be visible at once (layers can be toggled).

In keen 4, 5, and 6, the world map is built primarily from background tiles which do no have solid properties. Instead, special 'invisible' tiles are placed from the foreground tilset on the world map to block Keen's path. These can be difficult to figure out. Check tile properties with ckD456tli to figure out what is what and then edit the invisible tiles to have visual cues for placement (they can be made invisible again later). Alternatively, you can use foreground tiles to build the world map (although this will use more memory).

Keen Galaxy levels have a rectangular border of 2 tiles. Borders should be filled with solid tiles with some exceptions. To create a level exit, leave the border empty where you want Keen to exit. Keen cannot exit out the top or bottom of the screen (Keen will die on the screen bottom and Keen will glitch on the screen top).

Point items can be placed as both sprites or as tiles. It is important to place as many point items as tiles as possible to avoid memory issues. A good rule of thumb is to only place sprite items on foreground tiles.

Included below are general instructions for Ted5 (Sections written by Levellass and Adurdin, edited by Ceilick), Keen: Next (Written by Ceilick), and The Omegamatic (Written by Mink and edited by Ceilick).

== Ted5 ==
=== Setting up Ted5 ===
Download and unzip ted5 into your "keen4mod" folder.

1. Look for the file Egahead.ck4. Rename this file Egahead.ren.

2. Run Tedsetup.

3. Tedsetup will generate a new Egahead.ck4. Delete this file. Now Rename Egahead.ren to Egahead.ck4.

This is the only time you will need to run tedsetup and follow the above steps.

You will probably need dosbox to run Ted5. Just drag and drop the ted5.exe onto your dosbox icon.

=== The Interface ===
After dismissing the welcome screen, the first thing you will want to do is press F9, or click the "?" tab and select "Video Mode Switch". That will cause TED to run in 640x480 mode, giving you more space to work with. You can switch to the low resolution mode again anytime you want to make sure how much of the level is going to be displayed on the in-game screen at once.

At the bottom of the screen, you will see the Info Bar. From the far left to right, it displays:

* Selected Background tile.
* Selected Foreground tile.
* Selected Sprite Icon.

These items display the icon as a graphic, followed by the tile number in hexadecimal (like $00AE) and decimal (174). Clicking on any of them will bring up the tiles palette so you can select a new one.

Next appears the name of the level. This name is used only in Ted5, it does not affect the level name in-game.

Next appears: Active layers (B, F, I)
* B: Background Tiles
* F: Foreground Tiles
* I: Sprite Icon, door/switch coordinates

The letter indicates the layer where you will be adding new tiles to. You can select more than one and the selected tiles will all be placed, however, it is recommended that you work only one layer at a time.

Next appears: Visible layers (b, f, i)
This tells you which layers are being toggled. You can toggle layers with the hotkeys 4, 5, and 6.

When a layer is turned off you cannot place items in it by mistake. This allows you
to take a closer look at a specific layer to make sure everything is placed correctly.

Lastly, on the bottom far right: Cursor location (X, Y)
This gives you the tile coordinates at a specific spot on the map. This will also be given in both decimal and hexadecimal numbers. You will need those numbers in order to have switch that activate lifts, doors leading to other places, toggling bridges, and more.

=== Editing ===

By default, TED5 will load the world map for the game. In order to switch to another map, you will need to click the File menu and select Edit New Map. You will then be able to select any of the maps in the game. For this example, pick Slug Village.

You can use the arrow keys to scroll the level around.

You can toggle which type of tile to place (background, foreground, sprite icon) by pressing the 1, 2 or 3 keys. Note for each type of tile, you will need to press the number key to activate it and the same key again to deactivate it before using a different tile type.

Adding new tiles to the level is as simple left-clicking. The currently selected tiles will be placed in all active layers. You can select tiles in three ways: Clicking the tile icon to the left of the Info Bar, pressing the space bar to bring up the tile set, or right-clicking an existing tile.

Right-clicking an existing tile will switch all the active tiles to the ones in the active layers. This means, if you only have the Icon layer active, right-clicking a tile with a slug will only select the slug; while if you have all three layers active, it will select the slug, the Foreground tile, and the Background tile at that location.

Once you have a basic level made, you'll want to add more advanced features like moving platforms, switches, bridges, doors, and so on. These are all done with links in the sprite icon layer.

A simple moving platform in Keen 4 can be placed by putting a moving platform icon with a red arrow in the desired spot. To stop the platform moving off the edge of the screen however, you'll need to put some blocking tiles in its path: these icons look like a "B" in a square. Put one blocking tile to each side (for a horizontally-moving platform) or above and below (for a vertically-moving platform). A collapsing platform (the one with a yellow triangle below) only needs a single blocking tile beneath it. In Keen 5 and Keen 6, the platforms with green arrows (known as Goplats) need a path made of the yellow arrow icons to follow.

Often you want the player to have to turn a platform on with a switch. To do this, you need to place another blocking tile in the way of the platform between the other two. Make a note of the hexadecimal values of the location of the tile (the X and Y values beginning with $ at the right-hand side of the status bar). Now place a switch in an appropriate place, and link it to the blocking tile: Choose Misc, New INFOPLANE Value or press Enter, and type in a $ followed by the last two digits of the X and Y values you wrote down. Then click on the switch; this will place the link in the info plane, which will be shown as four digits. The switch will now turn the blocking tile off, to activate the platform.

When working on your world map, you'll want to use the infoplane to specify what levels your entrances will lead to. To do this, go to Misc, New INFOPLANE Value, and type in a $ followed by one of the following: $C0xx is a link to level where xx is the level number in hexadecimal, not decimal), $D0xx overlays blocking tiles that will be removed upon completion of the level (think the gates for border village and slug village), and $F0xx is for the flag holder which corresponds to the level. After entering your chosen value, you can then edit the info plane by left clicking.

In the same way, you can link a switch to a bridge (link to the left-hand edge of the bridge), a gem-holder to a closed door (link to the top of the door), and a walk-in doorway to the place you walk out (link to where you want Keen's feet to end up after he enters the doorway). Note that if you create a link from a switch to a square with nothing in the info plane, that switch will turn a blocking tile on; also that you need to use a particular tile to make a walk-in door (find out by looking at an existing level).

Another feature which makes Keen levels exciting is secret passages. Some foreground tiles allow Keen to walk behind them-these are suitable for secret passages. However, identifying which ones are like this and which ones are solid is difficult: I suggest examining some of the original levels and noting down the tile numbers of the "secret passage" tiles to keep track of them. When putting point items in a secret passage, you must use icons for them, rather than their foreground tiles. I suggest that you only place the "walk-behind" tiles in secret passages once the level is completed, so that while editing you can keep track of them more easily.

Finally, some Keen levels have separate areas that act like independent mini-levels (the Pyramid of the Forbidden is a good example of this). You can place scroll blocks in the info layer to mark horizontal and vertical edges between these areas. The scroll blocks look like horizontal and vertical blue lines with small white stripes; I suggest examining existing levels to see how they are
used before placing them in your own levels.

=== Saving ===
You can save your map at any time by going to the File menu and selecting Save Map; however, in order to actually play the level, you will need to Carmacize Maps. While ted5 has an option to do this, it takes too long to do so. The easiest method is to download InstantCarma and unzip the files into the folder with your maps. After you save your map in ted5, just run InstantCarma.

TEDSETUP creates an extra batch file (Go4.bat) and patch file (Patch4.pat) which you do not need if you open your existing patch file and add the line:

%maphead maphead.ck4

You only need to add this to your patch file once. Then just run your batch file to try your level!

=== Other Ted5 Features ===

Grid Mode toggles the showing of a grid on the current level. This can help with placing tiles in the right positions. Turn this on or off from the Mode menu or by pressing G.

Block Fill mode quickly fills a rectangular area with the currently selected tiles. Choose it from the Mode menu or press B, and click the left mouse button on the desired top-left corner, and the right button on the bottom-right corner, then press Enter to fill the area.

Flood Fill mode will fill an area of one tile with the currently selected tiles. Choose it from the Mode menu or press F, then click in the desired location to fill.

Copy Mode (also on the Mode menu, or press C) lets you select a rectangular set of tiles to copy so that you can duplicate them in another region easily. Select the area as for Block Fill mode, then press Enter.

Paste Mode (you know where to find it) allows you to paste one or more copies of the tiles chosen with Copy Mode. Click with the left mouse button to place a copy. You can use the Paste Overlay option (on the Mode menu, or press F3) to toggle pasting of empty tiles. The Snap-Paste option (press S) toggles pasting copies just anywhere, or in a tessellated pattern. This is especially useful for
filling in the background of a level.

You can change the size of a level with the "Change MAP Edges" option on the Edit menu. Select the edge you want to change, and enter a positive or negative number to add or remove rows from that edge.

== Keen:Next ==

=== Setting Up ===
Go to the keen 4 folder in Keen next and copy the tiles4.png file. Paste this into your "keen4mod" folder.

Edit tiles4.png to include your edited graphics. Be sure to save the file as .png.

Go to your Keen:Next folder and run the kmaps application. You may get an error message after running this, but this is not a problem, just click ok.

When the editor opens, the first thing to do is go up to 'file' then 'new'. A 'project properties' window will appear. Give your project a title (it doesn't matter what you name it) and then check the "keen project" box. We'll be using Keen4, which is the default setting. If you're planning to edit keen 5 or 6, just make sure to select those in the box next to "keen project". Next we need to choose the tileset. In the image file section, go to 'browse' and select the tileset you want to use (in this case, tiles4.png). After all this, click 'ok'.

* '''Note''': you will have to do this each time you open the editor.

Before editing levels, you must extract them in a way that Keen: Next can read them. Go to 'file', then 'create keen files'. Browse to your "keen4mod" folder and select keen4.exe. Your keen map files should now be created.

* '''Note''': this will not work if you have run tedsetup.

* '''Note''': You only have to do this once.

=== The Interface and Tools ===
The tiles should load on the right side of editor menu. You can adjust the tile menu width with the mouse by selecting the left edge. You can scroll between the background and foreground tiles.

In the upper left is a toolbar. The default tile tool is the pencil/paintbrush. You can click and place or click and drag to place tiles.

There is also a water dropper tool. This is useful for selecting a tile currently on the map instead of looking for it in the tileset.

* '''Note''': the water dropper will 'pick up' the tile from the tileset you're currently in; if you currently have a background tile selected and use the water dropper, it will pick up the background tile on the map. If you want a foreground tile, scroll down in the tileset on the right and select one of the foreground tiles, then use the water dropper on the map.

I do not recommend using the paint can tool, since it is very buggy.

The next tool can be used for selecting
a rectangular area of the map. This is useful for cutting a piece of the level and pasting it elsewhere (you will need to do this twice if you want to cut and paste both the background and foreground). You can also create stamps this way. Just select an area and go to "selection" and then "create brush". A stamp of the area will now appear on the left.

You can create stamps of a large area of tiles from the tileset also. To do this, click the top left corner of the area of tiles you want in the tileset. Then go to the bottom right corner of that area, while holding shift, and select that tile. Doing this successfully will result in the stamp image appearing on the left side of the editor. You can now use the paintbrush tool to place this stamp, and you can reselect this stamp at any time you're editing.

The next tool looks like a little cog. This is used for placing doors, level entrances, switches, and key-gem holders.

The last important tool has an icon that looks like an arachnut. Click this to bring up the sprite menu. This is used for placing enemies, points, and some other things. To switch back to tiles from sprites, click the little black square icon to the left of the arachnut icon you used to get to the sprite menu.

In addition to the tools, you can toggle the layers used in editing with the 'view' tab and checking/unchecking layer 1 and layer 2. Make sure that, in the "view" section, you have 'fade unused layers' unchecked. This makes level viewing easier.

* '''Note''': This is the buggiest part of Keen:Next and if you frequently toggle layers, glitches can ruin a lot of work put into a level. Its usually best to leave both layers visible, or save your progress before toggling layers and then reload Keen: Next as soon as you finish the work that required toggling them.

=== Editing ===
To begin editing, first load a map. Go to 'file', then 'Import Keen Map'. In your "keen4mod" folder, select 'maphead.ck4'. You should now be presented with a 'map select' box. Choose the level you'd like to edit. Let's start with the shadowlands.

The shadowlands map should now be loaded in the main editing area. You'll notice little white icons that look like this (!). These are the level sprites. To place these, use the little cog tool up in the upper left (next to the rectangular area selector). When this tool is used to click the map, you'll get an 'info plane' box asking for an x and y coordinate.

On the world map, this is how the coordinates work:
The x coordinate determines what kind of sprite is used. An X of 192 designates the sprite as a level entrance. Note: you cannot place a level entrance on a tile that appears over keen or on an animating tile.

An x of 208 is a level block (like those used in the slug village); this sprite does not actually block keen, but is placed over a foreground tile that does. When the level is beaten, this info number removes the foreground tile.

An x value of 240 is for the flag holders.

Y coordinates only designate what level the sprite is associated with. A Y of 1 will designate the level as level 1.

To place sprites (enemies) in a level, go to the tools menu and click the little icon that looks like an arachnut. The sprite menu should appear in place of the tileset. To place a sprite, make sure you have the paintbrush icon selected, then click the sprite you want to place. To switch back to tiles from sprites, click the little black square icon to the left of the arachnut icon you used to get to the sprite menu.

* '''Note''': some enemies appear more than once in the sprite menu; this is for enemies that appear on easy, moderate, and hard. You can see little numbers that designate this, but a general rule is that the order they appear in on the menu matches the easy/medium/harder order.

To place a keygem holder, first place the foreground keygem holder tile somewhere on the map (it can be anywhere). Next place a door (these are also foreground tiles) somewhere (anywhere). When making the door, there are three door tiles: a bottom, middle, and top. If you're making a door more than three tiles high, use the middle door piece for additional height. Using your mouse, hold it over the top tile of the door. In the lower left side of the editor, you'll notice that the map coordinates for this tile appear. Memorize or write these down. Now select the cog tool and then click your keygem holder. Enter in the coordinates for your door. You've now got a working door.

To place doors that Keen can enter, first place two sets of door tiles on the map. Now you must determine the coordinates. Go to one of your doors and hold the mouse over the tile below the bottom left door tile (not on the bottom left door tile or keen will drop out of the air). Check the coordinates. Then go to the door you want to connect to this spot and use the cog tool and click the lower left door tile (the lower left door tile, not the one below it). Enter in the coordinates. Do the same for the bottom right door tile. Now this door is connected to the other, but you also need to check the coordinates at this door and add them to the tiles of the other door.

To create a working switch, use the cog tool on a switch and use the coordinates for the thing you want the switch to affect. For a bridge, get the coordinates of the top left bridge tile and put this in the info box for the switch. For goplats (moving platforms), get the coordinates of a B sprite (these are sprites which goplats bounce off and then go in the other direction). The switch will remove that sprite so the goplat can move.

To resize a map, go to "edit" and "Resize map". Then select the new level boundaries and the side of the level which should be expanded or shrunk.

Keen: Next has an infinite undo button. Just go to "Edit" and click "Undo".

* '''Note''': Undo will work for everything except changes to the level boundaries. Make sure you save before changing level boundaries!

=== Saving ===
When you're ready to save, go to 'file', then 'export keen map', then select 'maphead.ck4', click yes, and reselect the level you want to save over and click ok.

* '''Note''': if you like, You can rename the level here before you click ok. The name you choose will only appear in the editor, however, and not in the in-game text.

* '''Note''': Do not click 'save' or 'save as'. These options do not actually save the level to the game, but as files only Keen: Next can read. Additionally, saving levels in this manner can cause Keen: Next to crash.

After saving you can test your levels by adding this to your patch file:

%maphead maphead.ck4
%gamemaps editmaps.ck4

Then run your batch file and you're all set.

== The Omegamatic ==
===Setting Up===
Run tom.exe and select the gamemaps.ck4 file. You will then need to select your tilesets which you exported modkeen: 4til0000 and 4til0001. After selecting these, if all goes well, the world map will open in TOM.

===The Interface and Tools===
Tom features two different level editing styles: Ted5 and Keen:Next. I highly recommend Keen:Next Mode and will only cover it in this tutorial. To activate this go to settings and click "Keen:Next Mode". You will now see the tileset on the right side of the TOM window.

In the bottom left of the window you will see three different boxes. These boxes display the tile you pick from the tileset on the right of the window. Each box displays from one of the three layers used in Keen:Galaxy: background tiles, foreground tiles, and sprite icons. To change which tileset to work with, use the hotkeys 1, 2, and 3 to switch between the layers.

To place a tile simply select the tile from the tileset with the left mouse button and click on the level where you want to place it with the left mouse button. You can also right click a tile from the level to make it the active tile for placing, just like a water dropper tool. To erase a tile you will need to right click an empty space in the level, which makes an empty tile the active tile, and then left click what you want to erase.

If you want to select an area of tiles from within a level, press C and left click a corner of the area you want to select. You should then left click the opposite corner of the area you want to select. The selected area will have it's colors inverted until you select the size of the area. You can then press P to paste the area you selected.

If you want to select an area of tiles from the tileset, left click the top left tile of the area you want to select. Then, while holding shift, left click the bottom right tile of the area you want to select. Release shift and then you should be able to place the selected area in the level by left clicking.

You can scroll around the level with your mouse wheel or with the arrow keys. You can zoom in and out in the "View" tab. You can also toggle on and off which layers can be seen with the hotkeys 4, 5, and 6.

To change the level you are editing go to "Levels" and select the level you want to edit. You can rename levels by going to "File" and then "Rename This Level".

You can resize a level by going to "Tools" and selecting either: Insert Row, Delete Row, Insert Column, or Delete Column. After selecting on of these move your mouse around the level and you will see a highlighted area which will be affected by whichever option was chosen. To disable any of these level adjustments just go back to "Tools" and uncheck it.

When working on your world map, you'll want to use sprites to specify what levels your entrances will lead to. To do this, first press 3 to activate the sprite icon layer. Press enter once and a message box will come up with an infoplane number in hexideciaml. Remove the number indicate and type one of the following: C0xx makes a level entrance where xx is the level number in hexadecimal, not decimal), D0xx overlays blocking tiles that will be removed upon completion of the level (think the gates for border village and slug village), and F0xx is for the flag holder which corresponds to the level. After entering your chosen value, you can then place the level entrance, gate, or flag sprite by left clicking.

===Sprites and Enemies===
To place sprites and enemies in a level, press 3 to bring up the sprite tileset. You can place sprites like you would normally place a tile. Some enemies appear more than once in the sprite menu; this is for enemies that appear on easy, moderate, and hard. You can see little numbers that designate this, but a general rule is that the order they appear in on the menu matches the easy/medium/harder order. Sometimes there is a blank space before or after the order of sprites. For example, the blue bird from keen 4 doesn't have a sprite icon for easy mode, however, it does have a blank tile where the easy mode icon would normally go. This blank tile can be placed to place a blue bird on easy. This works similarly for other enemies in this situation.

===Secret Passages===
Some foreground tiles have properties that allow Keen to walk behind them; these are secret passages. To make these you will need to identify which tiles have the correct foreground but not blocking properties. I suggest examining some of the original levels and noting down which tiles are used for the secret passages. You can also identify them with the CKD456tli utility. When putting point items in a secret passage, you must use points from the sprite list rather than the foreground tile points.

===Moving Platforms===
A simple moving platform in Keen 4 can be placed by putting a moving platform sprite icon with a red arrow in the desired spot. To stop the platform moving off the edge of the screen however, you'll need to put some blocking tiles in its path: these icons look like a "B" in a square. Put one blocking tile to each side (for a horizontally-moving platform) or above and below (for a vertically-moving platform). A falling platform (the one with a yellow triangle below) only needs a single blocking tile beneath it. In Keen 5 and Keen 6, the platforms with green arrows (known as Goplats) need a path made of the yellow arrow icons to follow.

===Switches for goplats===
Often you want the player to have to turn a platform on with a switch. To do this you will need to place another blocking tile in the way of the platform between the other two. After placing the blocking tile, hold the mouse over it and press enter two times. This will give you the hexidecimal coordinates which you will place on the corresponding switch. The switch will now turn the blocking tile off thus activating the platform.

===Switches for bridges===
To create a switch for bridges, first build the bridge using the bridge tiles. Then hold your mouse over the top left tile of the bridge and press enter twice to get the hexidecimal sprite value. Place this sprite on the switch you want to activate the bridge with. If you want the bridge to begin already opened, you will need to locate the invisible bridge tiles and place these where the bridge will be located, otherwise no bridge will appear. To find these either locate them in existing levels with open bridges or use ckd456tli.

===Key Gem Doors===
To place a keygem holder, first place the foreground keygem holder tile somewhere on the map (it can be anywhere). Next place a door (these are also foreground tiles) somewhere (anywhere). When making the door, there are three door tiles: a bottom, middle, and top. If you're making a door more than three tiles high, use the middle door piece for additional height. Using your mouse, hold it over the top tile of the door and press enter twice. Place the sprite that this gives you on the gem holder.

===Doors===
To place doors that Keen can enter, first place two sets of door tiles on the map. Then hold the mouse over bottom left or right of the first door and press enter twice. This gives you a sprite which you should place on the bottom of the second door you want connected to the first door. After placing the sprites at the bottom of the second door, you will need to press enter twice at the bottom of this second door and place the sprites on the first door in the same way.

===Scroll Blocks===
Some Keen levels have separate areas that act like independent mini-levels (the Pyramid of the Forbidden is a good example of this). You can place scroll blocks from the sprite menu to mark horizontal and vertical edges between these areas. The scroll blocks look like horizontal and vertical blue lines with small white stripes; I suggest examining existing levels to see how they are used before placing them in your own levels.

===Saving===
To save your progress go to "File" and then "Save all Levels". This will immediately save all your levels.

===Testing===
After saving you can test your levels by adding this to your patch file:

%maphead maphead.ck4

Then run your batch file.

== Abiathar ==

See Fleexy's [https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharHelp.pdf official manual] or [https://www.youtube.com/playlist?list=PL-BuW7CehquoCH_yGXeQqTIXQMY7sUm-u video tutorial playlist].

== General Level Editing Issues ==
If there are too many sprites in a level you will get the error 'No space left in objarray'; the game has run out of memory to store sprites. This usually occurs at the level start. To fix this, remove sprites from your level. When placing sprites, keep in mind that the more variety of enemies you use, the more memory is used up and the larger the sprite and the more frames it has, the more memory it uses. Also, when trying to save memory, check your points items: these exist both as tiles and sprites (try to use tile points whenever possible).

If you have too many different types of tiles (Background and foreground) then you will get the error 'No space left in tilearray'; this means that the game does not have enough memory to store all your different tile types. Foreground tiles use 8x the memory of background tiles. You shouldn't have more than about 400 tile types total (Background and foreground) in a level, usually 100 back and 300 fore. Additionally, animating tiles with many frames can increase your tile count drastically.

* '''Note''': I have never had this error before and imagine it would be difficult to attain, so don't be worried about using too much until you get this error.

You cannot have more than 20 actively animating tiles on-screen at any one time, this includes item tiles. This will cause an anim tile error. (Not enough memory to animate all these tiles.)

Note: This was a major problem in designing the Lava Falls in [[Dead in the Desert]], so be careful when it comes to animating tiles.

If a level is 'too large' for its music file, the error 'Not enough memory to play background music!' will occur. This is an indication of either large levels or large music files. To reduce this error, either make your level smaller or change the music to a smaller file.

If you see static gibberish instead of an animation while testing your level, then you have placed an animating background over an animating foreground. For memory reasons this is not allowed. Similarly, a sprite cannot be placed on top of an animating tile. This will crash the game.

= Music and Sounds=
Copy Keenwave.exe into your "keen4mod" folder. Run Keenwave and it will generate an IDWAVE text file. Create a folder called "sounds". Open IDwave.txt and add this line:

-episode=4 -export=raw -snddir="sounds"

Run Keenwave by dragging and dropping it onto dosbox.

Now look in your sounds folder. Here you will see a number of sound files and a few music files (IMF files) at the bottom. To change these, just replace the sounds with new file (they must be the same format, for music this is IMF). Sound effects can be created and modified using WDC. You can create IMF files by converting midi files with IMF Creator.

After changing the sounds or songs, go back to IDWAVE.txt and change the command to:

-episode=4 -import=raw -snddir="sounds"

Run Keenwave.

Now open your patch file and include the lines that apply to the episode you're modding:

#Keenwave patch file; Patch sounds Keen 4:
%patchfile $20DF0 AUDIOHED.CK4 #Audio header
%patchfile $354F6 AUDIODCT.CK4 #Audio dictionary

#Keenwave patch file; Patch sounds Keen 5:
%patchfile $21C80 AUDIOHED.CK5 #Audio header
%patchfile $35EC4 AUDIODCT.CK5 #Audio dictionary

#Keenwave patch file; Patch sounds Keen 6:
%patchfile $20C50 "AUDIOHED.CK6" #Audio header
%patchfile $36EEE "AUDIODCT.CK6" #Audio dictionary

== Creating and Editing Sound Effects ==

Begin by installing WDC to your tools folder. Once this is commplete, go to the new WDC folder and create three new folders inside: "Keen4input", "Keen4output", and "KeenSounds". You should then copy a clean version of Keen 4 into the "Keen4input folder", specfically the files: Audio.ck4, Egagraph.ck4, Gamemaps.ck4, and Keen4e.exe.

'''Note:''' Make sure this version of the keen4e.exe has NOT been unlzexed.

Now run WDC.exe. After is loads, go to "File" then "New Project". WDC will then ask you to name the project and save the project file; name it "keen4project" and save it to you WDC folder.

WDC will then bring up a window with several options. Under "Base Data Folder" select your folder "keen4input". You will then get a "no map code file" alert. When this occurs, select "User Other" and then select "blank.wmc". Under "Output Folder" select your folder "keen4output". On the left side you will see a small menu, select "Other Options" and then check the box for "Use Tile16s for maps, if they exist".

You should now see the Keen 4 world map. You'll be using only one part of WDC, however, so go to "View" and select either "PC Sounds" or "Adlib Sounds".

WDC will then load the list of sounds for that category. You can sample each sound by clicking it. Playback controls are located in the upper right. To edit a sound, click the small hammer icon in the lower right. WDC will then ask you where you want to save the file. Navigate to your "keensounds" folder. Name the sound in such a way that you can remember what it is: "slugslime", "jump", "item" etc.

WDC will then load it's sound editor. There are various tabs for effecting how the sound is played, and the main area allows you to use your mouse and 'draw' the sound. Sound editing is a complex task and the only real advice I can offer is to just play around in the editor and save sounds that you find good or interesting.

After you've saved some sounds, you'll want to swap these into your mod. To do so you'll first need to locate the original sound file you want to replace in the "sounds" folder you created when setting up Keenwave. You can do this by listening and finding the sound you want to replace in WDC and then locating the corresponding number in the sounds folder. This is easy for PC speaker sounds, but since Keenwave doesn't seperate the PC speaker sounds from the adlib, you'll have to locate the last PC Speaker sound and then begin counting again from 1 in order to match the adlib sound list in WDC to that in your sounds folder.

When you've located the original sound you want to swap out, copy it's name to your new sound and then replace the file. Then run Keenwave to import your new sound effect.

== Working with the IMF Format ==
In IMFCreator, go to the "options" menu and set the tics/sec to 560. This will make your songs convert at the correct tempo.

The following, excluding the tip from thehackercat, is written by Mr. M for PCKF/KeenModding:

Compose your music using your choice of software. As long as it outputs standard General MIDI files, you should be good to go.

Please read and get an understanding of the [http://www.shikadi.net/moddingwiki/IMF_Format IMF specs].

Tip From Thehackercat:
For those of you using a sheet-music editor such as Finale: You may write two or more parts for one instrument. Keep inside the required 4-note polyphony, but don't be shy about using layered parts and chords, especially on piano staves.

Tips From Mr. M:

(1) IMFCreator seems to interpret MIDI note velocities. If your instrument track is too quiet *and* it is set to maximum volume, try manually adjusting the note velocites to be higher. I know that FLStudio is capable of doing this; I'm sure other studio software packages are capable of this, too. If the volume of the track is too loud after making your note velocities higher, turn down the volume of that track.

(2) Keep percussion parts as simple as possible. It impedes the maximum polyphony limits that can be utilized by other parts. Simply put, you can write more complex parts that use this structure:

[SIMPLE/NO PERCUSSION]+[BASS LINE]+[CHORDS]+[CHORDS?]+[LEAD]

The number of dropped notes, if any, in IMFCreater is almost unnoticeable if you adhere to this formula. I've been able to push the IMF format to it's limits by doing this.

As Thehackercat stated, don't be shy about using chords and complex structures -- especially if your percussion line is nonexistent or very simple.

(3) Try not to use too many midi tracks, *especially* if they are all simultaneous. Too many midi tracks results in dropped notes (ie- parts drop out randomly *and* inconsistently), and songs that exceed the filesize limits. I personally only need 4-8 tracks, counting percussion, to acheive the sound that I get in my work.

(4) On the subject of percussion: To circumvent the polyphony limit that gets imposed when you use percussion parts, try using normal instruments played outside their normal range. Then in IMFCreator, tweak the patches you used by adjusting all the possible paramaters until you acheive the desired percussive sound. It may not work all the time, but it should do the trick in most cases. (Credit for this tip goes to [[Bobby Prince]])

(5) On the topic of modding instrument patches: Don't be afraid to tweak patches! It's under the 'EDIT' -> 'Instrument' (or press CTRL+I) menu. You can edit how all the instruments sound. All of them {including percussion). Distortion guitar not distorted enough? No problem. Pad not airy enough for you? Bass drum not punchy enough, or the hi-hat not sharp enough for you? No problems there. See the help menus for the specifics of how the patch parameters are edited.

When I do this, I make a patch set for each specific song. When you close the instrument editor, you are prompted to save changes. Do so, and save the .OP2 file that is generated as something *other* than GENMIDI.OP2 (I like to save it by song title for easy reference). Keep the original GENMIDI.OP2 file as a base set.

After you've tweaked the patches to your liking and saved your new .OP2 file, stop any playback of the song you're previewing. Under 'OPTIONS' and 'OP2 File:' you can choose the OP2 file that has the modded patches you created. Press play and listen to your new instruments!

* '''Note''': After editing an .OP2 file/patch set, you MUST stop and re-start playback of your song for the changes to take effect

(6) Be careful with pitchbends in your music. IMFCreator tends to overexaggerate them if the pitchbend scale and thresholds arent set properly. There's no ONE configuration for them; best bet is to tinker with them until you get a desireable sound. Remember: Lower numbers mean higher pitchbend scale!

As with editing the patch set, you MUST stop and re-start playback of your song for the changes to take effect.

= Loading Window =
Go to your graphics folder and look for the file 4msc0000.bin. Copy this to your keenscr folder.

Go to commander prompt and navigate to your keenscr folder and then type:

keenscr load

TheDraw will immediately start editing the screen, with the filename keenscr.bin.

Alt+H will display the help screen with all the commands that TheDraw supports; however, its basic use is extremely simple. Use the arrow keys or mouse to select where you want to enter text, then type it in. By default, it uses bright white color over black color; you can copy a color straight from the screen by placing the cursor over any character and pressing Alt+U, and it will use that color as you type.

You can use Alt+M to enter drawing mode, where you can use the cursor keys or the mouse to draw on the screen; you should enable Draw mode with the cursor in the place where you want to start drawing, as it will start immediately. Alt+F1 to Alt+F4 will give you different line styles for Draw mode.

Once you are done editing the screen, you can save it by pressing Alt+S. TheDraw will ask which format to save it in; press B to select Binary, and enter the filename keenscr.bin. It's important that you keep this filename (overwriting the existing one). After you exit TheDraw and KeenScr notifies you that the file has been updated.

Then you must copy 4msc0000.bin back into your graphics folder. Import using modkeen. You must also copy ck4load into your "mymod" folder.

Edit your patch file to include the patch for the respective episode:

%patchfile $1fe47 ck4load.bin
%patchfile $20cd7 ck5load.bin
%patchfile $1fca7 ck6load.bin

You can also edit the exit screen by going to the command prompt and typing: keenscr 4

When you're done, save it as keenscr.bin overwriting the generated file. You must save it in Binary format when TheDraw asks.

Then you must copy 4msc0000.bin back into your graphics folder. Import using modkeen.

= Scrolling Text =
Run Startext. The controls are listed. Select your episode of choice and then select edit scrolling story. Type your story as you want it, making sure not to go over the space limit or under it (the original story will appear at the bottom of your story if you do). Press enter.

Copy story.ck4 into your "mymods" folder.

Edit your patch file to include one of the following:

%patchfile $1EE40 "STORY.CK4"
%patchfile $1FDE0 "STORY.CK5"
%patchfile $1ED50 "STORY.CK6"

= Credits For This Tutorial =
* Written and Assembled by [[User:Ceilick|Ceilick]]
* Selections of [[User:Levellass|Levellass']] [[TED5|TED5 Tutorial]]
* Selections of [[Andrew Durdin|Andrew Durdin's]] [http://www.dosclassics.com/ckn/newsletter/issues/2002-03-01.txt|TED5 Tutorial]
* Selections of [[User:CK Guy|CK Guy's]] ck456tli readme
* Selections of [[User:Mink|Mink's]] The Omegamatic readme
* Selections of [[User:Leandrotlz|Leandrotlz's]] [[TheDraw|The Draw/Keenscr tutorial]]
* [[User:Shadow Master|Shadowmaster's]] [http://www.keenmodding.org/viewtopic.php?t=899 findings] for getting ted5 to work with modkeen 2.0
* [[User:Mr.M|_mr_m_'s]] IMF guide

[[Category:Tutorials]]"

Keen Galaxy Modding Tutorial (patch based)

2014-05-09T00:54:27Z

Fleexy: /* Level Editors */ Added Abiathar to level editor downloads

This tutorial aims to teach Keen Galaxy modding (Keen episodes 4, 5, and 6) to people who don't know the first thing about modding, but even the experienced modder should find this information as a good reference tool. Keen 4 will be used for specific examples, but if you are modding keen 5 or 6, you should be able to follow along.

= Setting Up Files and Folders =
Download my [https://dl.dropbox.com/u/3654819/Keen/Keen%20Galaxy%20Modding%20Package.zip Keen Galaxy Modding Package].

Alternatively, you can also manually create this package:

Create your base folder called "Keen Modding" on your desktop. In this folder you'll want to create two subfolders: "Keen4mod" and "Tools". In your "Keen4mod" folder, create a folder called "BMP".

Copy all your Keen 4 game files into the folder "Keen4mod".

* '''Note''': It is very important that you use the right version of the episode you wish to mod. Make sure they are the correct versions: Keen 4 v1.4, keen 5 v1.4, and keen 6 v1.4.

== Tool Downloads ==
These are the tools you will need in order to mod Keen's 4, 5, and 6 and included in the modding package. If you wish to download them individually:

* [http://files.keenmodding.org/modkeen2.zip Download Modkeen]
* [http://files.keenmodding.org/ckpatch-0.10.0.zip Download CkPatch]
* [http://files.commanderkeen.org/users/ceilick/UNLZEXE.EXE Download Unlzexe]
* [http://sourceforge.net/projects/clonekeenplus/files/Tools/unlzexe/win32/unlzexe081.zip/download Download Unlzexe (64 bit version)]
* [http://files.commanderkeen.org/users/mink/CkD456Tli(v3.3).zip Download CkD456tli]
* [http://files.commanderkeen.org/users/leandro/keenscr.zip Download KeenScr]
* [http://levellord.rewound.net/KEENWAVE.zip Download Keenwave]
* [http://levellord.rewound.net/STARTEXT.zip Download Startext]
* [http://winwolf3d.dugtrio17.com/download/IMFCreator Download IMF Creator]
* [http://winwolf3d.dugtrio17.com/download/WDC Download WDC]

* '''Note''': Depending on your computer's operating system you may need CWSDPMI.EXE to run modkeen and other modding programs. If your receive an error in later steps asking for this file, get it here:

* [http://www.delorie.com/djgpp/dl/ofc/simtel/v2misc/csdpmi5b.zip/BIN/CWSDPMI.EXE Download CWSDPMI.EXE]

=== Level Editors ===
You will need one of the four existing level editors: [[Keen: Next (level editor)|Keen Next]] (K:N), [[TED5]], [[The Photachyon Tranceiver]] (TPT), or [[The Omegamatic]] (TOM). This tutorial does not include instructions for The Photachyon Tranceiver since it is in many ways a windows based Ted5. I personally recommend The Omegamatic. All of these editors are included in my modding package.

* [http://files.commanderkeen.org/users/ceilick/TED5.zip Download TED5]
* [http://www.bipship.com/downloads/tpt3.zip Download The Photachyon Tranceiver]
* [http://files.commanderkeen.org/users/ceilick/KeenNextEditor.zip Download Keen: Next]
* [http://0x27.com/downloads/tom.zip Download The Omegamatic]
* [https://dl.dropboxusercontent.com/u/3771470/Abiathar/AbiatharUpdater.exe Download Abiathar (updater/downloader)]

=== Drawing Tools ===
One of the simplest tools for modifying Keen graphics is MS Paint. However, only the versions of MS Paint prior to Windows 7 will function with the Keen palette correctly.

* [http://sagorpirbd.deviantart.com/art/Win-7-MS-Paint-dll-XP-English-122788536 Old MSPaint]

Some modders use programs such as GIMP or PhotoShop.

= Setting Up Files and Folders (Continued) =

Unzip the tools in your tool folder. Copy the following files into your "Keen4mod" folder:
* modkeen.exe
* unlzexe.exe
* ck4patch.exe (Keen 5 requires 'ck5patch.exe', Keen 6 'ck6patch.exe')

Once these files are in place, Unlzexe your Keen4.exe by dragging and dropping the file onto Unlzexe.exe. A window may flash on the screen when you do so.

* '''Note''': If you are using the 64 bit version of Unlzexe, this will create a “Keen4.exenew”. You will then need to delete the old “Keen4.exe” and rename “Keen4.exenew” to “Keen4.exe”.

Open a command prompt. If you are unfamiliar with this process: go to your computer's start button, and either click 'run', or in the search field type 'run' and click the first result. In the run box, type 'cmd'. Now you have a command prompt open.

You'll see something like
C:\Users\UserName>

Type:

cd desktop\Keen Modding\My Mod

Press enter, then:

modkeen -episode=4 -export -bmpdir="BMP"

If all goes well, you should see a list of everything modkeen has exported followed by the word "Done!"

* '''Note''': If you are using a 64 bit version of windows modkeen may not run through the command prompt. You can run it instead by dropping modkeen.exe onto dosbox.exe and then typing: modkeen -episode=4 -export -bmpdir="graphics"

= Editing Graphics and Text =
To begin editing the graphics and most text found in the game, go to your "BMP" folder. You'll see a lot of images there as well some some text files and some other files.

== Graphics ==
You can edit any of these images how you want, but keep some things in mind:

* You need to use the original keen colors. This is easy to do if you just edit the images with MSpaint.
** '''Note''': Windows 7 users will need to download the old version of mspaint.

* On sprite images, you'll see three frames: the image against a black background, a black outline on a white background, and a red box on a grey background. The first image is where the sprite is drawn. The second is used to show what parts of the original image are going to be shown in-game. The last box is used for hitbox measurement, although it doesn't directly affect hitbox size (the 4sprites.txt determines this, see the 'hitboxes' section below).

* In the foreground tileset (4til0001) you'll see a similar black and white duplicate section on the right side. This is also used to show what parts of the tiles are going to be shown in-game.

* The height and width of images must be multiples of 8 (although some of the original images do not follow this rule).

* Changing the size of an enemy will affect how it spawns and the 'hitbox' area it uses to interact with the environment and with keen.

* You cannot change the size of the tilesets.

* Tiles are made up of a 16 by 16 area of pixels.

* The image that displays in the scrolling story (for Keen 4 this is 4bmp0102.bmp) is limited in palette colors. The colors availible can be changed with patching.

=== Hitboxes ===
In keen galaxy, hitboxes are invisible rectangular areas used for telling a sprite how to interact with the environment or with Keen. For a point item, the hitbox is the area keen must touch to collect the item. For an enemy, it is the area of the enemy that will touch the ground and touch keen. For Keen himself, its the area he can interact with platforms, enemies, and other objects.

To edit the hitboxes, open 4sprites.txt. This can be a complex, difficult process that often falls to trial and error.

We'll use Keen's left facing standing frame as an example. The image name for this is 4spr0006. So in 4sprites.txt, look for item 6. It will look like this:

6: [4, 0, 19, 31], [0, 0], 4.

The first set of brackets controls the hitbox. The first set of numbers are x and y coordinates for the top left corner of the image. These are measured from the top left of the image (4 pixels across and 0 down). The next coordinates are for the bottom right of the hitbox. These are also measured from the top left corner of the image (19 pixels across and 31 down). Notice that even though the image is actually 32 pixels high, the hitbox is designed to be 1 pixel away from the bottom. This is important for any sprite that needs to move on a platform.

The second set of brackets are coordinates that have to do with where a sprite image appears ingame relative to where it is placed in the level editor. In the example of the Keen sprite, these are 0,0. Its usually easiest to leave these at 0,0, but if you use a sprite that changes frame size over the course of its animation, or a sprite intended to float above the ground, you may want to experiment with this. The first value is an X coordinate and will determine how far to the right or left the sprite is placed. The second value is a Y coordinate which determines how far up or down the sprite is placed.

'''Note''': If you've modded an enemy and it is stuck in the ground or in the air, you'll want to edit the Y value to bring the hitbox even with the ground.

The last value is not a coordinate but has to do with animation frame rate. In the example of Keen, this value is 4. This value varies from 1, 2, and 4.This determines how 'smooth' the frames in a series animate, 4 being the smoothest, 2 medium, and 1 low. The smoother the animation, the more memory will be used in the level.
'''Note''': Use the 4 value sparingly to avoid memory issues and game crashes.

== Texts ==
You'll find a number of text files in your BMP folder. You can edit these with notepad or a similar application. These files include the help sections, the story, and the end-game story. These files employ a formatting code:

* ^P means "new page"

* ^G followed by a series of numbers is for a graphic image. The first two numbers are x and y coordinates for where the image will be located. The last number specifies the image used. These images numbers don't match up with the image numbers in your graphics folder, so you'll want to do some experimenting to get the right one.

There are specific codes for changing the color of text, but this list is not yet included in this tutorial.

There is also a specific code for creating 'timed' images which will animate based on a timer, but this is not yet included in this tutorial.

= Importing Graphics and Texts =
To import your graphics, go back to your command prompt and type in the same address as previously, but you'll change the command to import this time:

modkeen -episode=4 -import -bmpdir="BMP"

'''Note''': You may need to drag and drop modkeen onto dosbox and then type this command.

If you get the done message, you've imported successfully, however, you can't try out your new graphics until after creating a patch file and corresponding batch file, which is explained in the next section.

= Patch File and Batch File =

Your patch file is used to access all the edited content in your mod. It's what allows you to have new graphics, new tile properties, new levels, new music, new text, new enemy behaviors, etc. It also allows you to change the 'rules' of the game in certain ways (although there are limitations).

If you look in your "keen4mod" folder, you will notice that Modkeen has generated a patch file for you called "keen4.pat". You will want to rename this so that it isn't overwritten in the future. Locate Keen4.pat and rename it to something like "mymod.pat".

You can also create a patch file from scratch. To do this, create a new .txt file called "mymod". Open the file and save as "mymod.pat" and make sure you select "all files" in the "Save as type" section. You should now have a "mymod.pat" file.

Your batch file is what you'll use from now on to play your mod. To create a batch file, first create a new text document and name it whatever you want. In this example we'll use "Play". In the text file, type: ck4patch mymod.pat

Now, go to 'file' and save as "Play.bat" and make sure you select "all files" in the "Save as type" section.

Run "Play.bat" to make sure your mod is working. If you see your modified graphics and/or texts, it works!

== Patching Basics ==
After you've made sure Play.bat runs fine, open up mymod.pat with a text editor.

You should see:

ext ck4
version 1.4
# Load the modified graphics
%egahead EGAHEAD.CK4
%end

Here's what each line means:

* The first two lines mark the beginning of your patch file.

* The # symbol indicates a comment. Any line preceded by a # will be skipped over and allows you to include notes in your patch file.

* %egahead EGAHEAD.CK4 is what tells the game to use your new graphics.

* %end will mark the end of your patch file. Anything that appears after this will not be read by the game, so make sure that any patches you add to this file are included before this line.

You can find all kinds of patches on the [http://www.keenmodding.org/ Keen Modding Forum] as well as make specific requests. Additionally, your can run [[The Neural Stunner]] to generate some easy patches, or dig through the patch files of existing mods.

Here's an example patch that makes bounders unkillable:

%patch $11166 $12 $2F

Now add it to the patch file and also add a comment explaining what it does.

%ext ck4
%version 1.4
# Load the modified graphics
%egahead EGAHEAD.CK4
#Make bounders unkillable
%patch $11166 $12 $2F
%end

Now save your patch file and run Play.bat. Bounders should now be unkillable!

= Tile Properties =
Go to your "Tools" folder and go into your ckD456tli folder. Copy the Keen4.tli file into your "keen4mod" folder. Then go to your patchfile and add the patch that corresponds to your modded episode below:

%patchfile $249C2 keen4.tli
%patchfile $25B22 keen5.tli
%patchfile $25212 keen6.tli

Now run CkD456tli. The first item the program asks you for is the file which you just copied to your "keen4mod" folder. Locate and select it. Next, go into the BMP folder and select the background tileset, and after that select the foreground tileset.

You're now in the editing menu.

On the left side you can see the background tiles. The properties in that tileset are limited: either a tile can animate or have no properties. If a tile animates, the next tile in the animation sequence is outlined in a double red border. Note that tiles can only animate up to 128 tiles before or after any given tile, so try to keep tiles that animate near each other.

To animate a tile, select the first tile in the animation sequence. Next, right click the tile that should appear next in the sequence. Now left click that new tile and select the tile it will animate to next. Make sure the last tile in this sequence animates back to the original tile. Now go back and add animation times to each tile. By moving the scrollbar, you can change the amount of time spent on the tile while animating (0 to 255 time units).

If a tile animates that you don't want to animate, right click the original tile. You will need to repeat this step for each tile in the animation sequence.

* '''Note''': Reducing the scroll bar to zero will NOT prevent the tile from animating and will instead cause the game to crash

* '''Note''': After disabling a tile from animating, it is not necessary to reduce its value in the scroll bar to zero, although this is recommended to avoid future errors when editing.

On the right side is the foreground tiles. For foreground tiles, you can also edit the animation properties (and they work the same way), but there are several other properties you can edit as well. Above the enlarged pictures of the tile and its mask is a dropdown menu where you can select the properties of the top of the tile. Similarly, the dropdown menu below lets you select the properties of the bottom of the tile. Pushing in the buttons on either side signify that Keen (and other sprites) cannot enter the tile from that side, making it solid. (Note that these are almost always set or cleared together. One-way tiles do not work as well in Keens 4, 5, and 6 as they do in Keens 1, 2, and 3). Off to the right is another dropdown menu, which lets you change special properties of the tile. Lastly, when the "FRONT" button is pushed in, it means that the tile appears in front of Keen and other sprites rather than behind them.

* '''Note''': There are some exceptions where foreground tiles that animate have their animation value set to zero. This includes: Key-gem doors and and flag holders.

When you're finished editing, click save.

= Level Editing =
Before getting into special instructions for each editor, some general knowledge about how Keen Galaxy levels work is needed.

Keen 4, 5, and 6 levels consist of three layers of tiles: the background, foreground, and info layers. The background is just there to add color to the scene; Keen and the enemies don't interact with it. The foreground layer contains tiles that Keen interacts with: platforms, point items, doors, secret passages, and so on (note that many tiles in the foreground layer actually appear behind Keen, but they are not considered 'background tiles'). Finally, the info layer contains information about sprites and special features such as switches, doors, bridges and so on. When level editing, you will generally work with only one layer at a time, although all three may be visible at once (layers can be toggled).

In keen 4, 5, and 6, the world map is built primarily from background tiles which do no have solid properties. Instead, special 'invisible' tiles are placed from the foreground tilset on the world map to block Keen's path. These can be difficult to figure out. Check tile properties with ckD456tli to figure out what is what and then edit the invisible tiles to have visual cues for placement (they can be made invisible again later). Alternatively, you can use foreground tiles to build the world map (although this will use more memory).

Keen Galaxy levels have a rectangular border of 2 tiles. Borders should be filled with solid tiles with some exceptions. To create a level exit, leave the border empty where you want Keen to exit. Keen cannot exit out the top or bottom of the screen (Keen will die on the screen bottom and Keen will glitch on the screen top).

Point items can be placed as both sprites or as tiles. It is important to place as many point items as tiles as possible to avoid memory issues. A good rule of thumb is to only place sprite items on foreground tiles.

Included below are general instructions for Ted5 (Sections written by Levellass and Adurdin, edited by Ceilick), Keen: Next (Written by Ceilick), and The Omegamatic (Written by Mink and edited by Ceilick).

== Ted5 ==
=== Setting up Ted5 ===
Download and unzip ted5 into your "keen4mod" folder.

1. Look for the file Egahead.ck4. Rename this file Egahead.ren.

2. Run Tedsetup.

3. Tedsetup will generate a new Egahead.ck4. Delete this file. Now Rename Egahead.ren to Egahead.ck4.

This is the only time you will need to run tedsetup and follow the above steps.

You will probably need dosbox to run Ted5. Just drag and drop the ted5.exe onto your dosbox icon.

=== The Interface ===
After dismissing the welcome screen, the first thing you will want to do is press F9, or click the "?" tab and select "Video Mode Switch". That will cause TED to run in 640x480 mode, giving you more space to work with. You can switch to the low resolution mode again anytime you want to make sure how much of the level is going to be displayed on the in-game screen at once.

At the bottom of the screen, you will see the Info Bar. From the far left to right, it displays:

* Selected Background tile.
* Selected Foreground tile.
* Selected Sprite Icon.

These items display the icon as a graphic, followed by the tile number in hexadecimal (like $00AE) and decimal (174). Clicking on any of them will bring up the tiles palette so you can select a new one.

Next appears the name of the level. This name is used only in Ted5, it does not affect the level name in-game.

Next appears: Active layers (B, F, I)
* B: Background Tiles
* F: Foreground Tiles
* I: Sprite Icon, door/switch coordinates

The letter indicates the layer where you will be adding new tiles to. You can select more than one and the selected tiles will all be placed, however, it is recommended that you work only one layer at a time.

Next appears: Visible layers (b, f, i)
This tells you which layers are being toggled. You can toggle layers with the hotkeys 4, 5, and 6.

When a layer is turned off you cannot place items in it by mistake. This allows you
to take a closer look at a specific layer to make sure everything is placed correctly.

Lastly, on the bottom far right: Cursor location (X, Y)
This gives you the tile coordinates at a specific spot on the map. This will also be given in both decimal and hexadecimal numbers. You will need those numbers in order to have switch that activate lifts, doors leading to other places, toggling bridges, and more.

=== Editing ===

By default, TED5 will load the world map for the game. In order to switch to another map, you will need to click the File menu and select Edit New Map. You will then be able to select any of the maps in the game. For this example, pick Slug Village.

You can use the arrow keys to scroll the level around.

You can toggle which type of tile to place (background, foreground, sprite icon) by pressing the 1, 2 or 3 keys. Note for each type of tile, you will need to press the number key to activate it and the same key again to deactivate it before using a different tile type.

Adding new tiles to the level is as simple left-clicking. The currently selected tiles will be placed in all active layers. You can select tiles in three ways: Clicking the tile icon to the left of the Info Bar, pressing the space bar to bring up the tile set, or right-clicking an existing tile.

Right-clicking an existing tile will switch all the active tiles to the ones in the active layers. This means, if you only have the Icon layer active, right-clicking a tile with a slug will only select the slug; while if you have all three layers active, it will select the slug, the Foreground tile, and the Background tile at that location.

Once you have a basic level made, you'll want to add more advanced features like moving platforms, switches, bridges, doors, and so on. These are all done with links in the sprite icon layer.

A simple moving platform in Keen 4 can be placed by putting a moving platform icon with a red arrow in the desired spot. To stop the platform moving off the edge of the screen however, you'll need to put some blocking tiles in its path: these icons look like a "B" in a square. Put one blocking tile to each side (for a horizontally-moving platform) or above and below (for a vertically-moving platform). A collapsing platform (the one with a yellow triangle below) only needs a single blocking tile beneath it. In Keen 5 and Keen 6, the platforms with green arrows (known as Goplats) need a path made of the yellow arrow icons to follow.

Often you want the player to have to turn a platform on with a switch. To do this, you need to place another blocking tile in the way of the platform between the other two. Make a note of the hexadecimal values of the location of the tile (the X and Y values beginning with $ at the right-hand side of the status bar). Now place a switch in an appropriate place, and link it to the blocking tile: Choose Misc, New INFOPLANE Value or press Enter, and type in a $ followed by the last two digits of the X and Y values you wrote down. Then click on the switch; this will place the link in the info plane, which will be shown as four digits. The switch will now turn the blocking tile off, to activate the platform.

When working on your world map, you'll want to use the infoplane to specify what levels your entrances will lead to. To do this, go to Misc, New INFOPLANE Value, and type in a $ followed by one of the following: $C0xx is a link to level where xx is the level number in hexadecimal, not decimal), $D0xx overlays blocking tiles that will be removed upon completion of the level (think the gates for border village and slug village), and $F0xx is for the flag holder which corresponds to the level. After entering your chosen value, you can then edit the info plane by left clicking.

In the same way, you can link a switch to a bridge (link to the left-hand edge of the bridge), a gem-holder to a closed door (link to the top of the door), and a walk-in doorway to the place you walk out (link to where you want Keen's feet to end up after he enters the doorway). Note that if you create a link from a switch to a square with nothing in the info plane, that switch will turn a blocking tile on; also that you need to use a particular tile to make a walk-in door (find out by looking at an existing level).

Another feature which makes Keen levels exciting is secret passages. Some foreground tiles allow Keen to walk behind them-these are suitable for secret passages. However, identifying which ones are like this and which ones are solid is difficult: I suggest examining some of the original levels and noting down the tile numbers of the "secret passage" tiles to keep track of them. When putting point items in a secret passage, you must use icons for them, rather than their foreground tiles. I suggest that you only place the "walk-behind" tiles in secret passages once the level is completed, so that while editing you can keep track of them more easily.

Finally, some Keen levels have separate areas that act like independent mini-levels (the Pyramid of the Forbidden is a good example of this). You can place scroll blocks in the info layer to mark horizontal and vertical edges between these areas. The scroll blocks look like horizontal and vertical blue lines with small white stripes; I suggest examining existing levels to see how they are
used before placing them in your own levels.

=== Saving ===
You can save your map at any time by going to the File menu and selecting Save Map; however, in order to actually play the level, you will need to Carmacize Maps. While ted5 has an option to do this, it takes too long to do so. The easiest method is to download InstantCarma and unzip the files into the folder with your maps. After you save your map in ted5, just run InstantCarma.

TEDSETUP creates an extra batch file (Go4.bat) and patch file (Patch4.pat) which you do not need if you open your existing patch file and add the line:

%maphead maphead.ck4

You only need to add this to your patch file once. Then just run your batch file to try your level!

=== Other Ted5 Features ===

Grid Mode toggles the showing of a grid on the current level. This can help with placing tiles in the right positions. Turn this on or off from the Mode menu or by pressing G.

Block Fill mode quickly fills a rectangular area with the currently selected tiles. Choose it from the Mode menu or press B, and click the left mouse button on the desired top-left corner, and the right button on the bottom-right corner, then press Enter to fill the area.

Flood Fill mode will fill an area of one tile with the currently selected tiles. Choose it from the Mode menu or press F, then click in the desired location to fill.

Copy Mode (also on the Mode menu, or press C) lets you select a rectangular set of tiles to copy so that you can duplicate them in another region easily. Select the area as for Block Fill mode, then press Enter.

Paste Mode (you know where to find it) allows you to paste one or more copies of the tiles chosen with Copy Mode. Click with the left mouse button to place a copy. You can use the Paste Overlay option (on the Mode menu, or press F3) to toggle pasting of empty tiles. The Snap-Paste option (press S) toggles pasting copies just anywhere, or in a tessellated pattern. This is especially useful for
filling in the background of a level.

You can change the size of a level with the "Change MAP Edges" option on the Edit menu. Select the edge you want to change, and enter a positive or negative number to add or remove rows from that edge.

== Keen:Next ==

=== Setting Up ===
Go to the keen 4 folder in Keen next and copy the tiles4.png file. Paste this into your "keen4mod" folder.

Edit tiles4.png to include your edited graphics. Be sure to save the file as .png.

Go to your Keen:Next folder and run the kmaps application. You may get an error message after running this, but this is not a problem, just click ok.

When the editor opens, the first thing to do is go up to 'file' then 'new'. A 'project properties' window will appear. Give your project a title (it doesn't matter what you name it) and then check the "keen project" box. We'll be using Keen4, which is the default setting. If you're planning to edit keen 5 or 6, just make sure to select those in the box next to "keen project". Next we need to choose the tileset. In the image file section, go to 'browse' and select the tileset you want to use (in this case, tiles4.png). After all this, click 'ok'.

* '''Note''': you will have to do this each time you open the editor.

Before editing levels, you must extract them in a way that Keen: Next can read them. Go to 'file', then 'create keen files'. Browse to your "keen4mod" folder and select keen4.exe. Your keen map files should now be created.

* '''Note''': this will not work if you have run tedsetup.

* '''Note''': You only have to do this once.

=== The Interface and Tools ===
The tiles should load on the right side of editor menu. You can adjust the tile menu width with the mouse by selecting the left edge. You can scroll between the background and foreground tiles.

In the upper left is a toolbar. The default tile tool is the pencil/paintbrush. You can click and place or click and drag to place tiles.

There is also a water dropper tool. This is useful for selecting a tile currently on the map instead of looking for it in the tileset.

* '''Note''': the water dropper will 'pick up' the tile from the tileset you're currently in; if you currently have a background tile selected and use the water dropper, it will pick up the background tile on the map. If you want a foreground tile, scroll down in the tileset on the right and select one of the foreground tiles, then use the water dropper on the map.

I do not recommend using the paint can tool, since it is very buggy.

The next tool can be used for selecting
a rectangular area of the map. This is useful for cutting a piece of the level and pasting it elsewhere (you will need to do this twice if you want to cut and paste both the background and foreground). You can also create stamps this way. Just select an area and go to "selection" and then "create brush". A stamp of the area will now appear on the left.

You can create stamps of a large area of tiles from the tileset also. To do this, click the top left corner of the area of tiles you want in the tileset. Then go to the bottom right corner of that area, while holding shift, and select that tile. Doing this successfully will result in the stamp image appearing on the left side of the editor. You can now use the paintbrush tool to place this stamp, and you can reselect this stamp at any time you're editing.

The next tool looks like a little cog. This is used for placing doors, level entrances, switches, and key-gem holders.

The last important tool has an icon that looks like an arachnut. Click this to bring up the sprite menu. This is used for placing enemies, points, and some other things. To switch back to tiles from sprites, click the little black square icon to the left of the arachnut icon you used to get to the sprite menu.

In addition to the tools, you can toggle the layers used in editing with the 'view' tab and checking/unchecking layer 1 and layer 2. Make sure that, in the "view" section, you have 'fade unused layers' unchecked. This makes level viewing easier.

* '''Note''': This is the buggiest part of Keen:Next and if you frequently toggle layers, glitches can ruin a lot of work put into a level. Its usually best to leave both layers visible, or save your progress before toggling layers and then reload Keen: Next as soon as you finish the work that required toggling them.

=== Editing ===
To begin editing, first load a map. Go to 'file', then 'Import Keen Map'. In your "keen4mod" folder, select 'maphead.ck4'. You should now be presented with a 'map select' box. Choose the level you'd like to edit. Let's start with the shadowlands.

The shadowlands map should now be loaded in the main editing area. You'll notice little white icons that look like this (!). These are the level sprites. To place these, use the little cog tool up in the upper left (next to the rectangular area selector). When this tool is used to click the map, you'll get an 'info plane' box asking for an x and y coordinate.

On the world map, this is how the coordinates work:
The x coordinate determines what kind of sprite is used. An X of 192 designates the sprite as a level entrance. Note: you cannot place a level entrance on a tile that appears over keen or on an animating tile.

An x of 208 is a level block (like those used in the slug village); this sprite does not actually block keen, but is placed over a foreground tile that does. When the level is beaten, this info number removes the foreground tile.

An x value of 240 is for the flag holders.

Y coordinates only designate what level the sprite is associated with. A Y of 1 will designate the level as level 1.

To place sprites (enemies) in a level, go to the tools menu and click the little icon that looks like an arachnut. The sprite menu should appear in place of the tileset. To place a sprite, make sure you have the paintbrush icon selected, then click the sprite you want to place. To switch back to tiles from sprites, click the little black square icon to the left of the arachnut icon you used to get to the sprite menu.

* '''Note''': some enemies appear more than once in the sprite menu; this is for enemies that appear on easy, moderate, and hard. You can see little numbers that designate this, but a general rule is that the order they appear in on the menu matches the easy/medium/harder order.

To place a keygem holder, first place the foreground keygem holder tile somewhere on the map (it can be anywhere). Next place a door (these are also foreground tiles) somewhere (anywhere). When making the door, there are three door tiles: a bottom, middle, and top. If you're making a door more than three tiles high, use the middle door piece for additional height. Using your mouse, hold it over the top tile of the door. In the lower left side of the editor, you'll notice that the map coordinates for this tile appear. Memorize or write these down. Now select the cog tool and then click your keygem holder. Enter in the coordinates for your door. You've now got a working door.

To place doors that Keen can enter, first place two sets of door tiles on the map. Now you must determine the coordinates. Go to one of your doors and hold the mouse over the tile below the bottom left door tile (not on the bottom left door tile or keen will drop out of the air). Check the coordinates. Then go to the door you want to connect to this spot and use the cog tool and click the lower left door tile (the lower left door tile, not the one below it). Enter in the coordinates. Do the same for the bottom right door tile. Now this door is connected to the other, but you also need to check the coordinates at this door and add them to the tiles of the other door.

To create a working switch, use the cog tool on a switch and use the coordinates for the thing you want the switch to affect. For a bridge, get the coordinates of the top left bridge tile and put this in the info box for the switch. For goplats (moving platforms), get the coordinates of a B sprite (these are sprites which goplats bounce off and then go in the other direction). The switch will remove that sprite so the goplat can move.

To resize a map, go to "edit" and "Resize map". Then select the new level boundaries and the side of the level which should be expanded or shrunk.

Keen: Next has an infinite undo button. Just go to "Edit" and click "Undo".

* '''Note''': Undo will work for everything except changes to the level boundaries. Make sure you save before changing level boundaries!

=== Saving ===
When you're ready to save, go to 'file', then 'export keen map', then select 'maphead.ck4', click yes, and reselect the level you want to save over and click ok.

* '''Note''': if you like, You can rename the level here before you click ok. The name you choose will only appear in the editor, however, and not in the in-game text.

* '''Note''': Do not click 'save' or 'save as'. These options do not actually save the level to the game, but as files only Keen: Next can read. Additionally, saving levels in this manner can cause Keen: Next to crash.

After saving you can test your levels by adding this to your patch file:

%maphead maphead.ck4
%gamemaps editmaps.ck4

Then run your batch file and you're all set.

== The Omegamatic ==
===Setting Up===
Run tom.exe and select the gamemaps.ck4 file. You will then need to select your tilesets which you exported modkeen: 4til0000 and 4til0001. After selecting these, if all goes well, the world map will open in TOM.

===The Interface and Tools===
Tom features two different level editing styles: Ted5 and Keen:Next. I highly recommend Keen:Next Mode and will only cover it in this tutorial. To activate this go to settings and click "Keen:Next Mode". You will now see the tileset on the right side of the TOM window.

In the bottom left of the window you will see three different boxes. These boxes display the tile you pick from the tileset on the right of the window. Each box displays from one of the three layers used in Keen:Galaxy: background tiles, foreground tiles, and sprite icons. To change which tileset to work with, use the hotkeys 1, 2, and 3 to switch between the layers.

To place a tile simply select the tile from the tileset with the left mouse button and click on the level where you want to place it with the left mouse button. You can also right click a tile from the level to make it the active tile for placing, just like a water dropper tool. To erase a tile you will need to right click an empty space in the level, which makes an empty tile the active tile, and then left click what you want to erase.

If you want to select an area of tiles from within a level, press C and left click a corner of the area you want to select. You should then left click the opposite corner of the area you want to select. The selected area will have it's colors inverted until you select the size of the area. You can then press P to paste the area you selected.

If you want to select an area of tiles from the tileset, left click the top left tile of the area you want to select. Then, while holding shift, left click the bottom right tile of the area you want to select. Release shift and then you should be able to place the selected area in the level by left clicking.

You can scroll around the level with your mouse wheel or with the arrow keys. You can zoom in and out in the "View" tab. You can also toggle on and off which layers can be seen with the hotkeys 4, 5, and 6.

To change the level you are editing go to "Levels" and select the level you want to edit. You can rename levels by going to "File" and then "Rename This Level".

You can resize a level by going to "Tools" and selecting either: Insert Row, Delete Row, Insert Column, or Delete Column. After selecting on of these move your mouse around the level and you will see a highlighted area which will be affected by whichever option was chosen. To disable any of these level adjustments just go back to "Tools" and uncheck it.

When working on your world map, you'll want to use sprites to specify what levels your entrances will lead to. To do this, first press 3 to activate the sprite icon layer. Press enter once and a message box will come up with an infoplane number in hexideciaml. Remove the number indicate and type one of the following: C0xx makes a level entrance where xx is the level number in hexadecimal, not decimal), D0xx overlays blocking tiles that will be removed upon completion of the level (think the gates for border village and slug village), and F0xx is for the flag holder which corresponds to the level. After entering your chosen value, you can then place the level entrance, gate, or flag sprite by left clicking.

===Sprites and Enemies===
To place sprites and enemies in a level, press 3 to bring up the sprite tileset. You can place sprites like you would normally place a tile. Some enemies appear more than once in the sprite menu; this is for enemies that appear on easy, moderate, and hard. You can see little numbers that designate this, but a general rule is that the order they appear in on the menu matches the easy/medium/harder order. Sometimes there is a blank space before or after the order of sprites. For example, the blue bird from keen 4 doesn't have a sprite icon for easy mode, however, it does have a blank tile where the easy mode icon would normally go. This blank tile can be placed to place a blue bird on easy. This works similarly for other enemies in this situation.

===Secret Passages===
Some foreground tiles have properties that allow Keen to walk behind them; these are secret passages. To make these you will need to identify which tiles have the correct foreground but not blocking properties. I suggest examining some of the original levels and noting down which tiles are used for the secret passages. You can also identify them with the CKD456tli utility. When putting point items in a secret passage, you must use points from the sprite list rather than the foreground tile points.

===Moving Platforms===
A simple moving platform in Keen 4 can be placed by putting a moving platform sprite icon with a red arrow in the desired spot. To stop the platform moving off the edge of the screen however, you'll need to put some blocking tiles in its path: these icons look like a "B" in a square. Put one blocking tile to each side (for a horizontally-moving platform) or above and below (for a vertically-moving platform). A falling platform (the one with a yellow triangle below) only needs a single blocking tile beneath it. In Keen 5 and Keen 6, the platforms with green arrows (known as Goplats) need a path made of the yellow arrow icons to follow.

===Switches for goplats===
Often you want the player to have to turn a platform on with a switch. To do this you will need to place another blocking tile in the way of the platform between the other two. After placing the blocking tile, hold the mouse over it and press enter two times. This will give you the hexidecimal coordinates which you will place on the corresponding switch. The switch will now turn the blocking tile off thus activating the platform.

===Switches for bridges===
To create a switch for bridges, first build the bridge using the bridge tiles. Then hold your mouse over the top left tile of the bridge and press enter twice to get the hexidecimal sprite value. Place this sprite on the switch you want to activate the bridge with. If you want the bridge to begin already opened, you will need to locate the invisible bridge tiles and place these where the bridge will be located, otherwise no bridge will appear. To find these either locate them in existing levels with open bridges or use ckd456tli.

===Key Gem Doors===
To place a keygem holder, first place the foreground keygem holder tile somewhere on the map (it can be anywhere). Next place a door (these are also foreground tiles) somewhere (anywhere). When making the door, there are three door tiles: a bottom, middle, and top. If you're making a door more than three tiles high, use the middle door piece for additional height. Using your mouse, hold it over the top tile of the door and press enter twice. Place the sprite that this gives you on the gem holder.

===Doors===
To place doors that Keen can enter, first place two sets of door tiles on the map. Then hold the mouse over bottom left or right of the first door and press enter twice. This gives you a sprite which you should place on the bottom of the second door you want connected to the first door. After placing the sprites at the bottom of the second door, you will need to press enter twice at the bottom of this second door and place the sprites on the first door in the same way.

===Scroll Blocks===
Some Keen levels have separate areas that act like independent mini-levels (the Pyramid of the Forbidden is a good example of this). You can place scroll blocks from the sprite menu to mark horizontal and vertical edges between these areas. The scroll blocks look like horizontal and vertical blue lines with small white stripes; I suggest examining existing levels to see how they are used before placing them in your own levels.

===Saving===
To save your progress go to "File" and then "Save all Levels". This will immediately save all your levels.

===Testing===
After saving you can test your levels by adding this to your patch file:

%maphead maphead.ck4

Then run your batch file.

== General Level Editing Issues ==
If there are too many sprites in a level you will get the error 'No space left in objarray'; the game has run out of memory to store sprites. This usually occurs at the level start. To fix this, remove sprites from your level. When placing sprites, keep in mind that the more variety of enemies you use, the more memory is used up and the larger the sprite and the more frames it has, the more memory it uses. Also, when trying to save memory, check your points items: these exist both as tiles and sprites (try to use tile points whenever possible).

If you have too many different types of tiles (Background and foreground) then you will get the error 'No space left in tilearray'; this means that the game does not have enough memory to store all your different tile types. Foreground tiles use 8x the memory of background tiles. You shouldn't have more than about 400 tile types total (Background and foreground) in a level, usually 100 back and 300 fore. Additionally, animating tiles with many frames can increase your tile count drastically.

* '''Note''': I have never had this error before and imagine it would be difficult to attain, so don't be worried about using too much until you get this error.

You cannot have more than 20 actively animating tiles on-screen at any one time, this includes item tiles. This will cause an anim tile error. (Not enough memory to animate all these tiles.)

Note: This was a major problem in designing the Lava Falls in [[Dead in the Desert]], so be careful when it comes to animating tiles.

If a level is 'too large' for its music file, the error 'Not enough memory to play background music!' will occur. This is an indication of either large levels or large music files. To reduce this error, either make your level smaller or change the music to a smaller file.

If you see static gibberish instead of an animation while testing your level, then you have placed an animating background over an animating foreground. For memory reasons this is not allowed. Similarly, a sprite cannot be placed on top of an animating tile. This will crash the game.

= Music and Sounds=
Copy Keenwave.exe into your "keen4mod" folder. Run Keenwave and it will generate an IDWAVE text file. Create a folder called "sounds". Open IDwave.txt and add this line:

-episode=4 -export=raw -snddir="sounds"

Run Keenwave by dragging and dropping it onto dosbox.

Now look in your sounds folder. Here you will see a number of sound files and a few music files (IMF files) at the bottom. To change these, just replace the sounds with new file (they must be the same format, for music this is IMF). Sound effects can be created and modified using WDC. You can create IMF files by converting midi files with IMF Creator.

After changing the sounds or songs, go back to IDWAVE.txt and change the command to:

-episode=4 -import=raw -snddir="sounds"

Run Keenwave.

Now open your patch file and include the lines that apply to the episode you're modding:

#Keenwave patch file; Patch sounds Keen 4:
%patchfile $20DF0 AUDIOHED.CK4 #Audio header
%patchfile $354F6 AUDIODCT.CK4 #Audio dictionary

#Keenwave patch file; Patch sounds Keen 5:
%patchfile $21C80 AUDIOHED.CK5 #Audio header
%patchfile $35EC4 AUDIODCT.CK5 #Audio dictionary

#Keenwave patch file; Patch sounds Keen 6:
%patchfile $20C50 "AUDIOHED.CK6" #Audio header
%patchfile $36EEE "AUDIODCT.CK6" #Audio dictionary

== Creating and Editing Sound Effects ==

Begin by installing WDC to your tools folder. Once this is commplete, go to the new WDC folder and create three new folders inside: "Keen4input", "Keen4output", and "KeenSounds". You should then copy a clean version of Keen 4 into the "Keen4input folder", specfically the files: Audio.ck4, Egagraph.ck4, Gamemaps.ck4, and Keen4e.exe.

'''Note:''' Make sure this version of the keen4e.exe has NOT been unlzexed.

Now run WDC.exe. After is loads, go to "File" then "New Project". WDC will then ask you to name the project and save the project file; name it "keen4project" and save it to you WDC folder.

WDC will then bring up a window with several options. Under "Base Data Folder" select your folder "keen4input". You will then get a "no map code file" alert. When this occurs, select "User Other" and then select "blank.wmc". Under "Output Folder" select your folder "keen4output". On the left side you will see a small menu, select "Other Options" and then check the box for "Use Tile16s for maps, if they exist".

You should now see the Keen 4 world map. You'll be using only one part of WDC, however, so go to "View" and select either "PC Sounds" or "Adlib Sounds".

WDC will then load the list of sounds for that category. You can sample each sound by clicking it. Playback controls are located in the upper right. To edit a sound, click the small hammer icon in the lower right. WDC will then ask you where you want to save the file. Navigate to your "keensounds" folder. Name the sound in such a way that you can remember what it is: "slugslime", "jump", "item" etc.

WDC will then load it's sound editor. There are various tabs for effecting how the sound is played, and the main area allows you to use your mouse and 'draw' the sound. Sound editing is a complex task and the only real advice I can offer is to just play around in the editor and save sounds that you find good or interesting.

After you've saved some sounds, you'll want to swap these into your mod. To do so you'll first need to locate the original sound file you want to replace in the "sounds" folder you created when setting up Keenwave. You can do this by listening and finding the sound you want to replace in WDC and then locating the corresponding number in the sounds folder. This is easy for PC speaker sounds, but since Keenwave doesn't seperate the PC speaker sounds from the adlib, you'll have to locate the last PC Speaker sound and then begin counting again from 1 in order to match the adlib sound list in WDC to that in your sounds folder.

When you've located the original sound you want to swap out, copy it's name to your new sound and then replace the file. Then run Keenwave to import your new sound effect.

== Working with the IMF Format ==
In IMFCreator, go to the "options" menu and set the tics/sec to 560. This will make your songs convert at the correct tempo.

The following, excluding the tip from thehackercat, is written by Mr. M for PCKF/KeenModding:

Compose your music using your choice of software. As long as it outputs standard General MIDI files, you should be good to go.

Please read and get an understanding of the [http://www.shikadi.net/moddingwiki/IMF_Format IMF specs].

Tip From Thehackercat:
For those of you using a sheet-music editor such as Finale: You may write two or more parts for one instrument. Keep inside the required 4-note polyphony, but don't be shy about using layered parts and chords, especially on piano staves.

Tips From Mr. M:

(1) IMFCreator seems to interpret MIDI note velocities. If your instrument track is too quiet *and* it is set to maximum volume, try manually adjusting the note velocites to be higher. I know that FLStudio is capable of doing this; I'm sure other studio software packages are capable of this, too. If the volume of the track is too loud after making your note velocities higher, turn down the volume of that track.

(2) Keep percussion parts as simple as possible. It impedes the maximum polyphony limits that can be utilized by other parts. Simply put, you can write more complex parts that use this structure:

[SIMPLE/NO PERCUSSION]+[BASS LINE]+[CHORDS]+[CHORDS?]+[LEAD]

The number of dropped notes, if any, in IMFCreater is almost unnoticeable if you adhere to this formula. I've been able to push the IMF format to it's limits by doing this.

As Thehackercat stated, don't be shy about using chords and complex structures -- especially if your percussion line is nonexistent or very simple.

(3) Try not to use too many midi tracks, *especially* if they are all simultaneous. Too many midi tracks results in dropped notes (ie- parts drop out randomly *and* inconsistently), and songs that exceed the filesize limits. I personally only need 4-8 tracks, counting percussion, to acheive the sound that I get in my work.

(4) On the subject of percussion: To circumvent the polyphony limit that gets imposed when you use percussion parts, try using normal instruments played outside their normal range. Then in IMFCreator, tweak the patches you used by adjusting all the possible paramaters until you acheive the desired percussive sound. It may not work all the time, but it should do the trick in most cases. (Credit for this tip goes to [[Bobby Prince]])

(5) On the topic of modding instrument patches: Don't be afraid to tweak patches! It's under the 'EDIT' -> 'Instrument' (or press CTRL+I) menu. You can edit how all the instruments sound. All of them {including percussion). Distortion guitar not distorted enough? No problem. Pad not airy enough for you? Bass drum not punchy enough, or the hi-hat not sharp enough for you? No problems there. See the help menus for the specifics of how the patch parameters are edited.

When I do this, I make a patch set for each specific song. When you close the instrument editor, you are prompted to save changes. Do so, and save the .OP2 file that is generated as something *other* than GENMIDI.OP2 (I like to save it by song title for easy reference). Keep the original GENMIDI.OP2 file as a base set.

After you've tweaked the patches to your liking and saved your new .OP2 file, stop any playback of the song you're previewing. Under 'OPTIONS' and 'OP2 File:' you can choose the OP2 file that has the modded patches you created. Press play and listen to your new instruments!

* '''Note''': After editing an .OP2 file/patch set, you MUST stop and re-start playback of your song for the changes to take effect

(6) Be careful with pitchbends in your music. IMFCreator tends to overexaggerate them if the pitchbend scale and thresholds arent set properly. There's no ONE configuration for them; best bet is to tinker with them until you get a desireable sound. Remember: Lower numbers mean higher pitchbend scale!

As with editing the patch set, you MUST stop and re-start playback of your song for the changes to take effect.

= Loading Window =
Go to your graphics folder and look for the file 4msc0000.bin. Copy this to your keenscr folder.

Go to commander prompt and navigate to your keenscr folder and then type:

keenscr load

TheDraw will immediately start editing the screen, with the filename keenscr.bin.

Alt+H will display the help screen with all the commands that TheDraw supports; however, its basic use is extremely simple. Use the arrow keys or mouse to select where you want to enter text, then type it in. By default, it uses bright white color over black color; you can copy a color straight from the screen by placing the cursor over any character and pressing Alt+U, and it will use that color as you type.

You can use Alt+M to enter drawing mode, where you can use the cursor keys or the mouse to draw on the screen; you should enable Draw mode with the cursor in the place where you want to start drawing, as it will start immediately. Alt+F1 to Alt+F4 will give you different line styles for Draw mode.

Once you are done editing the screen, you can save it by pressing Alt+S. TheDraw will ask which format to save it in; press B to select Binary, and enter the filename keenscr.bin. It's important that you keep this filename (overwriting the existing one). After you exit TheDraw and KeenScr notifies you that the file has been updated.

Then you must copy 4msc0000.bin back into your graphics folder. Import using modkeen. You must also copy ck4load into your "mymod" folder.

Edit your patch file to include the patch for the respective episode:

%patchfile $1fe47 ck4load.bin
%patchfile $20cd7 ck5load.bin
%patchfile $1fca7 ck6load.bin

You can also edit the exit screen by going to the command prompt and typing: keenscr 4

When you're done, save it as keenscr.bin overwriting the generated file. You must save it in Binary format when TheDraw asks.

Then you must copy 4msc0000.bin back into your graphics folder. Import using modkeen.

= Scrolling Text =
Run Startext. The controls are listed. Select your episode of choice and then select edit scrolling story. Type your story as you want it, making sure not to go over the space limit or under it (the original story will appear at the bottom of your story if you do). Press enter.

Copy story.ck4 into your "mymods" folder.

Edit your patch file to include one of the following:

%patchfile $1EE40 "STORY.CK4"
%patchfile $1FDE0 "STORY.CK5"
%patchfile $1ED50 "STORY.CK6"

= Credits For This Tutorial =
* Written and Assembled by [[User:Ceilick|Ceilick]]
* Selections of [[User:Levellass|Levellass']] [[TED5|TED5 Tutorial]]
* Selections of [[Andrew Durdin|Andrew Durdin's]] [http://www.dosclassics.com/ckn/newsletter/issues/2002-03-01.txt|TED5 Tutorial]
* Selections of [[User:CK Guy|CK Guy's]] ck456tli readme
* Selections of [[User:Mink|Mink's]] The Omegamatic readme
* Selections of [[User:Leandrotlz|Leandrotlz's]] [[TheDraw|The Draw/Keenscr tutorial]]
* [[User:Shadow Master|Shadowmaster's]] [http://www.keenmodding.org/viewtopic.php?t=899 findings] for getting ted5 to work with modkeen 2.0
* [[User:Mr.M|_mr_m_'s]] IMF guide

[[Category:Tutorials]]"

Galaxy Tools

2014-04-16T19:30:39Z

Fleexy: Removed blank "External links", gave more realistic example in "Game Editing" header

== Game Editing ==

This section is organised by category. If an editor supports more than one type of editing (such as graphics editing and sound editing) it will be listed under both sections.

=== Level Editors ===

* [[TED5]]
* [[Keen: Next (level editor)|Keen: Next]]
* [[The Photachyon Transceiver]]
* [[The Omegamatic]]
* [[Abiathar]]

=== Graphics Editors ===

* [[EModKeen]]/[[LModKeen]]
* [[ModKeen]]
* [[Keengraph]]

=== Sound Editors ===

* [[KeenWave]] A program to import\export sounds and music, currently a beta, comes with an adlib sound player.

=== Music Editors ===

* [http://adplug.sourceforge.net AdPlug] - standalone DOS program and a Winamp / XMMS plugin for playing Keen's IMF music.
* [[IMF2MIDI]] - program to convert IMF songs into MIDI files.
* [[DRO2MIDI]] - improved program based on IMF2MIDI
* [[DRO2IMF]] - program to convert DRO files to IMF files.
* [[IMF Creator]] - program to convert MIDI songs into IMF files.

=== Story / Game Text Editors ===

* [[ModKeen]] For extracting data chunks
* [[Keengraph]] For extracting data chunks
* [[TheDraw]] for editing the final text screen.
* [[Startext]] for making text patches

=== Other editors and editing tools ===

* [[CKPatch]]
* [[Fixmhead]]
* [[Ck456Tli]]
* [[CK456DTli]]
* [[K5Splode]]
* [[Galactile]]
* [[Instant Carma]]
* [[TEDSetup]]
* [[The Neural Stunner (utility)|The Neural Stunner]]
* [[UNLZEXE]], needed to decompress the executable files
* [[UNP]], needed to decompress the executable files
* [[Wolf Data Compiler (WDC)]]

== Modding Tutorials ==

* [[Ceilick's Keen Galaxy Modding Tutorial|Ceilick's Tutorial]]
* [[Levellass' Keen Galaxy Modding Tutorial|Levellass' Tutorial]]
* [http://stefan.lohner-net.de/keen_modding/tutorial/ TheMagician's Tutorial]

== Game Information ==

* For details on the file formats used by the games, see the [[ModdingWiki:Commander Keen 4-6|Commander Keen 4-6]] section on the ModdingWiki.
* There is a [[:Category:Patches|list of patches]] that can be incorporated into mods to change the game's behaviour.

== See Also ==

* [[Vorticon Tools]]
* [[Other Tools]] (non-Vorticons/Galaxy)

[[Category:Tools]]

Abiathar

2014-04-11T16:45:40Z

Fleexy: Added note under image

Talk:Keen Galaxy Modding Tutorial (patch based)

2014-04-11T16:42:45Z

Fleexy: Asked about Abiathar tutorial

Hey Ceilick! If you want, I can add the [[Abiathar]] editing tutorial. Should I do this or do you want to write it yourself? [[User:Fleexy|Fleexy]] ([[User talk:Fleexy|talk]]) 16:42, 11 April 2014 (GMT)

Patch talk:Levels (Galaxy)

2014-04-03T13:51:02Z

Fleexy: Note about Abiathar change

Abiathar (released Keen Day 2014) contains more features and fewer bugs than TOM, should I change the "most advanced editor" to it? [[User:Fleexy|Fleexy]] ([[User talk:Fleexy|talk]]) 02:04, 15 March 2014 (GMT)
:I'd say yes. -[[User:Levellass|Levellass]] ([[User talk:Levellass|talk]]) 04:03, 19 March 2014 (GMT)
::Done. [[User:Fleexy|Fleexy]] ([[User talk:Fleexy|talk]]) 13:51, 3 April 2014 (GMT)

Patch:Levels (Galaxy)

2014-04-03T13:49:44Z

Fleexy: /* Editing levels */ Changed "most advanced editor"

This page deals with patches relating to levels in Keen galaxy and Dreams. Other patches relating to levels can be found at [[Patch:Levels]]. See also [[Patch:Map]], [[Patch:Oracle Janitor|Oracle Janitor]] and [[Patch:Flags]].

== Editing levels ==

A number of editors exist to edit Keen Galaxy levels. The oldest of these is the original, [[TED5]]. The newest and most advanced is [[Abiathar]]. In order to play modified Keen Galaxy levels patching is required. A 'map header' file must be patched into the executable. The name of the [[Patch:GAMEMAPS|game maps]] themselves can be changed, but this is not necessary. Following are patches relating to patching custom levels in Keen Galaxy.

Keen Dreams has a slightly different setup, requiring the patching of both a maphead and (depending on editor being used.) a mapdict file.

<patch title="Patch new levels into Keen Galaxy">
#Keen 4 :
%maphead maphead.ck4

#Keen 5 :
%maphead maphead.ck5

#Keen 6 :
%maphead maphead.ck6</patch>

<patch title="Keen Galaxy game maps filename">
#Keen 4 :
%patch $1334F [$3AE2W] #Text called from
%patch $32952 "GAMEMAPS.CK4" $00

#Keen 5 :
%patch $142EC [$3238W] #Text called from
%patch $33578 "GAMEMAPS.CK5" $00

#Keen 6 :
%patch $12E80 [$34E2W] #Text called from
%patch $34212 "GAMEMAPS.CK6" $00</patch>

== Lowest and highest levels accessible from map ==

There are two limits as to what levels the player can access from the main map. The first is the lowest level (By default level 1) and the second is the highest level (by default level 18, even if this many levels aren't provided by the game.) The difference between these two values is the number of levels accessible on the map. See also [[Patch:Jump conditions]].

<patch title="Range of levels Keen can enter from the map">
#Range of levels Keen can enter from the map in Keen 4
%patch $DF56 [$C000W] {$76} #Minimum - 1
%patch $DF5D [$C012W] {$77} #Maximum

#Range of levels Keen can enter from the map in Keen 6
%patch $D2BB [$C000W] {$76} #Minimum - 1
%patch $D2C2 [$C012W] {$77} #Maximum

#Range of levels Keen can enter from the map in Keen 6
%patch $D01A [$C000W] {$76} #Minimum - 1
%patch $D221 [$C012W] {$77} #Maximum</patch>

=== Extra levels ===

There are two limits to the number of levels in Keen Galaxy and Dreams. The first is a 'soft' limit' a simple check used to see if a level on the map can be entered. This is easily changed, allowing Keen to enter other levels. However the game will immediately crash if the level involved does not also have a valid name, level entry text and song. The second limit is a 'hard' limit of 25 levels determined by how the game's memory is set up. This is almost impossible to change. As such the following patch has additional sections setting up the level texts and songs. The extra levels will use the High Score level's name, entry and music. The example patch allows 24 levels in Keen 4 (The maximum possible without a more complex patch.)

For what the long lists mean see [[Patch:Levels_(Galaxy)#Level_text|level text]] and [[Patch:Music]]. Note that adding extra levels does not affect the [[Patch:Bean-With-Bacon-Megarocket#BWB-type_levels|Bean-With-Bacon-Megarocket level numbers]], this means the extra levels will likely be BWB-type. (Replayable) unless the BWB level(s) patch is altered.

==== Keen 4 ====

<patch title="Keen 4">
#Allow 24 levels in Keen 4 v1.4:
#First increase the number of levels we can access from the map to maximum (+6)
%patch $DF5D [$18] #Number of levels enterable ($18 = 24)
%patch $8CA4 [$18] #Number of level song entries (24, see below)

#Give extra levels valid stuff:
#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
$1F1C0000RL #Hall of fame
$1F1C0000RL
$1F1C0000RL
$1F1C0000RL
$1F1C0000RL
$1F1C0000RL

#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
$1F510000RL #Hall of fame
$1F510000RL
$1F510000RL
$1F510000RL
$1F510000RL
$1F510000RL

==== Keen 5 ====

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

<patch title="Keen 5">
#Allow 24 levels in Keen 5 v1.4:
#First increase the number of levels we can access from the map to maximum (+6)
%patch $D2C2 [$18] #Number of levels enterable ($18 = 24)
%patch $8C20 [$18] #Number of level song entries (24, see below)

#Level name pointers:
%patch $31AB4 $20040000RL #Map
$20050000RL #Level 1
$20070000RL #Level 2
$20080000RL #Level 3...
$200A0000RL
$200C0000RL
$200E0000RL
$20100000RL
$20120000RL
$20140000RL
$20160000RL
$20180000RL
$201A0000RL
$201C0000RL
$201D0000RL
$201E0000RL
$20100000RL #High scores
$00000000L #Extra level 1
$00000000L #Extra level 2
$00000000L #Extra level 3
$00000000L #Extra level 4
$00000000L #Extra level 5
$00000000L #Extra level 6
$00000000L #Extra level 7
$00000000L #Extra level 8
$00000000L #Extra level 9

%patch $31B18 $201F0000RL #Map
$20220000RL #Level 1
$20250000RL #Level 2
$20280000RL #Level 3...
$202B0000RL
$202E0000RL
$20310000RL
$20340000RL
$20370000RL
$203A0000RL
$203D0000RL
$20400000RL
$20440000RL
$20470000RL
$204A0000RL
$204D0000RL
$00000000L #Extra level 1
$00000000L #Extra level 2
$00000000L #Extra level 3
$00000000L #Extra level 4
$00000000L #Extra level 5
$00000000L #Extra level 6
$00000000L #Extra level 7
$00000000L #Extra level 8
$00000000L #Extra level 9

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

==== Keen 6 ====

<patch title="Keen 6">
#Allow 24 levels in Keen 6 v1.4:
#First increase the number of levels we can access from the map to maximum (+6)
%patch $D221 [$18] #Number of levels enterable ($18 = 24)
%patch $8A88 [$18] #Number of level song entries (24, see below)

#Level entrance pointers
%patch $32516 $1EF40000RL #Level 0
$1EF5000BRL #Level 1
$1EF7000DRL #Level 2
$1EF9000BRL #Level 3
$1EFC0007RL #Level 4
$1EFF0005RL #Level 5
$1F010001RL #Level 6
$1F040003RL #Level 7
$1F060007RL #Level 8
$1F08000FRL #Level 9
$1F0B0000RL #Level 10
$1F0F0001RL #Level 11
$1F100006RL #Level 12
$1F11000BRL #Level 13
$1F130000RL #Level 14
$1F140005RL #Level 15
$1F15000ARL #Level 16
$20100000RL #High scores
$00000000L #Extra level 1
$00000000L #Extra level 2
$00000000L #Extra level 3
$00000000L #Extra level 4
$00000000L #Extra level 5
$00000000L #Extra level 6
$00000000L #Extra level 7

#Level name pointers
%patch $324B2 $1F16000FRL #Level 0
$1F17000CRL #Level 1
$1EF8000DRL #Level 2
$1F190001RL #Level 3
$1EFD000FRL #Level 4
$1F000007RL #Level 5
$1F1A0002RL #Level 6
$1F050006RL #Level 7
$1F07000ERL #Level 8
$1F0A0001RL #Level 9
$1F1B0006RL #Level 10
$1F0F000DRL #Level 11
$1F110002RL #Level 12
$1F120007RL #Level 13
$1F13000CRL #Level 14
$1F150001RL #Level 15
$1F15000ARL #Level 16
$20100000RL #High scores
$00000000L #Extra level 1
$00000000L #Extra level 2
$00000000L #Extra level 3
$00000000L #Extra level 4
$00000000L #Extra level 5
$00000000L #Extra level 6
$00000000L #Extra level 7

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

== Infinite replays of some or all levels ==

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. These levels are known as [[Patch:Bean-With-Bacon-Megarocket|'BWB levels']] as the only level this is noticeable in by default is the BWB. The patch uses [[Patch:Jump conditions|jump conditions]].

<patch title="Keen 4">
#BwB levels: all levels above 17
%patch $60FD $11 $77</patch>

<patch title="Keen 5">
#BwB levels: all levels above 17
%patch $60B3 $11 $77</patch>

<patch title="Keen 6">
#BwB levels: all levels above 16
%patch $5ECD $10 $77</patch>

== Complete levels to win ==

Keen Galaxy has a [[Patch:Demo switch|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. More than one level can be the 'win' level, see [[Patch:Jump conditions]]. The last line is not necessary and should be omitted except when making a trial demo.

<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

#Specify level that must be beaten to win game (default is 2)
%patch $6B54 [$02] {$75}

#Win the game instead of going to high scores
%patch $6B57 $EB $99

#Enable "2 level demo" parameter by default (Not necessary)
%patch $3E90 $90 $90</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>

<patch title="Keen 5">
#Where level entry text list is located:
%patch $622F [$17D8W]
%patch $622B [$17DAW]

#Where level name list is located:
%patch $6603 [$1774W] #Didn't make it past 1
%patch $65FF [$1776W] #Didn't make it past 2
%patch $7D10 [$1774W] #Status window 1
%patch $7D0C [$1776W] #Status window 2</patch>

<patch title="Keen 6">
#Where level entry text list is located:
%patch $6044 [$17E6W]
%patch $6040 [$17E8W]

#Where level name list is located:
%patch $6418 [$1782W] #Didn't make it past 1
%patch $6414 [$1784W] #Didn't make it past 2
%patch $7AC0 [$1782W] #Status window 1
%patch $7ABC [$1784W] #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>

<patch title="Keen 5">
#Level name pointers:
%patch $31AB4 $20040000RL #Map
$20050000RL #Level 1
$20070000RL #Level 2
$20080000RL #Level 3...
$200A0000RL
$200C0000RL
$200E0000RL
$20100000RL
$20120000RL
$20140000RL
$20160000RL
$20180000RL
$201A0000RL
$201C0000RL
$201D0000RL #Korath base
$201E0000RL #BWB
$20100000RL #High scores

#Level entrance text pointers
%patch $31B18 $201F0000RL #Map
$20220000RL #Level 1
$20250000RL #Level 2
$20280000RL #Level 3...
$202B0000RL
$202E0000RL
$20310000RL
$20340000RL
$20370000RL
$203A0000RL
$203D0000RL
$20400000RL
$20440000RL
$20470000RL #Korath base
$204A0000RL #BWB
$204D0000RL #High scores</patch>

<patch title="Keen 6">
#Level name pointers:
%patch $324B2 $1EF40000RL #Map
$1EF50000RL #Level 1
$1EF70000RL #Level 2
$1EF80000RL #Level 3
$1EFA0000RL #Level 4...
$1EFC0000RL
$1EFD0000RL
$1EFF0000RL
$1F000000RL
$1F020000RL
$1F030000RL
$1F040000RL
$1F050000RL
$1F070000RL
$1F090000RL
$1F0B0000RL
$1F0D0000RL
$1F0E0000RL #BWB
$1F100000RL #High scores

#Level entrance text pointers
%patch $32516 $1F110000RL #Map
$1F130000RL #Level 1
$1F160000RL #Level 2
$1F190000RL #Level 3
$1F1C0000RL #Level 4...
$1F1F0000RL
$1F220000RL
$1F250000RL
$1F270000RL
$1F2A0000RL
$1F2D0000RL
$1F300000RL
$1F350000RL
$1F380000RL
$1F3C0000RL
$1F400000RL
$1F440000RL
$1F470000RL #BWB
$1F4A0000RL #Highscores</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>

<patch title="Keen 5">
#Level names:
%patch $20040 "Omegamatic" $00
%patch $20050 "Ion Ventilation System" $00
%patch $20070 "Security Center" $00
%patch $20080 "Defense Tunnel Vlook" $00
%patch $200A0 "Energy Flow Systems" $00
%patch $200C0 "Defense Tunnel Burrh" $00
%patch $200E0 "Regulation" $0A "Control Center" $00
%patch $20100 "Defense Tunnel Sorra" $00
%patch $20120 "Neutrino" $0A "Burst Injector" $00
%patch $20140 "Defense Tunnel Teln" $00
%patch $20160 "Brownian" $0A "Motion Inducer" $00
%patch $20180 "Gravitational" $0A "Damping Hub" $00
%patch $201A0 "Quantum" $0A "Explosion Dynamo" $00
%patch $201C0 "Korath III Base" $00
%patch $201D0 "BWBMegarocket" $00
%patch $201E0 "High Scores" $00

#Keen entering levels
%patch $201F0 "Keen purposefully" $0A "wanders about the" $0A "Omegamatic" $00
%patch $20220 "Keen investigates the" $0A "Ion Ventilation System" $00
%patch $20250 "Keen struts through" $0A "the Security Center" $00
%patch $20280 "Keen invades" $0A "Defense Tunnel Vlook" $00
%patch $202B0 "Keen engages" $0A "Energy Flow Systems" $00
%patch $202E0 "Keen barrels into" $0A "Defense Tunnel Burrh" $00
%patch $20310 "Keen goes nuts in" $0A "the Regulation" $0A "Control Center" $00
%patch $20340 "Keen regrets entering" $0A "Defense Tunnel Sorra" $00
%patch $20370 "Keen blows through" $0A "the Neutrino" $0A "Burst Injector" $00
%patch $203A0 "Keen trots through" $0A "Defense Tunnel Teln" $00
%patch $203D0 "Keen breaks into" $0A "the Brownian" $0A "Motion Inducer" $00
%patch $20400 "Keen hurries through" $0A "the Gravitational" $0A "Damping Hub" $00
%patch $20440 "Keen explodes into" $0A "the Quantum" $0A "Explosion Dynamo" $00
%patch $20470 "Keen faces danger" $0A "in the secret" $0A "Korath III Base" $00
%patch $204A0 "Keen will not be" $0A "in the BWBMegarocket" $00
%patch $204D0 "Keen unexplainedly" $0A "finds himself by" $0A "theHigh Scores" $00</patch>

<patch title="Keen 6">
#Keen entering levels
%patch $1F110 "Keen attacks" $0A "Fribbulus Xax" $00
%patch $1F130 "Keen hops across" $0A "Bloogwaters" $0A "Crossing" $00
%patch $1F160 "Keen fights his way" $0A "through Guard Post One" $00
%patch $1F190 "Keen crosses into the" $0A "First Dome of Darkness" $00
%patch $1F1C0 "Keen dares to enter the" $0A "Second Dome of Darkness" $00
%patch $1F1F0 "Keen foolishly enters" $0A "the Bloogdome" $00
%patch $1F220 "Keen makes his way" $0A "into Bloogton" $0A "Manufacturing" $00
%patch $1F250 "Keen ascends" $0A "Bloogton Tower" $00
%patch $1F270 "Keen hungrily enters" $0A "Bloogfoods, Inc." $00
%patch $1F2A0 "Keen smashes through" $0A "Guard Post Two" $00
%patch $1F2D0 "Keen seeks thrills" $0A "in Bloogville" $00
%patch $1F300 "Keen rockets into the" $0A "Bloog Aeronautics and" $0A "Space Administration" $00
%patch $1F350 "Keen boldly assaults" $0A "Guard Post Three" $00
%patch $1F380 "Keen whoops it up in" $0A "the Bloogbae" $0A "Recreational District" $00
%patch $1F3C0 "Keen purposefully struts" $0A "into the Bloogbase" $0A "Management District" $00
%patch $1F400 "Keen bravely enters the" $0A "Bloog Control Center," $0A "looking for Molly" $00
%patch $1F440 "Keen warily enters" $0A "Blooglab Space" $0A "Station" $00
%patch $1F470 "Keen returns to the" $0A "Bean-with-Bacon" $0A "Megarocket" $00
%patch $1F4A0 "Keen is in the High" $0A "Score screen. Call Id!" $00</patch>

==== High scores has entry text and name (Keen 4) ====

This patch gives the high scores level in Keen 4 an entry text and name. It does this by using parts of the level entry texts as level names, freeing up space for the high Score level name and entry text. This is useful for those who want to enable access to the high scores level.

<patch title="Keen 4">#Level name pointers: (Compressed)
%patch $30764 $1F200000RL #Map
$1F220009RL #Level 1
$1F250000RL #Level 2
$1F270007RL #Level 3
$1F090000RL #Level 4...
$1F0B0000RL
$1F0C0000RL
$1F0D0000RL
$1F0E0000RL
$1F0F0000RL
$1F100000RL
$1F110000RL
$1F130000RL
$1F150000RL
$1F180000RL
$1F1A0000RL
$1F1B0000RL
$1F1C0000RL
$1F1D0000RL #Bwb Rocket
$1F060005RL #High scores

#High score entry text
%patch $30814 $1F040000RL

#High score entry text and name
%patch $1F040 "Keen is in the High" $0A
"Scores! Call Id!" $00
"High Scores" $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 entry window ==

This window appears when Keen enters a level (Including the map, which happens when he exits a normal level.)

=== No 'thumbs up' sequence ===

This patch removes the 'thumbs up' sequence from the window. This means only one, unchanging, image appears in the window.

<patch title="Keen 6">
#No thumbs up when entering levels
%patch $61FA $CB</patch>

== Tile replacement ==

By default when Keen completes a level all of the tiles that have a specific infoplane (sprite) value on them will be replaced with tile 0, essentially deleting them from the level. This is used to make obstacles on the map that vanish on level completion.

=== Marker sprite ===

By default the marker sprite value is $D0xx. The level number is taken away from the sprite value and if it equals $D000 the tile is replaced. Changing the [[Patch:Jump conditions|jump]] To $EB will stop any tiles being replaced

<patch title="Marker sprite">
#D0xx Marker sprite - Keen 4
%patch $6120 [$D000W] {$75}

#D0xx Marker sprite - Keen 5
%patch $60D6 [$D000W] {$75}

#D0xx Marker sprite - Keen 6
%patch $5EF0 [$D000W] {$75}</patch>

=== Replacement tile ===

By default the replacement tile is tile 0, which in effect deletes the tile. This is not necessarily the case however and the replacement tile can be any valid tile.

<patch title="Replacement tile">
#D0xx Replacement tile - Keen 4
%patch $6130 [$0000W]

#D0xx Replacement tile - Keen 5
%patch $60E6 [$0000W]

#D0xx Replacement tile - Keen 6
%patch $5F00 [$0000W]</patch>

== Level game starts in ==

This patch causes the player to start the game in a different level than the [[ Patch:Map|map. (Level 0)]] The values of the [[Patch:Game stats|level variable]] given here will start the game in the default BWB level (except Keen 5 where the player will start in the [[Patch:High Scores (Galaxy)|High Scores level]] due to the game lacking a BWB level proper.)

Note that this does not change what the map level is; on exiting levels Keen will return to the map (level 0) and only the map will do such things as mark levels as done.

There is one minor side effect to this patch; the high word of the [[Patch:Extra Keen At|Extra Keen At score]] is not set to 0. What this means is that the game cannot start with an Extra Keen At score of more than 65'000 or so without a slightly more complicated patch being used.

<patch title="Keen 4">
#Keen starts game in the BWB
%patch $5CBB {$7A68W} [$0012W]</patch>

<patch title="Keen 5">
#Keen starts game in the BWB
%patch $5C8F {$6F68W} [$000FW]</patch>

<patch title="Keen 6">
#Keen starts game in the BWB
%patch $58AF {$75A4W} [$0011W]</patch>

== Misc ==

=== Keen can exit Well of Wishes by going offscreen ===

This patch relates to the [[Patch:Well Of Wishes|Well Of Wishes]] in [[Keen 4]]. It changes the level so that Keen can exit it in the same way as normal levels, by going off the edge of the screen. Further patches can be found on the linked page. As a side effect the level scrolling is altered slightly.

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

=== Connect two levels in Keen 5 ===

This somewhat convoluted patch creates two new sprites 'Up level', which sends Keen to the next level in the game, and 'Win level' which wins the current ''and'' previous level. Both sprites are 'activated' by Keen simply standing in the same place as they are. If the 'second' level is not linked in the [[Patch:Map|map]] then it will be reachable only via this sprite. If the second level is won via the win level sprite then both levels will be in effect 'linked'; Keen will enter the first level, progress to the second, then exit and complete both.

These sprites can also be used singularly rather than in combination for other neat effects such as completing one level making another level inaccessible (Since it too will be completed.)

The patch breaks down as follows. The first section disables two [[Category:Cheats patches|cheats]] to provide space for the patch, [[Patch:F10 C Cheat|F10-C]] and [[Patch:F10 T Cheat|F10-T]]. (The second leaves some spare patch space even with this patch that can be used.) The second section compacts Keen's spawning code to create [[Patch:Sprite spawning|sprite spawning space.]] The following section is pointers to the new sprites. (They are sprites $007D and $007E, represented by a flat yellow line and downward sloping yellow line in the default graphics, that is they are on the opposite end of the sprite row that contains the [[Patch:Korath|Korath]].) None of this should be altered in any way.

The next two sections are the initiation codes for the new sprites. The blue value is the [[Patch:Sprite cache|cached animation]] that will be sued by ''both'' sprites when they are place in-level. (It is possible to adjust the patch to use another, entire, sprite cache.) The two sections after that are the sprite spawning codes. The first blue value in each is the sprite's [[Patch:Sprite type|type;]] the second blue value is the sprite's [[Patch:Sprite actions|action.]]

The next two sections are the sprite's [[Patch:Sprite actions|action codes,]] The blue value is the animation the sprites use when in-level. (This is so Keen can touch them, the animation can be made invisible if wished.) Finally the last two sections are the uplevel and winlevel collision codes responsible for moving Keen up a level and winning two levels respectively. This uses [[Patch:Level state|level state code]].

<patch title="Keen 5">
#Disable cheats for space
%patch $7401 $EB $19 #F10-C
%patch $7679 $EB $12 #F10-T

#Compact left\right Keen spawn to create space $EE96-EEBA
%patch $EEBB $B8 $0001W $EB $03
%patch $F4C6 $016BW #Keen right uses compact spawn (At $EEBB

#Pointers to new sprites
%patch $F59C $0146W #Uplevel (At $EE96)
%patch $F59E $014FW #Winlevel (At $EE9F)

#New sprite spawn 1 (Goes to end of spawn 2)
%patch $EE96 $57 $56 $9A $06B90000RL $EB $07

#New sprite spawn 2 both cache $0117
%patch $EE9F $57 $56 $9A $06B9003ARL $83 $C4 $04 $B8 $2B7BRW $8A $16
$EC $6F $8E $C0 $26 $08 $16 [$0117W] $E9 $04EDW

#Uplevel spawning code = $06B90000RL
%patch $6B90 $55 $8B $EC $33 $C0 $50 $9A $06B91DCDRL $83 $C4 $02 $8B $1E
$40 $9E $C7 $07 [$0001W] $8B $46 $06 $B1 $08 $D3 $E0 $89 $47 $0A
$8B $46 $08 $D3 $E0 $89 $47 $3E $89 $47 $0C $B8 [$00F2W] $50 $53
$9A $090B11C4RL $83 $C4 $04 $5D $CB

#Winlevel spawning code = $06B9003ARL
%patch $6BCA $55 $8B $EC $33 $C0 $50 $9A $06B91DCDRL $83 $C4 $02 $8B $1E
$40 $9E $C7 $07 [$0001W] $8B $46 $06 $B1 $08 $D3 $E0 $89 $47 $0A
$8B $46 $08 $D3 $E0 $89 $47 $3E $89 $47 $0C $B8 [$0110W] $50 $53
$9A $090B11C4RL $83 $C4 $04 $5D $CB

#Uplevel action = $00F2
%patch $30432 [$0117W $0117W] $0002W $0000W $0000W $0000W $0000W $0000W
$00000000L $06B9015ERL $090B17B5RL $00F2W

#Winlevel action = $0110
%patch $30450 [$0117W $0117W] $0002W $0000W $0000W $0000W $0000W $0000W
$00000000L $06B9017ERL $090B17B5RL $0110W

#Uplevel collision: increment curr_lev and set level state to restart level = $06B9015ERL
%patch $6CEE $55 $8B $EC $56 $57 $8B $7E $06 $8B $76 $08 $81 $7C $1C $0888W
$75 $0A $FF $06 $6F68W $C7 $06 $6F70W $0003W $5F $5E $5D $CB

#Winlevel collision: mark previous level as done and set level state to win level = $06B9017ERL
%patch $6D0E $55 $8B $EC $56 $57 $8B $7E $06 $8B $76 $08 $81 $7C $1C $0888W
$75 $12 $8B $1E $55 $9E $D1 $E3 $C7 $87 $6F1AW $0001W $C7 $06
$6F70W $0002W $5F $5E $5D $CB</patch>

=== Automatically restart levels instead of having option to go to map ===

This patch changes things so that Keen is not given the opportunity to exit to the map level This patch uses [[Patch:Jump conditions|jump conditions]] and [[Patch:Game stats]]. By default this only happens when a [[Patch:Game over|game over]] is triggered. (When Keen has no lives.) Changing the lives requirement to anything else means that below a certain number of lives he will be forced to replay the level until a game over. Changing the requirement from lives can cause Keen to have to replay the level until he gets a certain item. Changing the jump can eliminate the option to quit to the map entirely and more.

<patch title="Keen 4">
#Automatically restart a level when killed (No map option) if Keen has no lives
%patch $6684 {$7A6AW} [$00] {$7D}</patch>

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Keen Dreams|}}
{{PatchCategories|Levels|}}
{{PatchCategories|Gameplay|}}

Abiathar

2014-03-27T22:12:13Z

Fleexy: Created

{{Stub}}

Abiathar is a Windows-based level and tileinfo editor for Keen Dreams and Keen Galaxy. It was developed by Fleexy starting on January 10, 2014 and publicly released on Keen Day 2014.

Other Tools

2014-03-23T23:48:23Z

Fleexy: Added Abiathar to list of level editors

== Game Editing ==

This section is organised by category. If an editor supports more than one type of editing (such as level editing and graphics editing) it will be listed under both sections.

The tools in this section apply to [[Keen Dreams]] or other Keen-related programs (not Keens 1-6, which have their own sections.)

=== DOS Emulators ===

* [[DosBox]]

=== Level Editors ===

* [[TED5]]
* [[Abiathar]]

=== Graphics Editors ===

* [[EModKeen]]/[[LModKeen]]
* [[ModKeen]]
* [[Keengraph]]

=== Sound Editors ===

* [[KeenWave]]

=== Music Editors ===

As there is no music in Keen Dreams, there are no music editors. Since the music was removed from Keen Dreams at the last minute, it may be possible to add music back in again, but as yet nobody has tried.

=== Story / Game Text Editors ===

* TODO

=== Other editors and editing tools ===

* [[KDRPatch]] (a CKPatch-based patching tool)

== Game Information ==

* For details on the file formats used by the games, see the [[ModdingWiki:Commander Keen Dreams|Commander Keen Dreams]] section on the ModdingWiki.
* There is a [[:Category:Patches|list of patches]] that can be incorporated into mods to change the game's behaviour.

== See Also ==

* [[Vorticon Tools]]
* [[Galaxy Tools]]

[[Category:Tools]]

User:Fleexy

2014-03-21T01:56:58Z

Fleexy: Created

Hi there! I'm Fleexy, creator of the amazing Galaxy level editor "Abiathar", check it out!

Patch:Game errors

2014-03-21T01:55:39Z

Fleexy: /* Forbidden pointer values and gibberish in-level */ Corrected the values and added note about Abiathar

Game errors are problems that occur during gameplay that (usually) result in the crash of the game or the display of an error message. They are useful patch-wise in that a well constructed mod will never use these errors and they can be co-opted for other means.

There are four types of error encountered in the Keen games; the first are nonfatal errors, these will display an error message, but will allow the game to continue being played. An example of this is the 'Unable to play background music' error. The second kind are fatal errors, they cause the game to halt or otherwise end, but are recognized and understood well enough that a sensible message will be displayed. An example is the 'unable to load level' error. The third kind are crashes, and they cause the game to crash leaving just a command prompt and (usually) a single line of text explaining technical details. These are the most common and least useful errors. An example is the 'too many animating tiles' error. The fourth kind of error is a freezing error, where the game will freeze, needing to be closed. An example is the animating tile freeze.

This page will cover two basic functions. The first is to identify errors and how they are triggered and thus aid the modder in avoiding them. The second will be to supply patches where possible to remove or modify error code or more useful purposes. (It may be useful to see [[Patch:Text patches]]

Since most errors occur in the Keen Galaxy series, all errors listed on this page apply ''only'' to Keens 4, 5 and 6 ''unless sated otherwise.''

= Nonfatal errors =

As noted these are errors that show a message, but allow the player to continue, though not without consequences.

=== Insufficient Memory to play music ===

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

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

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

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

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

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

<patch title="Insufficient memory to play music">
#Keen 4 :
#Insufficient memory to play music window
%patch $8D30 [$06ECW] #Text called from
%patch $2F55C "Insufficient memory" $0A
"for background music!" $00

#Keen 5 :
#Insufficient memory to play music window
%patch $8CA2 [$065EW] #Text called from
%patch $3099E "Insufficient memory" $0A
"for background music!" $00

#Keen 6 :
#Insufficient memory to play music window
%patch $8B0A [$0656W] #Text called from
%patch $31386 "Insufficient memory" $0A
"for background music!" $00</patch>

=== Not enough memory to load game ===

This error occurs quite simply when a saved game demands more memory than the game has. This usually happens if the game was saved in a different mod or different version of the same mod. In this case it is not the saved game or even necessarily the mod that is broken, there is simply an incompatibility between the conditions the game was saved in and the conditions it was loaded in. Even the smallest change can cause this. Working only with games saved in the most recent version of the game should fix this.

If this occurs in a completed or stable mod then it points to deep and unpredictable errors that can be difficult to fix. The best strategy is simply to attempt to discover what conditions cause this to happen, starting with which level\difficulty then looking for more specific subconditions such as the presence of a certain sprite.

There are two situations in which this error can arise and in Keen 4\6 they use different text. In Keen 5 they use the same text.

<patch title="Not enough memory to load game error">
#Keen 4 :
%patch $5E82 [$0259W] #Text called from
%patch $2F0C9 "Not enough memory" $0A "to load game!" $00
%patch $5EFF [$0279W] #Text called from
%patch $2F0E9 "Not enough memory" $0A "to load game!" $00

#Keen 5 :
%patch $5E1C [$01FEW] #Text called from 1
%patch $5E98 [$01FEW] #Text called from 2
%patch $3053E "Not enough memory" $0A "to load game!" $00

#Keen 6 :
%patch $5C56 [$019DW] #Text called from
%patch $30ECD "Not enough memory" $0A "to load game!" $00
%patch $5CD3 [$01BDW] #Text called from
%patch $30EED "Not enough memory" $0A "to load game!" $00</patch>

= Fatal errors =

As noted these errors will halt gameplay, but not crash the executable.

=== Insufficient Memory to load level ===

This occurs when a level is too large to be played. It relates entirely to the size of the level. A good 'large' size for a level is 100x100 tiles, (See also level size limits in the 'other limitations' section.) A level that is much larger than this, in area (Height * width) will exceed the memory allocated and be unable to load. the only way to resolve this is to reduce the size of the level.

At present the exact maximum size of the level that can be loaded is unknown. however it also affects sprites and background music, for both of these to load (In that order.) there must be enough ''free memory'' after the level has been loaded.

If the levels do not trigger this error then the code space may be used for other things.

<patch title="Insufficient memory to load level error">
#Keen 4 Insufficient memory to load level window:
%patch $69EF $EB #Never show (Free 69F1-6A32)
%patch $69F8 [$0008W] #Height
%patch $69FC [$0014W] #Width
%patch $6A0D [$0335W] #Text called from
%patch $2F1A5 "Insufficient memory" $0A
"to load level!" $00

#Keen 5 Insufficient memory to load level window:
%patch $69AA $EB #Never show (Free 69AC-69ED)
%patch $69B3 [$0008W] #Height
%patch $69B7 [$0014W] #Width
%patch $69C8 [$02D8W] #Text called from
%patch $30618 "Insufficient memory" $0A
"to load level!" $00

#Keen 6 Insufficient memory to load level window:
%patch $67E0 $EB #Never show (Free 67E2-6823)
%patch $67E9 [$0008W] #Height
%patch $67ED [$0014W] #Width
%patch $67FE [$027BW] #Text called from
%patch $30FAB "Insufficient memory" $0A
"to load level!" $00</patch>

= Crash errors =

As mentioned, these errors cause the executable to crash, leaving the user at the command prompt with technical details of the error.

=== RF_MarkTileGraphics errors ===

All errors involving 'RF_MarkTileGraphics' are errors with tile animation. They are patch problems that result when a modder produces a corrupt <tt>[[Patch:Tileinfo|TILEINFO.CKx]]</tt> file. This error is the best result as it provides information about both the problem and the tile responsible. The worst case scenario is that the game freezes.

There are three types of error and six possible errors (Five in [[Keen 5]]); three for background and three for foreground tiles. Each type of error is as follows.

''Too many unique animating tiles:'' Animating tiles require extra memory on top of what is needed for their graphics. When too many different types of animated tile are in a level then this memory will be overrun and the level will not be playable. The solution is to remove some kinds of animating tile from the level. (''All'' instances of a tile must be removed, which is why [[TED5]] has a feature to count the number of different tiles in a level, if even one tile of type x remains, type x will still be loaded into memory.)

If this error occurs ''during'' play, not at the start then the problem is with how ''many'' animating tiles are appearing at once; no more than 24 animating tiles of any kind can appear in play (Onscreen or within 2 tiles of the screen borders) at one time.

Note that in Keen 5 the same text is used for both the background and foreground error, in the other Galaxy games different texts are used.

''Anim of 0:'' This occurs when a tile animates to tile 0. Since tile 0 is a special case (No tile) this cannot happen. It is the easiest error to fix as the offending tile will be at the top of the tileset, within the first 128 tiles. The offending tile must be made to animate to another tile or not animate at all. This error is rare as it requires a modder to deliberately set tile 0 as an animation target.

''Unending animation:'' This occurs when a tile animation is not a nice neat loop. It is rather common as there are many ways a modder may unintentionally cause it. The first possibility is that a tile that animates (Has an animation delay) does not have anything to animate ''to'', this can happen if part of an animation loop is removed or not set in the first place.

The second way this may happen is if two tiles are set to animate to the same target ''and'' both 'start' tiles are present in a level. Like two cars trying to park in the same space, they clash.

If a modder is conscientious they will have kept a record of what they have done before the error so that they have a good idea as to what tile may be the problem. If not there may be some guesswork. The tile error might well give a tile number, but this is hard to pin down as it is a 'chunk number' and needs a certain value removed from it to give the actual tile number. In desperate situations it is possible to back up levels and delete the newest parts of them, stopping when the error stops/ (The tile can then be identified, fixed and the backed up levels restored.)

<patch title="'RF_MarkTileGraphics' errors">
#Keen 4 :
%patch $168F9 [$4099W] #Text called from
%patch $32F09 "RF_MarkTileGraphics: Background anim of 0:" $00

%patch $16969 [$40C4W] #Text called from
%patch $32F34 "RF_MarkTileGraphics: Too many unique animated tiles!" $00

%patch $169F5 [$40F9W] #Text called from
%patch $32F69 "RF_MarkTileGraphics: Unending background animation:" $00

%patch $16AC1 [$412DW] #Text called from
%patch $32F9D "RF_MarkTileGraphics: Foreground anim of 0:" $00

%patch $16B3A [$4158W] #Text called from
%patch $32FC8 "RF_MarkTileGraphics: Too many unique animated tiles!" $00

%patch $16BC6 [$418DW] #Text called from
%patch $32FFD "RF_MarkTileGraphics: Unending foreground animation:" $00

#Keen 5 :
%patch $17896 [$3750W] #Text called from
%patch $33A90 "RF_MarkTileGraphics: Background anim of 0:" $00

%patch $17906 [$377BW] #Text called from
%patch $33ABB "RF_MarkTileGraphics: Too many unique animated tiles!" $00

%patch $17992 [$37B0W] #Text called from
%patch $33AF0 "RF_MarkTileGraphics: Unending background animation:" $00

%patch $17A5E [$37E4W] #Text called from
%patch $33B24 "RF_MarkTileGraphics: Foreground anim of 0:" $00

%patch $17B63 [$380FW] #Text called from
%patch $33B4F "RF_MarkTileGraphics: Unending foreground animation:" $00

#Keen 6 :
%patch $16468 [$3A99W] #Text called from
%patch $347C9 "RF_MarkTileGraphics: Background anim of 0:" $00

%patch $164DC [$3AC4W] #Text called from
%patch $347F4 "RF_MarkTileGraphics: Too many unique animated tiles!" $00

%patch $165B7 [$3AF9W] #Text called from
%patch $34829 "RF_MarkTileGraphics: Unending background animation:" $00

%patch $16686 [$3B2DW] #Text called from
%patch $3485D "RF_MarkTileGraphics: Foreground anim of 0:" $00

%patch $16703 [$3B58W] #Text called from
%patch $34888 "RF_MarkTileGraphics: Too many unique animated tiles!" $00

%patch $167E3 [$3B8DW] #Text called from
%patch $348BD "RF_MarkTileGraphics: Unending foreground animation:" $00</patch>

=== RF_CheckForAnimTile error ===

This error occurs when too many animated tiles are shown onscreen at once. There is only a limited number of tile frames available for animation and this can be exhausted by many animated tiles being onscreen, an animation loop having lots of different tiles in it, or both.

The most common cause is too many tiles, removing any large blocks of animating tiles from the level will fix this.

There are two errors, one for background and on for foreground tiles. both use the same text, and in [[Keen 5]] and [[Keen Dreams]] the texts were combined for efficiency.

<patch title="RF_CheckForAnimTile error">
#Keen 4 :
%patch $16CA1 [$41C1W] #Text called from
%patch $33031 "RF_CheckForAnimTile: No free spots in tilearray!" $00
%patch $16D3A [$41F2W] #Text called from
%patch $33062 "RF_CheckForAnimTile: No free spots in tilearray!" $00

#Keen 5 :
%patch $17C3E [$3843W] #Text called from
%patch $33B83 "RF_CheckForAnimTile: No free spots in tilearray!" $00

#Keen 6 :
%patch $168D5 [$3BC1W] #Text called from
%patch $348F1 "RF_CheckForAnimTile: No free spots in tilearray!" $00
%patch $16974 [$3BF2W] #Text called from
%patch $34922 "RF_CheckForAnimTile: No free spots in tilearray!" $00

#Keen 7 :
%patch $E9A2 [$4146W] #Text called from
%patch $27BB6 "RF_CheckForAnimTile: No free spots in tilearray!" $00</patch>

=== WallDebug errors ===

These are [[Patch:Tileinfo|tileinfo errors]] that occur when the game encounters a tile that has values for either its left or right sides that are not 0 or 1. (Pass or block.) It will occur when the [[Patch:F10 Y Cheat|Wall Debug cheat (F10 + Y)]] is used in a level containing a problematic tile. The number of the ''first'' tile that has this problem will be given with the error, allowing quick identification and fixing.

It is possible for this to occur via bugs in the program used to edit tileinfo or by a patch being placed within the tileinfo segment of the game. In this case it will always appear in a similar situation and depend on specific tile(s). If a nonsensical number (Say 0 or a negative number.) is given as the affected tile, or the tile number keeps changing randomly or is not given at all, then it is possible the bug is a 'scrambling error' caused by a patch in another area of code becoming scrambled and accidentally referring to the error code. In this case testing of recent patches may solve the problem.

<patch title="WallDebug errors">
#Keen 4 :
%patch $72EC [$04ACW] #Text called from
%patch $2F31C "WallDebug: East wall other than 1:" $00

%patch $7350 [$04CFW] #Text called from
%patch $2F33F "WallDebug: West wall other than 1:" $00

#Keen 5 :
%patch $72A1 [$0428W] #Text called from
%patch $30768 "WallDebug: East wall other than 1:" $00

%patch $7305 [$044BW] #Text called from
%patch $3078B "WallDebug: West wall other than 1:" $00

#Keen 6 :
%patch $70BB [$0424W] #Text called from
%patch $31154 "WallDebug: East wall other than 1:" $00

%patch $711F [$0447W] #Text called from
%patch $31177 "WallDebug: West wall other than 1:" $00</patch>

=== Map is too tall ===

This error can occur under two circumstances. The first, which is very rare, is when the map is literally too tall, over 250 tiles high. Such a level will already be suffering from the 'level size limit' bug in the 'other limits' section.

However the most common appearance of this level is an accidental triggering when using [[TED5]] as a level editor. TED5 can compress levels (Carmackize them) and Keen Galaxy games require this. If the levels are saved but ''not'' compressed (Which takes time unless [[Instant Carma]] is used.) then the game sees nothing but gibberish and crashes with this error. Checking that levels are carmackized is the first step to solving this.

Similar situation will also cause this bug, if level data has become corrupt, if the <tt>MAPHEAD.CKx</tt> file is corrupt or not the right one for the levels or not patched correctly. Such situations can be aggravating and underlie the need to backup regularly.

<patch title="Map too tall error">
#Keen 4 :
%patch $16744 [$4080W] #Text called from
%patch $32EF0 "RF_NewMap: Map too tall!" $00

#Keen 5 :
%patch $176E1 [$3737W] #Text called from
%patch $33A77 "RF_NewMap: Map too tall!" $00

#Keen 6 :
%patch $16275 [$3A80W] #Text called from
%patch $347B0 "RF_NewMap: Map too tall!" $00</patch>

=== Insufficient memory to load map level ===

This error is identical in nature to the 'unable to load level' error, except that in this case it is the map level that cannot be loaded. Since a lot of important things are also done at this point, the game cannot simply throw up an error, but must crash. The solutions are the same as given in the level error section above.

<patch title="Keen 4">
#Keen 4 :
%patch $6A3B [$0358W] #Text called from
%patch $2F1C8 "GameLoop: Insufficient memory to load world map!" $00

#Keen 5 :
%patch $69F6 [$02FBW] #Text called from
%patch $3063B "GameLoop: Insufficient memory to load world map!" $00

#Keen 6 :
%patch $682C [$029EW] #Text called from
%patch $30FCE "GameLoop: Insufficient memory to load world map!" $00</patch>

=== [[Patch:GAMEMAPS|GAMEMAPS and KDREAMS.MAP]] errors ===

If the <tt>GAMEMAPS.CKx</tt> file is absent (or the equivalent file if <tt>GAMEMAPS.CKx</tt> has been renamed.) then the game will abort with an error.

<patch title="Keen Galaxy\Dreams map errors">
#Keen 4:
%patch $13363 [$3AEFW] #Text called from
%patch $3295F "Can't open GAMEMAPS.CK4!" $00

#Keen 5:
%patch $14300 [$3245W] #Text called from
%patch $33585 "Can't open GAMEMAPS.CK5!" $00

#Keen 6:
%patch $12E94 [$34EFW] #Text called from
%patch $3421F "Can't open GAMEMAPS.CK6!" $00

#Keen Dreams:
%patch $B983 [$283AW] #Text called from
%patch $262AA "Can't open KDREAMS.MAP!" $00</patch>

=== RF_SetScrollBlock errors ===

This error occurs when the modder has placed too many [[Patch:Scrollbars|scrollbars]] in a level. It should always happen when first entering a level. The error will explain which type of scrollbar is at fault, vertical or horizontal. The only solution to this is to remove scrollbars from the level until the error stops occurring.

If all scrollbars are removed yet the error recurs then it is a patch error and the entire patchfile must be checked.

<patch title="Scroll bar errors">
#Keen 4 :
%patch $1706B [$4244W] #Text called from
%patch $330B4 "RF_SetScrollBlock: Too many horizontal scroll blocks" $00
%patch $17094 [$4279W] #Text called from
%patch $330E9 "RF_SetScrollBlock: Too many vertical scroll blocks" $00

#Keen 5 :
%patch $18008 [$3895W] #Text called from
%patch $33BD5 "RF_SetScrollBlock: Too many horizontal scroll blocks" $00
%patch $18031 [$38CAW] #Text called from
%patch $33C0A "RF_SetScrollBlock: Too many vertical scroll blocks" $00

#Keen 6 :
%patch $16CDB [$3C44W] #Text called from
%patch $34974 "RF_SetScrollBlock: Too many horizontal scroll blocks" $00
%patch $16D04 [$3C79W] #Text called from
%patch $349A9 "RF_SetScrollBlock: Too many vertical scroll blocks" $00</patch>

=== No free spots in Objarray ===

This error occurs at the start of a level when there are too many objects (Enemies, keys, siwtches, etc) in a level. The 'object array' can only hold about 128 different objects, that is things in layer 3 of the level (Not tiles of any kind.) and this is why [[TED5]] has a feature to show how many objects exist in the level..

The object array is an area o memory that has a specific amount of memory set aside for any object placed in the level, no matter how much it uses. Therefore the only way to rectify this error is to remove objects from the level, starting with the least significant. (Such at point objects, but not point tiles.)

If this error occurs not when the level starts, but some time after, it is usually due to there being no way to destroy new sprites being produced. For example, if the [[Poison Slug]]'s slime is prevented from drying up, more and more slime will be produced in any level with a slug in it, until there is no more space in memory for them and the game crashes.

This error is included in [[Keen Dreams]], but is called a 'sprite array' error, see the below section. In Keen Vorticons the level will simply crash on loading. The limit in Vorticons is 76 sprites or fewer per level.

<patch title="Keen 4">
#Keen 4 :
%patch $89FD [$067FW] #Text called from
%patch $2F4EF "GetNewObj: No free spots in objarray!" $00

#Keen 5 :
%patch $8979 [$05F1W] #Text called from
%patch $30931 "GetNewObj: No free spots in objarray!" $00

#Keen 6 :
%patch $87E1 [$05E9W] #Text called from
%patch $31319 "GetNewObj: No free spots in objarray!" $00</patch>

=== No free spots in Sprite array ===

This error occurs for the same reasons as the error above; there is no space in the sprite (object) array for new sprites to be placed. However it differs in that it occurs in the middle of gameplay, not when the level is loaded. In other words it occurs when existing sprites that fit into the sprite array produce a new sprite that can't.

This will happen if any sprite shoots a projectile that isn't destroyed or shoots fast enough that about 60 new sprites can be onscreen at once or if a marginal level produces just one or two extra sprites. This can be checked using the [[Patch:F10 C Cheat|Count objects cheat]] included in the game for just this purpose. The total number of objects in a level should not exceed 70 or so. If the count is high at the level start, this means the level is dangerously marginal and some objects should be removed from the map. If not then it is a production\disposal problem and regular checks of the count will keep the modder informed as to what id going on.

In [[Keen Dreams]] this cannot occur as the game prevents new sprites being produced when the object array is full. This is a surprising feature. However wen this error ''does'' occur, it is not a sprite array error but an object array error, triggered at the level start. (See above section.) Only the wording is different.

<patch title="Keen Galaxy placesprite errors">
#Keen 4 :
%patch $17C1B [$42C1W] #Text called from
%patch $33131 "RF_PlaceSprite: No free spots in spritearray!" $00

#Keen 5 :
%patch $18BB8 [$3912W] #Text called from
%patch $33C52 "RF_PlaceSprite: No free spots in spritearray!" $00

#Keen 6 :
%patch $1788A [$3CC1W] #Text called from
%patch $349F1 "RF_PlaceSprite: No free spots in spritearray!" $00

#Keen 7 :
%patch $F2A3 [$41ADW] #Text called from
%patch $27C1D "RF_PlaceSprite: No free spots in spritearray!" $00</patch>

=== Placed uncached sprite ===

This error occurs during gameplay when an object tries to use a graphic image that wasn't cached at the level start. (See [[Patch:Sprite animations|Animations]] and [[Patch:Sprite cache|Sprite cache]] for an explanation of this.) This is annoyingly common when advanced patching is involved and enemies, etc are using animations they did not originally.

The error comes with a number, which is useful if the modder is using [[Keengraph]] as it will be the same number as the sprite bitmap that was trying to be loaded, usually allowing the modder to check, identify the sprite at fault and alter their patch file accordingly. In Modkeen this is not possible as the sprite bitmaps are not numbered as the game numbers them.

<patch title="Placed uncached sprite error">
#Keen 4 :
%patch $17C88 [$42EFW] #Text called from
%patch $3315F "RF_PlaceSprite: Placed an uncached sprite:" $00

#Keen 5 :
%patch $18C25 [$3940W] #Text called from
%patch $33C80 "RF_PlaceSprite: Placed an uncached sprite:" $00

#Keen 6 :
%patch $178F7 [$3CEFW] #Text called from
%patch $34A1F "RF_PlaceSprite: Placed an uncached sprite:" $00</patch>

=== Tried to remove the player ===

The game tracks a certain sprite (The last Keen-type sprite encountered when loading sprites from the level map.) as the player. The screen will follow it, it will die when the 'kill player' code is called, etc. While other sprites can ''act'' like the player, they are not special and can be removed, destroyed, etc. However if due to a certain patch the player sprite is set to action=0 (Nothing, that is, removed from the level.) then the game will crash as it does not have a way to pick a new player sprite.

This is always a patching error. It usually occurs when two sprites collide. As an example, setting Keen's [[Patch:Sprite type|sprite type]] to 3 (The same as his shot) will cause Keen to stun enemy sprites and vanish. The only way to solve this problem is to check the patch file for any patches that may be causing a problem.

<patch title="'Tried to remove the player' error">
#Keen 4 :
%patch $8A69 [$06A5W] #Text called from
%patch $2F515 "RemoveObj: Tried to remove the player!" $00

#Keen 5 :
%patch $89E5 [$0617W] #Text called from
%patch $30957 "RemoveObj: Tried to remove the player!" $00

#Keen 6 :
%patch $884D [$060FW] #Text called from
%patch $3133F "RemoveObj: Tried to remove the player!" $00</patch>

=== [[Patch:Sprite shifts|Bad shifts number]] ===

This is a graphics error that occurs when the modder has written an incorrect [[Patch:Sprite shifts|sprite shifts]] entry in <tt>SPRITES.TXT</tt> (Modkeen) or <tt>LIST.TXT</tt> (Keengraph) and imported it. This relates to the number of sprite shifts, or how smoothly a sprite animation can move in the level. it can be 1, 2 or 4, but no other number. This number is the last number in every sprite entry in the text file. This error will only occur when an incorrect sprite animation is called, which will help narrow down the search.

<patch title="Keen Galaxy and Dreams shifts errors">
#Keen 4 :
%patch $13954 [$3B28W] #Text called from
%patch $32998 "CAL_CacheSprite: Bad shifts number!" $00

#Keen 5 :
%patch $148F1 [$327EW] #Text called from
%patch $335BE "CAL_CacheSprite: Bad shifts number!" $00

#Keen 6 :
%patch $13485 [$3528W] #Text called from
%patch $34258 "CAL_CacheSprite: Bad shifts number!" $00

#Keen 7 :
%patch $BEFC [$2876W] #Text called from
%patch $262E6 "CAL_CacheSprite: Bad shifts number!" $00</patch>

=== No star specs for object ===

This error occurs only in [[Keen 6]] and is encountered when the game is not told where to put the [[Patch:Stunned sprite stars|stun stars]] when a sprite is stunned. Notably, changing the [[Patch:Nospike|Nospike's]] sprite type will cause this to happen whenever one is stunned or falls off a cliff.

This error can be fixed by patching the relevant entry for the [[Patch:Stunned sprite stars#Keen_6|stunned sprite star position]] to <tt>$1A6CW</tt> or another valid value.

<patch title="Keen 6">
#No star specs for object error
%patch $A9A1 [$7F0W] #Text called from
%patch $31520 "No star spec for object!" $00</patch>

=== SpawnShot - Bad dir ===

This error technically occurs because the player has produced a shot that is moving in an illegal direction (Say up and down at the same time.) In practice this will appear only due to patch errors corrupting the shooting code. (Around $E500) The only solution to this is to check each patch, especially recently added patches to see if this fixes the error.

<patch title="Spawn shot errors">
#Keen 4 :
%patch $E608 [$184CW] #Text called from
%patch $306BC "SpawnShot: Bad dir!" $00

#Keen 5 :
%patch $DD37 [$1631W] #Text called from
%patch $31971 "SpawnShot: Bad dir!" $00

#Keen 6 :
%patch $D8A2 [$1652W] #Text called from
%patch $32382 "SpawnShot: Bad dir!" $00</patch>

=== Keyholder points to bad spot ===

This error should occur when the player tries to [[Patch:Keygem door|place a key gem to open a door.]] It occurs when the keyholder does not have a correct sprite value over it. usually this happens when the modder forgets to put a value in, giving a default value of 0,0. Other invalid values are those outside the level borders. This error is easy enough to fix since there should only be a small number of keyholders in the level to check for validity.

This error may also occur if a 'hidden' keyholder is triggered, say if the modder accidentally gives a tile the keyholder property. (The hidden holder will of course not be given a value and can be hard to find until the player accidentally runs into one while having the right colored gem.)

In either case the best course of action is to play the level and note exactly where the game crashes. This will be the exact location of the broken keyholder.

<patch title="Keyholder errors">
#Keen 4 :
%patch $C2E0 [$1426W] #Text called from
%patch $30296 "Keyholder points to a bad spot!" $00

#Keen 5 :
%patch $B6FE [$130EW] #Text called from
%patch $3164E "Keyholder points to a bad spot!" $00

#Keen 6 :
%patch $B4E1 [$129EW] #Text called from
%patch $31FCE "Keyholder points to a bad spot!" $00</patch>

=== StartMusic - Bad level number ===

This error occurs when a song is started. This is usually when a level is entered, but may also be when something else changes the music, the ending sequence for example or rescuing an Oracle Council member. StartMusic works by taking a value (3 say) then looking at the level music list and reading that music entry from it to play. (Why it doesn't just take a music value directly is unknown.) See [[Patch:Music]].

There are two sources of error that may cause this. In the first the entry in the level music list is for a song that doesn't exist. (Say song 300.) Obviously playing a nonexistent song is impossible. The second cause is if the game is told to play the song of a nonexistent level. This can happen when the background music for say, the ending sequence is set to a nonexistent level (Again, say level 300) Both of these errors will involve a problem in the music patch.

It is also possible a faulty sound file will cause this problem, but this is unlikely.

<patch title="'StartMusic - Bad level number' error">
#Keen 4 :
%patch $8CAD [$06CCW] #Text called from
%patch $2F53C "StartMusic() - bad level number" $00

#Keen 5 :
%patch $8C29 [$063EW] #Text called from
%patch $3097E "StartMusic() - bad level number" $00

#Keen 6 :
%patch $8A91 [$0636W] #Text called from
%patch $31366 "StartMusic() - bad level number" $00</patch>

=== MM_Set errors ===

There are two possible errors in the 'MM Set'; Purge and Lock. Both are caused by massive memory problems and are always symptomatic of patching errors. The first occurs most often when an exceptionally long string of text is loaded somewhere expecting a short string, such as a level name. This is similar to the 'string exceeds width' error above, but moreso. This often happens when a terminal $00 is left out of a [[Patch:Text patches|text patch,]] mixing two strings into one big one.

This can also occur when a non-level music call asks for a song that doesn't exist. For example, if the[[Patch:Ending sequence|ending sequence]] song is set to level 3's music, and level 3 plays song 99 (Which doesn't exist.) then entering level 3 will cause a song error, but winning the game will result in this error. (If the game can be won without entering level 3, then the player will not encounter any error before this one.)

The second occurs more rarely and tends to occur when a patch tries to load something into memory that it shouldn't. It's hard to cause, and hard to fix.

<patch title="Keen MM_Set errors">
#Keen 4 :
%patch $16091 [$4008W] #Text called from
%patch $32E78 "MM_SetPurge: Block not found!" $00

%patch $16114 [$4026W] #Text called from
%patch $32E96 "MM_SetLock: Block not found!" $00

#Keen 5 :
%patch $1702E [$36BFW] #Text called from
%patch $339FF "MM_SetPurge: Block not found!" $00

%patch $170B1 [$36DDW] #Text called from
%patch $33A1D "MM_SetLock: Block not found!" $00

#Keen 6 :
%patch $15BC2 [$3A08W] #Text called from
%patch $34738 "MM_SetPurge: Block not found!" $00

%patch $15C45 [$3A26W] #Text called from
%patch $34756 "MM_SetLock: Block not found!" $00</patch>

=== String exceeds width ===

This error occurs when a text window is given a line of text too wide for it. This is nearly always the result of a [[Patch:Text patches|text patch,]] usually when a $0A or $00 is left out, resulting in one long, wide line of text. Close checking of text patches will often show the problem.

This error can also occur when inputting text into the [[Patch:Story Screen (Galaxy)|star wars story screen,]] in this case the cause is identical, one of the lines of text in the story is too wide and must be reduced. The maximum width of a line of text is approximately 24 characters (Or "123456789012345678901234" for reference when patching.), but this varies with what characters are used.

<patch title="String exceeds width error">
#Keen 4 :
%patch $1A195 [$4721W] #Text called from
%patch $33591 "US_CPrintLine() - String exceeds width" $00

#Keen 5 :
%patch $1B133 [$3D3CW] #Text called from
%patch $3407C "US_CPrintLine() - String exceeds width" $00

#Keen 6 :
%patch $19E05 [$4121W] #Text called from
%patch $34E51 "US_CPrintLine() - String exceeds width" $00</patch>

=== PageLayout errors ===

These errors should be encountered while using the [[Patch:Computer Wrist|Computer Wrist]] or in the [[Patch:Ending sequence|ending sequence.]] They occur when something is wrong relating to the text in these sequences. They will be triggered when the offending sequence is loaded, meaning that each page in the sequence will have to be scanned for possible errors.

The first error, the word limit, occurs when too much text has been placed on a single page. The word limit is such that in order to trigger this error the text will have to spill off the bottom of the page. It usually occurs when two pages are accidentally merged when modding the page text document.

The second error, 'Text not headed with ^P' occurs, as would be expected, when text in a page does not start with '^P' This can occur if the sequence document does not start with '^P', but usually occurs when a page ''that is not the last page in the sequence'' has no text on it at all; this confuses the parser into thinking the ''next'' page has no '^P' header.

The third error, "No ^E to terminate file" occurs when the text in a chunk does not end with '^E'. All text chunks must end with this to tell the game when to stop reading data. This however may occur with a perfectly fine chunk in the [[Patch:Ending sequence (Keen 4)|Keen 4 ending sequence]] if the wrong chunk is used. Due to a unique bug only one specific text chunk can be used to end the game.

All these errors can only be corrected by a modder looking at the offending text document.

<patch title="Keen PageLayout errors">
#Keen 4 :
%patch $955F [$720W] #Text called from
%patch $2F590 "PageLayout: Word limit exceeded" $00

%patch $96DE [$740W] #Text called from
%patch $2F5B0 "PageLayout: Text not headed with ^P" $00

%patch $98DD [$76DW] #Text called from
%patch $2F5DD "CacheLayoutGraphics: No ^E to terminate file!" $00

#Keen 5 :
%patch $E4C7 [$1650W] #Text called from
%patch $31990 "PageLayout: Word limit exceeded" $00

%patch $E646 [$1670W] #Text called from
%patch $319B0 "PageLayout: Text not headed with ^P" $00

%patch $E845 [$169DW] #Text called from
%patch $319DD "CacheLayoutGraphics: No ^E to terminate file!" $00

#Keen 6 :
%patch $DFE7 [$1666W] #Text called from
%patch $32396 "PageLayout: Word limit exceeded" $00

%patch $E0FD [$1686W] #Text called from
%patch $323B6 "PageLayout: Text not headed with ^P" $00

%patch $E2D3 [$16B3W] #Text called from
%patch $323E3 "CacheLayoutGraphics: No ^E to terminate file!" $00</patch>

=== USL_ConfirmComm errors ===

This error is very rare and occurs when the [[Patch:Main menu|Main Menu]] is asked to do something it cannot, such as save a game when no game is being played. Getting this error is a sign that some patch has gone severely wrong, interfering with the menu code around $19000-$1C000. The only solution is to make a note of what circumstances cause the error and check the patch file for patches that fix the error when removed.

<patch title="USL_ConfirmComm errors">
#Keen 4 :
%patch $1AF87 [$4903W] #Text called from
%patch $33773 "USL_ConfirmComm() - empty comm" $00

#Keen 5 :
%patch $1BF25 [$3EF4W] #Text called from
%patch $34234 "USL_ConfirmComm() - empty comm" $00

#Keen 6 :
%patch $1ABF7 [$437DW] #Text called from
%patch $350AD "USL_ConfirmComm() - empty comm" $00</patch>

=== [[Patch:EGAGRAPH|EGAGRAPH errors]] ===

In [[Keen 4]] the game contains code both to check for <tt>EGAGRAPH</tt> and if it is not found to create it from two files, <tt>EGA1.CK4</tt> and <tt>EGA2.CK4</tt>. [[Keen 5]] has the code but it is defective, and [[Keen 6]] does not have this ability at all. The only error that should appear is the "Can't open EGAGRAPH.CK4!" if the <tt>EGAGRAPH</tt> file is absent or its name has been patched and a matching file is not present.

<patch title="Check for EGAGRAPH">
#Keen 4 :
%patch $3CD4 [$0112W] #Check for this file (EGAGRAPH) if not found...
%patch $3CF7 [$011FW] #Combining text
%patch $3D03 [$015DW] #Prepare to write data to this file (EGAGRAPH)
%patch $3D07 [$0154W] #Check for this file (EGA1)
%patch $3D18 [$016AW] #Can't rename file
%patch $3D34 [$0181W] #Rename EGA1 data to this (EGAGRAPH)
%patch $3D47 [$018EW] #Can't open EGAGRAPH to dump data
%patch $3D74 [$01A7W] #Check for this file (EGA2)
%patch $3D87 [$01B0W] #Can't find EGA2
%patch $3E6A [$01C5W] #Rename this file (EGA2)

%patch $2EF82 "EGAGRAPH.CK4" $00 #Check for this file
%patch $2EF8F "Combining EGA1.CK4 and EGA2.CK4 into EGAGRAPH.CK4..." $00

%patch $2EFCD "EGAGRAPH.CK4" $00 #Create this file
%patch $2EFC4 "EGA1.CK4" $00 #Check, read from this file...
%patch $2EFDA "Can't rename EGA1.CK4!" $00
%patch $2EFF1 "EGAGRAPH.CK4" $00 #...rename to this file
%patch $2EFFE "Can't open EGAGRAPH.CK4!" $00
%patch $2F017 "EGA2.CK4" $00 #Check, read from this file...
%patch $2F020 "Can't find EGA2.CK4!" $00
%patch $2F035 "EGA2.CK4" $00 #Rename this file?

#Keen 5 :
%patch $3CCE [$00E5W] #Check for this file (EGAGRAPH) if not found...
%patch $3CF1 [$00F2W] #Combining text
%patch $3D01 [$0127W] #Check for this file (EGA1)
%patch $3D12 [$0130W] #Can't rename file
%patch $3D41 [$0147W] #Can't open EGAGRAPH to dump data
%patch $3D6E [$0160W] #Check for this file (EGA2)
%patch $3D81 [$0169W] #Can't find EGA2

%patch $30425 "EGAGRAPH.CK5" $00 #Check for this file
%patch $30432 "Combining EGA1.CK5 and EGA2.CK5 into EGAGRAPH.CK5..." $00

%patch $30467 "EGA1.CK5" $00 #Check, read from this file...
%patch $30470 "Can't rename EGA1.CK5!" $00
%patch $30487 "Can't open EGAGRAPH.CK5!" $00
%patch $304A0 "EGA2.CK5" $00 #Check, read from this file...
%patch $304A9 "Can't find EGA2.CK5!" $00</patch>

=== Demo loop exited ===

This error occurs when something goes wrong with the [[Patch:Demo#Main_Menu_Demo_Loop|demo loop]] in Keen Galaxy or Dreams. The exact sources of error vary but are usually a corrupt demo file or a problem with the demo loop code. Checking demo files and demo patches is a good way to debug this.

<patch title="Demo loop exited error">
#Keen 4 :
%patch $3ECF [$01DAW] #Text called from
%patch $2F04A "Demo loop exited???" $00

#Keen 5 :
%patch $3EC9 [$018AW] #Text called from
%patch $304CA "Demo loop exited???" $00

#Keen 6 :
%patch $3CF8 [$011EW] #Text called from
%patch $30E4E "Demo loop exited???" $00

#Keen 7 :
%patch $3BF7 [$0357W] #Text called from
%patch $23DC7 "Demo loop exited???" $00</patch>

=== Demo buffer overflow ===

This error occurs when something goes wrong with the [[Patch:F10 D Cheat|demo cheat]] in Keen Galaxy or Dreams. Specifically it occurs when a demo is recorded for too long, exceeding the amount of memory available for storing a demo file. The solution is to stop recording a demo before this happens. If this does not occur during demo recording then it is due to a random patch corrupting the game.

<patch title="Demo buffer overflow error">
#Keen 4 :
%patch $152FA [$3EFCW] #Text called from
%patch $32D6C "Demo buffer overflow" $00

#Keen 5 :
%patch $16297 [$35B4W] #Text called from
%patch $338F4 "Demo buffer overflow" $00

#Keen 6 :
%patch $14E2B [$38FCW] #Text called from
%patch $3462C "Demo buffer overflow" $00

#Keen 7 :
%patch $1093A [$461EW] #Text called from
%patch $2808E "Demo buffer overflow" $00</patch>

=== Demo playback exceeded ===

This error occurs when trying to play a demo that is too large for the memory set aside. It is thus similar to the above error except that it occurs when a demo is being played rather than recorded. This should not be possible however if a demo chunk is corrupted or was recorded under different memory conditions than the demo is being played back then it is possible that this error will occur. The only solution is to use a smaller\shorter demo chunk for this demo. If this error occurs no matter what demo is used or outside of the [[Patch:Demo#Main_Menu_Demo_Loop|demo loop]] then it is due to a random patch corrupting the game.

<patch title="Demo playback exceeded">
#Keen 4 :
%patch $1504B [$3EE5W] #Text called from
%patch $32D55 "Demo playback exceeded" $00

#Keen 5 :
%patch $15FE8 [$359DW] #Text called from
%patch $338DD "Demo playback exceeded" $00

#Keen 6 :
%patch $14B7C [$38E5W] #Text called from
%patch $34615 "Demo playback exceeded" $00

#Keen 7 :
%patch $106E2 [$4607W] #Text called from
%patch $28077 "Demo playback exceeded" $00</patch>

= Freeze errors =

These errors cause the game to freeze, and sometimes cause the music to stick on a single note. The game is unresponsive and must be closed down. These are also known as 'divide by zero' errors after their most common cause. There is no way to tell what the error is except via context, timing and trial and error. As such the following subsections describe the cause of the error, not any sort of message the player may get.

=== Game freezes at ONE MOMENT image ===

This error occurs in Vorticons and is when the game freezes, often with a display of gibberish, at the [[Patch:One Moment Screen (Vorticons)|One Moment screen.]] This is usually caused by a corrputed data file, usually the <tt>SCORE.CKx</tt> file, but possibly a <tt>*TEXT.CKx</tt> file or <tt>CTLPANEL.CKx</tt> file. Deleting or replacing these files should solve the problem.

If the screen fills entirely with gibberish then what has likely happened is that there was no valid one moment graphic in the graphics file. This may have been due to graphic modification or a patch that changes what bitmap is used. (If the game can be run without the patch file but still freezes it is the second option.)

=== Level freezes just after loading ===

This error occurs when the game freezes shortly after entering a level, usually less than ten seconds after. It does not matter what the player does, though the freeze can be delayed by going to the main menu or checking the status window.

The cause is an animating tile that animates to a non-animating tile. The game tries to animate this tile infinitely fast, freezing the game. This is usually a [[Patch:Tileinfo|tileinfo]] problem and can be resolved by fixing the errant tile. There are two ways to do this.

The first is to check the tileinfo by carefully going over ll the tiles used in the level and checking them. This may miss the tile.

The second is to remove tiles from the level until it no longer freezes, then adding suspect tiles back to see if the error returns. This is often more reliable, but requires the modder to back up their game maps.

=== Level loads to black screen ===

This error occurs when a sprite is behaving improperly. Usually this is the player sprite or something in the sprite's [[Patch:Sprite spawning|initiation or spawning code]], since it occurs immediately after the level loads. The most common cause is the modder not putting a player sprite in the level (for example mistaking the 'I' Keen helmet for the actual player sprite.) Levels can be debugged by checking the player sprite is present, and if the error persists, removing sprite types from the level one by one and seeing when functionality is restored. (The affected sprite can then be checked over.)

== Level loads to gibberish or gibberish appears while loading ==

This is usually a patch error, but may, in rare circumstances be a level error (See the 'other limits' section below.) In short the level has loaded as gibberish, causing the game to display nonsense.

The first step to fixing this is to check if only one level is affected, if all levels are affected this is likely a patch problem. If only one level is affected it may be a patch relating to a sprite appearing only in that level. Otherwise it may be a game limit bug.

If the level is in Vorticons and complex enough it may be that the sprite limit has been reached. In Vorticons only 76 ordinary sprites can be placed in any one level. If this limit is exceeded when the level starts then the level will turn to gibberish and crash. In some level editors this is easy enough to check by adding up all the sprites.

= Other limits\problems =

These are not errors as such, or have no way for the game to handle them, but are limitations that the modder may not be aware of. In some cases it is possible to circumvent these, in other cases not.

=== Level height\width limit ===

In Keen Galaxy and Dreams it is impossible for a level to be wider ''or'' taller than 257 tiles. This is because of how the game reads Keen's position. If a level exceeds one of these dimensions (It cannot exceed both) then a large part of the level, though displaying correctly, will be 'uninhabitable' for Keen; he will simply exit the level or die when he enters it.

This is because the game 'wraps the level around' so it thinks that most of the level is negative and thus that Keen is outside it, ready to exit to the world map.

It is also possible for a map to be so large it causes its own 'map to tall' error, but this is unlikely.

There is no way to circumvent this error at present, nor is there likely to be.

=== Maximum number of sprites ===

In Keen galaxy an error will appear if the sprite limit is exceeded. (No free spots in objarray for example.) In Keen Vorticons the level will simply crash on loading. (See freeze errors section above.) The limit in Keen Vorticons is 76 sprites.

=== Forbidden pointer values and gibberish in-level ===

Due to the way the game's compression works, there are certain values that cannot be used as sprite pointers for doors or switches by naive level editors. This is especially an issue in levels that are 100 tiles wide or wider.

There are three sets of forbidden values that will cause the level to load as gibberish or freeze if placed within it. The first is the value $ABCD which affects the RLEW compression. The second is $xxA7 and the third $xxA8, both of which destroy the Carmack compression of the level. It is unlikely these values will be placed in a level, but it has happened.

Levels saved by [[Abiathar]] are invincible to these problems; it performs RLEW compression and escapes Carmack magic values.

=== Tiles become gibberish ===

There are numerous conditions when a tile will not display correctly. To see examples of this use the [[Patch:F10 Y Cheat|F10 Y cheat]] in Keen 4 or 6. Such gibberish is actually data from memory where the tile ''should'' be.

The first way this may happen is if animating foreground tiles are placed over animating background tiles. Due to the way these work they interfere and result in nonsense. Note that item tiles are animating tiles.

The second way is when a [[Patch:Doors (Galaxy)|door is not set up properly,]] a door must consist of a top tile, any number of middle tiles and a bottom tile, all of which must not animate but have animation targets set ''and'' be part of a door opening tile sequence (By default four frames long.) If any of these conditions is not met, some or all of the door tiles will become gibberish.

The third way this may occur is similar, but involving [[Patch:Bridges and switches|bridges and switches,]] switch tiles must have the switch property and have animation targets but not animate (bridge tiles are the same) They must also loop, so that eventually the bridge or switch can return to its original appearance.

=== Maximum number of cached items ===

The maximum number of items the game can cache at once is 1200. This includes sprite images, sounds, tiles, music and other game chunks. Of this tiles are likely to be the largest component. This causes no error, just a game crash.

=== Maximum number of sprite images onscreen ===

No more than 60 sprite images can be onscreen at once. This is not 60 sprite, but rather 60 separate sprite image chunks. So a sprite like Keen 4's moving platform which is one single object with several images counts for more than one sprite image. (The [[Patch:Sphereful|Sphereful]] counts for 5 images for example.)

=== Maximum number of affected tiles ===

There is a limit to how many 16x16 tile squares can be updated via scrolling onscreen, having a sprite pass in front of them or animating. Only 90 tiles may do this in any one game loop.

=== Cannot place Keyholder pointers, Switch pointers or [B] sprites on animating tiles ===

The animation time of an animating tile is stored in the ifnoplane (sprite) layer of the level. This means that any infoplane value that must sit there for the duration of the level will be deleted if the tile (background or foreground) animates. These things include [B] sprites used for changing the direction of moving platforms and pointers for doors and bridges.

{{PatchCategories|Keen 4|}}
{{PatchCategories|Keen 5|}}
{{PatchCategories|Keen 6|}}
{{PatchCategories|Gameplay|}}
{{PatchCategories|Item|}}
{{PatchCategories|Misc|}}
{{PatchCategories|Sprite|}}
{{PatchCategories|Text|}}
{{PatchCategories|Tutorial|}}

Patch talk:Levels (Galaxy)

2014-03-15T02:04:53Z

Fleexy: Asked about changing most advanced editor

Galaxy Tools

2014-03-15T02:01:33Z

Fleexy: Added Abiathar to the level editor list, reordered the others to be in chronological order

== Game Editing ==

This section is organised by category. If an editor supports more than one type of editing (such as level editing and graphics editing) it will be listed under both sections.

=== Level Editors ===

* [[TED5]]
* [[Keen: Next (level editor)|Keen: Next]]
* [[The Photachyon Transceiver]]
* [[The Omegamatic]]
* [[Abiathar]]

=== Graphics Editors ===

* [[EModKeen]]/[[LModKeen]]
* [[ModKeen]]
* [[Keengraph]]

=== Sound Editors ===

* [[KeenWave]] A program to import\export sounds and music, currently a beta, comes with an adlib sound player.

=== Music Editors ===

* [http://adplug.sourceforge.net AdPlug] - standalone DOS program and a Winamp / XMMS plugin for playing Keen's IMF music.
* [[IMF2MIDI]] - program to convert IMF songs into MIDI files.
* [[DRO2MIDI]] - improved program based on IMF2MIDI
* [[DRO2IMF]] - program to convert DRO files to IMF files.
* [[IMF Creator]] - program to convert MIDI songs into IMF files.

=== Story / Game Text Editors ===

* [[ModKeen]] For extracting data chunks
* [[Keengraph]] For extracting data chunks
* [[TheDraw]] for editing the final text screen.
* [[Startext]] for making text patches

=== Other editors and editing tools ===

* [[CKPatch]]
* [[Fixmhead]]
* [[Ck456Tli]]
* [[CK456DTli]]
* [[K5Splode]]
* [[Galactile]]
* [[Instant Carma]]
* [[TEDSetup]]
* [[The Neural Stunner (utility)|The Neural Stunner]]
* [[UNLZEXE]], needed to decompress the executable files
* [[UNP]], needed to decompress the executable files
* [[Wolf Data Compiler (WDC)]]

== Modding Tutorials ==

* [[Ceilick's Keen Galaxy Modding Tutorial|Ceilick's Tutorial]]
* [[Levellass' Keen Galaxy Modding Tutorial|Levellass' Tutorial]]
* [http://stefan.lohner-net.de/keen_modding/tutorial/ TheMagician's Tutorial]

== Game Information ==

* For details on the file formats used by the games, see the [[ModdingWiki:Commander Keen 4-6|Commander Keen 4-6]] section on the ModdingWiki.
* There is a [[:Category:Patches|list of patches]] that can be incorporated into mods to change the game's behaviour.

== See Also ==

* [[Vorticon Tools]]
* [[Other Tools]] (non-Vorticons/Galaxy)

==External links==

[[Category:Tools]]

Talk:The Universe Is Toast

2012-03-17T17:14:56Z

Fleexy:

Does anyone know where this title came from? It doesn't seem to be mentioned in the Keen games themselves. -- [[User:Malvineous|Malvineous]] 06:46, 13 July 2007 (GMT)

: I would need to check this out, but I seem to recall that this name was mentioned at the ending of Keen 6. I'm not really sure, however... I'll check out if it was from somewhere else.[[User:Sega381|Sega381]] 14:25, 13 July 2007 (GMT)

::Nope, I checked the Keen 6 ending - it had even less to say about it than the Keen 5 ending, which is why I went with the K5 screenshot in this article. -- [[User:Malvineous|Malvineous]] 23:48, 13 July 2007 (GMT)

::: You're right, and in fact I was thinking about the Keen 5 ending, but neither of them mentions that. At least I know it's mentioned in the Apogee FAQ, but I had the idea I had heard it before, somehwere else...[[User:Sega381|Sega381]] 21:12, 14 July 2007 (GMT)

::: This is the most official place I've seen the name, besides the FAQ: [http://www.3drealms.com/keenhistory/keenhistory2.html A look back on Commander Keen]. It's an article on the Apogee website with interviews to the id guys, and it mentions the name.[[User:Sega381|Sega381]] 04:23, 24 July 2007 (GMT)

:::: Ah, that's a good reference - I've added that to the main article. Thanks! -- [[User:Malvineous|Malvineous]] 06:37, 24 July 2007 (GMT)

::::: Back when the keen games were just starting to be classified as old, I found the title "Commander Keen 8: The Universe is Toast" featured in a list of games on the ID Games website. ID seemed to think TUIT was just the name of another episode, not a full series alike the FAQ sheet suggests. --[[User:Ipfreely555|Ipfreely555]] 05:09, 21 March 2010 (GMT)

My (poor) fangame is a link to this article in the fangames list. Should there be a separate article or should there be a subsection in this document for it? [[User:Fleexy|Fleexy]] 17:14, 17 March 2012 (GMT)

Vorticon Mods

2012-03-17T17:10:21Z

Fleexy: Corrected Keen -5 information

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]

== 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
! Modder(s)
! Mod of
! # of levels
! Protagonist
! Notes
|-
|[[A Christmas Mod]]
|[http://www.bipship.com/mods/christmas1.zip full]
|2007-12-22
|[[User:Levellass|Levellass]]
|Keen 1
|1
|Tzen
|
|-
|A Christmas Mod Mk II: [[Merry Keenmas]]
|[http://www.bipship.com/mods/christmas2.rar full]
|2006-01-06
|[[Levellord]]
|Keen 2
|16
|Keen
|graphical remake of Keen 2
|-
|[[A Matter of Minkcraft]]
|[http://www.paramultart.comyr.com/trasharchive/mods/ck1/Kimprov1.zip full]
|2010-08-29
|levellass
|Keen 1
|1
|Keen
|[http://www.paramultart.comyr.com/kimprov1.html Website] [http://www.pckf.com/viewtopic.php?t=1393&start=0 Discussion] Has music.
|-
|[[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.bipship.com/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 beta] [http://dl.dropbox.com/u/3665944/SArmag2.zip super]
|2005-08-29 2011-03-13
|Najawa [[User:Tulip|Tulip]]
|Keen 1
|8/17
|Keen
|has music
|-
|[[Bad Dreams]]
|[http://dosclassics.com/download/128 full]
|2004-09-25 
|[[Levellord]]
|Keen 1
|14
|Keen
|There is also a "[http://www.bp/mods/Bad%20Dreams%204%20Spleen.zip Spleen's Birthday Edition]" of this
|-
|[[Bananasauros]]
|[http://www.zero1productions.com/billy/vbb/files/bananasauros1.21.rar full v1.21] [http://www.zero1productions.com/billy/BillsTCs/files/bananasauros1.1.rar full v1.1] [http://www.zero1productions.com/billy/BillsTCs/files/bananasauros.rar full v1.0]
|2011-07-26 2010-12-16? 2010-12-15
|VikingBoyBilly
|Keen 1
|16
|Bananasauros
|[http://www.pckf.com/viewtopic.php?t=1743 Discussion] Has music.
|-
|[[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
|
|-
|[[Commander Bleen]]
|[http://www.paramultart.comyr.com/trasharchive/mods/ck1/Kimprov1.zip full]
|2010-08-29
|tulip
|Keen 1
|2
|Bleen
|[http://www.paramultart.comyr.com/kimprov1.html Website] [http://www.pckf.com/viewtopic.php?t=1393&start=0 Discussion]
|-
|[[Comrade Keen]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/ComradeKeen.zip demo]
|2010-06-22
|[[User:StupidBunny|StupidBunny]]
|Keen 1
|8
|Keen
|[http://www.pckf.com/viewtopic.php?t=1288 Discussion]
|-
|[[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
|
|-
|[[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
|[[User:StupidBunny|StupidBunny]]
|Keen 1
|11
|Character
|[http://www.pckf.com/viewtopic.php?t=1203 Discussion] 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-30
|[[User:Flaose|Flaose]]
|Keen 1
|1
|Dangerous Dave
|Version 1.02
|-
|[[Dangerous Keen in The Haunted Mansion]]
|[http://dosclassics.com/download/107 full]
|2004-3-14
|[[Levellord]]
|Keen 1
|16
|Keen
|
|-
|[[Daniel's Keen Mod]]
|[http://www.bipship.com/mods/Daniel%27s_Keen_MOD.zip beta]
|2003-10-22
|Dagneilius
|Keen 1
|16
|Keen
|abandoned
|-
|[[Death to the Vorticons]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/Dttv1.zip full]
|2008-08-26
|[[User:Shikadi|shikadi]]
|Keen 3
|16
|Keen
|half mod, half levelpack
|-
|[[Death to the Vorticons 2]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Dttv2.zip 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
|
|-
|[[Earl Pedro in "Untitled"|Earl Pedro in "Untitled"]]
|[http://www.maguidhir.com/fionn/benvolio/benvolio_funpack.zip demo]
|2011-10-31
|[[User:Benvolio|Benvolio]]
|Keen 1
|4
|Earl Pedro
|[http://www.pckf.com/viewtopic.php?p=49073 Discussion] abandoned, released as part of Benvolio's Fun-Pack 2011
|-
|[[Episode Dash]]
|[http://www.shikadi.net/wiki/files/Mods/Keen3/KeenDash.zip full]
|2004-10-22
|[[User:Xky Rauh|Xky Rauh]]
|Keen 3
|16
|Keen
|
|-
|[[Episode Null]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/KeenNull.zip full]
|2004-03-11
|[[User:Xky Rauh|Xky Rauh]]
|Keen 2
|16
|Keen
|
|-
|[[Episode Smile]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/Smile.zip full]
|2005-01-07
|[[User:KeenRush|KeenRush]]
|Keen 2
|16
|Keen
|
|-
|[[Episode X]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenX.zip full]
|2002-06-30
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|18
|Keen
|[http://archive.shikadi.net/pckf/other/382.htm Discussion] 2nd-ever Keen mod
|-
|[[Episode Y]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenY.zip full] [http://www.bipship.com/mods/keenybeta.zip beta]
|2003-06-19
|Grelphy
|Keen 1
|21
|Keen
|
|-
|[[Episode 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
|
|-
|[[Fall Up]]
|[http://www.keeniverse.net/keen/must/die/fall_up.zip full]
|2010-11-23
|[[User:KeenRush|KeenRush]]
|Keen 1
|16
|Keen
|[http://www.pckf.com/viewtopic.php?t=1668 Discussion]
|-
|[[The Four Golden Crystals]]
|[http://dosclassics.com/download/4 full]
|2003-01-28
|Unfleexable
|Keen 1
|16
|Keen
|
|-
|[[Generic Mod I]]
|[http://www.bipship.com/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.bipship.com/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
|
|-
|[[The Grand Intellect: Fathership Revenge]]
|[http://files.commanderkeen.org/users/szemigi/Mort2.zip full]
|2009-08-16
|[[User:szemigi|szemigi]]
|Keen 2
|18
|Mortimer McMire
|[http://www.pckf.com/viewtopic.php?t=809 Discussion]
|-
|[[The Grand Intelligence: Cybernetic Dream]]
|[http://www.mediafire.com/download.php?e4f1i3955d2kj9m full] [http://www.mediafire.com/download.php?8so1hhubzn9ib79 v1.1]
|2011-05-18
|[[User:szemigi|szemigi]]
|Keen 1
|20
|Martinez McMeyer
|[http://www.pckf.com/viewtopic.php?t=1954 Discussion]
|-
|[[Halloween Horrors]]
|[http://www.bipship.com/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
|
|-
|[[Highway Blues]]
|[http://www.maguidhir.com/fionn/benvolio/benvolio_funpack.zip demo]
|2011-10-31
|[[User:Benvolio|Benvolio]]
|Keen 1
|4
|Keen
|[http://www.pckf.com/viewtopic.php?p=49073 Discussion] abandoned, released as part of Benvolio's Fun-Pack 2011
|-
|[[How Bleen Saved Kwanzaa]]
|[http://www.zero1productions.com/billy/BillsTCs/files/kwanzaa.rar full]
|2011-01-08
|Paramultart VikingBoyBilly
|Keen 1
|1
|Bleen
|[http://www.pckf.com/viewtopic.php?t=1782 Discussion] Has music.
|-
|[[How the Vorticon Stole Christmas]] (Gorti Vrinch)
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Gortivrinch.zip special edition]
|2008-12-20
|[[User:Stealthy71088|Stealthy71088]]
|Keen 1
|4
|Gorti Vrinch
|
|-
|[[In the Bloogbrain]]
|[http://www.paramultart.comyr.com/trasharchive/mods/ck1/Kimprov1.zip full]
|2010-08-29
|Bonevelous
|Keen 1
|1
|Keen
|[http://www.paramultart.comyr.com/kimprov1.html Website] [http://www.pckf.com/viewtopic.php?t=1393&start=0 Discussion]
|-
|[[In the Bobrick Tower]]
|[http://files.commanderkeen.org/users/stupidbunny/BTOWER.zip full]
|2012-03-14
|[[User:StupidBunny|StupidBunny]]
|Keen 3
|1
|Keen
|[http://www.pckf.com/viewtopic.php?t=2309 Discussion]
|-
|[[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 (2009 version)]
|2003-04-29 2009-10-04
|[[User:Ceilick|Ceilick]] [[User:Tulip|Tulip]]
|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
|[http://www.pckf.com/viewtopic.php?t=837 Discussion]
|-
|[[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
|-
|[[Justice and Freedom]]
|[http://www.mediafire.com/?omkxz0qvnj2 full]
|2009-08-20
|[[JM2008]]
|Keen 3
|16
|Keen
|[http://www.pckf.com/viewtopic.php?t=816 Discussion] very few changes
|-
|[[Keen -5]]
|[http://dl.dropbox.com/u/3771470/k-5demo2.zip demo 2] [http://home.mchsi.com/~bootsisbig/k-5demo1.zip demo 1]
|2010-03-14 2009-10-22
|[[User:Fleexy|Fleexy]]
|Keen 2
|15
|Keen
|Discussion: [http://www.pckf.com/viewtopic.php?t=927 demo 1] [http://www.pckf.com/viewtopic.php?t=1091 demo 2]
|-
|[[Keen -6]]
|[http://home.mchsi.com/~bootsisbig/keen-6.zip full]
|2009-08-08
|[[User:Fleexy|Fleexy]]
|Keen 1
|16
|Keen
|[http://www.pckf.com/viewtopic.php?t=793 Discussion]
|-
|[[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|Lemm]]
|Keen 1
|16
|Keen
|Graphics unchanged; Game runs at 640x480 in Dosbox emulating Paradise PVGA1A SVGA
|-
|[[Keenbot]]
|[http://dosclassics.com/download/120 beta]
|2004-07-05
|Victor4k
|Keen 1
|4
|Keenbot
|
|-
|[[Keen in Mineepleo]]
|[http://www.mediafire.com/?tnuuwaoscmv demo]
|2009-03-14
|Harvey
|Keen 1
|5
|Keen
|
|-
|[[Keen Rescue]]
|[http://dl.dropbox.com/u/18319523/releases/krescue.zip full]
|2012-03-14
|[[User:Vikingboybilly|Vikingboybilly]] and [[User:Paramultart|Paramultart]]
|Keen 3
|16
|Marta
|[http://www.pckf.com/viewtopic.php?t=2303 Discussion]
|-
|[[Keen S]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/KeenS.zip full]
|2010-03-13
|[[User:Shikadi|Shikadi]]
|Keen 1
|16
|Keen
|[http://www.pckf.com/viewtopic.php?t=1085 Discussion]
|-
|[[Keen T]]
|[http://www.bipship.com/mods/keen%20t.rar full]
|2010-11-17
|[[User:Shikadi|Shikadi]]
|Keen 3
|16
|Keen
|[http://www.pckf.com/viewtopic.php?t=1651 Discussion]
|-
|[[Keen Static]]
|[http://www.mediafire.com/?2fbeoma6zo6b9h2 full]
|1999-04-15
|CrazyKeen
|Keen 1-3
|16
|Keen
|[http://skyscraper.fortunecity.com/null/816/ckstatic.html Website]
|-
|[[Keen Universe: Aliens Ate my Homework]]
|[http://www.zapzot.net/mods/Universe1.zip full]
|2006-5-27
|[[User:Stealthy71088|Stealthy71088]]
|Keen 1
|16
|Keen
|
|-
|[[Keen Q]]
|[http://www.shikadi.net/wiki/files/Mods/Keen2/KeenQ.zip full]
|2007-11-09
|Joriz::
|Keen 2
|16
|Keen
|[http://www.pckf.com/viewtopic.php?t=61 Discussion]
|-
|[[Keen's Pepsi Craving]]
|[http://dl.dropbox.com/u/12906264/Keen's%20Pepsi%20Craving%20-%20Demo%201.zip demo]
|2011-08-11
|Najawa
|Keen 1
|1
|Keen
|[http://keenmodding.org/viewtopic.php?t=1534 Discussion]
|-
|[[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 Shards of Narsil]]
|[http://www.shikadi.net/wiki/files/Mods/abandoned/Lotr.zip demo 1] [http://www.shikadi.net/wiki/files/Mods/abandoned/Lotr1.5.zip demo 2]
|2005-09-25
|Najawa
|Keen 1
|1
|Legolas
|[http://publiccommanderkeenforum.yuku.com/topic/912/Lord-of-the-Rings Discussion]
|-
|[[Marooned on Mars Part II]]
|[http://www.bipship.com/mods/keen-1a.zip full]
|2003-09-02
|Matze
|Keen 1
|17
|Keen
|Matze considers it a levelpack with modified graphics
|-
|[[Mars Kingdoms]]
|[http://www.shikadi.net/wiki/files/Mods/abandoned/marsk.zip demo]
|2009-11-04
|thehackercat
|Keen 1
|1
|Keen
|[http://www.pckf.com/viewtopic.php?t=948 Discussion]
|-
|[[Marta 0|Marta 0 - Marta's Moon Adventure]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Marta0.zip full]
|2010-08-29
|[[User:VikingBoyBilly|VikingBoyBilly]]
|Keen 1
|1
|Marta
|Improv competition entry [http://www.paramultart.comyr.com/kimprov1.html Website] [http://www.pckf.com/viewtopic.php?t=1393&start=0 Discussion]
|-
|[[Mondochrome]]
|[http://dl.dropbox.com/u/3700644/keen/mods/mondo/mondo.zip full]
|2011-02-05 2010-12-14
|[[User:Commander Spleen|Commander Spleen]]
|Keen 1
|16 + 1
|Keen
|[http://www.pckf.com/viewtopic.php?t=1742 Discussion] Includes bonus "silly" level
|-
|[[OrbKeen1|Monky Business: An Essence of Mayhem]]
|[http://dosclassics.com/download/121 beta]
|2004-08-07
|[[User:Commander Spleen|Commander Spleen]]
|Keen 1
|8
|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
|[http://archive.shikadi.net/pckf/unofficial/533.htm Discussion]
|-
|[[Norp the Yorp 2|Norp the Yorp 2: Diffusion]]
|[http://www.bipship.com/mods/n2.zip full]
|2002-12-23
|[[Xtraverse]]
|Keen 2
|16
|Norp
|
|-
|[[Norp the Yorp 3|Norp the Yorp 3: Brain Damage]]
|[http://www.bipship.com/mods/norp3.zip full]
|2003-02-03
|[[Xtraverse]]
|Keen 3
|16
|Norp
|
|-
|[[Norp the Yorp 3.5|Norp the Yorp 3.5: The Maze of Doom]]
|[http://www.bipship.com/mods/norpmaze.zip full]
|2005-03-23
|[[Xtraverse]]
|Keen 1
|1
|Norp
|
|-
||[[Oasiz's Mod]]
|[http://www.zapzot.net/mods/Oasiz.zip full]
|2010-08-29
|Oasiz
|Keen 1
|1
|Keen
|
|-
|[[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: The Adventures of The Oracle Janitor]]
|[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.shikadi.net/wiki/files/Mods/Keen2/Patchwork2.zip 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
|
|-
|[[The Psychedelic Mod]]
|[http://www.maguidhir.com/fionn/benvolio/benvolio_funpack.zip demo]
|2011-10-31
|[[User:Benvolio|Benvolio]]
|Keen 1
|5
|Keen
|[http://www.pckf.com/viewtopic.php?p=49073 Discussion] abandoned, released as part of Benvolio's Fun-Pack 2011
|-
|[[Redemption]]
|[http://www.shikadi.net/wiki/files/Mods/abandoned/CC2unfinished.zip demo]
|2005-07-08
|[[User:Allstories|Allstories]]
|Keen 1
|2
|Becky Blaze
|[http://publiccommanderkeenforum.yuku.com/topic/608 Discussion]
|-
|[[Retrosis]]
|[http://www.jimage.org/keen/Retrosis01.zip Demo 2] [http://www.jimage.org/keen/Retrosis00.zip Demo 1]
|2010-07-29 2010-03-14
|[[User:Commander Spleen|Commander Spleen]]
|Keen 1
|9
|Pogo with an Eye
|[http://www.pckf.com/viewtopic.php?t=1089 Discussion] Has music.
|-
|[[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.bipship.com/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.bipship.com/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.shikadi.net/wiki/files/Mods/Keen2/Shadowkeen2.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
|
|-
|[[Shmaynoria]]
|[http://www.paramultart.comyr.com/trasharchive/mods/shmay/SHMAYv1.zip full]
|2010-11-02
|[[Paramultart]]
|Keen 1
|11
|Keen
|[http://www.pckf.com/viewtopic.php?t=1601 Discussion] Has music.
|-
|[[Story Land]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/Storyland.zip full]
|2005-09-03
|[[User:Ceilick|Ceilick]]
|Keen 1
|16
|Keen
|
|-
|[[Super Mario Brothers 1]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/SuperMarioBrothers1.zip full]
|2010-10-01
|[[User:Szemigi|Szemigi]]
|Keen 1
|30
|Mario
|[http://www.pckf.com/viewtopic.php?t=1501 Discussion] remake of the NES Super Mario Bros. game
|-
|[[Thwarting Mort]]
|[http://www.shikadi.net/wiki/files/Mods/Keen1/ThwartingMort.zip full]
|2005-01-08
|[[User:Benvolio|Benvolio]]
|Keen 1
|9
|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
|21
|Keen
|[http://www.pckf.com/viewtopic.php?t=1407 Discussion]
|-
|[[Vox 1]]
|[http://www.bipship.com/mods/vox1.zip beta]
|2008-07-15
|Grelphy
|Keen 1
|20
|Keen
|
|-
|[[Vox 2]]
|[http://www.bipship.com/mods/vox2.zip beta]
|2008-07-15
|Grelphy
|Keen 3
|16
|Keen
|
|-
|[[Vox 3]]
|[http://www.bipship.com/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.bipship.com/mods/beta.zip beta]
|2002-06-25
|[[User:KeenRush|KeenRush]]
|Keen 1
|16
|Keen
|[http://archive.shikadi.net/pckf/other/377.htm Discussion] The first-ever mod
|-
|[[Zelda II]]
|[http://dosclassics.com/download/111 full]
|2004-01-22
|CheesyDave
|Keen 1
|21
|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

|-
|[[A New Dope#Levelpacks|A New Dope Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/DopePack.zip full]
|2009-08-09
|[[User:shikadi|shikadi]]
|A New Dope
|16
|
|-
|[[A.A.'s 1st Levelpack]]
|[http://www.dosclassics.com/download/259 full]
|1999-08-02
|A.A.
|Keen 1
|9
|
|-
|[[A.R.'s Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.a_r_.k1.1999-03-07.zip full]
|1999-03-07
|A.R.
|Keen 1
|6
|
|-
|[[A.R.'s Puzzle Levelpack]]
|[http://www.dosclassics.com/download/291 full]
|1999-01-25
|A.R.
|Keen 1
|10
|Better known as Unknown I's 1st Levelpack
|-
|[[Adurdin's 1st Levelpack]]
|[http://www.dosclassics.com/download/295 full]
|2000-12-21
|adurdin
|Keen 2
|1
|
|-
|[[Airefresco's Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.airefresco.k1.1999-06-18.zip full]
|1999-06-18
|Airefresco
|Keen 1
|7
|
|-
|[[Airefresco's Keen 2 Levelpack]]
|[http://www.dosclassics.com/download/296 full]
|1999-07-10
|Airefresco
|Keen 2
|1
|
|-
|[[Aria AmirYar's Levelpack]]
|[http://cc314.shikadi.net/aria01.zip full]
|1999-11-22
|Aria AmirYar
|Keen 1
|16
|
|-
|[[Art Pass Competition]]
|[http://www.shikadi.net/wiki/files/Packs/Keen3/l.keen_community.k3.2010-08-23.zip full]
|2010-08-23
|Keen Community
|Keen 3
|21
|
|-
|[[The Best Mod Ever Made]]
|[http://www.2shared.com/file/kwzEn0gd/TBMEM.html demo]
|2010-12-14
|[[User:CKeen|CKeen]]
|Keen 2
|5
|
|-
|[[BlueBounder's 1st Levelpack]]
|[http://www.dosclassics.com/download/300 full]
|2002-06-01
|BlueBounder
|Keen 3
|1
|
|-
|[[CK Guy's 1st Levelpack]]
|[http://www.dosclassics.com/download/310 full]
|2004-04-30
|[[User:CK Guy|CK Guy]]
|Keen 3
|1
|
|-
|[[Episode X#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
|Discussion: [http://www.pckf.com/viewtopic.php?t=945 release 1] [http://www.pckf.com/viewtopic.php?t=1090 release 2]
|-
|[[Episode Smile#Levelpacks|Community Smile Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/PCKFSmilePack.zip full]
|2009-08-30
|Keen Community
|Episode Smile
|13
|[http://www.pckf.com/viewtopic.php?p=15708#15708 Discussion]
|-
|[[Dagneilius's 1st Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen3/l.dagneilius.k3.2003-07-06.zip full]
|2003-07-06
|Dagneilius
|Keen 3
|1
|
|-
|[[Dark Side of Mars]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.mrc_marky.k1.1999-11-22.zip full]
|1999-11-22
|MRC Marky
|Keen 1
|8
|
|-
|[[Dungeon of Mystery]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.perry_scanlon.k1.2003-12-15.zip full]
|2003-12-15
|Perry Scanlon
|Keen 1
|2
|
|-
|[[Engine Room and First Level]]
|[http://www.dosclassics.com/download/297 full]
|2003-03-17
|Grelphy
|Keen 2
|2
|
|-
|[[Episode Smile#Levelpacks|Episode Gnash]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/EpisodeGnash.zip full]
|2009-09-01
|[[User:Fleexy|Fleexy]] HoboRed
|Episode Smile
|16
|[http://www.pckf.com/viewtopic.php?t=840 Discussion]
|-
|[[Extreme Keen]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.perry_scanlon.k1.2003-03-01.zip full]
|2003-03-01
|Perry Scanlon
|Keen 1
|8
|
|-
|[[Flaose's Original Level Pack]]
|[http://cc314.shikadi.net/flaose01.zip full]
|1999-01-18
|[[User:Flaose|Flaose]]
|Keen 1
|2
|Better known as Unknown II's 1st and 2nd levelpacks
|-
|[[The Freaking Vorticon]]
|[http://www.dosclassics.com/download/266 full]
|2001-08-08
|Pablo Dictter
|Keen 1
|2
|
|-
|[[GARGapplesauce's CK1 Levelpack]]
|[http://applesaucewiki.wikispaces.com/file/view/CK1-001.zip/181455435/CK1-001.zip demo]
|2010-11-20
|GARGapplesauce
|Keen 1
|1
|[http://www.pckf.com/viewtopic.php?t=1660 Discussion]
|-
|[[Christmas Special 2004#Levelpacks|Happy Easter Pack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/EasterPack.zip full]
|2009-04-12
|[[User:Tulip|Tulip]]
|Christmas Special 2004
|4
|
|-
|[[I Am Frozen]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.valerio.k1.2002-05-08.zip full]
|2002-05-08
|Valerio
|Keen 1
|1
|
|-
|[[The Ice Factory]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.xky_rauh.k1.1998-01-14.zip full]
|1998-01-14
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|1
|
|-
|[[Ice Levels]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.neil_mcrae.k1.1999-04-18.zip full]
|1999-04-18
|Neil McRae
|Keen 1
|15
|
|-
|[[Ilsoap's Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.ilsoap.k1.2002-06-18.zip full v3] [http://dosclassics.com/download/271 full v2] [http://dosclassics.com/download/272 full v1]
|2002-06-18 1999-09-01 1999-01-26
|Ilsoap
|Keen 1
|7
|
|-
|[[Jumping Practice]]
|[http://www.dosclassics.com/download/274 full]
|1999-04-27
|Justin
|Keen 1
|1
|
|-
|[[Keen 1 BwB Level]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.flaose.k1.1999-01-20.zip full]
|1999-01-20
|[[User:Flaose|Flaose]]
|Keen 1
|1
|Often called by the misnomer ''Flaose's First Levels''
|-
|[[Keen 1 Level Competition Level Pack (January 2007)|Keen 1 Competition Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.keen_community.k1.2007-01-01.zip full]
|2007-01-01
|Keen Community
|Keen 1
|16
|[http://www.pckf.com/viewtopic.php?t=1032 Discussion]
|-
|[[Keen 2 Competition Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen2/l.keen_community.k2.2007-03-17.zip full]
|2007-03-17
|Keen Community
|Keen 2
|16
|
|-
|[[Keen 3 Part 2]]
|[http://www.shikadi.net/wiki/files/Packs/Keen3/l.dibodo.k3.2010-10-16.01.zip normal] [http://www.shikadi.net/wiki/files/Packs/Keen3/l.dibodo.k3.2010-10-16.02.zip easy]
|2010-10-16
|Dibodo
|Keen 3
|16
|[http://www.pckf.com/viewtopic.php?t=1544 Discussion]
|-
|[[Keen Armageddon]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.adam.k1.1999-04-21.zip full]
|1999-04-21
|Adam
|Keen 1
|16
|
|-
|[[Keen XMas 2010 Levelpack]]
|[http://dl.dropbox.com/u/3665944/Xmaspack.zip full]
|2010-12-24
|[[User:Tulip|Tulip]]
|Keen 1
|4
|[http://www.pckf.com/viewtopic.php?t=1765 Discussion]
|-
|[[KMO Default Levels]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.peder_johnson.k1.1999-02-13.zip full]
|1999-02-13
|Peder Johnson
|Keen 1
|8
|
|-
|[[Kuliwil's Level Pack]]
|[http://filedump.onecuckoosnest.com/LEVEL01.CK1 level01] [http://filedump.onecuckoosnest.com/LEVEL02.CK1 level02] [http://dl.dropbox.com/u/12124596/Kuliwil%27s%20levels.zip FAIL version]
|2011-01-02
|Kuliwil
|Keen 1
|2
|[http://www.pckf.com/viewtopic.php?t=1774 Discussion]. "FAIL version" features [http://www.youtube.com/watch?v=1Xm2GCRCfcA FAIL].
|-
|[[Lego Levels]]
|[http://www.keeniverse.net/ckfiles/levels/legolevs.zip full]
|2010-02-09
|KeenRush
|Lego Keen
|7
|[http://www.pckf.com/viewtopic.php?t=1040 Discussion]
|-
|[[Manboy's Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.manboy.k1.2001-09-27.zip full]
|2001-09-27
|Manboy
|Keen 1
|3
|
|-
|[[Marooned on Mars Forever]]
|[http://www.shikadi.net/wiki/files/Mods/abandoned/bp's%20keen%201.zip beta]
|2005-10-08
|Bp
|Keen 1
|16
|[http://publiccommanderkeenforum.yuku.com/topic/913/my-mod-released Discussion] Did not reach the state of a "mod"
|-
|[[Martian Building and Skyscraper]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.grelphy.k1.2003-06-04.zip full]
|2003-06-04
|Grelphy
|Keen 1
|2
|
|-
|[[Mitchell's 1st Levelpack]]
|[http://www.dosclassics.com/download/298 full]
|2001-02-18
|Mitchell
|Keen 2
|1
|
|-
|[[Mitchell's 2nd Levelpack]]
|[http://www.dosclassics.com/download/278 full]
|2001-02-20
|Mitchell
|Keen 1
|1
|
|-
|[[Mitchell's 3rd Levelpack]]
|[http://www.dosclassics.com/download/299 full]
|2001-03-10
|Mitchell
|Keen 2
|1
|
|-
|[[MrBlackPack]]
|[http://www.bipship.com/db/uploads/Keen3lvpack_MrBlackPack.zip full]
|2009-01-18
|MrBlack
|Keen 3
|15
|[http://www.pckf.com/viewtopic.php?t=492 Discussion]
|-
|[[Neil McRae's 2nd Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.neil_mcrae.k1.1999-03-07.zip full]
|1999-03-07
|Neil McRae
|Keen 1
|6
|
|-
|[[Peder Johnson's 2nd Levelpack]]
|[http://www.dosclassics.com/download/281 full]
|1999-02-08
|Peder Johnson
|Keen 1
|7
|
|-
|[[Peter Heardghana's Keen 1 Level]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.peter_heardghana.k1.1999-02-28.zip full]
|1999-02-28
|Peter Heardghana
|Keen 1
|1
|
|-
|[[pLeitorian's Levelpacks#1st Levelpack|pLeitorian's 1st Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.pleitorian.k1.1999-03-06.zip full]
|1999-03-06
|pLeitorian
|Keen 1
|16
|
|-
|[[pLeitorian's Levelpacks#2nd Levelpack|pLeitorian's 2nd Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.pleitorian.k1.1999-03-25.zip full]
|1999-03-25
|pLeitorian
|Keen 1
|16
|
|-
|[[pLeitorian's Levelpacks#3rd Levelpack|pLeitorian's 3rd Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.pleitorian.k1.1999-04-07.zip full]
|1999-04-07
|pLeitorian
|Keen 1
|16
|
|-
|[[Psycho Keen]]
|[http://www.dosclassics.com/download/284 full]
|1999-02-13
|Adam
|Keen 1
|16
|
|-
|[[Realms of Doom v2.1]]
|[http://www.dosclassics.com/download/285 full]
|1999-04-25
|Justin
|Keen 1
|2
|
|-
|[[Return on Mars]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.benoit_rouleau.k1.2001-09-29.zip full]
|2001-09-29
|Benoit Rouleau
|Keen 1
|14
|
|-
|[[rrian's 1st Levelpack]]
|[http://www.dosclassics.com/download/310 full]
|2004-06-09
|rrian
|Keen 3
|3
|
|-
|[[A New Dope#Levelpacks|Some Dope Levels]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/SomeDopeLevels.zip full]
|2007-06-14
|[[User:CK Guy|CK Guy]]
|A New Dope
|2
|
|-
|[[The Phantom Blob's 1st Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen3/l.the_phantom_blob.k3.2003-08-06.zip full]
|2003-08-06
|The Phantom Blob
|Keen 3
|11
|
|-
|[[therealdopefish's 1st Levelpack]]
|[http://dosclassics.com/download/263 full]
|1999-01-22
|therealdopefish
|Keen 1
|4
|
|-
|[[therealdopefish's 2nd Levelpack]]
|[http://www.dosclassics.com/download/264 full]
|1999-02-10
|therealdopefish
|Keen 1
|16
|
|-
|[[Thomas and Kael's Keen 1 Levelpack]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.thomas_and_kael.k1.2001-12-29.zip full]
|2001-12-29
|Thomas & Kael
|Keen 1
|14
|
|-
|[[Tom Bailey's Levelpack]]
|[http://www.dosclassics.com/download/288 full]
|1999-02-10
|Tom Bailey
|Keen 1
|6
|
|-
|[[Tom Bailey's Secret Level]]
|[http://www.dosclassics.com/download/289 full]
|1999-02-07
|Tom Bailey
|Keen 1
|1
|
|-
|[[Twin Towers]]
|[http://www.shikadi.net/wiki/files/Packs/Keen1/l.alienkillerxx.k1.2000-06-27.zip full]
|2000-06-27
|AlienKillerXX
|Keen 1
|1
|
|-
|[[Underground Level, Underground Base, and Vorticon]]
|[http://www.dosclassics.com/download/297 full]
|2003-05-05
|Grelphy
|Keen 3
|3
|
|-
|[[Vorta Retra]]
|[http://dl.fileplanet.com/dl/dl.asp?ClassicGaming/cc314/shock01.zip full]
|2001-01-02
|Shockshund, Vorter Ninja, Terri, and Grace
|Keen 3
|16
|
|-
|[[Episode X#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/l.xky_rauh.k1.1999-01-24.zip full]
|1999-01-24
|[[User:Xky Rauh|Xky Rauh]]
|Keen 1
|1
|
|-
|[[Episode Null#Level Pack|XkyKeen 2 Competition Level Pack]]
|[http://www.shikadi.net/wiki/files/Packs/ModPacks/Xky2Community.zip full]
|2008-04-23
|Keen Community
|Keen Null
|16
|
|-
|[[The Yellow Submarine]]
|full (lost)
|
|Caribbean Blue
|Keen 1
|1
|[http://www.dosclassics.com/download/602/ Webpage] download link broken.
|-
|[[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
|
|}

==See Also==
*[[Galaxy Mods]]

== External links ==
*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]
*[http://www.zapzot.net/ Zap/Zot/Net]

[[Category:Mods| ]]

Patch:Scancodes

2011-08-12T23:30:54Z

Fleexy: corrected a few scancodes

Scan codes are values that represent keypresses in-game. They can be thought of as 'codes' that represent all the buttons a player can press. Each game has a different set of codes, created by adding a value to the key's value. The same codes are used any time the game looks for a keypress, so if you know the code for a key you can use a hex editor to check where that key is looked for in the game executable.

The values of keys are as follows:

ESC $01 U $16 | or \ $2B F6 $40
! or 1 $02 I $17 Z $2C F7 $41
@ or 2 $03 O $18 X $2D F8 $42
# or 3 $04 P $19 C $2E F9 $43
$ or 4 $05 { or [ $1A V $2F F10 $44
% or 5 $06 } or ] $1B B $30 NUMLOCK $45
^ or 6 $07 ENTER $1C N $31 SCROLL LOCK $46
& or 7 $08 CTRL $1D M $32 HOME or 7 $47
* or 8 $09 A $1E < or , $33 UP or 8 $48
( or 9 $0A S $1F > or . $34 PGUP or 9 $49
) or 0 $0B D $20 ? or / $35 NUMPAD - $4A
_ or - $0C F $21 RIGHT SHIFT $36 LEFT or 4 $4B
+ or = $0D G $22 PRTSC $37 NUMPAD 5 $4C
BKSP $0E H $23 ALT $38 RIGHT or 6 $4D
TAB $0F J $24 SPACEBAR $39 NUMPAD + $4E
Q $10 K $25 CAPSLOCK $3A END or 1 $4F
W $11 L $26 F1 $3B DOWN or 2 $50
E $12 : or ; $27 F2 $3C PGDN or 3 $51
R $13 " or ' $28 F3 $3D INS or 0 $52
T $14 ~ or ` $29 F4 $3E DEL or . $53
Y $15 LEFT SHIFT $2A F5 $3F

The value added to this by each game in the Keen series is:

1 $502C
2 $5008
3 $5258
4 $?
5 $?
6 $?
D $?

As an example the C T Space cheat code in Keen 1 is:

#CTSpace cheat keys:
%patch $11F5 $5A $50
%patch $11FC $40 $50
%patch $1203 $65 $50

A simple way to disable something is to set one or more of its keys to $00. That is we use the value added by the game for at least one of the keys, a key that can never be pressed. (The code itself still works though, so can't be used by anything else.) Thus to disable the C T Space cheat we can use the patch:

#Disable CTSpace:
%patch $11F5 $2C $50
%patch $11FC $2C $50
%patch $1203 $2C $50

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Misc|}}
{{PatchCategories|Tutorial|}}

Patch:Scancodes

2011-08-12T23:16:00Z

Fleexy: fixed "~ or `"

Scan codes are values that represent keypresses in-game. They can be thought of as 'codes' that represent all the buttons a player can press. Each game has a different set of codes, created by adding a value to the key's value. The same codes are used any time the game looks for a keypress, so if you know the code for a key you can use a hex editor to check where that key is looked for in the game executable.

The values of keys are as follows:

ESC $01 U $16 | or \ $2B F6 $40
! or 1 $02 I $17 Z $2C F7 $41
@ or 2 $03 O $18 X $2D F8 $42
# or 3 $04 P $19 C $2E F9 $43
$ or 4 $05 { or [ $1A V $2F F10 $44
% or 5 $06 } or ] $1B B $30 NUMLOCK $45
^ or 6 $07 ENTER $1C N $31 SCROLL LOCK $46
& or 7 $08 CTRL $1D M $32 HOME or 7 $47
* or 8 $09 A $1E < or , $33 UP or 8 $48
( or 9 $0A S $1F > or . $34 PGUP or 9 $49
) or 0 $0B D $20 ? or / $35 NUMPAD - $4A
_ or - $0C F $21 RIGHT SHIFT $36 LEFT or 4 $4B
+ or = $0D G $22 PRTSC or * $37 NUMPAD 5 $4C
LEFT $0E H $23 ALT $38 RIGHT or 6 $4D
TAB $0F J $24 SPACEBAR $39 NUMPAD + $4E
Q $10 K $25 CAPSLOCK $3A END or 1 $4F
W $11 L $26 F1 $3B DOWN or 2 $50
E $12 : or ; $27 F2 $3C PGDN or 3 $51
R $13 " or ' $28 F3 $3D INS or 0 $52
T $14 ~ or ` $29 F4 $3E DEL or . $53
Y $15 LEFT SHIFT $2A F5 $3F

The value added to this by each game in the Keen series is:

1 $502C
2 $5008
3 $5258
4 $?
5 $?
6 $?
D $?

As an example the C T Space cheat code in Keen 1 is:

#CTSpace cheat keys:
%patch $11F5 $5A $50
%patch $11FC $40 $50
%patch $1203 $65 $50

A simple way to disable something is to set one or more of its keys to $00. That is we use the value added by the game for at least one of the keys, a key that can never be pressed. (The code itself still works though, so can't be used by anything else.) Thus to disable the C T Space cheat we can use the patch:

#Disable CTSpace:
%patch $11F5 $2C $50
%patch $11FC $2C $50
%patch $1203 $2C $50

{{PatchCategories|Keen 1|}}
{{PatchCategories|Keen 2|}}
{{PatchCategories|Keen 3|}}
{{PatchCategories|Misc|}}
{{PatchCategories|Tutorial|}}

Keen 2 Bugs

2010-08-03T21:51:34Z

Fleexy: renamed

This page lists all the bugs, odd behaviors and unexpected actions that have been discovered in [[Keen 2]].

==== Shoot through the roof ====
See the [[Keen 1]] [[Keen_1_Bugs#Shoot through the roof|Shoot through the roof]] bug, which applies to Keen 2 as well.

==== F8 Crash ====
See the [[Keen 1]] [[Keen_1_Bugs#F8 Crash|F8 Crash]] bug, which applies to Keen 2 as well, in version 1.0.

==== Extra levels ====
See the Keen 1 [[Keen_1_Bugs#Extra_levels|Extra levels]] bug, which applies to Keen 2 as well.

==== Swapped levels ====
The [[Vorticon Mothership]] (the world map) has text on written in [[SGA]] to indicate which levels the player will be entering. Unfortunately the levels for [[Moscow Tantalus Center|Moscow]] and [[Rome Tantalus Center|Rome]] must have been mixed up during the game's development, as entering the level marked as Rome actually loads the Moscow level, and entering the level marked as Moscow loads the Rome level.

Steps to reproduce:

* Go to the top of the world map
* Enter the level marked as "[[Wikipedia:Rome|Rome]]"
* Observe that the picture near the Tantalus Ray is of [[Wikipedia:Saint Basil's Cathedral|Saint Basil's Cathedral]] in the [[Wikipedia:Red Square|Moscow Red Square]]
* Enter the level marked as "[[Wikipedia:Moscow|Moscow]]"
* Observe the Tantalus picture is of the [[Wikipedia:Colosseum|Roman Colosseum]]

==== Anti-Hero ====
Keen can leave [[Rome Tantalus Center|Rome's Tantalus Ray]] still active if he goes as far right as possible at the beginning, and hopping up the little hole. This is not actually a bug, but leaves the player in a situation where they can't complete the game.

==== Youths with Talent ====
When there is a group of [[Youth]]s running around in a small room, sometimes one or two of them can actually jump right through walls. This bug is most common in [[Home A]] in the room with the 5 [[Stuffed Toy Vorticon]]s and 7 Youths.

==== Architectural Error ====
[[Image:K2_error.png]]

In the [[Moscow Tantalus Center]], there is a corner missing off a block. See the above picture. Look to the right of [[Keen]], and you won't see a black line where there should be one!

==== Scrub has the key ====
In the [[Weaponry A]] level, you can be pushed through each door without collecting all the keys. If Keen is late, the scrubs will melt and the level will become unwinable.

Steps to reproduce:

* Free the [[Scrub|scrubs]] near the green key by collecting cola cans
* Allow the scrubs to walk to the doors (normaly forcing them towards the yellow key which is heigher than you can jump) by collecting more cola cans.
* Stand near the first (yellow) door before the scrubs arrive
* The scrubs will push you through the door, opening all four for you



[[Category: Keen 2]]

Keen 2 Bugs

2010-07-31T20:19:08Z

Fleexy: Hey, architect, my corner has a probem!

This page lists all the bugs, odd behaviors and unexpected actions that have been discovered in [[Keen 2]].

==== Shoot through the roof ====
See the [[Keen 1]] [[Keen_1_Bugs#Shoot through the roof|Shoot through the roof]] bug, which applies to Keen 2 as well.

==== F8 Crash ====
See the [[Keen 1]] [[Keen_1_Bugs#F8 Crash|F8 Crash]] bug, which applies to Keen 2 as well, in version 1.0.

==== Extra levels ====
See the Keen 1 [[Keen_1_Bugs#Extra_levels|Extra levels]] bug, which applies to Keen 2 as well.

==== Swapped levels ====
The [[Vorticon Mothership]] (the world map) has text on written in [[SGA]] to indicate which levels the player will be entering. Unfortunately the levels for [[Moscow Tantalus Center|Moscow]] and [[Rome Tantalus Center|Rome]] must have been mixed up during the game's development, as entering the level marked as Rome actually loads the Moscow level, and entering the level marked as Moscow loads the Rome level.

Steps to reproduce:

* Go to the top of the world map
* Enter the level marked as "[[Wikipedia:Rome|Rome]]"
* Observe that the picture near the Tantalus Ray is of [[Wikipedia:Saint Basil's Cathedral|Saint Basil's Cathedral]] in the [[Wikipedia:Red Square|Moscow Red Square]]
* Enter the level marked as "[[Wikipedia:Moscow|Moscow]]"
* Observe the Tantalus picture is of the [[Wikipedia:Colosseum|Roman Colosseum]]

==== Anti-Hero ====
Keen can leave [[Rome Tantalus Center|Rome's Tantalus Ray]] still active if he goes as far right as possible at the beginning, and hopping up the little hole. This is not actually a bug, but leaves the player in a situation where they can't complete the game.

==== Youths with Talent ====
When there is a group of [[Youth]]s running around in a small room, sometimes one or two of them can actually jump right through walls. This bug is most common in [[Home A]] in the room with the 5 [[Stuffed Toy Vorticon]]s and 7 Youths.

==== Hey, architect, my corner has a probem! ====
[[Image:K2_error.png]]

In the [[Moscow Tantalus Center]], there is a corner missing off a block. See the above picture. Look to the right of [[Keen]], and you won't see a black line where there should be one!

==== Scrub has the key ====
In the [[Weaponry A]] level, you can be pushed through each door without collecting all the keys. If Keen is late, the scrubs will melt and the level will become unwinable.

Steps to reproduce:

* Free the [[Scrub|scrubs]] near the green key by collecting cola cans
* Allow the scrubs to walk to the doors (normaly forcing them towards the yellow key which is heigher than you can jump) by collecting more cola cans.
* Stand near the first (yellow) door before the scrubs arrive
* The scrubs will push you through the door, opening all four for you



[[Category: Keen 2]]

Keen 6 Bugs

2009-09-01T16:59:29Z

Fleexy: /* Unreachable Extra Lives */ fixed categorization

This page lists all the bugs, odd behaviours, unexpected actions and mistakes (such as typographical errors) that have been discovered in [[Keen 6]].

__TOC__

==== Level bug: The [[Bloogdome]] - Walk into the rock ====
[[Image:keen6_bloogdome_rock.png|frame|The [[Bloogdome]] "walk into the rock" bug]]

In the top left corner of this level, it's possible to jump through the rock surrounding the dome and run around inside the grey rock surrounding the level.

Steps to reproduce:
* Go as high as you can in the level, until you can see the grey rock.
* Go across to the left, until the grey rock starts to appear at the left of the level as well.
* In the angled section of rock closest to the top of the level (as soon as it angles down towards the left) there is no blocking, so you can jump across into the rock (or pogo up from the lower ledge just below.)

 
==== Typo entering Bloogfoods, Inc. ====
[[Image:keen6-bug-hungily.png|frame|Typo in the word "hungrily"]]
When entering the [[Bloogfoods, Inc.]] level, the entrance text reads "hungily" instead of "hungrily".

Steps to reproduce:
* Enter the level, observe the message on-screen; it says "hungily".

 
==== Typo: Bloogbae ====
[[Image:keen6-bug-bloogbae.png|frame|Typo in the word "Bloogbase"]]
When entering the [[Bloogbase Recreational District]], the level text reads "Bloogbae" instead of "Bloogbase."

Steps to reproduce:
* Enter the level, observe the message on-screen says "Bloogbae"
* Press Enter while in the level, observe the level name begins with "Bloogbase"

 
==== Impossible Bullet ====
[[Image:keen6-bug-impossiblebullet.png|thumb|320px|Impossible bullet.]]

This bug requires careful timing to exploit, and only works in [[Keen 6]]. It is not an officially documented trick as with the [[Impossible Pogo Trick]], but named as such by fans upon its discovery due to its comparable difficulty and niftiness. The trick allows the player to fly upwards, until hitting the ceiling or otherwise interrupting the manoeuvre (such as by jumping - although it is possible to walk a couple of pixels left and right before "falling off" the bullet.) It can be very helpful in levels such as Bloogton Towers and getting the grappling hook, although technically it is considered cheating.

Steps to reproduce:
* Jump in the air.
* As you start to fall, shoot downward.
* If done correctly, when you land, you should be standing a tile above the ground.
* Shoot up, and you will fly up with your bullet.
It takes some practice to get the timing right.

If you are standing against a wall when you perform this trick, shooting into the wall will also raise you by a small amount. The Impossible Bullet bug is used extensively in a walkthrough for Keen 6 in which the player gets no points, exploits various clipping errors, etc. Commander Keendom, the website that originally provided the walkthrough, is now gone but [[Keen 6 Walkthrough|there is a copy of the walkthrough]] rescued from [http://www.archive.org www.archive.org].

The technicalities of how this trick works are unknown, as the source code for the games has not been made available. The explanation likely revolves around some unintended quirk whereby the bullet sprite is given a clipping property similar to the [[Gik]] or [[Goplat]]. While Keen is standing on it, the sprite is kept alive by way of the clipping function, despite the animation rendering it invisible. Instead of creating a new bullet at the end of the [[Neural Stunner]] when firing the subsequent shot into the air, the game reuses the existing one.

 

==== Eye am stuck ====
[[Image:Eyemstuck.png|frame|Stuck [[Orbatrix]].]]

In many levels, if the [[Orbatrix]] are bounding about then unfurl next to a sloped surface, or even a wall, they will become stuck in the ground and just hover up and down. They may be freed if Keen walks close to them, causing them to furl and bounce again. It is harder to trap an Orbatrix in a wall, but it can be done. This trick is easy once mastered and a great way of detaining an indestructable enemy.

Steps to reproduce:
* Go somewhere, like near Molly, that has both Orbatrix and sloping surfaces.
* Make the Orbatrix curl and bound, you will need to do this carefully to avoid death.
* If properly positioned they will unfurl and get stuck.

 

==== A nose for trouble ====
[[Image:Nostuck.png|frame|[[Nospike]] stuck in walls.]]

If a charging [[Nospike]] rams into a wall it can get stuck in it, either walking back and forth rapidly on air, or standing 8 pixels higher than normal in the wall. It cannot charge, unless shot. When shot, it will charge, pause, then fall 8 pixels to the floor and stun as if it had fallen off a cliff.

Steps to reproduce:
* Hard mode is helpful.
* Go to the [[Bloogdome]].
* Try and make a Nospike charge you as much as possible ([[God mode]] helps.)
* If done right, some will get stuck in walls.

 

==== Rhetorical Question ====
[[Image:Noquestion.png|frame|A [[Nospike]] all confused.]]

If you manage to reproduce the above error, under the right circumstances you may be able to preserve the Nospike's question-mark of surprise. It is not known specifically what causes the question-mark to remain, though it does have to be embedded in a wall tile. It is almost impossible to get this glitch to work, especially without cheating.

 
==== Eyeball confuses camera ====

If you stand on an eyeball and save your game, when you load the game again the camera becomes broken and shows the wrong part of the level (not where Keen is.) There is [http://www.youtube.com/watch?v=AjXVBz_-8TY a video demonstrating this] at YouTube.

 
==== Stand-a-Switch ====
[[Image:stand-on-switch.png|thumb|320px|Standing on the switch :).]]

In the [[Bloogton Tower]], you can stand on the tall switch without flipping it. Simply ride the [[Goplat]] to the left of the switch, while the platform is going down, go the far right of the platform and wait. You will be standing on the edge of the switch.

Steps to reproduce:

* Activate the platform
* Make sure the switch is in the up position
* Wait for the platform to get to the top
* Go to the far right of the platform
* Wait till you pass the switch. If done correctly, you will stay on the switch

 

==== Jump Through Walls ====
[[Image:Keen6_BloogFoods_clip.gif|thumb|320px|Jumping through the wall.]]

In [[Bloogfoods, Inc.]] some of the vertical walls of the downward snaking passage can be jumped through. If the other side has nothing above it Keen can freely clip through it without any sort of cheats. This exploit allows the level to be completed without ever retrieving the green key.

Steps to reproduce:

* Goto Bloogfoods, Inc. past the red and blue doors
* Stand against the vertical wall
* Jump while walking into it
* Some times Keen will not pass through and instead rapidly look left and right until a key is pressed

 
=== Offscreen onscreen ===

[[Image:Offscreen.png|200px|thumb|right|Keen offscreen]]
There are several levels, notably the BWB Megarocket, where Keen can go offscreen. If he saves his game in this position, when restored, you can see the level's edge.

 

=== Unreachable Extra Lives ===
[[Image:BASA-unreachable-extra-lives.png|thumb|320px|Unreachable extra lives.]]

In [[Bloog Aeronautics and Space Administration]], there are two [[Queen Viva]]s hidden in the floor at the bottom of the level between two retractable bridges. These two extra lives are unreachable without cheating.

[[Category:Keen 6]]

File:Ghost Guard.png

2009-08-27T22:31:37Z

Fleexy:

Ghost Guard

2009-08-27T22:31:04Z

Fleexy: made main page

{{Creature Infobox
| Appears = [[Keen -6]]
| Harmful = Yes
| Image = Ghost_Guard.png
}}

The Ghost Guards guard important areas in the Shelter of [[Keen -6]]. They came to the Shelter with the [[CrazyNERM]]s. Guarding of less important areas is left to the [[DangerBot]]s.

File:DangerBOT.png

2009-08-27T22:26:44Z

Fleexy:

DangerBot

2009-08-27T22:26:21Z

Fleexy: made main page

{{Creature Infobox
| Appears = [[Keen -6]]
| Shots = 1
| Harmful = Yes
| Image = DangerBOT.png
}}

The DangerBots guard semi-important areas when the [[Chompzillo]]s are not there. They are machines, but were taken to the Shelter by their masters, the [[Chompzillo]]s. Guarding of more important areas is taken up by the [[Ghost Guard]]s.

File:CrazyNERM.png

2009-08-27T22:20:53Z

Fleexy:

CrazyNERM

2009-08-27T22:20:32Z

Fleexy: made main page

{{Creature Infobox
| Appears = [[Keen -6]]
| Shots = 1
| Harmful = Yes, by phaser blasts
| Image = CrazyNERM.png
}}

CrazyNERM is based on Nerm from an old run-it-through-GWBASIC DOS game. In here he fires a red phaser and pushes Keen. It appears only in the last level of [[Keen -6]], the Shelter, because of an atomic bomb landing on [[Cromaj]]ian IV.

File:Chompzillo.png

2009-08-27T21:59:33Z

Fleexy: Chompzillo in Keen -6

Chompzillo in Keen -6

Chompzillo

2009-08-27T21:58:06Z

Fleexy: added infobox, added text

{{Creature Infobox
| Appears = [[Keen -6]]
| Shots = 1
| Harmful = Yes
| Image = Chompzillo.png
}}

Chompzillos are very fast creatures that would love to have you for lunch in [[Keen -6]]. They have three yellow teeth and two eyes, which can be green or red, depending on their mood. They float in the air and have floating eyes as well. Because of an atomic bomb landing on [[Cromaj]]ian IV, they only appear in the shelter.

Cromaj

2009-08-27T21:49:59Z

Fleexy: fixed image

{{Creature Infobox
| Appears = [[Keen -6]]
| Shots = 1
| Harmful = No
| Image = Cromaj.PNG
}}

The Cromajians are the target of Keen's evangelistic speech in [[Keen -6]]. They only appear in the Shelter becuase of an atomic bomb landing on their planet. They are very happy and freindly, coming toward you and usually found in groups. They don't like it when you mess up their hair.

Cromaj

2009-08-27T21:48:53Z

Fleexy: added infobox and text

{{Creature Infobox
| Appears = [[Keen -6]]
| Shots = 1
| Harmful = No
| Image = Cromaj.png
}}

The Cromajians are the target of Keen's evangelistic speech in [[Keen -6]]. They only appear in the Shelter becuase of an atomic bomb landing on their planet. They are very happy and freindly, coming toward you and usually found in groups. They don't like it when you mess up their hair.

File:Cromaj.PNG

2009-08-27T21:43:41Z

Fleexy: Keen -6 Cromaj

Keen -6 Cromaj

Keen -6

2009-08-27T21:35:30Z

Fleexy: added links to enemies

Keen -6 is a mod released by Fleexy. It is one of the more difficult mods, stated by a few people on PCKF and Keen:Modding. Here, Keen was giving an evangelistic speech to the Cromajians, but he forgot his sermon notes. Some passages are written on the back of crosses scattered around Cromajian IV. Because of an atomic bomb landing on the planet, the only life is in the Shelter. The item scores are very low in this mod, so you never get extra lives.

== Items ==
*Red Cross
*Yellow Cross
*Green Cross
*Blue Cross
*Phaser - 5 phaser power
*Cherry Gumdrop - 1 point
*Marshmallow - 2 points
*Jawbreaker - 4 points
*Necco Pack - 5 points
*Bible - 10 points

== Enemies ==
*[[Cromaj]] - The target of Keen's speech. Get upset if you mess up their hair.
*[[Chompzillo]] - Crazy creatures who would love to have you for lunch.
*[[CrazyNERM]] - Nerm gone bad, flips around and fires a red phaser.
*[[DangerBot]] - Big robots who try to flatten you out.
*[[Ghost Guard]] - Ghosts that Guard.

== Hazards ==
*Acid pipes
*Spikes
*Acid-tipped spikes
*Green acid
*Purple acid
*Nasty spaghetti
*Purple acid-tipped spikes
*Red spikes
*Wall spikes

== Debate ==
It is currently being debated whether Keen -6 is harder than Episode Smile. Most people have gotten farther in Smile than in Keen -6, but Episode Smile has been around longer. Also, Keen -6 requires 15 levels complete to win.

== Level Maps ==

Spoiler Warning! This shows the whole levels, including the password for the endtext

<gallery>
Image:Keen-6Level01.png|Park Guard 1
Image:Keen-6Level02.png|Park Guard 2
Image:Keen-6Level03.png|Park
Image:Keen-6Level04.png|Subway/Elevator
Image:Keen-6Level05.png|Cromaj Hotel
Image:Keen-6Level06.png|Sewer
Image:Keen-6Level07.png|Townhouse
Image:Keen-6Level08.png|Food Pantry
Image:Keen-6Level09.png|Fun House
Image:Keen-6Level10.png|Arena
Image:Keen-6Level11.png|Maze
Image:Keen-6Level12.png|Shelter Guard 1
Image:Keen-6Level13.png|Shelter Guard 2
Image:Keen-6Level14.png|Shelter Guard 3
Image:Keen-6Level15.png|Shelter Guard 4
Image:Keen-6Level16.png|Shelter
</gallery>

== External links ==

* [http://home.mchsi.com/~bootsisbig/keen-6.zip Download "Keen -6"]

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

File:Keen-6Level09.png

2009-08-26T22:55:59Z

Fleexy: uploaded a new version of "Image:Keen-6Level09.png"

Ninth level of Keen -6

Keen -6

2009-08-26T20:36:39Z

Fleexy: added official level names

Keen -6 is a mod released by Fleexy. It is one of the more difficult mods, stated by a few people on PCKF and Keen:Modding. Here, Keen was giving an evangelistic speech to the Cromajians, but he forgot his sermon notes. Some passages are written on the back of crosses scattered around Cromajian IV. Because of an atomic bomb landing on the planet, the only life is in the Shelter. The item scores are very low in this mod, so you never get extra lives.

== Items ==
*Red Cross
*Yellow Cross
*Green Cross
*Blue Cross
*Phaser - 5 phaser power
*Cherry Gumdrop - 1 point
*Marshmallow - 2 points
*Jawbreaker - 4 points
*Necco Pack - 5 points
*Bible - 10 points

== Enemies ==
*Cromaj - The target of Keen's speech. Get upset if you mess up their hair.
*Chompzillo - Crazy creatures who would love to have you for lunch.
*CrazyNERM - Nerm gone bad, flips around and fires a red phaser.
*DangerBot - Big robots who try to flatten you out.
*Ghost Guard - Ghosts that Guard.

== Hazards ==
*Acid pipes
*Spikes
*Acid-tipped spikes
*Green acid
*Purple acid
*Nasty spaghetti
*Purple acid-tipped spikes
*Red spikes
*Wall spikes

== Debate ==
It is currently being debated whether Keen -6 is harder than Episode Smile. Most people have gotten farther in Smile than in Keen -6, but Episode Smile has been around longer. Also, Keen -6 requires 15 levels complete to win.

== Level Maps ==

Spoiler Warning! This shows the whole levels, including the password for the endtext

<gallery>
Image:Keen-6Level01.png|Park Guard 1
Image:Keen-6Level02.png|Park Guard 2
Image:Keen-6Level03.png|Park
Image:Keen-6Level04.png|Subway/Elevator
Image:Keen-6Level05.png|Cromaj Hotel
Image:Keen-6Level06.png|Sewer
Image:Keen-6Level07.png|Townhouse
Image:Keen-6Level08.png|Food Pantry
Image:Keen-6Level09.png|Fun House
Image:Keen-6Level10.png|Arena
Image:Keen-6Level11.png|Maze
Image:Keen-6Level12.png|Shelter Guard 1
Image:Keen-6Level13.png|Shelter Guard 2
Image:Keen-6Level14.png|Shelter Guard 3
Image:Keen-6Level15.png|Shelter Guard 4
Image:Keen-6Level16.png|Shelter
</gallery>

== External links ==

* [http://home.mchsi.com/~bootsisbig/keen-6.zip Download "Keen -6"]

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

Keen -6

2009-08-26T17:08:02Z

Fleexy: added enemies + hazards

{{Stub}}

Keen -6 is a mod released by Fleexy. It is one of the more difficult mods, stated by a few people on PCKF and Keen:Modding. Here, Keen was giving an evangelistic speech to the Cromajians, but he forgot his sermon notes. Some passages are written on the back of crosses scattered around Cromajian IV. Because of an atomic bomb landing on the planet, the only life is in the Shelter. The item scores are very low in this mod, so you never get extra lives.

== Items ==
*Red Cross
*Yellow Cross
*Green Cross
*Blue Cross
*Phaser - 5 phaser power
*Cherry Gumdrop - 1 point
*Marshmallow - 2 points
*Jawbreaker - 4 points
*Necco Pack - 5 points
*Bible - 10 points

== Enemies ==
*Cromaj - The target of Keen's speech. Get upset if you mess up their hair.
*Chompzillo - Crazy creatures who would love to have you for lunch.
*CrazyNERM - Nerm gone bad, flips around and fires a red phaser.
*DangerBot - Big robots who try to flatten you out.
*Ghost Guard - Ghosts that Guard.

== Hazards ==
*Acid pipes
*Spikes
*Acid-tipped spikes
*Green acid
*Purple acid
*Nasty spaghetti
*Purple acid-tipped spikes
*Red spikes
*Wall spikes

== Debate ==
It is currently being debated whether Keen -6 is harder than Episode Smile. Most people have gotten farther in Smile than in Keen -6, but Episode Smile has been around longer. Also, Keen -6 requires 15 levels complete to win.

Keen -6

2009-08-26T17:01:02Z

Fleexy: expanded, added items