Cosmo Savegame Format

2013-04-10T17:26:18Z

Fuzzie: explain the unknowns

== File Format ==

The '''Cosmo Savegame Format''' is an uncompressed file with extension .SV# (where # is a number from 1 to 9), used to store savegame information to be retrieved later by the game engine.

{|class="wikitable"
! Data type !! Description
|-
| [[UINT16LE]] iHealth || Player's health (0 to 6; 1 means no bars left, 0 means dead)
|-
| [[UINT32LE]] iScore || Current score
|-
| [[UINT16LE]] iStars || Number of collected stars
|-
| [[UINT16LE]] iMapOn || Current level number
|-
| [[UINT16LE]] iBombs || Number of bombs in the inventory (0 to 9)
|-
| [[UINT16LE]] iHealthBars || Number of health bars the player has (3 to 5)
|-
| [[UINT16LE]] iCheated || 1 if cheats have been used, 0 otherwise
|-
| [[UINT16LE]] iHasHadBomb || Hint system: 1 if cosmo has ever had a bomb, 0 otherwise (controls whether help text is shown when no bombs are present)
|-
| [[UINT16LE]] iKnowsHowToKill || Hint system: 0 to start with, 1 if cosmo took damage and so the "jump on top of enemies to defend yourself" help should be shown, and finally 2 once either cosmo has jumped on an enemy or the help text has been shown
|-
| [[UINT16LE]] iKnowsAboutPowerups || Hint system: 0 to start with, 1 if the "power up modules increase cosmo's health" help text has been shown
|-
| [[UINT16LE]] iChecksum || Must match iHealth + iStars + iMapOn + iBombs + iHealthBars
|}

If the user tries to load a savegame with an invalid checksum, the game will show an error message and quit to DOS.

== Credits ==

This file format was reverse engineered by [[User:K1n9_Duk3|K1n9_Duk3]]. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

Cosmo Level Format

2013-01-22T05:47:11Z

Fuzzie: ramble a bit about the map widths

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 8×8
| Viewport = 304×144
| Game1 = Cosmo's Cosmic Adventures
}}

== File format ==
The file is in this basic layout:

{|class="wikitable"
!Data type!!Description
|-
|UINT16LE iFlags||Flags indicating music, backdrop and other stuff
|-
|UINT16LE iMapWidth||Map width in tiles
|-
|UINT16LE iActorSize||Number of UINT16 values in the actor block
|-
|ACTORDATA actorData[]||Variable-length array of all the actors in the level
|-
|BYTE bgLayer[65528]||The map data for the background layer
|}

The iMapWidth values in the original Cosmo levels is either 64, 128, 256 or 512. The "view window" in the game is 304x144 Pixels, so the minimal map width would be 38. However, the width must be a power of 2 to work (from 32 to 2048).

The iActorSize values are reliable for all the original Cosmo level files (Version 1.20).

The map data is actually sized 65528 Bytes or 32764 Words. Each entry in this block is divisable by 8 (see [[#Mapping cell values to tiles]]).

=== Level Flags ===

The structure of the bits in the iFlags value is as follows:

[ mmmmm | ppp | yxr | bbbbb ]

m: music index
p: palette animation type
y: y-scrolling backdrop
x: x-scrolling backdrop
r: rain
b: backdrop index

The indices for music and backdrop refer to an array of filename strings stored in the executable. You can find them by searching for the first filename in each array. For backdrops, the first filename (index: 0) is <tt>BDBLANK.MNI</tt>, for music it's <tt>MCAVES.MNI</tt>. Note that some backdrop files are not used by the games (and therefore are not not included).

The palette animation types indicate the following:

%000: (most levels) no palette changes
%001: (A4) random lightning (with thunder soundeffect)
%010: (C8-C10) cycling: red -> yellow -> white
%011: (A7) cycling: red -> green -> blue
%100: (A8, B3, B4, B7) cycling: black -> grey -> white
%101: (C6, C7) flashing: red -> magenta -> white
%110: (C1) replace dark magenta with black, no animation

=== Background Layer ===

The <tt>bgLayer</tt> block contains the grid/cell data:

{|class="wikitable"
!Data type!!Description
|-
|UINT16LE iMapData[32764]||Actual map data
|}

Each "element" in <tt>iMapData</tt> refers to the foreground and/or background tile used in a single grid cell. The grids are arranged left to right, top to bottom, so the index can be calculated by this formula:

int iIndex = (y * iMapWidth) + x;
iMapData[iIndex] = <new value to set at x,y>

The map data in the original Cosmo level files is a constant 32764 UINT16LE cells long (65528 bytes), and the engine will never read more than 65535 bytes. However, the game calculates the map height by dividing the width in bytes by 65536:

int iMapHeight = 32768 / iMapWidth;

Since the width of the map is always a power of 2 (min. 64), you can see that each file is "missing" 8 Bytes (or 4 Words). That means the last line of the map will always be missing the last 4 tiles. The game ignores that last, incomplete line. However, in one level (A8.MNI), there is an actor placed in that last line. Since actors are saved as individual structures instead of a grid, that actor will still be loaded by the game. But for editing a level, you should make sure the last line is visible, so that it's possible to place actors in that line or remove them from there.

==== Mapping cell values to tiles ====

The method of mapping elements in the <tt>iMapData</tt> structure into tiles is fairly straightforward. Each cell value is a pixel index into the tilemap. Imagine the tileset laid out left to right all on the one row. Since each tile is 8x8 pixels, at 16 pixels into the image, the third tile will begin (x = 0 for first tile, x = 8 for second tile, x = 16 for third tile.) The cell value is essentially a pixel x-coordinate into the tileset.

Note that in the tileset file, the solid tiles are made up of 2000 4-plane (16-colour) images, and these are followed by 1000 5-plane images (16-colour + transparency.) Although separate images, they appear to be concatenated when the game loads them, as the cell value will be zero for the first solid tile, it will be eight for the second solid tile, it will be 15992 for the last solid tile, and it will be 16000 for the first masked tile.

This means that if the solid and masked tiles have been treated as separate images, a check will need to be performed so that any cell value below 16000 is loaded from the solid tileset, and any value larger than this is loaded from the masked tileset (after subtracting 16000 from the cell value, to put it at zero for the first masked tile.) However, for some reason the values for the masked tiles are at multiples of five tiles (tile #0 (x=0) is the first tile, tile #5 (x=40) is the second tile.) This formula can be used to convert the values into tile numbers once they stray into the masked tile area:

#define COSMO_TS_SOLID_NUMTILES 2000 // 40x25
#define COSMO_TS_MASKED_NUMTILES 1000 // 40x4

tile = cell_value / 8
if (tile > COSMO_TS_SOLID_NUMTILES) {
// Once we're in the masked tileset it counts up in multiples of five planes
tile = COSMO_TS_SOLID_NUMTILES + (tile - COSMO_TS_SOLID_NUMTILES) / 5;
}
// Now 'tile' will be between 0 and 2999 inclusive

As an example of a few tile values:

{|class="wikitable"
! Cell value !! Tile number !! Tileset !! Index !! Comments
|-
| 0 || 0 || N/A || N/A || See through to map backdrop
|-
| 8 || 1 || Solid || 1 || First solid tile, note increment of 8
|-
| 16 || 2 || Solid || 2 || Second solid tile, increment of 8 again
|-
| 15992 || 1999 || Solid || 1999 || Last solid tile
|-
| 16000 || 2000 || Masked || 0 || First masked tile
|-
| 16040 || 2001 || Masked || 1 || Second masked tile, note increment of 40
|-
| 16080 || 2002 || Masked || 2 || Third masked tile, increment of 40 again
|-
| 55960 || 2999 || Masked || 999 || Last masked tile
|-
| 56000 || N/A || N/A || N/A || Should never get a value this size or larger
|}

Note that while the cell value cannot be out of range for the solid tiles/background layer (since any values larger than 16000 will be loaded from the masked tileset) the cell values for the masked tileset have no such restriction. (Although obviously out of range tiles will not be drawn correctly by the engine!)

==== Gotchas ====

* The first tile in the solid tileset is used as a transparent tile. It will appear completely black if drawn (e.g. in a map editor) however the game does not draw this tile, so any cells with this as the background cell will be where the map backdrop shows through. If you wish to draw the map with the backdrop in-place, remember not to draw tile #0 over the top of the backdrop.

=== Actor data ===

The <tt>actorData</tt> block is in the following format:

{|class="wikitable"
!Data type!!Description
|-
|UINT16LE iType||Type of actor
|-
|UINT16LE iX||X-coordinate of actor (in tile units)
|-
|UINT16LE iY||Y-coordinate of actor (in tile units)
|}

Because the <tt>iActorSize</tt> value in the header is in UINT16s and there are three UINT16s per actor, the number of actors can be obtained quite simply:

iNumActors = iActorSize / 3

This is assuming <tt>iActorSize</tt> is reliable - the original specs from Dave Bollinger indicate this is not always the case for DukeII, but no examples are known at the moment.

==== Mapping Actor Types to image indices ====

For the ActorTypes from 32 to 296 (inclusive), you can get an image index from ACTORS.MNI and ACTRINFO.MNI like this:

ImageIndex = ActorType - 31

However, this does not work for every ActorType. Some share the same images (e.g.: normal stars and falling stars), some use flipped versions of other images (like the pink eye plants) and some are invisible in the game. In either case, the index in the ACTRINFO.MNI will contain no data. You will either have to include hard-coded info to draw these, or just draw something else (like the actual ActorType as text).

==== List of Actor Types ====

This is a list of all the actor types that can be found in the original levels of the three episodes. There might be more ActorTypes that work in the game. For example, 69 is probably the (falling) "Onion" item as you can guess by looking at the numbers 62-68.

0 PLAYER: Cosmo (facing right)
1 moving platform (fixed path)
2 PLAT: mud fountain 1 (small)
3 PLAT: mud fountain 2 (normal)
4 PLAT: mud fountain 3 (big)
5 PLAT: mud fountain 4 (huge)
6 BRIGHTNESS: left border of light
7 BRIGHTNESS: light source (top center)
8 BRIGHTNESS: right border of light

22 ??? (only in A8.MNI, doesn't seem to be doing anything)

32 BONUS: Star (200)
33 PLAT: Catapult (ground)
34 ENEMY: Big Arrow (from right to left)
35 ENEMY: Big Arrow (from left to right)
36 ENEMY: Fireball (from right to left)
37 ENEMY: Fireball (from left to right)
38 Blue Switch (on ceiling)
39 Red Switch (on ceiling)
40 Green Switch
41 Yellow Switch
42 Blue Door
43 Red Door
44 Green Door
45 Yellow Door

47 ENEMY: Blue Catapult Car
48 ENEMY: Double Spikes on ground
49 ENEMY: Double Spikes (coming out of the ground)

51 ENEMY: Big Saw Blade

56 ENEMY: Green Ball

59 BONUS: Power Up (health/12800)
60 BARREL: Power Up (health/12800)

62 CRATE: Green Tomato
63 BONUS: Green Tomato (falling)
64 CRATE: Tomato (200)
65 BONUS: Tomato (falling)
66 CRATE: Yellow/Cyan Fruit
67 BONUS: Yellow/Cyan Fruit (falling)
68 CRATE: Onion

70 Exit Sign (ends level on touch)

72 ENEMY: Spear (coming down from ceiling)
73 ENEMY: Green stuff leaking (NOT dropping)
74 ENEMY: Green stuff dropping down
75 ENEMY: Blue Flame flying up & down
76 ENEMY: "Two Tons" Weight going down & up
77 ENEMY: Jumping Bullets
78 ENEMY: Big Grey Heads falling down and going back up
79 ENEMY: Big Yellow Spike on ceiling
80 ENEMY: Big Yellow Spike on ceiling (falling down)
81 ENEMY: Big Yellow Spike on ground
82 ENEMY: Ghost
83 CRATE: Green thingy

85 ENEMY: Cyan Ball
86 ENEMY: Small Red Plant
87 BARREL: Bomb (100)
88 BONUS: Bomb (100)

90 switch (1)

92 switch (2)
93 question mark
94 claw spikes from ground
95 Rubber Wall (can blow it up)
96 ENEMY: cyan jumping ball

100 CREATURE: Green Worm
101 PIPES: Arrow Up
102 PIPES: Arrow Down
103 PIPES: Arrow Left
104 PIPES: Arrow Right
105 ENEMY: Egg Head (special?) -- only 1x: in B2.MNI
106 ENEMY: Egg Head

109 ENEMY: Spike on ground (animated)

111 ENEMY: Spike on ceiling (animated)
112 CRATE: Burger

114 ENEMY: Blue/Red plant

116 BONUS: Purple Grapes (800)
117 ENEMY: Blue Ball
118 ENEMY: Spikes (on left wall)
119 ENEMY: Spikes (on left wall) goes in & out of wall
120 ENEMY: Spikes (on right wall)
121 ENEMY: Robot with elctric beam
122 PLAT: Blue Platform (opens afer a few seconds)
123 ENEMY: Spark

125 BONUS: Cyan Mushroom (400)
126 DECO: Pink Eye Plant
127 DECO: Pink Eye Plant (hanging upside down)

132 ENEMY: Big Red Jumper
133 ENEMY: BOSS

135 PIPES: Exit
136 PIPES: Entrance
137 ENEMY: Yellow Dude with blue legs
138 Scooter (Teleporter 1)
139 Scooter (Teleporter 2)

142 ENEMY: Cyan Spitting Plant (on left wall)
143 ENEMY: Cyan Spitting Plant (on right wall)
144 ENEMY: Blue spitting thing
145 PLAT: Platform you can ride and control
146 CRATE: pile of green balls

148 BARREL: Saxophone-like thing
149 ENEMY: little red dude
150 CRATE: Salad
151 switch (3)
152 switch (4)
153 Energy Beam (|)
154 Energy Beam (-)
155 ENEMY: slug/Worm
156 HINT: "These hint globes will help you along your journey. Press the up key to reread them."
157 ENEMY: Grey Dude (pushes player around)
158 ENEMY: Robot

160 PLAT: Dragonfly
161 Crate/Box (can only be destroyed with bombs)

165 BONUS: Bottle with red liquid
166 BONUS: Green thing
167 BONUS: Blue thing
168 BONUS: Salad?
169 BONUS: Pile of green things
170 BONUS: whatever..

172 BONUS: blue thing

174 DECO: Sattelite

176 ENEMY: Green Plant
177 BONUS: 5 Yellow Grapes (800)
178 BONUS: whatever...
179 CRATE: with item 178
180 DECO: Jaws & Tongue
181 invisible exit marker (go right to exit)
182 small flame
183 ENEMY: Big Red Plant (spitting Blue Balls/catapult)

185 BONUS: Blue Crystal (on ground)
186 BONUS: Red Crystal (on ground)
187 BARREL: Red/Green Gem
188 BARREL: Blue Crystal
189 BARREL: Red Crystal
190 BONUS: Green Tomato
191 BONUS: Tomato
192 BONUS: Yellow/Cyan Fruit (200)
193 ENEMY: Bear Trap
194 PLAT: Blue Cube (falls down when you walk off)
195 MESSAGE: "What's happening? Is Cosmo falling to his doom?"
196 MESSAGE: "Is there no end to this pit? An what danger awaits below?!"
197 Level End Object?
198 CRATE: Root (400)
199 BONUS: Root
200 CRATE: 4 Brown Berries (400)
201 BONUS: 4 Brown Berries

203 BONUS: Potato?
204 BARREL: Green Gem
205 BONUS: Green Gem
206 BARREL: Diamond (3200)
207 BONUS: Diamond

217 ENEMY: Big Green Plant (level exit?)
218 ENEMY: Blue Bird
219 OBJECT: Rocket
220 BONUS: Invincibility
221 PLAT: Podest 1 (14 tiles high)
222 PLAT: Podest 2 (20 tiles high)
223 PLAT: Podest 3 (26 tiles high)
224 BARREL: Diamond 2
225 BONUS: Diamond 2 (falling)
226 BARREL: Red Berry
227 BONUS: Red Berry (falling)
228 BARREL: Crystal (800)
229 BONUS: Crystal (falling)
230 BARREL: Blue Gem
231 BONUS: Blue Gem (falling)

233 DECO: Rocket Exhaust
234 Scooter (Level Exit)
235 HINT: "Bump head into switch above!"
236 HINT: "The ice in this cave is very, very slippery."
237 HINT: "Use this shield for temporary invincibility."
238 HINT: "You found a secret area!!! Good Job!"
239 HINT: "In hight places look up to find bonus objects."
240 HINT: "Out of Order..."
241 HINT: "This might be a good time to save your game!"
242 HINT: "Press your up key to use the transporter."
243 HINT: "(1) FOR..."
244 BONUS: Diamond 2
245 BONUS: Red Berry
246 BONUS: Crystal
247 BONUS: Blue Gem (800)
248 PLAT: Catapult on ceiling
249 BARREL: Headphones
250 BONUS: Headphones
251 BONUS: Headphones (falling)
252 OBJECT: Frozen Duke NukUm

254 BONUS: 3 Bananas (800)
255 CRATE: Strawberry
256 BONUS: Strawberry (400)

258 CRATE: Brown Pear
259 BONUS: Brown Pear

261 CRATE: Carrot
262 BONUS: Carrot (400)

264 DANGER: Flame (<-)
265 DANGER: Flame (->)

267 DANGER: Red stuff leaking
268 DANGER: Red stuff dropping down
269 HINT: "(2) EXTRA..."
270 HINT: "(3) POINTS,..."
271 HINT: "(4) DESTROY..."
272 HINT: "(5) HINT..."
273 HINT: "(6) GLOBES!!!"
274 HINT: "The Clam Plants won't hurt you if their mouths are closed."+Clam Sprite

278 DECO: Big Mouth (end of E1/start of E2)
279 DECO: Normal Smoke Rising
280 DECO: Big Smoke rising
281 invisible, end level when you fall below (Bonus Levels only)

283 BONUS: Red Crystal hanging from ceiling
284 HINT: "Collect the STARS to advance to BONUS STAGES."
285 HINT: "Some creatures require more than one pounce to defeat!"
286 HINT: "Cosmo can climb wall's with his suction hands."+CosmoWallSprite

294 BONUS: Power Up (falling) (health/12800)
295 BONUS: Star (falling) (200)
296 end of episode 2 trigger?

The hint texts are the messages you get in episode 1, the other episodes have different (and less!) messages. The later hint globes probably don't work in those episodes.

== Credits ==

This file format was reverse engineered by [http://www.geocities.com/dooknookimklassik/ Dave Bollinger]. Most of this info came from the [http://www.geocities.com/dooknookimklassik/dn2specs.txt Duke II specs on his website], with [[User:Malvineous|Malvineous]] working out which bits to remove to read Cosmo maps. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

Cosmo Tile Attributes

2013-01-22T05:34:29Z

Fuzzie: bit 6 is sloped

The structure of Cosmo's tile attribute format is very similar to the format used in the [[Duke Nukem II CZone Format]], only this one uses [[UINT8]] values instead of [[UINT16LE]] values.

The attribute data consists of 2000 [[UINT8]] values (settings for the solid tiles), followed by another 5000 [[UINT8]] values (five [[UINT8]]s for each masked tile). It seems like only the first [[UINT8]] for each masked tile is actually used by the game.

Bit | Description
----+------------
7 | can grab wall
6 | sloped (auto-descend)
5 | in-front
4 | slippery
3 | block right
2 | block left
1 | block up
0 | block down

= Credits =

This file format was reverse engineered by [[User:K1n9_Duk3|K1n9_Duk3]]. If you find this information helpful in a project you're working on, please give credit where credit is due. (A link back to this wiki would be nice too!)

[[Category:Cosmo's Cosmic Adventures]]
[[Category:File Formats]]

ModdingWiki - User contributions [en-gb]

Cosmo Savegame Format

Cosmo Level Format

Cosmo Tile Attributes