2 * Copyright (c) 2007, 2008, 2009, Czirkos Zoltan <cirix@fw.hu>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include <glib/gi18n.h>
19 #include <glib/gstdio.h>
24 /* this stores the caves. */
27 /* the data of the caveset: name, highscore, max number of lives, etc. */
28 GdCavesetData *gd_caveset_data;
30 /* is set to true, when the caveset was edited since the last save. */
31 boolean gd_caveset_edited;
33 /* last selected-to-play cave */
34 int gd_caveset_last_selected;
35 int gd_caveset_last_selected_level;
37 /* list of possible extensions which can be opened */
38 char *gd_caveset_extensions[] =
48 #define CAVESET_OFFSET(property) (G_STRUCT_OFFSET(GdCavesetData, property))
50 const GdStructDescriptor gd_caveset_properties[] =
53 {"", GD_TAB, 0, N_("Caveset data")},
54 {"Name", GD_TYPE_STRING, 0, N_("Name"), CAVESET_OFFSET(name), 1, N_("Name of the game")},
55 {"Description", GD_TYPE_STRING, 0, N_("Description"), CAVESET_OFFSET(description), 1, N_("Some words about the game")},
56 {"Author", GD_TYPE_STRING, 0, N_("Author"), CAVESET_OFFSET(author), 1, N_("Name of author")},
57 {"Date", GD_TYPE_STRING, 0, N_("Date"), CAVESET_OFFSET(date), 1, N_("Date of creation")},
58 {"WWW", GD_TYPE_STRING, 0, N_("WWW"), CAVESET_OFFSET(www), 1, N_("Web page or e-mail address")},
59 {"Difficulty", GD_TYPE_STRING, 0, N_("Difficulty"), CAVESET_OFFSET(difficulty), 1, N_("Difficulty (informative)")},
61 {"Lives", GD_TYPE_INT, 0, N_("Initial lives"), CAVESET_OFFSET(initial_lives), 1, N_("Number of lives you get at game start."), 3, 9},
62 {"Lives", GD_TYPE_INT, 0, N_("Maximum lives"), CAVESET_OFFSET(maximum_lives), 1, N_("Maximum number of lives you can have by collecting bonus points."), 3, 99},
63 {"BonusLife", GD_TYPE_INT, 0, N_("Bonus life score"), CAVESET_OFFSET(bonus_life_score), 1, N_("Number of points to collect for a bonus life."), 100, 5000},
65 {"Story", GD_TYPE_LONGSTRING, 0, N_("Story"), CAVESET_OFFSET(story), 1, N_("Long description of the game.")},
66 {"Remark", GD_TYPE_LONGSTRING, 0, N_("Remark"), CAVESET_OFFSET(remark), 1, N_("Remark (informative).")},
68 {"TitleScreen", GD_TYPE_LONGSTRING, GD_DONT_SHOW_IN_EDITOR, N_("Title screen"), CAVESET_OFFSET(title_screen), 1, N_("Title screen image")},
69 {"TitleScreenScroll", GD_TYPE_LONGSTRING, GD_DONT_SHOW_IN_EDITOR, N_("Title screen, scrolling"), CAVESET_OFFSET(title_screen_scroll), 1, N_("Scrolling background for title screen image")},
74 static GdPropertyDefault caveset_defaults[] =
77 {CAVESET_OFFSET(initial_lives), 3},
78 {CAVESET_OFFSET(maximum_lives), 9},
79 {CAVESET_OFFSET(bonus_life_score), 500},
84 GdCavesetData *gd_caveset_data_new(void)
89 data = checked_calloc(sizeof(GdCavesetData));
92 for (i = 0; gd_caveset_properties[i].identifier != NULL; i++)
93 if (gd_caveset_properties[i].type == GD_TYPE_LONGSTRING)
94 G_STRUCT_MEMBER(GString *, data, gd_caveset_properties[i].offset) =
97 gd_struct_set_defaults_from_array(data, gd_caveset_properties, caveset_defaults);
102 void gd_caveset_data_free(GdCavesetData *data)
107 for (i = 0; gd_caveset_properties[i].identifier != NULL; i++)
108 if (gd_caveset_properties[i].type == GD_TYPE_LONGSTRING)
109 g_string_free(G_STRUCT_MEMBER(GString *, data, gd_caveset_properties[i].offset), TRUE);
114 /******************************************************************************
116 * Misc caveset functions
120 /** Clears all caves in the caveset. also to be called at application start */
121 void gd_caveset_clear(void)
125 g_list_foreach(gd_caveset, (GFunc) gd_cave_free, NULL);
126 g_list_free(gd_caveset);
132 free(gd_caveset_data);
133 gd_caveset_data = NULL;
136 /* always newly create this */
137 /* create pseudo cave containing default values */
138 gd_caveset_data = gd_caveset_data_new();
139 gd_strcpy(gd_caveset_data->name, _("New caveset"));
142 /* return number of caves currently in memory. */
143 int gd_caveset_count(void)
145 return g_list_length(gd_caveset);
148 /* return index of first selectable cave */
149 static int caveset_first_selectable_cave_index(void)
154 for (i = 0, iter = gd_caveset; iter != NULL; i++, iter = iter->next)
156 GdCave *cave = (GdCave *)iter->data;
158 if (cave->selectable)
162 Warn("no selectable cave in caveset!");
164 /* and return the first one. */
168 /* return a cave identified by its index */
169 GdCave *gd_return_nth_cave(const int cave)
171 return g_list_nth_data(gd_caveset, cave);
174 /* get a selected cave from the loaded caveset (original, unmodified cave) */
175 GdCave *gd_get_original_cave_from_caveset(const int cave)
177 /* get specified cave from caveset already stored in memory */
178 GdCave *original_cave = gd_return_nth_cave(cave);
180 return original_cave;
183 /* get a selected cave from the loaded caveset (cave prepared for playing) */
184 GdCave *gd_get_prepared_cave_from_caveset(const int cave, const int level)
186 /* get specified cave from caveset already stored in memory */
187 GdCave *original_cave = gd_return_nth_cave(cave);
189 /* get prepared cave from original cave */
190 GdCave *prepared_cave = gd_get_prepared_cave(original_cave, level);
192 return prepared_cave;
195 /* get a cave prepared for playing from a given original, unmodified cave (with seed) */
196 GdCave *gd_get_prepared_cave(const GdCave *original_cave, const int level)
198 /* get rendered cave using the selected seed for playing */
199 GdCave *prepared_cave = gd_cave_new_rendered(original_cave, level, game_bd.random_seed);
201 /* initialize some cave variables (like player position) */
202 gd_cave_setup_for_game(prepared_cave);
204 return prepared_cave;
207 /* colors: 4: purple 3: ciklamen 2: orange 1: blue 0: green */
208 static GdElement brc_import_table[] =
211 O_SPACE, O_DIRT, O_BRICK, O_MAGIC_WALL, O_PRE_OUTBOX, O_OUTBOX, O_UNKNOWN, O_STEEL,
212 O_H_EXPANDING_WALL, O_H_EXPANDING_WALL /* scanned */, O_FIREFLY_1 /* scanned */, O_FIREFLY_1 /* scanned */, O_FIREFLY_1, O_FIREFLY_2, O_FIREFLY_3, O_FIREFLY_4,
215 O_BUTTER_1 /* scanned */, O_BUTTER_1 /* scanned */, O_BUTTER_1, O_BUTTER_2, O_BUTTER_3, O_BUTTER_4, O_PLAYER, O_PLAYER /* scanned */,
216 O_STONE, O_STONE /* scanned */, O_STONE_F, O_STONE_F /* scanned */, O_DIAMOND, O_DIAMOND /* scanned */, O_DIAMOND_F, O_DIAMOND_F /* scanned */,
219 O_NONE /* WILL_EXPLODE_THING */, O_EXPLODE_1, O_EXPLODE_2, O_EXPLODE_3, O_EXPLODE_4, O_EXPLODE_5, O_NONE /* WILL EXPLODE TO DIAMOND_THING */, O_PRE_DIA_1,
220 O_PRE_DIA_2, O_PRE_DIA_3, O_PRE_DIA_4, O_PRE_DIA_5, O_AMOEBA, O_AMOEBA /* scanned */, O_SLIME, O_NONE,
223 O_CLOCK, O_NONE /* clock eaten */, O_INBOX, O_PRE_PL_1, O_PRE_PL_2, O_PRE_PL_3, O_NONE, O_NONE,
224 O_NONE, O_NONE, O_V_EXPANDING_WALL, O_NONE, O_VOODOO, O_UNKNOWN, O_EXPANDING_WALL, O_EXPANDING_WALL /* sc */,
227 O_FALLING_WALL, O_FALLING_WALL_F, O_FALLING_WALL_F /* scanned */, O_UNKNOWN, O_ACID, O_ACID /* scanned */, O_NITRO_PACK, O_NITRO_PACK /* scanned */,
228 O_NITRO_PACK_F, O_NITRO_PACK_F /* scanned */, O_NONE, O_NONE, O_NONE, O_NONE, O_NONE, O_NONE,
231 O_NONE /* bomb explosion utolso */, O_UNKNOWN, O_NONE /* solid bomb glued */, O_UNKNOWN, O_STONE_GLUED, O_UNKNOWN, O_DIAMOND_GLUED, O_UNKNOWN,
232 O_UNKNOWN, O_UNKNOWN, O_NONE, O_NONE, O_NONE, O_NONE, O_NONE, O_NONE,
235 O_ALT_FIREFLY_1 /* scanned */, O_ALT_FIREFLY_1 /* scanned */, O_ALT_FIREFLY_1, O_ALT_FIREFLY_2, O_ALT_FIREFLY_3, O_ALT_FIREFLY_4, O_PLAYER_BOMB, O_PLAYER_BOMB /* scanned */,
236 O_BOMB, O_BOMB_TICK_1, O_BOMB_TICK_2, O_BOMB_TICK_3, O_BOMB_TICK_4, O_BOMB_TICK_5, O_BOMB_TICK_6, O_BOMB_TICK_7,
239 O_BOMB_TICK_7, O_BOMB_EXPL_1, O_BOMB_EXPL_2, O_BOMB_EXPL_3, O_BOMB_EXPL_4, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN,
240 O_UNKNOWN, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN,
243 static GdElement brc_effect_table[] =
245 O_STEEL, O_DIRT, O_SPACE, O_STONE, O_STONE_F, O_STONE_GLUED, O_DIAMOND, O_DIAMOND_F, O_DIAMOND_GLUED, O_PRE_DIA_1,
246 O_PLAYER, O_PRE_PL_1, O_PLAYER_BOMB, O_PRE_OUTBOX, O_OUTBOX, O_FIREFLY_1, O_FIREFLY_2, O_FIREFLY_3, O_FIREFLY_4,
247 O_BUTTER_1, O_BUTTER_2, O_BUTTER_3, O_BUTTER_4, O_BRICK, O_MAGIC_WALL, O_H_EXPANDING_WALL, O_V_EXPANDING_WALL, O_EXPANDING_WALL,
248 O_FALLING_WALL, O_FALLING_WALL_F, O_AMOEBA, O_SLIME, O_ACID, O_VOODOO, O_CLOCK, O_BOMB, O_UNKNOWN, O_UNKNOWN, O_UNKNOWN,
249 O_ALT_FIREFLY_1, O_ALT_FIREFLY_2, O_ALT_FIREFLY_3, O_ALT_FIREFLY_4, O_ALT_BUTTER_1, O_ALT_BUTTER_2, O_ALT_BUTTER_3, O_ALT_BUTTER_4,
250 O_EXPLODE_1, O_BOMB_EXPL_1, O_UNKNOWN,
253 static GdColor brc_color_table[] =
255 0x518722, 0x3a96fa, 0xdb7618, 0xff3968,
256 0x9b5fff, 0x0ee06c, 0xc25ea6, 0xf54826,
260 static GdColor brc_color_table_comp[] =
262 0x582287, 0xfa9d39, 0x187ddb, 0x38ffd1,
263 0xc1ff5e, 0xe00d81, 0x5dc27a, 0x27d3f5,
267 static GdElement brc_effect(guint8 byt)
269 if (byt >= G_N_ELEMENTS(brc_effect_table))
271 Warn("invalid element identifier for brc effect: %02x", byt);
276 return brc_effect_table[byt];
279 static void brc_import(guint8 *data)
284 /* we import 100 caves, and the put them in the correct order. */
285 GdCave *imported[100];
286 boolean import_effect;
290 /* this is some kind of a version number */
291 import_effect = FALSE;
301 import_effect = TRUE;
305 Warn("unknown brc version %02x", data[23]);
309 for (level = 0; level < 5; level++)
314 for (cavenum = 0; cavenum < 20; cavenum++)
318 /* 5 levels, 20 caves, 24 bytes - max 40*2 properties for each cave */
321 int datapos = (cavenum * 5 +level) * 24 + 22;
324 cave = gd_cave_new();
325 imported[level * 20 + cavenum] = cave;
328 g_snprintf(cave->name, sizeof(GdString), "Cave %c/%d", 'A' + cavenum,
331 g_snprintf(cave->name, sizeof(GdString), "Intermission %d/%d",
332 cavenum - 15, level + 1);
334 /* fixed intermission caves; are smaller. */
341 cave->map = gd_cave_map_new(cave, GdElement);
343 for (y = 0; y < cave->h; y++)
345 for (x = 0; x < cave->w; x++)
349 import = data[y + level * 24 + cavenum * 24 * 5 + x * 24 * 5 * 20];
351 // if (i == printcave) g_print("%2x", import);
352 if (import < G_N_ELEMENTS(brc_import_table))
353 cave->map[y][x] = brc_import_table[import];
355 cave->map[y][x] = O_UNKNOWN;
359 for (i = 0; i < 5; i++)
361 cave->level_time[i] = data[0 * c + datapos];
362 cave->level_diamonds[i] = data[1 * c + datapos];
363 cave->level_magic_wall_time[i] = data[4 * c + datapos];
364 cave->level_amoeba_time[i] = data[5 * c + datapos];
365 cave->level_amoeba_threshold[i] = data[6 * c + datapos];
367 /* bonus time: 100 was added, so it could also be negative */
368 cave->level_bonus_time[i] = (int)data[11 * c + datapos + 1] - 100;
369 cave->level_hatching_delay_frame[i] = data[10 * c + datapos];
371 /* this was not set in boulder remake. */
372 cave->level_speed[i] = 150;
375 cave->diamond_value = data[2 * c + datapos];
376 cave->extra_diamond_value = data[3 * c +datapos];
378 /* BRC PROBABILITIES */
379 /* a typical code example:
380 46:if (random(slime*4)<4) and (tab[x,y+2] = 0) then
\r
381 Begin tab[x,y]:=0;col[x,y+2]:=col[x,y];tab[x,y+2]:=27;mat[x,y+2]:=9;Voice4:=2;end;
\r
382 where slime is the byte loaded from the file as it is.
383 pascal random function generates a random number between 0..limit-1, inclusive, for random(limit).
385 so a random number between 0..limit*4-1 is generated.
386 for limit=1, 0..3, which is always < 4, so P=1.
387 for limit=2, 0..7, 0..7 is < 4 in P=50%.
388 for limit=3, 0..11, is < 4 in P=33%.
389 So the probability is exactly 100%/limit.
390 just make sure we do not divide by zero for some broken input.
393 if (data[7 * c + datapos] == 0)
394 Warn("amoeba growth cannot be zero, error at byte %d",
395 data[7 * c + datapos]);
397 cave->amoeba_growth_prob = 1E6 / data[7 * c + datapos] + 0.5; /* 0.5 for rounding */
399 if (data[8 * c + datapos] == 0)
400 Warn("amoeba growth cannot be zero, error at byte %d",
401 data[8 * c + datapos]);
403 cave->amoeba_fast_growth_prob = 1E6 / data[8 * c + datapos] + 0.5; /* 0.5 for rounding */
405 cave->slime_predictable = FALSE;
407 for (i = 0; i < 5; i++)
408 cave->level_slime_permeability[i] = 1E6 / data[9 * c + datapos] + 0.5; /* 0.5 for rounding */
410 /* probability -> *1E6 */
411 cave->acid_spread_ratio = 1E6 / data[10 * c + datapos] + 0.5;
413 /* br only allowed values 1..8 in here, but works the same way. prob -> *1E6 */
414 cave->pushing_stone_prob = 1E6 / data[11 * c + datapos] + 0.5;
416 cave->magic_wall_stops_amoeba = (data[12 * c + datapos + 1] != 0);
417 cave->intermission = (cavenum >= 16 || data[14 * c + datapos + 1] != 0);
420 colind = data[31 * c + datapos] % G_N_ELEMENTS(brc_color_table);
421 cave->colorb = 0x000000; /* fixed rgb black */
422 cave->color0 = 0x000000; /* fixed rgb black */
423 cave->color1 = brc_color_table[colind];
424 cave->color2 = brc_color_table_comp[colind]; /* complement */
425 cave->color3 = 0xffffff; /* white for brick */
426 cave->color4 = 0xe5ad23; /* fixed for amoeba */
427 cave->color5 = 0x8af713; /* fixed for slime */
431 cave->amoeba_enclosed_effect = brc_effect(data[14 * c + datapos + 1]);
432 cave->amoeba_too_big_effect = brc_effect(data[15 * c + datapos + 1]);
433 cave->explosion_effect = brc_effect(data[16 * c + datapos + 1]);
434 cave->bomb_explosion_effect = brc_effect(data[17 * c + datapos + 1]);
436 /* 18 solid bomb explode to */
437 cave->diamond_birth_effect = brc_effect(data[19 * c + datapos + 1]);
438 cave->stone_bouncing_effect = brc_effect(data[20 * c + datapos + 1]);
439 cave->diamond_bouncing_effect = brc_effect(data[21 * c + datapos + 1]);
440 cave->magic_diamond_to = brc_effect(data[22 * c + datapos + 1]);
441 cave->acid_eats_this = brc_effect(data[23 * c + datapos + 1]);
444 (diamond,boulder,bomb),
448 cave->amoeba_enclosed_effect = brc_effect(data[14 * c + datapos + 1]);
453 /* put them in the caveset - take correct order into consideration. */
454 for (level = 0; level < 5; level++)
458 for (cavenum = 0; cavenum < 20; cavenum++)
460 static const int reorder[] =
462 0, 1, 2, 3, 16, 4, 5, 6, 7, 17, 8, 9, 10, 11, 18, 12, 13, 14, 15, 19
464 GdCave *cave = imported[level * 20 + reorder[cavenum]];
468 /* check if cave contains only dirt.
469 that is an empty cave, and do not import. */
472 for (y = 1; y < cave->h - 1 && only_dirt; y++)
473 for (x = 1; x < cave->w - 1 && only_dirt; x++)
474 if (cave->map[y][x] != O_DIRT)
477 /* append to caveset or forget it. */
479 gd_caveset = g_list_append(gd_caveset, cave);
486 static void caveset_name_set_from_filename(const char *filename)
491 /* make up a caveset name from the filename. */
492 name = g_path_get_basename(filename);
493 gd_strcpy(gd_caveset_data->name, name);
496 /* convert underscores to spaces */
497 while ((c = strchr (gd_caveset_data->name, '_')) != NULL)
500 /* remove extension */
501 if ((c = strrchr (gd_caveset_data->name, '.')) != NULL)
505 /* Load caveset from file.
506 Loads the caveset from a file.
508 File type is autodetected by extension.
509 param filename: Name of file.
510 result: FALSE if failed
512 boolean gd_caveset_load_from_file(char *filename)
514 GError *error = NULL;
521 if (g_stat(filename, &st) != 0)
523 Warn("cannot stat() file");
528 if (st.st_size > 1048576)
530 Warn("file bigger than 1MiB, refusing to load");
535 read = g_file_get_contents (filename, &buf, &length, &error);
538 Warn("%s", error->message);
545 if (strSuffix(filename, ".brc") ||
546 strSuffix(filename, ".BRC"))
548 /* loading a boulder remake file */
551 Warn("BRC files must be 96000 bytes long");
557 if (strSuffix(filename, ".brc") ||
558 strSuffix(filename, "*.BRC"))
560 brc_import((guint8 *) buf);
561 gd_caveset_edited = FALSE; /* newly loaded cave is not edited */
562 gd_caveset_last_selected = caveset_first_selectable_cave_index();
563 gd_caveset_last_selected_level = 0;
565 caveset_name_set_from_filename(filename);
571 if (gd_caveset_imported_get_format((guint8 *) buf) == GD_FORMAT_UNKNOWN)
573 /* try to load as bdcff */
576 /* bdcff: start another function */
577 result = gd_caveset_load_from_bdcff(buf);
579 /* newly loaded file is not edited. */
580 gd_caveset_edited = FALSE;
582 gd_caveset_last_selected = caveset_first_selectable_cave_index();
583 gd_caveset_last_selected_level = 0;
589 /* try to load as a binary file, as we know the format */
590 new_caveset = gd_caveset_import_from_buffer ((guint8 *) buf, length);
593 /* if unable to load, exit here. error was reported by import_from_buffer() */
597 /* no serious error :) */
599 /* only clear caveset here. if file read was unsuccessful, caveset remains in memory. */
602 gd_caveset = new_caveset;
604 /* newly loaded cave is not edited */
605 gd_caveset_edited = FALSE;
607 gd_caveset_last_selected = caveset_first_selectable_cave_index();
608 gd_caveset_last_selected_level = 0;
609 caveset_name_set_from_filename(filename);
614 int gd_cave_check_replays(GdCave *cave, boolean report, boolean remove, boolean repair)
619 riter = cave->replays;
620 while (riter != NULL)
622 GdReplay *replay = (GdReplay *)riter->data;
625 GList *next = riter->next;
627 rendered = gd_cave_new_rendered(cave, replay->level, replay->seed);
628 checksum = gd_cave_adler_checksum(rendered);
629 gd_cave_free(rendered);
631 replay->wrong_checksum = FALSE;
633 /* count wrong ones... the checksum might be changed later to "repair" */
634 if (replay->checksum != 0 && checksum != replay->checksum)
637 if (replay->checksum == 0 || repair)
639 /* if no checksum found, add one. or if repair requested, overwrite old one. */
640 replay->checksum = checksum;
644 /* if has a checksum, compare with this one. */
645 if (replay->checksum != checksum)
647 replay->wrong_checksum = TRUE;
650 Warn("%s: replay played by %s at %s has wrong checksum",
651 cave->name, replay->player_name, replay->date);
656 cave->replays = g_list_remove_link(cave->replays, riter);
657 gd_replay_free(replay);
662 /* advance to next list item which we remembered. the current one might have been deleted */
669 boolean gd_caveset_has_replays(void)
674 for (citer = gd_caveset; citer != NULL; citer = citer->next)
676 GdCave *cave = (GdCave *)citer->data;
682 /* if neither of the caves had a replay, */