1 /***********************************************************
2 * Rocks'n'Diamonds -- McDuffin Strikes Back! *
3 *----------------------------------------------------------*
4 * (c) 1995-2002 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
19 #include "libgame/libgame.h"
27 #define CHUNK_ID_LEN 4 /* IFF style chunk id length */
28 #define CHUNK_SIZE_UNDEFINED 0 /* undefined chunk size == 0 */
29 #define CHUNK_SIZE_NONE -1 /* do not write chunk size */
30 #define FILE_VERS_CHUNK_SIZE 8 /* size of file version chunk */
31 #define LEVEL_HEADER_SIZE 80 /* size of level file header */
32 #define LEVEL_HEADER_UNUSED 1 /* unused level header bytes */
33 #define LEVEL_CHUNK_CNT2_SIZE 160 /* size of level CNT2 chunk */
34 #define LEVEL_CHUNK_CNT2_UNUSED 11 /* unused CNT2 chunk bytes */
35 #define LEVEL_CHUNK_CNT3_HEADER 16 /* size of level CNT3 header */
36 #define LEVEL_CHUNK_CNT3_UNUSED 10 /* unused CNT3 chunk bytes */
37 #define LEVEL_CPART_CUS3_SIZE 134 /* size of CUS3 chunk part */
38 #define LEVEL_CPART_CUS3_UNUSED 15 /* unused CUS3 bytes / part */
39 #define LEVEL_CHUNK_GRP1_SIZE 74 /* size of level GRP1 chunk */
40 #define TAPE_HEADER_SIZE 20 /* size of tape file header */
41 #define TAPE_HEADER_UNUSED 3 /* unused tape header bytes */
43 #define LEVEL_CHUNK_CNT3_SIZE(x) (LEVEL_CHUNK_CNT3_HEADER + (x))
44 #define LEVEL_CHUNK_CUS3_SIZE(x) (2 + (x) * LEVEL_CPART_CUS3_SIZE)
45 #define LEVEL_CHUNK_CUS4_SIZE(x) (48 + 48 + (x) * 48)
47 /* file identifier strings */
48 #define LEVEL_COOKIE_TMPL "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
49 #define TAPE_COOKIE_TMPL "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
50 #define SCORE_COOKIE "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2"
52 /* values for level file type identifier */
53 #define LEVEL_FILE_TYPE_UNKNOWN 0
54 #define LEVEL_FILE_TYPE_RND 1
55 #define LEVEL_FILE_TYPE_BD 2
56 #define LEVEL_FILE_TYPE_EM 3
57 #define LEVEL_FILE_TYPE_SP 4
58 #define LEVEL_FILE_TYPE_DX 5
59 #define LEVEL_FILE_TYPE_SB 6
60 #define LEVEL_FILE_TYPE_DC 7
62 #define LEVEL_FILE_TYPE_RND_PACKED (10 + LEVEL_FILE_TYPE_RND)
63 #define LEVEL_FILE_TYPE_EM_PACKED (10 + LEVEL_FILE_TYPE_EM)
65 #define IS_SINGLE_LEVEL_FILE(x) (x < 10)
66 #define IS_PACKED_LEVEL_FILE(x) (x > 10)
69 /* ========================================================================= */
70 /* level file functions */
71 /* ========================================================================= */
73 void setElementChangePages(struct ElementInfo *ei, int change_pages)
75 int change_page_size = sizeof(struct ElementChangeInfo);
77 ei->num_change_pages = MAX(1, change_pages);
80 checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
82 if (ei->current_change_page >= ei->num_change_pages)
83 ei->current_change_page = ei->num_change_pages - 1;
85 ei->change = &ei->change_page[ei->current_change_page];
88 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
92 change->can_change = FALSE;
94 change->events = CE_BITMASK_DEFAULT;
96 change->trigger_player = CH_PLAYER_ANY;
97 change->trigger_side = CH_SIDE_ANY;
98 change->trigger_page = CH_PAGE_ANY;
100 change->target_element = EL_EMPTY_SPACE;
102 change->delay_fixed = 0;
103 change->delay_random = 0;
104 change->delay_frames = 1;
106 change->trigger_element = EL_EMPTY_SPACE;
108 change->explode = FALSE;
109 change->use_target_content = FALSE;
110 change->only_if_complete = FALSE;
111 change->use_random_replace = FALSE;
112 change->random_percentage = 100;
113 change->replace_when = CP_WHEN_EMPTY;
115 for (x = 0; x < 3; x++)
116 for (y = 0; y < 3; y++)
117 change->target_content[x][y] = EL_EMPTY_SPACE;
119 change->direct_action = 0;
120 change->other_action = 0;
122 change->pre_change_function = NULL;
123 change->change_function = NULL;
124 change->post_change_function = NULL;
127 static void setLevelInfoToDefaults(struct LevelInfo *level)
129 static boolean clipboard_elements_initialized = FALSE;
133 level->file_version = FILE_VERSION_ACTUAL;
134 level->game_version = GAME_VERSION_ACTUAL;
136 level->encoding_16bit_field = FALSE; /* default: only 8-bit elements */
137 level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
138 level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
140 level->fieldx = STD_LEV_FIELDX;
141 level->fieldy = STD_LEV_FIELDY;
143 for (x = 0; x < MAX_LEV_FIELDX; x++)
144 for (y = 0; y < MAX_LEV_FIELDY; y++)
145 level->field[x][y] = EL_SAND;
148 level->gems_needed = 0;
150 level->amoeba_speed = 10;
152 level->time_magic_wall = 10;
153 level->time_wheel = 10;
154 level->time_light = 10;
155 level->time_timegate = 10;
157 level->amoeba_content = EL_DIAMOND;
159 level->double_speed = FALSE;
160 level->initial_gravity = FALSE;
161 level->em_slippery_gems = FALSE;
162 level->block_last_field = FALSE;
163 level->sp_block_last_field = TRUE;
164 level->instant_relocation = FALSE;
165 level->can_pass_to_walkable = FALSE;
166 level->grow_into_diggable = TRUE;
168 level->can_move_into_acid_bits = ~0; /* everything can move into acid */
169 level->dont_collide_with_bits = ~0; /* always deadly when colliding */
171 level->use_spring_bug = FALSE;
172 level->use_step_counter = FALSE;
174 level->use_custom_template = FALSE;
176 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
177 level->name[i] = '\0';
178 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
179 level->author[i] = '\0';
181 strcpy(level->name, NAMELESS_LEVEL_NAME);
182 strcpy(level->author, ANONYMOUS_NAME);
184 for (i = 0; i < 4; i++)
186 level->envelope_text[i][0] = '\0';
187 level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
188 level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
191 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
192 level->score[i] = 10;
194 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
195 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
196 for (x = 0; x < 3; x++)
197 for (y = 0; y < 3; y++)
198 level->yamyam_content[i][x][y] =
199 (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
201 level->field[0][0] = EL_PLAYER_1;
202 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
204 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
208 /* never initialize clipboard elements after the very first time */
209 if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
212 setElementChangePages(&element_info[element], 1);
213 setElementChangeInfoToDefaults(element_info[element].change);
215 if (IS_CUSTOM_ELEMENT(element) ||
216 IS_GROUP_ELEMENT(element) ||
217 IS_INTERNAL_ELEMENT(element))
219 for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
220 element_info[element].description[j] = '\0';
222 if (element_info[element].custom_description != NULL)
223 strncpy(element_info[element].description,
224 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
226 strcpy(element_info[element].description,
227 element_info[element].editor_description);
229 element_info[element].use_gfx_element = FALSE;
230 element_info[element].gfx_element = EL_EMPTY_SPACE;
233 if (IS_CUSTOM_ELEMENT(element) ||
234 IS_INTERNAL_ELEMENT(element))
236 element_info[element].access_direction = MV_ALL_DIRECTIONS;
238 element_info[element].collect_score = 10; /* special default */
239 element_info[element].collect_count = 1; /* special default */
241 element_info[element].push_delay_fixed = -1; /* initialize later */
242 element_info[element].push_delay_random = -1; /* initialize later */
243 element_info[element].drop_delay_fixed = 0;
244 element_info[element].drop_delay_random = 0;
245 element_info[element].move_delay_fixed = 0;
246 element_info[element].move_delay_random = 0;
248 element_info[element].move_pattern = MV_ALL_DIRECTIONS;
249 element_info[element].move_direction_initial = MV_START_AUTOMATIC;
250 element_info[element].move_stepsize = TILEX / 8;
251 element_info[element].move_enter_element = EL_EMPTY_SPACE;
252 element_info[element].move_leave_element = EL_EMPTY_SPACE;
253 element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
255 element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
257 element_info[element].explosion_delay = 16;
258 element_info[element].ignition_delay = 8;
260 for (x = 0; x < 3; x++)
261 for (y = 0; y < 3; y++)
262 element_info[element].content[x][y] = EL_EMPTY_SPACE;
264 element_info[element].access_type = 0;
265 element_info[element].access_layer = 0;
266 element_info[element].access_protected = 0;
267 element_info[element].walk_to_action = 0;
268 element_info[element].smash_targets = 0;
269 element_info[element].deadliness = 0;
270 element_info[element].consistency = 0;
272 element_info[element].can_explode_by_fire = FALSE;
273 element_info[element].can_explode_smashed = FALSE;
274 element_info[element].can_explode_impact = FALSE;
276 element_info[element].current_change_page = 0;
278 /* start with no properties at all */
279 for (j = 0; j < NUM_EP_BITFIELDS; j++)
280 Properties[element][j] = EP_BITMASK_DEFAULT;
282 /* now set default properties */
283 SET_PROPERTY(element, EP_CAN_MOVE_INTO_ACID, TRUE);
285 element_info[element].modified_settings = FALSE;
288 if (IS_GROUP_ELEMENT(element) ||
289 IS_INTERNAL_ELEMENT(element))
291 /* initialize memory for list of elements in group */
292 if (element_info[element].group == NULL)
293 element_info[element].group =
294 checked_malloc(sizeof(struct ElementGroupInfo));
296 for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
297 element_info[element].group->element[j] = EL_EMPTY_SPACE;
299 /* default: only one element in group */
300 element_info[element].group->num_elements = 1;
302 element_info[element].group->choice_mode = ANIM_RANDOM;
306 clipboard_elements_initialized = TRUE;
308 BorderElement = EL_STEELWALL;
310 level->no_valid_file = FALSE;
312 if (leveldir_current == NULL) /* only when dumping level */
315 /* try to determine better author name than 'anonymous' */
316 if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
318 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
319 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
323 switch (LEVELCLASS(leveldir_current))
325 case LEVELCLASS_TUTORIAL:
326 strcpy(level->author, PROGRAM_AUTHOR_STRING);
329 case LEVELCLASS_CONTRIB:
330 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
331 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
334 case LEVELCLASS_PRIVATE:
335 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
336 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
340 /* keep default value */
346 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
348 level_file_info->nr = 0;
349 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
350 level_file_info->packed = FALSE;
351 level_file_info->basename = NULL;
352 level_file_info->filename = NULL;
355 static void ActivateLevelTemplate()
357 /* Currently there is no special action needed to activate the template
358 data, because 'element_info' and 'Properties' overwrite the original
359 level data, while all other variables do not change. */
362 static char *getLevelFilenameFromBasename(char *basename)
364 static char *filename = NULL;
366 checked_free(filename);
368 filename = getPath2(getCurrentLevelDir(), basename);
373 static int getFileTypeFromBasename(char *basename)
375 static char *filename = NULL;
376 struct stat file_status;
378 /* ---------- try to determine file type from filename ---------- */
380 /* check for typical filename of a Supaplex level package file */
381 if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
382 strncmp(basename, "LEVELS.D", 8) == 0))
383 return LEVEL_FILE_TYPE_SP;
385 /* ---------- try to determine file type from filesize ---------- */
387 checked_free(filename);
388 filename = getPath2(getCurrentLevelDir(), basename);
390 if (stat(filename, &file_status) == 0)
392 /* check for typical filesize of a Supaplex level package file */
393 if (file_status.st_size == 170496)
394 return LEVEL_FILE_TYPE_SP;
397 return LEVEL_FILE_TYPE_UNKNOWN;
400 static char *getSingleLevelBasename(int nr, int type)
402 static char basename[MAX_FILENAME_LEN];
403 char *level_filename = getStringCopy(leveldir_current->level_filename);
405 if (level_filename == NULL)
406 level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
410 case LEVEL_FILE_TYPE_RND:
412 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
414 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
417 case LEVEL_FILE_TYPE_EM:
418 sprintf(basename, "%d", nr);
421 case LEVEL_FILE_TYPE_UNKNOWN:
423 sprintf(basename, level_filename, nr);
427 free(level_filename);
432 static char *getPackedLevelBasename(int type)
434 static char basename[MAX_FILENAME_LEN];
435 char *directory = getCurrentLevelDir();
437 struct dirent *dir_entry;
439 strcpy(basename, UNDEFINED_FILENAME); /* default: undefined file */
441 if ((dir = opendir(directory)) == NULL)
443 Error(ERR_WARN, "cannot read current level directory '%s'", directory);
448 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
450 char *entry_basename = dir_entry->d_name;
451 int entry_type = getFileTypeFromBasename(entry_basename);
453 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) /* found valid level package */
455 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
458 strcpy(basename, entry_basename);
470 static char *getSingleLevelFilename(int nr, int type)
472 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
476 static char *getPackedLevelFilename(int type)
478 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
482 char *getDefaultLevelFilename(int nr)
484 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
487 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
492 lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
493 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
496 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
501 lfi->basename = getPackedLevelBasename(lfi->type);
502 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
505 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
507 /* special case: level number is negative => check for level template file */
510 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
515 if (leveldir_current->level_filename != NULL)
517 /* check for file name/pattern specified in "levelinfo.conf" */
518 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
519 if (fileExists(lfi->filename))
523 /* check for native Rocks'n'Diamonds level file */
524 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
525 if (fileExists(lfi->filename))
528 /* check for classic Emerald Mine level file */
529 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
530 if (fileExists(lfi->filename))
533 /* check for various packed level file formats */
534 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
535 if (fileExists(lfi->filename))
538 /* no known level file found -- try to use default values */
539 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
542 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
544 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
545 lfi->type = getFileTypeFromBasename(lfi->basename);
548 static struct LevelFileInfo *getLevelFileInfo(int nr)
550 static struct LevelFileInfo level_file_info;
552 /* always start with reliable default values */
553 setFileInfoToDefaults(&level_file_info);
555 level_file_info.nr = nr; /* set requested level number */
557 determineLevelFileInfo_Filename(&level_file_info);
558 determineLevelFileInfo_Filetype(&level_file_info);
560 return &level_file_info;
564 /* ------------------------------------------------------------------------- */
565 /* functions for loading R'n'D level */
566 /* ------------------------------------------------------------------------- */
568 int getMappedElement(int element)
570 /* remap some (historic, now obsolete) elements */
575 case EL_PLAYER_OBSOLETE:
576 element = EL_PLAYER_1;
579 case EL_KEY_OBSOLETE:
582 case EL_EM_KEY_1_FILE_OBSOLETE:
583 element = EL_EM_KEY_1;
586 case EL_EM_KEY_2_FILE_OBSOLETE:
587 element = EL_EM_KEY_2;
590 case EL_EM_KEY_3_FILE_OBSOLETE:
591 element = EL_EM_KEY_3;
594 case EL_EM_KEY_4_FILE_OBSOLETE:
595 element = EL_EM_KEY_4;
598 case EL_ENVELOPE_OBSOLETE:
599 element = EL_ENVELOPE_1;
607 if (element >= NUM_FILE_ELEMENTS)
609 Error(ERR_WARN, "invalid level element %d", element);
611 element = EL_UNKNOWN;
616 if (element >= NUM_FILE_ELEMENTS)
618 Error(ERR_WARN, "invalid level element %d", element);
620 element = EL_UNKNOWN;
622 else if (element == EL_PLAYER_OBSOLETE)
623 element = EL_PLAYER_1;
624 else if (element == EL_KEY_OBSOLETE)
631 int getMappedElementByVersion(int element, int game_version)
633 /* remap some elements due to certain game version */
635 if (game_version <= VERSION_IDENT(2,2,0,0))
637 /* map game font elements */
638 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
639 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
640 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
641 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
644 if (game_version < VERSION_IDENT(3,0,0,0))
646 /* map Supaplex gravity tube elements */
647 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
648 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
649 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
650 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
657 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
659 level->file_version = getFileVersion(file);
660 level->game_version = getFileVersion(file);
665 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
669 level->fieldx = getFile8Bit(file);
670 level->fieldy = getFile8Bit(file);
672 level->time = getFile16BitBE(file);
673 level->gems_needed = getFile16BitBE(file);
675 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
676 level->name[i] = getFile8Bit(file);
677 level->name[MAX_LEVEL_NAME_LEN] = 0;
679 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
680 level->score[i] = getFile8Bit(file);
682 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
683 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
684 for (y = 0; y < 3; y++)
685 for (x = 0; x < 3; x++)
686 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
688 level->amoeba_speed = getFile8Bit(file);
689 level->time_magic_wall = getFile8Bit(file);
690 level->time_wheel = getFile8Bit(file);
691 level->amoeba_content = getMappedElement(getFile8Bit(file));
692 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
693 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
694 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
695 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
697 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
699 level->block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
700 level->sp_block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
701 level->can_move_into_acid_bits = getFile32BitBE(file);
702 level->dont_collide_with_bits = getFile8Bit(file);
704 level->use_spring_bug = (getFile8Bit(file) == 1 ? TRUE : FALSE);
705 level->use_step_counter = (getFile8Bit(file) == 1 ? TRUE : FALSE);
707 level->instant_relocation = (getFile8Bit(file) == 1 ? TRUE : FALSE);
708 level->can_pass_to_walkable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
709 level->grow_into_diggable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
711 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
716 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
720 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
721 level->author[i] = getFile8Bit(file);
722 level->author[MAX_LEVEL_NAME_LEN] = 0;
727 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
730 int chunk_size_expected = level->fieldx * level->fieldy;
732 /* Note: "chunk_size" was wrong before version 2.0 when elements are
733 stored with 16-bit encoding (and should be twice as big then).
734 Even worse, playfield data was stored 16-bit when only yamyam content
735 contained 16-bit elements and vice versa. */
737 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
738 chunk_size_expected *= 2;
740 if (chunk_size_expected != chunk_size)
742 ReadUnusedBytesFromFile(file, chunk_size);
743 return chunk_size_expected;
746 for (y = 0; y < level->fieldy; y++)
747 for (x = 0; x < level->fieldx; x++)
749 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
754 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
758 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
759 int chunk_size_expected = header_size + content_size;
761 /* Note: "chunk_size" was wrong before version 2.0 when elements are
762 stored with 16-bit encoding (and should be twice as big then).
763 Even worse, playfield data was stored 16-bit when only yamyam content
764 contained 16-bit elements and vice versa. */
766 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
767 chunk_size_expected += content_size;
769 if (chunk_size_expected != chunk_size)
771 ReadUnusedBytesFromFile(file, chunk_size);
772 return chunk_size_expected;
776 level->num_yamyam_contents = getFile8Bit(file);
780 /* correct invalid number of content fields -- should never happen */
781 if (level->num_yamyam_contents < 1 ||
782 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
783 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
785 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
786 for (y = 0; y < 3; y++)
787 for (x = 0; x < 3; x++)
788 level->yamyam_content[i][x][y] =
789 getMappedElement(level->encoding_16bit_field ?
790 getFile16BitBE(file) : getFile8Bit(file));
794 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
798 int num_contents, content_xsize, content_ysize;
799 int content_array[MAX_ELEMENT_CONTENTS][3][3];
801 element = getMappedElement(getFile16BitBE(file));
802 num_contents = getFile8Bit(file);
803 content_xsize = getFile8Bit(file);
804 content_ysize = getFile8Bit(file);
806 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
808 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
809 for (y = 0; y < 3; y++)
810 for (x = 0; x < 3; x++)
811 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
813 /* correct invalid number of content fields -- should never happen */
814 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
815 num_contents = STD_ELEMENT_CONTENTS;
817 if (element == EL_YAMYAM)
819 level->num_yamyam_contents = num_contents;
821 for (i = 0; i < num_contents; i++)
822 for (y = 0; y < 3; y++)
823 for (x = 0; x < 3; x++)
824 level->yamyam_content[i][x][y] = content_array[i][x][y];
826 else if (element == EL_BD_AMOEBA)
828 level->amoeba_content = content_array[0][0][0];
832 Error(ERR_WARN, "cannot load content for element '%d'", element);
838 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
844 int chunk_size_expected;
846 element = getMappedElement(getFile16BitBE(file));
847 if (!IS_ENVELOPE(element))
848 element = EL_ENVELOPE_1;
850 envelope_nr = element - EL_ENVELOPE_1;
852 envelope_len = getFile16BitBE(file);
854 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
855 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
857 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
859 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
860 if (chunk_size_expected != chunk_size)
862 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
863 return chunk_size_expected;
866 for (i = 0; i < envelope_len; i++)
867 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
872 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
874 int num_changed_custom_elements = getFile16BitBE(file);
875 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
878 if (chunk_size_expected != chunk_size)
880 ReadUnusedBytesFromFile(file, chunk_size - 2);
881 return chunk_size_expected;
884 for (i = 0; i < num_changed_custom_elements; i++)
886 int element = getFile16BitBE(file);
887 int properties = getFile32BitBE(file);
889 if (IS_CUSTOM_ELEMENT(element))
890 Properties[element][EP_BITFIELD_BASE] = properties;
892 Error(ERR_WARN, "invalid custom element number %d", element);
898 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
900 int num_changed_custom_elements = getFile16BitBE(file);
901 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
904 if (chunk_size_expected != chunk_size)
906 ReadUnusedBytesFromFile(file, chunk_size - 2);
907 return chunk_size_expected;
910 for (i = 0; i < num_changed_custom_elements; i++)
912 int element = getFile16BitBE(file);
913 int custom_target_element = getFile16BitBE(file);
915 if (IS_CUSTOM_ELEMENT(element))
916 element_info[element].change->target_element = custom_target_element;
918 Error(ERR_WARN, "invalid custom element number %d", element);
924 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
926 int num_changed_custom_elements = getFile16BitBE(file);
927 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
930 if (chunk_size_expected != chunk_size)
932 ReadUnusedBytesFromFile(file, chunk_size - 2);
933 return chunk_size_expected;
936 for (i = 0; i < num_changed_custom_elements; i++)
938 int element = getFile16BitBE(file);
940 if (!IS_CUSTOM_ELEMENT(element))
942 Error(ERR_WARN, "invalid custom element number %d", element);
944 element = EL_INTERNAL_DUMMY;
947 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
948 element_info[element].description[j] = getFile8Bit(file);
949 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
951 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
953 /* some free bytes for future properties and padding */
954 ReadUnusedBytesFromFile(file, 7);
956 element_info[element].use_gfx_element = getFile8Bit(file);
957 element_info[element].gfx_element =
958 getMappedElement(getFile16BitBE(file));
960 element_info[element].collect_score = getFile8Bit(file);
961 element_info[element].collect_count = getFile8Bit(file);
963 element_info[element].push_delay_fixed = getFile16BitBE(file);
964 element_info[element].push_delay_random = getFile16BitBE(file);
965 element_info[element].move_delay_fixed = getFile16BitBE(file);
966 element_info[element].move_delay_random = getFile16BitBE(file);
968 element_info[element].move_pattern = getFile16BitBE(file);
969 element_info[element].move_direction_initial = getFile8Bit(file);
970 element_info[element].move_stepsize = getFile8Bit(file);
972 for (y = 0; y < 3; y++)
973 for (x = 0; x < 3; x++)
974 element_info[element].content[x][y] =
975 getMappedElement(getFile16BitBE(file));
977 element_info[element].change->events = getFile32BitBE(file);
979 element_info[element].change->target_element =
980 getMappedElement(getFile16BitBE(file));
982 element_info[element].change->delay_fixed = getFile16BitBE(file);
983 element_info[element].change->delay_random = getFile16BitBE(file);
984 element_info[element].change->delay_frames = getFile16BitBE(file);
986 element_info[element].change->trigger_element =
987 getMappedElement(getFile16BitBE(file));
989 element_info[element].change->explode = getFile8Bit(file);
990 element_info[element].change->use_target_content = getFile8Bit(file);
991 element_info[element].change->only_if_complete = getFile8Bit(file);
992 element_info[element].change->use_random_replace = getFile8Bit(file);
994 element_info[element].change->random_percentage = getFile8Bit(file);
995 element_info[element].change->replace_when = getFile8Bit(file);
997 for (y = 0; y < 3; y++)
998 for (x = 0; x < 3; x++)
999 element_info[element].change->target_content[x][y] =
1000 getMappedElement(getFile16BitBE(file));
1002 element_info[element].slippery_type = getFile8Bit(file);
1004 /* some free bytes for future properties and padding */
1005 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
1007 /* mark that this custom element has been modified */
1008 element_info[element].modified_settings = TRUE;
1014 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
1016 struct ElementInfo *ei;
1017 int chunk_size_expected;
1021 element = getFile16BitBE(file);
1023 if (!IS_CUSTOM_ELEMENT(element))
1025 Error(ERR_WARN, "invalid custom element number %d", element);
1027 ReadUnusedBytesFromFile(file, chunk_size - 2);
1031 ei = &element_info[element];
1033 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1034 ei->description[i] = getFile8Bit(file);
1035 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1037 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
1038 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
1040 ei->num_change_pages = getFile8Bit(file);
1042 /* some free bytes for future base property values and padding */
1043 ReadUnusedBytesFromFile(file, 5);
1045 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
1046 if (chunk_size_expected != chunk_size)
1048 ReadUnusedBytesFromFile(file, chunk_size - 48);
1049 return chunk_size_expected;
1052 /* read custom property values */
1054 ei->use_gfx_element = getFile8Bit(file);
1055 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1057 ei->collect_score = getFile8Bit(file);
1058 ei->collect_count = getFile8Bit(file);
1060 ei->drop_delay_fixed = getFile8Bit(file);
1061 ei->push_delay_fixed = getFile8Bit(file);
1062 ei->drop_delay_random = getFile8Bit(file);
1063 ei->push_delay_random = getFile8Bit(file);
1064 ei->move_delay_fixed = getFile16BitBE(file);
1065 ei->move_delay_random = getFile16BitBE(file);
1067 /* bits 0 - 15 of "move_pattern" ... */
1068 ei->move_pattern = getFile16BitBE(file);
1069 ei->move_direction_initial = getFile8Bit(file);
1070 ei->move_stepsize = getFile8Bit(file);
1072 ei->slippery_type = getFile8Bit(file);
1074 for (y = 0; y < 3; y++)
1075 for (x = 0; x < 3; x++)
1076 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
1078 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
1079 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
1080 ei->move_leave_type = getFile8Bit(file);
1082 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
1083 ei->move_pattern |= (getFile16BitBE(file) << 16);
1085 ei->access_direction = getFile8Bit(file);
1087 ei->explosion_delay = getFile8Bit(file);
1088 ei->ignition_delay = getFile8Bit(file);
1090 /* some free bytes for future custom property values and padding */
1091 ReadUnusedBytesFromFile(file, 2);
1093 /* read change property values */
1095 setElementChangePages(ei, ei->num_change_pages);
1097 for (i = 0; i < ei->num_change_pages; i++)
1099 struct ElementChangeInfo *change = &ei->change_page[i];
1101 /* always start with reliable default values */
1102 setElementChangeInfoToDefaults(change);
1104 change->events = getFile32BitBE(file);
1106 change->target_element = getMappedElement(getFile16BitBE(file));
1108 change->delay_fixed = getFile16BitBE(file);
1109 change->delay_random = getFile16BitBE(file);
1110 change->delay_frames = getFile16BitBE(file);
1112 change->trigger_element = getMappedElement(getFile16BitBE(file));
1114 change->explode = getFile8Bit(file);
1115 change->use_target_content = getFile8Bit(file);
1116 change->only_if_complete = getFile8Bit(file);
1117 change->use_random_replace = getFile8Bit(file);
1119 change->random_percentage = getFile8Bit(file);
1120 change->replace_when = getFile8Bit(file);
1122 for (y = 0; y < 3; y++)
1123 for (x = 0; x < 3; x++)
1124 change->target_content[x][y] = getMappedElement(getFile16BitBE(file));
1126 change->can_change = getFile8Bit(file);
1128 change->trigger_side = getFile8Bit(file);
1131 change->trigger_player = getFile8Bit(file);
1132 change->trigger_page = getFile8Bit(file);
1134 change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
1135 CH_PAGE_ANY : (1 << change->trigger_page));
1137 /* some free bytes for future change property values and padding */
1138 ReadUnusedBytesFromFile(file, 6);
1142 /* some free bytes for future change property values and padding */
1143 ReadUnusedBytesFromFile(file, 8);
1147 /* mark this custom element as modified */
1148 ei->modified_settings = TRUE;
1153 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1155 struct ElementInfo *ei;
1156 struct ElementGroupInfo *group;
1160 element = getFile16BitBE(file);
1162 if (!IS_GROUP_ELEMENT(element))
1164 Error(ERR_WARN, "invalid group element number %d", element);
1166 ReadUnusedBytesFromFile(file, chunk_size - 2);
1170 ei = &element_info[element];
1172 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1173 ei->description[i] = getFile8Bit(file);
1174 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1176 group = element_info[element].group;
1178 group->num_elements = getFile8Bit(file);
1180 ei->use_gfx_element = getFile8Bit(file);
1181 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1183 group->choice_mode = getFile8Bit(file);
1185 /* some free bytes for future values and padding */
1186 ReadUnusedBytesFromFile(file, 3);
1188 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1189 group->element[i] = getMappedElement(getFile16BitBE(file));
1191 /* mark this group element as modified */
1192 element_info[element].modified_settings = TRUE;
1197 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1198 struct LevelFileInfo *level_file_info)
1200 char *filename = level_file_info->filename;
1201 char cookie[MAX_LINE_LEN];
1202 char chunk_name[CHUNK_ID_LEN + 1];
1206 if (!(file = fopen(filename, MODE_READ)))
1208 level->no_valid_file = TRUE;
1210 if (level != &level_template)
1211 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1216 getFileChunkBE(file, chunk_name, NULL);
1217 if (strcmp(chunk_name, "RND1") == 0)
1219 getFile32BitBE(file); /* not used */
1221 getFileChunkBE(file, chunk_name, NULL);
1222 if (strcmp(chunk_name, "CAVE") != 0)
1224 level->no_valid_file = TRUE;
1226 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1231 else /* check for pre-2.0 file format with cookie string */
1233 strcpy(cookie, chunk_name);
1234 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1235 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1236 cookie[strlen(cookie) - 1] = '\0';
1238 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1240 level->no_valid_file = TRUE;
1242 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1247 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1249 level->no_valid_file = TRUE;
1251 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1256 /* pre-2.0 level files have no game version, so use file version here */
1257 level->game_version = level->file_version;
1260 if (level->file_version < FILE_VERSION_1_2)
1262 /* level files from versions before 1.2.0 without chunk structure */
1263 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1264 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1272 int (*loader)(FILE *, int, struct LevelInfo *);
1276 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1277 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1278 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1279 { "BODY", -1, LoadLevel_BODY },
1280 { "CONT", -1, LoadLevel_CONT },
1281 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1282 { "CNT3", -1, LoadLevel_CNT3 },
1283 { "CUS1", -1, LoadLevel_CUS1 },
1284 { "CUS2", -1, LoadLevel_CUS2 },
1285 { "CUS3", -1, LoadLevel_CUS3 },
1286 { "CUS4", -1, LoadLevel_CUS4 },
1287 { "GRP1", -1, LoadLevel_GRP1 },
1291 while (getFileChunkBE(file, chunk_name, &chunk_size))
1295 while (chunk_info[i].name != NULL &&
1296 strcmp(chunk_name, chunk_info[i].name) != 0)
1299 if (chunk_info[i].name == NULL)
1301 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1302 chunk_name, filename);
1303 ReadUnusedBytesFromFile(file, chunk_size);
1305 else if (chunk_info[i].size != -1 &&
1306 chunk_info[i].size != chunk_size)
1308 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1309 chunk_size, chunk_name, filename);
1310 ReadUnusedBytesFromFile(file, chunk_size);
1314 /* call function to load this level chunk */
1315 int chunk_size_expected =
1316 (chunk_info[i].loader)(file, chunk_size, level);
1318 /* the size of some chunks cannot be checked before reading other
1319 chunks first (like "HEAD" and "BODY") that contain some header
1320 information, so check them here */
1321 if (chunk_size_expected != chunk_size)
1323 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1324 chunk_size, chunk_name, filename);
1333 /* ------------------------------------------------------------------------- */
1334 /* functions for loading EM level */
1335 /* ------------------------------------------------------------------------- */
1337 static int map_em_element_yam(int element)
1341 case 0x00: return EL_EMPTY;
1342 case 0x01: return EL_EMERALD;
1343 case 0x02: return EL_DIAMOND;
1344 case 0x03: return EL_ROCK;
1345 case 0x04: return EL_ROBOT;
1346 case 0x05: return EL_SPACESHIP_UP;
1347 case 0x06: return EL_BOMB;
1348 case 0x07: return EL_BUG_UP;
1349 case 0x08: return EL_AMOEBA_DROP;
1350 case 0x09: return EL_NUT;
1351 case 0x0a: return EL_YAMYAM;
1352 case 0x0b: return EL_QUICKSAND_FULL;
1353 case 0x0c: return EL_SAND;
1354 case 0x0d: return EL_WALL_SLIPPERY;
1355 case 0x0e: return EL_STEELWALL;
1356 case 0x0f: return EL_WALL;
1357 case 0x10: return EL_EM_KEY_1;
1358 case 0x11: return EL_EM_KEY_2;
1359 case 0x12: return EL_EM_KEY_4;
1360 case 0x13: return EL_EM_KEY_3;
1361 case 0x14: return EL_MAGIC_WALL;
1362 case 0x15: return EL_ROBOT_WHEEL;
1363 case 0x16: return EL_DYNAMITE;
1365 case 0x17: return EL_EM_KEY_1; /* EMC */
1366 case 0x18: return EL_BUG_UP; /* EMC */
1367 case 0x1a: return EL_DIAMOND; /* EMC */
1368 case 0x1b: return EL_EMERALD; /* EMC */
1369 case 0x25: return EL_NUT; /* EMC */
1370 case 0x80: return EL_EMPTY; /* EMC */
1371 case 0x85: return EL_EM_KEY_1; /* EMC */
1372 case 0x86: return EL_EM_KEY_2; /* EMC */
1373 case 0x87: return EL_EM_KEY_4; /* EMC */
1374 case 0x88: return EL_EM_KEY_3; /* EMC */
1375 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1376 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1377 case 0xaf: return EL_DYNAMITE; /* EMC */
1378 case 0xbd: return EL_SAND; /* EMC */
1381 Error(ERR_WARN, "invalid level element %d", element);
1386 static int map_em_element_field(int element)
1388 if (element >= 0xc8 && element <= 0xe1)
1389 return EL_CHAR_A + (element - 0xc8);
1390 else if (element >= 0xe2 && element <= 0xeb)
1391 return EL_CHAR_0 + (element - 0xe2);
1395 case 0x00: return EL_ROCK;
1396 case 0x01: return EL_ROCK; /* EMC */
1397 case 0x02: return EL_DIAMOND;
1398 case 0x03: return EL_DIAMOND;
1399 case 0x04: return EL_ROBOT;
1400 case 0x05: return EL_ROBOT; /* EMC */
1401 case 0x06: return EL_EMPTY_SPACE; /* EMC */
1402 case 0x07: return EL_EMPTY_SPACE; /* EMC */
1403 case 0x08: return EL_SPACESHIP_UP;
1404 case 0x09: return EL_SPACESHIP_RIGHT;
1405 case 0x0a: return EL_SPACESHIP_DOWN;
1406 case 0x0b: return EL_SPACESHIP_LEFT;
1407 case 0x0c: return EL_SPACESHIP_UP;
1408 case 0x0d: return EL_SPACESHIP_RIGHT;
1409 case 0x0e: return EL_SPACESHIP_DOWN;
1410 case 0x0f: return EL_SPACESHIP_LEFT;
1412 case 0x10: return EL_BOMB;
1413 case 0x11: return EL_BOMB; /* EMC */
1414 case 0x12: return EL_EMERALD;
1415 case 0x13: return EL_EMERALD;
1416 case 0x14: return EL_BUG_UP;
1417 case 0x15: return EL_BUG_RIGHT;
1418 case 0x16: return EL_BUG_DOWN;
1419 case 0x17: return EL_BUG_LEFT;
1420 case 0x18: return EL_BUG_UP;
1421 case 0x19: return EL_BUG_RIGHT;
1422 case 0x1a: return EL_BUG_DOWN;
1423 case 0x1b: return EL_BUG_LEFT;
1424 case 0x1c: return EL_AMOEBA_DROP;
1425 case 0x1d: return EL_AMOEBA_DROP; /* EMC */
1426 case 0x1e: return EL_AMOEBA_DROP; /* EMC */
1427 case 0x1f: return EL_AMOEBA_DROP; /* EMC */
1429 case 0x20: return EL_ROCK;
1430 case 0x21: return EL_BOMB; /* EMC */
1431 case 0x22: return EL_DIAMOND; /* EMC */
1432 case 0x23: return EL_EMERALD; /* EMC */
1433 case 0x24: return EL_MAGIC_WALL;
1434 case 0x25: return EL_NUT;
1435 case 0x26: return EL_NUT; /* EMC */
1436 case 0x27: return EL_NUT; /* EMC */
1438 /* looks like magic wheel, but is _always_ activated */
1439 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1441 case 0x29: return EL_YAMYAM; /* up */
1442 case 0x2a: return EL_YAMYAM; /* down */
1443 case 0x2b: return EL_YAMYAM; /* left */ /* EMC */
1444 case 0x2c: return EL_YAMYAM; /* right */ /* EMC */
1445 case 0x2d: return EL_QUICKSAND_FULL;
1446 case 0x2e: return EL_EMPTY_SPACE; /* EMC */
1447 case 0x2f: return EL_EMPTY_SPACE; /* EMC */
1449 case 0x30: return EL_EMPTY_SPACE; /* EMC */
1450 case 0x31: return EL_SAND; /* EMC */
1451 case 0x32: return EL_SAND; /* EMC */
1452 case 0x33: return EL_SAND; /* EMC */
1453 case 0x34: return EL_QUICKSAND_FULL; /* EMC */
1454 case 0x35: return EL_QUICKSAND_FULL; /* EMC */
1455 case 0x36: return EL_QUICKSAND_FULL; /* EMC */
1456 case 0x37: return EL_SAND; /* EMC */
1457 case 0x38: return EL_ROCK; /* EMC */
1458 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1459 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1460 case 0x3b: return EL_DYNAMITE_ACTIVE; /* 1 */
1461 case 0x3c: return EL_DYNAMITE_ACTIVE; /* 2 */
1462 case 0x3d: return EL_DYNAMITE_ACTIVE; /* 3 */
1463 case 0x3e: return EL_DYNAMITE_ACTIVE; /* 4 */
1464 case 0x3f: return EL_ACID_POOL_BOTTOM;
1466 case 0x40: return EL_EXIT_OPEN; /* 1 */
1467 case 0x41: return EL_EXIT_OPEN; /* 2 */
1468 case 0x42: return EL_EXIT_OPEN; /* 3 */
1469 case 0x43: return EL_BALLOON; /* EMC */
1470 case 0x44: return EL_UNKNOWN; /* EMC ("plant") */
1471 case 0x45: return EL_SPRING; /* EMC */
1472 case 0x46: return EL_SPRING; /* falling */ /* EMC */
1473 case 0x47: return EL_SPRING; /* left */ /* EMC */
1474 case 0x48: return EL_SPRING; /* right */ /* EMC */
1475 case 0x49: return EL_UNKNOWN; /* EMC ("ball 1") */
1476 case 0x4a: return EL_UNKNOWN; /* EMC ("ball 2") */
1477 case 0x4b: return EL_UNKNOWN; /* EMC ("android") */
1478 case 0x4c: return EL_EMPTY_SPACE; /* EMC */
1479 case 0x4d: return EL_UNKNOWN; /* EMC ("android") */
1480 case 0x4e: return EL_INVISIBLE_WALL; /* EMC (? "android") */
1481 case 0x4f: return EL_UNKNOWN; /* EMC ("android") */
1483 case 0x50: return EL_UNKNOWN; /* EMC ("android") */
1484 case 0x51: return EL_UNKNOWN; /* EMC ("android") */
1485 case 0x52: return EL_UNKNOWN; /* EMC ("android") */
1486 case 0x53: return EL_UNKNOWN; /* EMC ("android") */
1487 case 0x54: return EL_UNKNOWN; /* EMC ("android") */
1488 case 0x55: return EL_EMPTY_SPACE; /* EMC */
1489 case 0x56: return EL_EMPTY_SPACE; /* EMC */
1490 case 0x57: return EL_EMPTY_SPACE; /* EMC */
1491 case 0x58: return EL_EMPTY_SPACE; /* EMC */
1492 case 0x59: return EL_EMPTY_SPACE; /* EMC */
1493 case 0x5a: return EL_EMPTY_SPACE; /* EMC */
1494 case 0x5b: return EL_EMPTY_SPACE; /* EMC */
1495 case 0x5c: return EL_EMPTY_SPACE; /* EMC */
1496 case 0x5d: return EL_EMPTY_SPACE; /* EMC */
1497 case 0x5e: return EL_EMPTY_SPACE; /* EMC */
1498 case 0x5f: return EL_EMPTY_SPACE; /* EMC */
1500 case 0x60: return EL_EMPTY_SPACE; /* EMC */
1501 case 0x61: return EL_EMPTY_SPACE; /* EMC */
1502 case 0x62: return EL_EMPTY_SPACE; /* EMC */
1503 case 0x63: return EL_SPRING; /* left */ /* EMC */
1504 case 0x64: return EL_SPRING; /* right */ /* EMC */
1505 case 0x65: return EL_ACID; /* 1 */ /* EMC */
1506 case 0x66: return EL_ACID; /* 2 */ /* EMC */
1507 case 0x67: return EL_ACID; /* 3 */ /* EMC */
1508 case 0x68: return EL_ACID; /* 4 */ /* EMC */
1509 case 0x69: return EL_ACID; /* 5 */ /* EMC */
1510 case 0x6a: return EL_ACID; /* 6 */ /* EMC */
1511 case 0x6b: return EL_ACID; /* 7 */ /* EMC */
1512 case 0x6c: return EL_ACID; /* 8 */ /* EMC */
1513 case 0x6d: return EL_EMPTY_SPACE; /* EMC */
1514 case 0x6e: return EL_EMPTY_SPACE; /* EMC */
1515 case 0x6f: return EL_EMPTY_SPACE; /* EMC */
1517 case 0x70: return EL_EMPTY_SPACE; /* EMC */
1518 case 0x71: return EL_EMPTY_SPACE; /* EMC */
1519 case 0x72: return EL_NUT; /* left */ /* EMC */
1520 case 0x73: return EL_SAND; /* EMC (? "nut") */
1521 case 0x74: return EL_STEELWALL;
1522 case 0x75: return EL_EMPTY_SPACE; /* EMC */
1523 case 0x76: return EL_EMPTY_SPACE; /* EMC */
1524 case 0x77: return EL_BOMB; /* left */ /* EMC */
1525 case 0x78: return EL_BOMB; /* right */ /* EMC */
1526 case 0x79: return EL_ROCK; /* left */ /* EMC */
1527 case 0x7a: return EL_ROCK; /* right */ /* EMC */
1528 case 0x7b: return EL_ACID; /* (? EMC "blank") */
1529 case 0x7c: return EL_EMPTY_SPACE; /* EMC */
1530 case 0x7d: return EL_EMPTY_SPACE; /* EMC */
1531 case 0x7e: return EL_EMPTY_SPACE; /* EMC */
1532 case 0x7f: return EL_EMPTY_SPACE; /* EMC */
1534 case 0x80: return EL_EMPTY;
1535 case 0x81: return EL_WALL_SLIPPERY;
1536 case 0x82: return EL_SAND;
1537 case 0x83: return EL_STEELWALL;
1538 case 0x84: return EL_WALL;
1539 case 0x85: return EL_EM_KEY_1;
1540 case 0x86: return EL_EM_KEY_2;
1541 case 0x87: return EL_EM_KEY_4;
1542 case 0x88: return EL_EM_KEY_3;
1543 case 0x89: return EL_EM_GATE_1;
1544 case 0x8a: return EL_EM_GATE_2;
1545 case 0x8b: return EL_EM_GATE_4;
1546 case 0x8c: return EL_EM_GATE_3;
1547 case 0x8d: return EL_INVISIBLE_WALL; /* EMC (? "dripper") */
1548 case 0x8e: return EL_EM_GATE_1_GRAY;
1549 case 0x8f: return EL_EM_GATE_2_GRAY;
1551 case 0x90: return EL_EM_GATE_4_GRAY;
1552 case 0x91: return EL_EM_GATE_3_GRAY;
1553 case 0x92: return EL_MAGIC_WALL;
1554 case 0x93: return EL_ROBOT_WHEEL;
1555 case 0x94: return EL_QUICKSAND_EMPTY; /* (? EMC "sand") */
1556 case 0x95: return EL_ACID_POOL_TOPLEFT;
1557 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1558 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1559 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1560 case 0x99: return EL_ACID; /* (? EMC "fake blank") */
1561 case 0x9a: return EL_AMOEBA_DEAD; /* 1 */
1562 case 0x9b: return EL_AMOEBA_DEAD; /* 2 */
1563 case 0x9c: return EL_AMOEBA_DEAD; /* 3 */
1564 case 0x9d: return EL_AMOEBA_DEAD; /* 4 */
1565 case 0x9e: return EL_EXIT_CLOSED;
1566 case 0x9f: return EL_CHAR_LESS; /* arrow left */
1568 /* looks like normal sand, but behaves like wall */
1569 case 0xa0: return EL_UNKNOWN; /* EMC ("fake grass") */
1570 case 0xa1: return EL_UNKNOWN; /* EMC ("lenses") */
1571 case 0xa2: return EL_UNKNOWN; /* EMC ("magnify") */
1572 case 0xa3: return EL_UNKNOWN; /* EMC ("fake blank") */
1573 case 0xa4: return EL_UNKNOWN; /* EMC ("fake grass") */
1574 case 0xa5: return EL_UNKNOWN; /* EMC ("switch") */
1575 case 0xa6: return EL_UNKNOWN; /* EMC ("switch") */
1576 case 0xa7: return EL_EMPTY_SPACE; /* EMC */
1577 case 0xa8: return EL_EMC_WALL_1; /* EMC ("decor 8") */
1578 case 0xa9: return EL_EMC_WALL_2; /* EMC ("decor 9") */
1579 case 0xaa: return EL_EMC_WALL_3; /* EMC ("decor 10") */
1580 case 0xab: return EL_EMC_WALL_7; /* EMC ("decor 5") */
1581 case 0xac: return EL_CHAR_COMMA; /* EMC */
1582 case 0xad: return EL_CHAR_QUOTEDBL; /* EMC */
1583 case 0xae: return EL_CHAR_MINUS; /* EMC */
1584 case 0xaf: return EL_DYNAMITE;
1586 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC ("steel 3") */
1587 case 0xb1: return EL_EMC_WALL_8; /* EMC ("decor 6") */
1588 case 0xb2: return EL_UNKNOWN; /* EMC ("decor 7") */
1589 case 0xb3: return EL_STEELWALL; /* 2 */ /* EMC */
1590 case 0xb4: return EL_WALL_SLIPPERY; /* 2 */ /* EMC */
1591 case 0xb5: return EL_EMC_WALL_6; /* EMC ("decor 2") */
1592 case 0xb6: return EL_EMC_WALL_5; /* EMC ("decor 4") */
1593 case 0xb7: return EL_EMC_WALL_4; /* EMC ("decor 3") */
1594 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1595 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1596 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1597 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1598 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1599 case 0xbd: return EL_SAND; /* EMC ("dirt") */
1600 case 0xbe: return EL_UNKNOWN; /* EMC ("plant") */
1601 case 0xbf: return EL_UNKNOWN; /* EMC ("key 5") */
1603 case 0xc0: return EL_UNKNOWN; /* EMC ("key 6") */
1604 case 0xc1: return EL_UNKNOWN; /* EMC ("key 7") */
1605 case 0xc2: return EL_UNKNOWN; /* EMC ("key 8") */
1606 case 0xc3: return EL_UNKNOWN; /* EMC ("door 5") */
1607 case 0xc4: return EL_UNKNOWN; /* EMC ("door 6") */
1608 case 0xc5: return EL_UNKNOWN; /* EMC ("door 7") */
1609 case 0xc6: return EL_UNKNOWN; /* EMC ("door 8") */
1610 case 0xc7: return EL_UNKNOWN; /* EMC ("bumper") */
1612 /* characters: see above */
1614 case 0xec: return EL_CHAR_PERIOD;
1615 case 0xed: return EL_CHAR_EXCLAM;
1616 case 0xee: return EL_CHAR_COLON;
1617 case 0xef: return EL_CHAR_QUESTION;
1619 case 0xf0: return EL_CHAR_GREATER; /* arrow right */
1620 case 0xf1: return EL_CHAR_COPYRIGHT; /* EMC: "decor 1" */
1621 case 0xf2: return EL_UNKNOWN; /* EMC ("fake door 5") */
1622 case 0xf3: return EL_UNKNOWN; /* EMC ("fake door 6") */
1623 case 0xf4: return EL_UNKNOWN; /* EMC ("fake door 7") */
1624 case 0xf5: return EL_UNKNOWN; /* EMC ("fake door 8") */
1625 case 0xf6: return EL_EMPTY_SPACE; /* EMC */
1626 case 0xf7: return EL_EMPTY_SPACE; /* EMC */
1628 case 0xf8: return EL_EMPTY_SPACE; /* EMC */
1629 case 0xf9: return EL_EMPTY_SPACE; /* EMC */
1630 case 0xfa: return EL_EMPTY_SPACE; /* EMC */
1631 case 0xfb: return EL_EMPTY_SPACE; /* EMC */
1632 case 0xfc: return EL_EMPTY_SPACE; /* EMC */
1633 case 0xfd: return EL_EMPTY_SPACE; /* EMC */
1635 case 0xfe: return EL_PLAYER_1; /* EMC: "blank" */
1636 case 0xff: return EL_PLAYER_2; /* EMC: "blank" */
1639 /* should never happen (all 8-bit value cases should be handled) */
1640 Error(ERR_WARN, "invalid level element %d", element);
1645 #define EM_LEVEL_SIZE 2106
1646 #define EM_LEVEL_XSIZE 64
1647 #define EM_LEVEL_YSIZE 32
1649 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1650 struct LevelFileInfo *level_file_info)
1652 char *filename = level_file_info->filename;
1654 unsigned char leveldata[EM_LEVEL_SIZE];
1655 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1656 unsigned char code0 = 0x65;
1657 unsigned char code1 = 0x11;
1658 boolean level_is_crypted = FALSE;
1659 int nr = level_file_info->nr;
1662 if (!(file = fopen(filename, MODE_READ)))
1664 level->no_valid_file = TRUE;
1666 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1671 for(i = 0; i < EM_LEVEL_SIZE; i++)
1672 leveldata[i] = fgetc(file);
1676 /* check if level data is crypted by testing against known starting bytes
1677 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1679 if ((leveldata[0] == 0xf1 ||
1680 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1682 level_is_crypted = TRUE;
1684 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1685 leveldata[0] = 0xf1;
1688 if (level_is_crypted) /* decode crypted level data */
1690 for(i = 0; i < EM_LEVEL_SIZE; i++)
1692 leveldata[i] ^= code0;
1693 leveldata[i] -= code1;
1695 code0 = (code0 + 7) & 0xff;
1699 level->fieldx = EM_LEVEL_XSIZE;
1700 level->fieldy = EM_LEVEL_YSIZE;
1702 level->time = header[46] * 10;
1703 level->gems_needed = header[47];
1705 /* The original Emerald Mine levels have their level number stored
1706 at the second byte of the level file...
1707 Do not trust this information at other level files, e.g. EMC,
1708 but correct it anyway (normally the first row is completely
1709 steel wall, so the correction does not hurt anyway). */
1711 if (leveldata[1] == nr)
1712 leveldata[1] = leveldata[2]; /* correct level number field */
1714 sprintf(level->name, "Level %d", nr); /* set level name */
1716 level->score[SC_EMERALD] = header[36];
1717 level->score[SC_DIAMOND] = header[37];
1718 level->score[SC_ROBOT] = header[38];
1719 level->score[SC_SPACESHIP] = header[39];
1720 level->score[SC_BUG] = header[40];
1721 level->score[SC_YAMYAM] = header[41];
1722 level->score[SC_NUT] = header[42];
1723 level->score[SC_DYNAMITE] = header[43];
1724 level->score[SC_TIME_BONUS] = header[44];
1726 level->num_yamyam_contents = 4;
1728 for(i = 0; i < level->num_yamyam_contents; i++)
1729 for(y = 0; y < 3; y++)
1730 for(x = 0; x < 3; x++)
1731 level->yamyam_content[i][x][y] =
1732 map_em_element_yam(header[i * 9 + y * 3 + x]);
1734 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1735 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1736 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1737 level->amoeba_content = EL_DIAMOND;
1739 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1741 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1743 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1744 new_element = EL_AMOEBA_WET;
1746 level->field[x][y] = new_element;
1749 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1750 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1751 level->field[x][y] = EL_PLAYER_1;
1753 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1754 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1755 level->field[x][y] = EL_PLAYER_2;
1758 /* ------------------------------------------------------------------------- */
1759 /* functions for loading SP level */
1760 /* ------------------------------------------------------------------------- */
1762 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1763 #define SP_LEVEL_SIZE 1536
1764 #define SP_LEVEL_XSIZE 60
1765 #define SP_LEVEL_YSIZE 24
1766 #define SP_LEVEL_NAME_LEN 23
1768 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1773 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1774 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1776 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1778 int element_old = fgetc(file);
1781 if (element_old <= 0x27)
1782 element_new = getMappedElement(EL_SP_START + element_old);
1783 else if (element_old == 0x28)
1784 element_new = EL_INVISIBLE_WALL;
1787 Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1788 Error(ERR_WARN, "invalid level element %d", element_old);
1790 element_new = EL_UNKNOWN;
1793 level->field[x][y] = element_new;
1797 ReadUnusedBytesFromFile(file, 4);
1799 /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1800 level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1802 ReadUnusedBytesFromFile(file, 1);
1804 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1805 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1806 level->name[i] = fgetc(file);
1807 level->name[SP_LEVEL_NAME_LEN] = '\0';
1809 /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1810 ReadUnusedBytesFromFile(file, 1); /* !!! NOT SUPPORTED YET !!! */
1812 /* number of infotrons needed; 0 means that Supaplex will count the total
1813 amount of infotrons in the level and use the low byte of that number.
1814 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1815 level->gems_needed = fgetc(file);
1817 /* information about special gravity port entries */
1818 ReadUnusedBytesFromFile(file, 65); /* !!! NOT SUPPORTED YET !!! */
1820 level->fieldx = SP_LEVEL_XSIZE;
1821 level->fieldy = SP_LEVEL_YSIZE;
1823 level->time = 0; /* no time limit */
1824 level->amoeba_speed = 0;
1825 level->time_magic_wall = 0;
1826 level->time_wheel = 0;
1827 level->amoeba_content = EL_EMPTY;
1829 for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1830 level->score[i] = 0; /* !!! CORRECT THIS !!! */
1832 /* there are no yamyams in supaplex levels */
1833 for(i = 0; i < level->num_yamyam_contents; i++)
1834 for(y = 0; y < 3; y++)
1835 for(x = 0; x < 3; x++)
1836 level->yamyam_content[i][x][y] = EL_EMPTY;
1839 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1840 struct LevelFileInfo *level_file_info)
1842 char *filename = level_file_info->filename;
1844 int nr = level_file_info->nr - leveldir_current->first_level;
1846 char name_first, name_last;
1847 struct LevelInfo multipart_level;
1848 int multipart_xpos, multipart_ypos;
1849 boolean is_multipart_level;
1850 boolean is_first_part;
1851 boolean reading_multipart_level = FALSE;
1852 boolean use_empty_level = FALSE;
1854 if (!(file = fopen(filename, MODE_READ)))
1856 level->no_valid_file = TRUE;
1858 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1863 /* position file stream to the requested level inside the level package */
1864 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1866 level->no_valid_file = TRUE;
1868 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1873 /* there exist Supaplex level package files with multi-part levels which
1874 can be detected as follows: instead of leading and trailing dashes ('-')
1875 to pad the level name, they have leading and trailing numbers which are
1876 the x and y coordinations of the current part of the multi-part level;
1877 if there are '?' characters instead of numbers on the left or right side
1878 of the level name, the multi-part level consists of only horizontal or
1881 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1883 LoadLevelFromFileStream_SP(file, level, l);
1885 /* check if this level is a part of a bigger multi-part level */
1887 name_first = level->name[0];
1888 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
1890 is_multipart_level =
1891 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1892 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
1895 ((name_first == '?' || name_first == '1') &&
1896 (name_last == '?' || name_last == '1'));
1898 /* correct leading multipart level meta information in level name */
1899 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1900 level->name[i] = '-';
1902 /* correct trailing multipart level meta information in level name */
1903 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1904 level->name[i] = '-';
1906 /* ---------- check for normal single level ---------- */
1908 if (!reading_multipart_level && !is_multipart_level)
1910 /* the current level is simply a normal single-part level, and we are
1911 not reading a multi-part level yet, so return the level as it is */
1916 /* ---------- check for empty level (unused multi-part) ---------- */
1918 if (!reading_multipart_level && is_multipart_level && !is_first_part)
1920 /* this is a part of a multi-part level, but not the first part
1921 (and we are not already reading parts of a multi-part level);
1922 in this case, use an empty level instead of the single part */
1924 use_empty_level = TRUE;
1929 /* ---------- check for finished multi-part level ---------- */
1931 if (reading_multipart_level &&
1932 (!is_multipart_level ||
1933 strcmp(level->name, multipart_level.name) != 0))
1935 /* we are already reading parts of a multi-part level, but this level is
1936 either not a multi-part level, or a part of a different multi-part
1937 level; in both cases, the multi-part level seems to be complete */
1942 /* ---------- here we have one part of a multi-part level ---------- */
1944 reading_multipart_level = TRUE;
1946 if (is_first_part) /* start with first part of new multi-part level */
1948 /* copy level info structure from first part */
1949 multipart_level = *level;
1951 /* clear playfield of new multi-part level */
1952 for (y = 0; y < MAX_LEV_FIELDY; y++)
1953 for (x = 0; x < MAX_LEV_FIELDX; x++)
1954 multipart_level.field[x][y] = EL_EMPTY;
1957 if (name_first == '?')
1959 if (name_last == '?')
1962 multipart_xpos = (int)(name_first - '0');
1963 multipart_ypos = (int)(name_last - '0');
1966 printf("----------> part (%d/%d) of multi-part level '%s'\n",
1967 multipart_xpos, multipart_ypos, multipart_level.name);
1970 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1971 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1973 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1978 multipart_level.fieldx = MAX(multipart_level.fieldx,
1979 multipart_xpos * SP_LEVEL_XSIZE);
1980 multipart_level.fieldy = MAX(multipart_level.fieldy,
1981 multipart_ypos * SP_LEVEL_YSIZE);
1983 /* copy level part at the right position of multi-part level */
1984 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1986 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1988 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1989 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1991 multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
1998 if (use_empty_level)
2000 setLevelInfoToDefaults(level);
2002 level->fieldx = SP_LEVEL_XSIZE;
2003 level->fieldy = SP_LEVEL_YSIZE;
2005 for (y = 0; y < SP_LEVEL_YSIZE; y++)
2006 for (x = 0; x < SP_LEVEL_XSIZE; x++)
2007 level->field[x][y] = EL_EMPTY;
2009 strcpy(level->name, "-------- EMPTY --------");
2011 Error(ERR_WARN, "single part of multi-part level -- using empty level");
2014 if (reading_multipart_level)
2015 *level = multipart_level;
2018 /* ------------------------------------------------------------------------- */
2019 /* functions for loading generic level */
2020 /* ------------------------------------------------------------------------- */
2022 void LoadLevelFromFileInfo(struct LevelInfo *level,
2023 struct LevelFileInfo *level_file_info)
2025 /* always start with reliable default values */
2026 setLevelInfoToDefaults(level);
2028 switch (level_file_info->type)
2030 case LEVEL_FILE_TYPE_RND:
2031 LoadLevelFromFileInfo_RND(level, level_file_info);
2034 case LEVEL_FILE_TYPE_EM:
2035 LoadLevelFromFileInfo_EM(level, level_file_info);
2038 case LEVEL_FILE_TYPE_SP:
2039 LoadLevelFromFileInfo_SP(level, level_file_info);
2043 LoadLevelFromFileInfo_RND(level, level_file_info);
2048 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
2050 static struct LevelFileInfo level_file_info;
2052 /* always start with reliable default values */
2053 setFileInfoToDefaults(&level_file_info);
2055 level_file_info.nr = 0; /* unknown level number */
2056 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
2057 level_file_info.filename = filename;
2059 LoadLevelFromFileInfo(level, &level_file_info);
2062 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
2064 if (leveldir_current == NULL) /* only when dumping level */
2068 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
2071 /* determine correct game engine version of current level */
2073 if (!leveldir_current->latest_engine)
2075 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
2076 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
2077 IS_LEVELCLASS_UNDEFINED(leveldir_current))
2081 printf("\n::: This level is private or contributed: '%s'\n", filename);
2085 printf("\n::: Use the stored game engine version for this level\n");
2088 /* For all levels which are not forced to use the latest game engine
2089 version (normally user contributed, private and undefined levels),
2090 use the version of the game engine the levels were created for.
2092 Since 2.0.1, the game engine version is now directly stored
2093 in the level file (chunk "VERS"), so there is no need anymore
2094 to set the game version from the file version (except for old,
2095 pre-2.0 levels, where the game version is still taken from the
2096 file format version used to store the level -- see above). */
2099 /* player was faster than enemies in 1.0.0 and before */
2100 if (level->file_version == FILE_VERSION_1_0)
2101 level->double_speed = TRUE;
2103 /* do some special adjustments to support older level versions */
2104 if (level->file_version == FILE_VERSION_1_0)
2106 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2107 Error(ERR_WARN, "using high speed movement for player");
2109 /* player was faster than monsters in (pre-)1.0 levels */
2110 level->double_speed = TRUE;
2114 /* default behaviour for EM style gems was "slippery" only in 2.0.1 */
2115 if (level->game_version == VERSION_IDENT(2,0,1,0))
2116 level->em_slippery_gems = TRUE;
2118 if (level->game_version < VERSION_IDENT(2,2,0,0))
2119 level->use_spring_bug = TRUE;
2121 if (level->game_version < VERSION_IDENT(3,1,0,0))
2125 level->can_move_into_acid_bits = 0; /* nothing can move into acid */
2126 level->dont_collide_with_bits = 0; /* nothing is deadly when colliding */
2128 setMoveIntoAcidProperty(level, EL_ROBOT, TRUE);
2129 setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
2130 setMoveIntoAcidProperty(level, EL_PENGUIN, TRUE);
2131 setMoveIntoAcidProperty(level, EL_BALLOON, TRUE);
2133 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2134 SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
2136 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2138 int element = EL_CUSTOM_START + i;
2139 struct ElementInfo *ei = &element_info[element];
2141 for (j = 0; j < ei->num_change_pages; j++)
2143 struct ElementChangeInfo *change = &ei->change_page[j];
2145 change->trigger_player = CH_PLAYER_ANY;
2146 change->trigger_page = CH_PAGE_ANY;
2154 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2155 leveldir_current->sort_priority, filename);
2159 printf("\n::: Use latest game engine version for this level.\n");
2162 /* For all levels which are forced to use the latest game engine version
2163 (normally all but user contributed, private and undefined levels), set
2164 the game engine version to the actual version; this allows for actual
2165 corrections in the game engine to take effect for existing, converted
2166 levels (from "classic" or other existing games) to make the emulation
2167 of the corresponding game more accurate, while (hopefully) not breaking
2168 existing levels created from other players. */
2171 printf("::: changing engine from %d to %d\n",
2172 level->game_version, GAME_VERSION_ACTUAL);
2175 level->game_version = GAME_VERSION_ACTUAL;
2177 /* Set special EM style gems behaviour: EM style gems slip down from
2178 normal, steel and growing wall. As this is a more fundamental change,
2179 it seems better to set the default behaviour to "off" (as it is more
2180 natural) and make it configurable in the level editor (as a property
2181 of gem style elements). Already existing converted levels (neither
2182 private nor contributed levels) are changed to the new behaviour. */
2184 if (level->file_version < FILE_VERSION_2_0)
2185 level->em_slippery_gems = TRUE;
2189 printf("::: => %d\n", level->game_version);
2193 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2197 /* map custom element change events that have changed in newer versions
2198 (these following values were accidentally changed in version 3.0.1) */
2199 if (level->game_version <= VERSION_IDENT(3,0,0,0))
2201 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2203 int element = EL_CUSTOM_START + i;
2205 /* order of checking and copying events to be mapped is important */
2206 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2208 if (HAS_CHANGE_EVENT(element, j - 2))
2210 SET_CHANGE_EVENT(element, j - 2, FALSE);
2211 SET_CHANGE_EVENT(element, j, TRUE);
2215 /* order of checking and copying events to be mapped is important */
2216 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2218 if (HAS_CHANGE_EVENT(element, j - 1))
2220 SET_CHANGE_EVENT(element, j - 1, FALSE);
2221 SET_CHANGE_EVENT(element, j, TRUE);
2227 /* some custom element change events get mapped since version 3.0.3 */
2228 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2230 int element = EL_CUSTOM_START + i;
2232 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2233 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2235 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2236 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2238 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2242 /* initialize "can_change" field for old levels with only one change page */
2243 if (level->game_version <= VERSION_IDENT(3,0,2,0))
2245 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2247 int element = EL_CUSTOM_START + i;
2249 if (CAN_CHANGE(element))
2250 element_info[element].change->can_change = TRUE;
2254 /* correct custom element values (for old levels without these options) */
2255 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2257 int element = EL_CUSTOM_START + i;
2258 struct ElementInfo *ei = &element_info[element];
2260 if (ei->access_direction == MV_NO_MOVING)
2261 ei->access_direction = MV_ALL_DIRECTIONS;
2263 for (j = 0; j < ei->num_change_pages; j++)
2265 struct ElementChangeInfo *change = &ei->change_page[j];
2267 if (change->trigger_side == CH_SIDE_NONE)
2268 change->trigger_side = CH_SIDE_ANY;
2273 /* set default push delay values (corrected since version 3.0.7-1) */
2274 if (level->game_version < VERSION_IDENT(3,0,7,1))
2276 game.default_push_delay_fixed = 2;
2277 game.default_push_delay_random = 8;
2281 game.default_push_delay_fixed = 8;
2282 game.default_push_delay_random = 8;
2285 /* set uninitialized push delay values of custom elements in older levels */
2286 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2288 int element = EL_CUSTOM_START + i;
2290 if (element_info[element].push_delay_fixed == -1)
2291 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2292 if (element_info[element].push_delay_random == -1)
2293 element_info[element].push_delay_random = game.default_push_delay_random;
2297 /* map elements that have changed in newer versions */
2298 level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
2299 level->game_version);
2300 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2301 for (x = 0; x < 3; x++)
2302 for (y = 0; y < 3; y++)
2303 level->yamyam_content[i][x][y] =
2304 getMappedElementByVersion(level->yamyam_content[i][x][y],
2305 level->game_version);
2307 /* initialize element properties for level editor etc. */
2308 InitElementPropertiesEngine(level->game_version);
2311 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2315 /* map elements that have changed in newer versions */
2316 for (y = 0; y < level->fieldy; y++)
2318 for (x = 0; x < level->fieldx; x++)
2320 int element = level->field[x][y];
2323 element = getMappedElementByVersion(element, level->game_version);
2325 if (level->game_version <= VERSION_IDENT(2,2,0,0))
2327 /* map game font elements */
2328 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2329 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2330 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2331 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2334 if (level->game_version < VERSION_IDENT(3,0,0,0))
2336 /* map Supaplex gravity tube elements */
2337 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2338 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2339 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2340 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2345 level->field[x][y] = element;
2349 /* copy elements to runtime playfield array */
2350 for (x = 0; x < MAX_LEV_FIELDX; x++)
2351 for (y = 0; y < MAX_LEV_FIELDY; y++)
2352 Feld[x][y] = level->field[x][y];
2354 /* initialize level size variables for faster access */
2355 lev_fieldx = level->fieldx;
2356 lev_fieldy = level->fieldy;
2358 /* determine border element for this level */
2362 void LoadLevelTemplate(int nr)
2365 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2366 char *filename = level_file_info->filename;
2368 LoadLevelFromFileInfo(&level_template, level_file_info);
2370 char *filename = getDefaultLevelFilename(nr);
2372 LoadLevelFromFilename_RND(&level_template, filename);
2375 LoadLevel_InitVersion(&level, filename);
2376 LoadLevel_InitElements(&level, filename);
2378 ActivateLevelTemplate();
2381 void LoadLevel(int nr)
2384 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2385 char *filename = level_file_info->filename;
2387 LoadLevelFromFileInfo(&level, level_file_info);
2389 char *filename = getLevelFilename(nr);
2391 LoadLevelFromFilename_RND(&level, filename);
2394 if (level.use_custom_template)
2395 LoadLevelTemplate(-1);
2398 LoadLevel_InitVersion(&level, filename);
2399 LoadLevel_InitElements(&level, filename);
2400 LoadLevel_InitPlayfield(&level, filename);
2402 LoadLevel_InitLevel(&level, filename);
2406 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2408 putFileVersion(file, level->file_version);
2409 putFileVersion(file, level->game_version);
2412 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2416 putFile8Bit(file, level->fieldx);
2417 putFile8Bit(file, level->fieldy);
2419 putFile16BitBE(file, level->time);
2420 putFile16BitBE(file, level->gems_needed);
2422 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2423 putFile8Bit(file, level->name[i]);
2425 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2426 putFile8Bit(file, level->score[i]);
2428 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2429 for (y = 0; y < 3; y++)
2430 for (x = 0; x < 3; x++)
2431 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2432 level->yamyam_content[i][x][y]));
2433 putFile8Bit(file, level->amoeba_speed);
2434 putFile8Bit(file, level->time_magic_wall);
2435 putFile8Bit(file, level->time_wheel);
2436 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2437 level->amoeba_content));
2438 putFile8Bit(file, (level->double_speed ? 1 : 0));
2439 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2440 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2441 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2443 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2445 putFile8Bit(file, (level->block_last_field ? 1 : 0));
2446 putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2447 putFile32BitBE(file, level->can_move_into_acid_bits);
2448 putFile8Bit(file, level->dont_collide_with_bits);
2450 putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2451 putFile8Bit(file, (level->use_step_counter ? 1 : 0));
2453 putFile8Bit(file, (level->instant_relocation ? 1 : 0));
2454 putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
2455 putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
2457 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2460 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2464 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2465 putFile8Bit(file, level->author[i]);
2468 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2472 for (y = 0; y < level->fieldy; y++)
2473 for (x = 0; x < level->fieldx; x++)
2474 if (level->encoding_16bit_field)
2475 putFile16BitBE(file, level->field[x][y]);
2477 putFile8Bit(file, level->field[x][y]);
2481 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2485 putFile8Bit(file, EL_YAMYAM);
2486 putFile8Bit(file, level->num_yamyam_contents);
2487 putFile8Bit(file, 0);
2488 putFile8Bit(file, 0);
2490 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2491 for (y = 0; y < 3; y++)
2492 for (x = 0; x < 3; x++)
2493 if (level->encoding_16bit_field)
2494 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2496 putFile8Bit(file, level->yamyam_content[i][x][y]);
2500 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2503 int num_contents, content_xsize, content_ysize;
2504 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2506 if (element == EL_YAMYAM)
2508 num_contents = level->num_yamyam_contents;
2512 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2513 for (y = 0; y < 3; y++)
2514 for (x = 0; x < 3; x++)
2515 content_array[i][x][y] = level->yamyam_content[i][x][y];
2517 else if (element == EL_BD_AMOEBA)
2523 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2524 for (y = 0; y < 3; y++)
2525 for (x = 0; x < 3; x++)
2526 content_array[i][x][y] = EL_EMPTY;
2527 content_array[0][0][0] = level->amoeba_content;
2531 /* chunk header already written -- write empty chunk data */
2532 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2534 Error(ERR_WARN, "cannot save content for element '%d'", element);
2538 putFile16BitBE(file, element);
2539 putFile8Bit(file, num_contents);
2540 putFile8Bit(file, content_xsize);
2541 putFile8Bit(file, content_ysize);
2543 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2545 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2546 for (y = 0; y < 3; y++)
2547 for (x = 0; x < 3; x++)
2548 putFile16BitBE(file, content_array[i][x][y]);
2551 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2554 int envelope_nr = element - EL_ENVELOPE_1;
2555 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2557 putFile16BitBE(file, element);
2558 putFile16BitBE(file, envelope_len);
2559 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2560 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2562 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2564 for (i = 0; i < envelope_len; i++)
2565 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2569 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2570 int num_changed_custom_elements)
2574 putFile16BitBE(file, num_changed_custom_elements);
2576 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2578 int element = EL_CUSTOM_START + i;
2580 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2582 if (check < num_changed_custom_elements)
2584 putFile16BitBE(file, element);
2585 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2592 if (check != num_changed_custom_elements) /* should not happen */
2593 Error(ERR_WARN, "inconsistent number of custom element properties");
2598 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2599 int num_changed_custom_elements)
2603 putFile16BitBE(file, num_changed_custom_elements);
2605 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2607 int element = EL_CUSTOM_START + i;
2609 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2611 if (check < num_changed_custom_elements)
2613 putFile16BitBE(file, element);
2614 putFile16BitBE(file, element_info[element].change->target_element);
2621 if (check != num_changed_custom_elements) /* should not happen */
2622 Error(ERR_WARN, "inconsistent number of custom target elements");
2627 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2628 int num_changed_custom_elements)
2630 int i, j, x, y, check = 0;
2632 putFile16BitBE(file, num_changed_custom_elements);
2634 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2636 int element = EL_CUSTOM_START + i;
2638 if (element_info[element].modified_settings)
2640 if (check < num_changed_custom_elements)
2642 putFile16BitBE(file, element);
2644 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2645 putFile8Bit(file, element_info[element].description[j]);
2647 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2649 /* some free bytes for future properties and padding */
2650 WriteUnusedBytesToFile(file, 7);
2652 putFile8Bit(file, element_info[element].use_gfx_element);
2653 putFile16BitBE(file, element_info[element].gfx_element);
2655 putFile8Bit(file, element_info[element].collect_score);
2656 putFile8Bit(file, element_info[element].collect_count);
2658 putFile16BitBE(file, element_info[element].push_delay_fixed);
2659 putFile16BitBE(file, element_info[element].push_delay_random);
2660 putFile16BitBE(file, element_info[element].move_delay_fixed);
2661 putFile16BitBE(file, element_info[element].move_delay_random);
2663 putFile16BitBE(file, element_info[element].move_pattern);
2664 putFile8Bit(file, element_info[element].move_direction_initial);
2665 putFile8Bit(file, element_info[element].move_stepsize);
2667 for (y = 0; y < 3; y++)
2668 for (x = 0; x < 3; x++)
2669 putFile16BitBE(file, element_info[element].content[x][y]);
2671 putFile32BitBE(file, element_info[element].change->events);
2673 putFile16BitBE(file, element_info[element].change->target_element);
2675 putFile16BitBE(file, element_info[element].change->delay_fixed);
2676 putFile16BitBE(file, element_info[element].change->delay_random);
2677 putFile16BitBE(file, element_info[element].change->delay_frames);
2679 putFile16BitBE(file, element_info[element].change->trigger_element);
2681 putFile8Bit(file, element_info[element].change->explode);
2682 putFile8Bit(file, element_info[element].change->use_target_content);
2683 putFile8Bit(file, element_info[element].change->only_if_complete);
2684 putFile8Bit(file, element_info[element].change->use_random_replace);
2686 putFile8Bit(file, element_info[element].change->random_percentage);
2687 putFile8Bit(file, element_info[element].change->replace_when);
2689 for (y = 0; y < 3; y++)
2690 for (x = 0; x < 3; x++)
2691 putFile16BitBE(file, element_info[element].change->content[x][y]);
2693 putFile8Bit(file, element_info[element].slippery_type);
2695 /* some free bytes for future properties and padding */
2696 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2703 if (check != num_changed_custom_elements) /* should not happen */
2704 Error(ERR_WARN, "inconsistent number of custom element properties");
2708 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2710 struct ElementInfo *ei = &element_info[element];
2713 putFile16BitBE(file, element);
2715 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2716 putFile8Bit(file, ei->description[i]);
2718 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2719 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
2721 putFile8Bit(file, ei->num_change_pages);
2723 /* some free bytes for future base property values and padding */
2724 WriteUnusedBytesToFile(file, 5);
2726 /* write custom property values */
2728 putFile8Bit(file, ei->use_gfx_element);
2729 putFile16BitBE(file, ei->gfx_element);
2731 putFile8Bit(file, ei->collect_score);
2732 putFile8Bit(file, ei->collect_count);
2734 putFile8Bit(file, ei->drop_delay_fixed);
2735 putFile8Bit(file, ei->push_delay_fixed);
2736 putFile8Bit(file, ei->drop_delay_random);
2737 putFile8Bit(file, ei->push_delay_random);
2738 putFile16BitBE(file, ei->move_delay_fixed);
2739 putFile16BitBE(file, ei->move_delay_random);
2741 /* bits 0 - 15 of "move_pattern" ... */
2742 putFile16BitBE(file, ei->move_pattern & 0xffff);
2743 putFile8Bit(file, ei->move_direction_initial);
2744 putFile8Bit(file, ei->move_stepsize);
2746 putFile8Bit(file, ei->slippery_type);
2748 for (y = 0; y < 3; y++)
2749 for (x = 0; x < 3; x++)
2750 putFile16BitBE(file, ei->content[x][y]);
2752 putFile16BitBE(file, ei->move_enter_element);
2753 putFile16BitBE(file, ei->move_leave_element);
2754 putFile8Bit(file, ei->move_leave_type);
2756 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
2757 putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
2759 putFile8Bit(file, ei->access_direction);
2761 putFile8Bit(file, ei->explosion_delay);
2762 putFile8Bit(file, ei->ignition_delay);
2764 /* some free bytes for future custom property values and padding */
2765 WriteUnusedBytesToFile(file, 2);
2767 /* write change property values */
2769 for (i = 0; i < ei->num_change_pages; i++)
2771 struct ElementChangeInfo *change = &ei->change_page[i];
2773 putFile32BitBE(file, change->events);
2775 putFile16BitBE(file, change->target_element);
2777 putFile16BitBE(file, change->delay_fixed);
2778 putFile16BitBE(file, change->delay_random);
2779 putFile16BitBE(file, change->delay_frames);
2781 putFile16BitBE(file, change->trigger_element);
2783 putFile8Bit(file, change->explode);
2784 putFile8Bit(file, change->use_target_content);
2785 putFile8Bit(file, change->only_if_complete);
2786 putFile8Bit(file, change->use_random_replace);
2788 putFile8Bit(file, change->random_percentage);
2789 putFile8Bit(file, change->replace_when);
2791 for (y = 0; y < 3; y++)
2792 for (x = 0; x < 3; x++)
2793 putFile16BitBE(file, change->target_content[x][y]);
2795 putFile8Bit(file, change->can_change);
2797 putFile8Bit(file, change->trigger_side);
2800 putFile8Bit(file, change->trigger_player);
2801 putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
2802 log_2(change->trigger_page)));
2804 /* some free bytes for future change property values and padding */
2805 WriteUnusedBytesToFile(file, 6);
2809 /* some free bytes for future change property values and padding */
2810 WriteUnusedBytesToFile(file, 8);
2815 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2817 struct ElementInfo *ei = &element_info[element];
2818 struct ElementGroupInfo *group = ei->group;
2821 putFile16BitBE(file, element);
2823 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2824 putFile8Bit(file, ei->description[i]);
2826 putFile8Bit(file, group->num_elements);
2828 putFile8Bit(file, ei->use_gfx_element);
2829 putFile16BitBE(file, ei->gfx_element);
2831 putFile8Bit(file, group->choice_mode);
2833 /* some free bytes for future values and padding */
2834 WriteUnusedBytesToFile(file, 3);
2836 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2837 putFile16BitBE(file, group->element[i]);
2840 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2842 int body_chunk_size;
2846 if (!(file = fopen(filename, MODE_WRITE)))
2848 Error(ERR_WARN, "cannot save level file '%s'", filename);
2852 level->file_version = FILE_VERSION_ACTUAL;
2853 level->game_version = GAME_VERSION_ACTUAL;
2855 /* check level field for 16-bit elements */
2856 level->encoding_16bit_field = FALSE;
2857 for (y = 0; y < level->fieldy; y++)
2858 for (x = 0; x < level->fieldx; x++)
2859 if (level->field[x][y] > 255)
2860 level->encoding_16bit_field = TRUE;
2862 /* check yamyam content for 16-bit elements */
2863 level->encoding_16bit_yamyam = FALSE;
2864 for (i = 0; i < level->num_yamyam_contents; i++)
2865 for (y = 0; y < 3; y++)
2866 for (x = 0; x < 3; x++)
2867 if (level->yamyam_content[i][x][y] > 255)
2868 level->encoding_16bit_yamyam = TRUE;
2870 /* check amoeba content for 16-bit elements */
2871 level->encoding_16bit_amoeba = FALSE;
2872 if (level->amoeba_content > 255)
2873 level->encoding_16bit_amoeba = TRUE;
2875 /* calculate size of "BODY" chunk */
2877 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2879 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2880 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2882 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2883 SaveLevel_VERS(file, level);
2885 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2886 SaveLevel_HEAD(file, level);
2888 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2889 SaveLevel_AUTH(file, level);
2891 putFileChunkBE(file, "BODY", body_chunk_size);
2892 SaveLevel_BODY(file, level);
2894 if (level->encoding_16bit_yamyam ||
2895 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2897 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2898 SaveLevel_CNT2(file, level, EL_YAMYAM);
2901 if (level->encoding_16bit_amoeba)
2903 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2904 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2907 /* check for envelope content */
2908 for (i = 0; i < 4; i++)
2910 if (strlen(level->envelope_text[i]) > 0)
2912 int envelope_len = strlen(level->envelope_text[i]) + 1;
2914 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2915 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2919 /* check for non-default custom elements (unless using template level) */
2920 if (!level->use_custom_template)
2922 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2924 int element = EL_CUSTOM_START + i;
2926 if (element_info[element].modified_settings)
2928 int num_change_pages = element_info[element].num_change_pages;
2930 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2931 SaveLevel_CUS4(file, level, element);
2936 /* check for non-default group elements (unless using template level) */
2937 if (!level->use_custom_template)
2939 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2941 int element = EL_GROUP_START + i;
2943 if (element_info[element].modified_settings)
2945 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2946 SaveLevel_GRP1(file, level, element);
2953 SetFilePermissions(filename, PERMS_PRIVATE);
2956 void SaveLevel(int nr)
2958 char *filename = getDefaultLevelFilename(nr);
2960 SaveLevelFromFilename(&level, filename);
2963 void SaveLevelTemplate()
2965 char *filename = getDefaultLevelFilename(-1);
2967 SaveLevelFromFilename(&level, filename);
2970 void DumpLevel(struct LevelInfo *level)
2972 if (level->no_valid_file)
2974 Error(ERR_WARN, "cannot dump -- no valid level file found");
2979 printf_line("-", 79);
2980 printf("Level xxx (file version %08d, game version %08d)\n",
2981 level->file_version, level->game_version);
2982 printf_line("-", 79);
2984 printf("Level author: '%s'\n", level->author);
2985 printf("Level title: '%s'\n", level->name);
2987 printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
2989 printf("Level time: %d seconds\n", level->time);
2990 printf("Gems needed: %d\n", level->gems_needed);
2992 printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
2993 printf("Time for wheel: %d seconds\n", level->time_wheel);
2994 printf("Time for light: %d seconds\n", level->time_light);
2995 printf("Time for timegate: %d seconds\n", level->time_timegate);
2997 printf("Amoeba speed: %d\n", level->amoeba_speed);
2999 printf("Initial gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
3000 printf("Double speed movement: %s\n", (level->double_speed ? "yes" : "no"));
3001 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
3002 printf("Player blocks last field: %s\n", (level->block_last_field ? "yes" : "no"));
3003 printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
3004 printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
3005 printf("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
3007 printf_line("-", 79);
3011 /* ========================================================================= */
3012 /* tape file functions */
3013 /* ========================================================================= */
3015 static void setTapeInfoToDefaults()
3019 /* always start with reliable default values (empty tape) */
3022 /* default values (also for pre-1.2 tapes) with only the first player */
3023 tape.player_participates[0] = TRUE;
3024 for (i = 1; i < MAX_PLAYERS; i++)
3025 tape.player_participates[i] = FALSE;
3027 /* at least one (default: the first) player participates in every tape */
3028 tape.num_participating_players = 1;
3030 tape.level_nr = level_nr;
3032 tape.changed = FALSE;
3034 tape.recording = FALSE;
3035 tape.playing = FALSE;
3036 tape.pausing = FALSE;
3038 tape.no_valid_file = FALSE;
3041 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
3043 tape->file_version = getFileVersion(file);
3044 tape->game_version = getFileVersion(file);
3049 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
3053 tape->random_seed = getFile32BitBE(file);
3054 tape->date = getFile32BitBE(file);
3055 tape->length = getFile32BitBE(file);
3057 /* read header fields that are new since version 1.2 */
3058 if (tape->file_version >= FILE_VERSION_1_2)
3060 byte store_participating_players = getFile8Bit(file);
3063 /* since version 1.2, tapes store which players participate in the tape */
3064 tape->num_participating_players = 0;
3065 for (i = 0; i < MAX_PLAYERS; i++)
3067 tape->player_participates[i] = FALSE;
3069 if (store_participating_players & (1 << i))
3071 tape->player_participates[i] = TRUE;
3072 tape->num_participating_players++;
3076 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
3078 engine_version = getFileVersion(file);
3079 if (engine_version > 0)
3080 tape->engine_version = engine_version;
3082 tape->engine_version = tape->game_version;
3088 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
3090 int level_identifier_size;
3093 level_identifier_size = getFile16BitBE(file);
3095 tape->level_identifier =
3096 checked_realloc(tape->level_identifier, level_identifier_size);
3098 for (i = 0; i < level_identifier_size; i++)
3099 tape->level_identifier[i] = getFile8Bit(file);
3101 tape->level_nr = getFile16BitBE(file);
3103 chunk_size = 2 + level_identifier_size + 2;
3108 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
3111 int chunk_size_expected =
3112 (tape->num_participating_players + 1) * tape->length;
3114 if (chunk_size_expected != chunk_size)
3116 ReadUnusedBytesFromFile(file, chunk_size);
3117 return chunk_size_expected;
3120 for (i = 0; i < tape->length; i++)
3122 if (i >= MAX_TAPELEN)
3125 for (j = 0; j < MAX_PLAYERS; j++)
3127 tape->pos[i].action[j] = MV_NO_MOVING;
3129 if (tape->player_participates[j])
3130 tape->pos[i].action[j] = getFile8Bit(file);
3133 tape->pos[i].delay = getFile8Bit(file);
3135 if (tape->file_version == FILE_VERSION_1_0)
3137 /* eliminate possible diagonal moves in old tapes */
3138 /* this is only for backward compatibility */
3140 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
3141 byte action = tape->pos[i].action[0];
3142 int k, num_moves = 0;
3144 for (k = 0; k<4; k++)
3146 if (action & joy_dir[k])
3148 tape->pos[i + num_moves].action[0] = joy_dir[k];
3150 tape->pos[i + num_moves].delay = 0;
3159 tape->length += num_moves;
3162 else if (tape->file_version < FILE_VERSION_2_0)
3164 /* convert pre-2.0 tapes to new tape format */
3166 if (tape->pos[i].delay > 1)
3169 tape->pos[i + 1] = tape->pos[i];
3170 tape->pos[i + 1].delay = 1;
3173 for (j = 0; j < MAX_PLAYERS; j++)
3174 tape->pos[i].action[j] = MV_NO_MOVING;
3175 tape->pos[i].delay--;
3186 if (i != tape->length)
3187 chunk_size = (tape->num_participating_players + 1) * i;
3192 void LoadTapeFromFilename(char *filename)
3194 char cookie[MAX_LINE_LEN];
3195 char chunk_name[CHUNK_ID_LEN + 1];
3199 /* always start with reliable default values */
3200 setTapeInfoToDefaults();
3202 if (!(file = fopen(filename, MODE_READ)))
3204 tape.no_valid_file = TRUE;
3207 Error(ERR_WARN, "cannot read tape '%s' -- using empty tape", filename);
3213 getFileChunkBE(file, chunk_name, NULL);
3214 if (strcmp(chunk_name, "RND1") == 0)
3216 getFile32BitBE(file); /* not used */
3218 getFileChunkBE(file, chunk_name, NULL);
3219 if (strcmp(chunk_name, "TAPE") != 0)
3221 tape.no_valid_file = TRUE;
3223 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3228 else /* check for pre-2.0 file format with cookie string */
3230 strcpy(cookie, chunk_name);
3231 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3232 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3233 cookie[strlen(cookie) - 1] = '\0';
3235 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3237 tape.no_valid_file = TRUE;
3239 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3244 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3246 tape.no_valid_file = TRUE;
3248 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3253 /* pre-2.0 tape files have no game version, so use file version here */
3254 tape.game_version = tape.file_version;
3257 if (tape.file_version < FILE_VERSION_1_2)
3259 /* tape files from versions before 1.2.0 without chunk structure */
3260 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3261 LoadTape_BODY(file, 2 * tape.length, &tape);
3269 int (*loader)(FILE *, int, struct TapeInfo *);
3273 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
3274 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
3275 { "INFO", -1, LoadTape_INFO },
3276 { "BODY", -1, LoadTape_BODY },
3280 while (getFileChunkBE(file, chunk_name, &chunk_size))
3284 while (chunk_info[i].name != NULL &&
3285 strcmp(chunk_name, chunk_info[i].name) != 0)
3288 if (chunk_info[i].name == NULL)
3290 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3291 chunk_name, filename);
3292 ReadUnusedBytesFromFile(file, chunk_size);
3294 else if (chunk_info[i].size != -1 &&
3295 chunk_info[i].size != chunk_size)
3297 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3298 chunk_size, chunk_name, filename);
3299 ReadUnusedBytesFromFile(file, chunk_size);
3303 /* call function to load this tape chunk */
3304 int chunk_size_expected =
3305 (chunk_info[i].loader)(file, chunk_size, &tape);
3307 /* the size of some chunks cannot be checked before reading other
3308 chunks first (like "HEAD" and "BODY") that contain some header
3309 information, so check them here */
3310 if (chunk_size_expected != chunk_size)
3312 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3313 chunk_size, chunk_name, filename);
3321 tape.length_seconds = GetTapeLength();
3324 printf("::: tape game version: %d\n", tape.game_version);
3325 printf("::: tape engine version: %d\n", tape.engine_version);
3329 void LoadTape(int nr)
3331 char *filename = getTapeFilename(nr);
3333 LoadTapeFromFilename(filename);
3336 void LoadSolutionTape(int nr)
3338 char *filename = getSolutionTapeFilename(nr);
3340 LoadTapeFromFilename(filename);
3343 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3345 putFileVersion(file, tape->file_version);
3346 putFileVersion(file, tape->game_version);
3349 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3352 byte store_participating_players = 0;
3354 /* set bits for participating players for compact storage */
3355 for (i = 0; i < MAX_PLAYERS; i++)
3356 if (tape->player_participates[i])
3357 store_participating_players |= (1 << i);
3359 putFile32BitBE(file, tape->random_seed);
3360 putFile32BitBE(file, tape->date);
3361 putFile32BitBE(file, tape->length);
3363 putFile8Bit(file, store_participating_players);
3365 /* unused bytes not at the end here for 4-byte alignment of engine_version */
3366 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3368 putFileVersion(file, tape->engine_version);
3371 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3373 int level_identifier_size = strlen(tape->level_identifier) + 1;
3376 putFile16BitBE(file, level_identifier_size);
3378 for (i = 0; i < level_identifier_size; i++)
3379 putFile8Bit(file, tape->level_identifier[i]);
3381 putFile16BitBE(file, tape->level_nr);
3384 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3388 for (i = 0; i < tape->length; i++)
3390 for (j = 0; j < MAX_PLAYERS; j++)
3391 if (tape->player_participates[j])
3392 putFile8Bit(file, tape->pos[i].action[j]);
3394 putFile8Bit(file, tape->pos[i].delay);
3398 void SaveTape(int nr)
3400 char *filename = getTapeFilename(nr);
3402 boolean new_tape = TRUE;
3403 int num_participating_players = 0;
3404 int info_chunk_size;
3405 int body_chunk_size;
3408 InitTapeDirectory(leveldir_current->subdir);
3410 /* if a tape still exists, ask to overwrite it */
3411 if (access(filename, F_OK) == 0)
3414 if (!Request("Replace old tape ?", REQ_ASK))
3418 if (!(file = fopen(filename, MODE_WRITE)))
3420 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3424 tape.file_version = FILE_VERSION_ACTUAL;
3425 tape.game_version = GAME_VERSION_ACTUAL;
3427 /* count number of participating players */
3428 for (i = 0; i < MAX_PLAYERS; i++)
3429 if (tape.player_participates[i])
3430 num_participating_players++;
3432 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3433 body_chunk_size = (num_participating_players + 1) * tape.length;
3435 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3436 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3438 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3439 SaveTape_VERS(file, &tape);
3441 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3442 SaveTape_HEAD(file, &tape);
3444 putFileChunkBE(file, "INFO", info_chunk_size);
3445 SaveTape_INFO(file, &tape);
3447 putFileChunkBE(file, "BODY", body_chunk_size);
3448 SaveTape_BODY(file, &tape);
3452 SetFilePermissions(filename, PERMS_PRIVATE);
3454 tape.changed = FALSE;
3457 Request("tape saved !", REQ_CONFIRM);
3460 void DumpTape(struct TapeInfo *tape)
3465 if (tape->no_valid_file)
3467 Error(ERR_WARN, "cannot dump -- no valid tape file found");
3472 if (TAPE_IS_EMPTY(*tape))
3474 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3480 printf_line("-", 79);
3481 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3482 tape->level_nr, tape->file_version, tape->game_version);
3483 printf("Level series identifier: '%s'\n", tape->level_identifier);
3484 printf_line("-", 79);
3486 for (i = 0; i < tape->length; i++)
3488 if (i >= MAX_TAPELEN)
3491 printf("%03d: ", i);
3493 for (j = 0; j < MAX_PLAYERS; j++)
3495 if (tape->player_participates[j])
3497 int action = tape->pos[i].action[j];
3499 printf("%d:%02x ", j, action);
3500 printf("[%c%c%c%c|%c%c] - ",
3501 (action & JOY_LEFT ? '<' : ' '),
3502 (action & JOY_RIGHT ? '>' : ' '),
3503 (action & JOY_UP ? '^' : ' '),
3504 (action & JOY_DOWN ? 'v' : ' '),
3505 (action & JOY_BUTTON_1 ? '1' : ' '),
3506 (action & JOY_BUTTON_2 ? '2' : ' '));
3510 printf("(%03d)\n", tape->pos[i].delay);
3513 printf_line("-", 79);
3517 /* ========================================================================= */
3518 /* score file functions */
3519 /* ========================================================================= */
3521 void LoadScore(int nr)
3524 char *filename = getScoreFilename(nr);
3525 char cookie[MAX_LINE_LEN];
3526 char line[MAX_LINE_LEN];
3530 /* always start with reliable default values */
3531 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3533 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3534 highscore[i].Score = 0;
3537 if (!(file = fopen(filename, MODE_READ)))
3540 /* check file identifier */
3541 fgets(cookie, MAX_LINE_LEN, file);
3542 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3543 cookie[strlen(cookie) - 1] = '\0';
3545 if (!checkCookieString(cookie, SCORE_COOKIE))
3547 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3552 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3554 fscanf(file, "%d", &highscore[i].Score);
3555 fgets(line, MAX_LINE_LEN, file);
3557 if (line[strlen(line) - 1] == '\n')
3558 line[strlen(line) - 1] = '\0';
3560 for (line_ptr = line; *line_ptr; line_ptr++)
3562 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3564 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3565 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3574 void SaveScore(int nr)
3577 char *filename = getScoreFilename(nr);
3580 InitScoreDirectory(leveldir_current->subdir);
3582 if (!(file = fopen(filename, MODE_WRITE)))
3584 Error(ERR_WARN, "cannot save score for level %d", nr);
3588 fprintf(file, "%s\n\n", SCORE_COOKIE);
3590 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3591 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3595 SetFilePermissions(filename, PERMS_PUBLIC);
3599 /* ========================================================================= */
3600 /* setup file functions */
3601 /* ========================================================================= */
3603 #define TOKEN_STR_PLAYER_PREFIX "player_"
3606 #define SETUP_TOKEN_PLAYER_NAME 0
3607 #define SETUP_TOKEN_SOUND 1
3608 #define SETUP_TOKEN_SOUND_LOOPS 2
3609 #define SETUP_TOKEN_SOUND_MUSIC 3
3610 #define SETUP_TOKEN_SOUND_SIMPLE 4
3611 #define SETUP_TOKEN_TOONS 5
3612 #define SETUP_TOKEN_SCROLL_DELAY 6
3613 #define SETUP_TOKEN_SOFT_SCROLLING 7
3614 #define SETUP_TOKEN_FADING 8
3615 #define SETUP_TOKEN_AUTORECORD 9
3616 #define SETUP_TOKEN_QUICK_DOORS 10
3617 #define SETUP_TOKEN_TEAM_MODE 11
3618 #define SETUP_TOKEN_HANDICAP 12
3619 #define SETUP_TOKEN_TIME_LIMIT 13
3620 #define SETUP_TOKEN_FULLSCREEN 14
3621 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3622 #define SETUP_TOKEN_GRAPHICS_SET 16
3623 #define SETUP_TOKEN_SOUNDS_SET 17
3624 #define SETUP_TOKEN_MUSIC_SET 18
3625 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3626 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3627 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3629 #define NUM_GLOBAL_SETUP_TOKENS 22
3632 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3633 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3634 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3635 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3636 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3637 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3638 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3639 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3640 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3641 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3642 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3643 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3645 #define NUM_EDITOR_SETUP_TOKENS 12
3647 /* shortcut setup */
3648 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3649 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3650 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3652 #define NUM_SHORTCUT_SETUP_TOKENS 3
3655 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3656 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3657 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3658 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3659 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3660 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3661 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3662 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3663 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3664 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3665 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3666 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3667 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3668 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3669 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3670 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3672 #define NUM_PLAYER_SETUP_TOKENS 16
3675 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
3676 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
3678 #define NUM_SYSTEM_SETUP_TOKENS 2
3681 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
3683 #define NUM_OPTIONS_SETUP_TOKENS 1
3686 static struct SetupInfo si;
3687 static struct SetupEditorInfo sei;
3688 static struct SetupShortcutInfo ssi;
3689 static struct SetupInputInfo sii;
3690 static struct SetupSystemInfo syi;
3691 static struct OptionInfo soi;
3693 static struct TokenInfo global_setup_tokens[] =
3695 { TYPE_STRING, &si.player_name, "player_name" },
3696 { TYPE_SWITCH, &si.sound, "sound" },
3697 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
3698 { TYPE_SWITCH, &si.sound_music, "background_music" },
3699 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
3700 { TYPE_SWITCH, &si.toons, "toons" },
3701 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
3702 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
3703 { TYPE_SWITCH, &si.fading, "screen_fading" },
3704 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
3705 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
3706 { TYPE_SWITCH, &si.team_mode, "team_mode" },
3707 { TYPE_SWITCH, &si.handicap, "handicap" },
3708 { TYPE_SWITCH, &si.time_limit, "time_limit" },
3709 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
3710 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
3711 { TYPE_STRING, &si.graphics_set, "graphics_set" },
3712 { TYPE_STRING, &si.sounds_set, "sounds_set" },
3713 { TYPE_STRING, &si.music_set, "music_set" },
3714 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3715 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
3716 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
3719 static struct TokenInfo editor_setup_tokens[] =
3721 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
3722 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
3723 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
3724 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
3725 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
3726 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
3727 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
3728 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
3729 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
3730 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
3731 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
3732 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
3735 static struct TokenInfo shortcut_setup_tokens[] =
3737 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
3738 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
3739 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
3742 static struct TokenInfo player_setup_tokens[] =
3744 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
3745 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
3746 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
3747 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
3748 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
3749 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
3750 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
3751 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
3752 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
3753 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
3754 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
3755 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
3756 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
3757 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
3758 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
3759 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
3762 static struct TokenInfo system_setup_tokens[] =
3764 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
3765 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3768 static struct TokenInfo options_setup_tokens[] =
3770 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
3773 static char *get_corrected_login_name(char *login_name)
3775 /* needed because player name must be a fixed length string */
3776 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3778 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3779 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3781 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
3782 if (strchr(login_name_new, ' '))
3783 *strchr(login_name_new, ' ') = '\0';
3785 return login_name_new;
3788 static void setSetupInfoToDefaults(struct SetupInfo *si)
3792 si->player_name = get_corrected_login_name(getLoginName());
3795 si->sound_loops = TRUE;
3796 si->sound_music = TRUE;
3797 si->sound_simple = TRUE;
3799 si->double_buffering = TRUE;
3800 si->direct_draw = !si->double_buffering;
3801 si->scroll_delay = TRUE;
3802 si->soft_scrolling = TRUE;
3804 si->autorecord = TRUE;
3805 si->quick_doors = FALSE;
3806 si->team_mode = FALSE;
3807 si->handicap = TRUE;
3808 si->time_limit = TRUE;
3809 si->fullscreen = FALSE;
3810 si->ask_on_escape = TRUE;
3812 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3813 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3814 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3815 si->override_level_graphics = FALSE;
3816 si->override_level_sounds = FALSE;
3817 si->override_level_music = FALSE;
3819 si->editor.el_boulderdash = TRUE;
3820 si->editor.el_emerald_mine = TRUE;
3821 si->editor.el_more = TRUE;
3822 si->editor.el_sokoban = TRUE;
3823 si->editor.el_supaplex = TRUE;
3824 si->editor.el_diamond_caves = TRUE;
3825 si->editor.el_dx_boulderdash = TRUE;
3826 si->editor.el_chars = TRUE;
3827 si->editor.el_custom = TRUE;
3828 si->editor.el_custom_more = FALSE;
3830 si->editor.el_headlines = TRUE;
3831 si->editor.el_user_defined = FALSE;
3833 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3834 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3835 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3837 for (i = 0; i < MAX_PLAYERS; i++)
3839 si->input[i].use_joystick = FALSE;
3840 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3841 si->input[i].joy.xleft = JOYSTICK_XLEFT;
3842 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3843 si->input[i].joy.xright = JOYSTICK_XRIGHT;
3844 si->input[i].joy.yupper = JOYSTICK_YUPPER;
3845 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3846 si->input[i].joy.ylower = JOYSTICK_YLOWER;
3847 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
3848 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
3849 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
3850 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3851 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
3852 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
3853 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
3854 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
3857 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3858 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3860 si->options.verbose = FALSE;
3863 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3867 if (!setup_file_hash)
3872 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3873 setSetupInfo(global_setup_tokens, i,
3874 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3879 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3880 setSetupInfo(editor_setup_tokens, i,
3881 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3884 /* shortcut setup */
3885 ssi = setup.shortcut;
3886 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3887 setSetupInfo(shortcut_setup_tokens, i,
3888 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3889 setup.shortcut = ssi;
3892 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3896 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3898 sii = setup.input[pnr];
3899 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3901 char full_token[100];
3903 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3904 setSetupInfo(player_setup_tokens, i,
3905 getHashEntry(setup_file_hash, full_token));
3907 setup.input[pnr] = sii;
3912 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3913 setSetupInfo(system_setup_tokens, i,
3914 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3918 soi = setup.options;
3919 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3920 setSetupInfo(options_setup_tokens, i,
3921 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3922 setup.options = soi;
3927 char *filename = getSetupFilename();
3928 SetupFileHash *setup_file_hash = NULL;
3930 /* always start with reliable default values */
3931 setSetupInfoToDefaults(&setup);
3933 setup_file_hash = loadSetupFileHash(filename);
3935 if (setup_file_hash)
3937 char *player_name_new;
3939 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3940 decodeSetupFileHash(setup_file_hash);
3942 setup.direct_draw = !setup.double_buffering;
3944 freeSetupFileHash(setup_file_hash);
3946 /* needed to work around problems with fixed length strings */
3947 player_name_new = get_corrected_login_name(setup.player_name);
3948 free(setup.player_name);
3949 setup.player_name = player_name_new;
3952 Error(ERR_WARN, "using default setup values");
3957 char *filename = getSetupFilename();
3961 InitUserDataDirectory();
3963 if (!(file = fopen(filename, MODE_WRITE)))
3965 Error(ERR_WARN, "cannot write setup file '%s'", filename);
3969 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3970 getCookie("SETUP")));
3971 fprintf(file, "\n");
3975 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3977 /* just to make things nicer :) */
3978 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3979 i == SETUP_TOKEN_GRAPHICS_SET)
3980 fprintf(file, "\n");
3982 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3987 fprintf(file, "\n");
3988 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3989 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3991 /* shortcut setup */
3992 ssi = setup.shortcut;
3993 fprintf(file, "\n");
3994 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3995 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3998 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4002 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4003 fprintf(file, "\n");
4005 sii = setup.input[pnr];
4006 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4007 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
4012 fprintf(file, "\n");
4013 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4014 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
4017 soi = setup.options;
4018 fprintf(file, "\n");
4019 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4020 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
4024 SetFilePermissions(filename, PERMS_PRIVATE);
4027 void LoadCustomElementDescriptions()
4029 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4030 SetupFileHash *setup_file_hash;
4033 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4035 if (element_info[i].custom_description != NULL)
4037 free(element_info[i].custom_description);
4038 element_info[i].custom_description = NULL;
4042 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4045 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4047 char *token = getStringCat2(element_info[i].token_name, ".name");
4048 char *value = getHashEntry(setup_file_hash, token);
4051 element_info[i].custom_description = getStringCopy(value);
4056 freeSetupFileHash(setup_file_hash);
4059 void LoadSpecialMenuDesignSettings()
4061 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4062 SetupFileHash *setup_file_hash;
4065 /* always start with reliable default values from default config */
4066 for (i = 0; image_config_vars[i].token != NULL; i++)
4067 for (j = 0; image_config[j].token != NULL; j++)
4068 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
4069 *image_config_vars[i].value =
4070 get_auto_parameter_value(image_config_vars[i].token,
4071 image_config[j].value);
4073 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4076 /* special case: initialize with default values that may be overwritten */
4077 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
4079 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
4080 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
4081 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
4083 if (value_x != NULL)
4084 menu.draw_xoffset[i] = get_integer_from_string(value_x);
4085 if (value_y != NULL)
4086 menu.draw_yoffset[i] = get_integer_from_string(value_y);
4087 if (list_size != NULL)
4088 menu.list_size[i] = get_integer_from_string(list_size);
4091 /* read (and overwrite with) values that may be specified in config file */
4092 for (i = 0; image_config_vars[i].token != NULL; i++)
4094 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
4097 *image_config_vars[i].value =
4098 get_auto_parameter_value(image_config_vars[i].token, value);
4101 freeSetupFileHash(setup_file_hash);
4104 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
4106 char *filename = getEditorSetupFilename();
4107 SetupFileList *setup_file_list, *list;
4108 SetupFileHash *element_hash;
4109 int num_unknown_tokens = 0;
4112 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
4115 element_hash = newSetupFileHash();
4117 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4118 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4120 /* determined size may be larger than needed (due to unknown elements) */
4122 for (list = setup_file_list; list != NULL; list = list->next)
4125 /* add space for up to 3 more elements for padding that may be needed */
4128 *elements = checked_malloc(*num_elements * sizeof(int));
4131 for (list = setup_file_list; list != NULL; list = list->next)
4133 char *value = getHashEntry(element_hash, list->token);
4137 (*elements)[(*num_elements)++] = atoi(value);
4141 if (num_unknown_tokens == 0)
4143 Error(ERR_RETURN_LINE, "-");
4144 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4145 Error(ERR_RETURN, "- config file: '%s'", filename);
4147 num_unknown_tokens++;
4150 Error(ERR_RETURN, "- token: '%s'", list->token);
4154 if (num_unknown_tokens > 0)
4155 Error(ERR_RETURN_LINE, "-");
4157 while (*num_elements % 4) /* pad with empty elements, if needed */
4158 (*elements)[(*num_elements)++] = EL_EMPTY;
4160 freeSetupFileList(setup_file_list);
4161 freeSetupFileHash(element_hash);
4165 for (i = 0; i < *num_elements; i++)
4166 printf("editor: element '%s' [%d]\n",
4167 element_info[(*elements)[i]].token_name, (*elements)[i]);
4171 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
4174 SetupFileHash *setup_file_hash = NULL;
4175 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
4176 char *filename_music, *filename_prefix, *filename_info;
4182 token_to_value_ptr[] =
4184 { "title_header", &tmp_music_file_info.title_header },
4185 { "artist_header", &tmp_music_file_info.artist_header },
4186 { "album_header", &tmp_music_file_info.album_header },
4187 { "year_header", &tmp_music_file_info.year_header },
4189 { "title", &tmp_music_file_info.title },
4190 { "artist", &tmp_music_file_info.artist },
4191 { "album", &tmp_music_file_info.album },
4192 { "year", &tmp_music_file_info.year },
4198 filename_music = (is_sound ? getCustomSoundFilename(basename) :
4199 getCustomMusicFilename(basename));
4201 if (filename_music == NULL)
4204 /* ---------- try to replace file extension ---------- */
4206 filename_prefix = getStringCopy(filename_music);
4207 if (strrchr(filename_prefix, '.') != NULL)
4208 *strrchr(filename_prefix, '.') = '\0';
4209 filename_info = getStringCat2(filename_prefix, ".txt");
4212 printf("trying to load file '%s'...\n", filename_info);
4215 if (fileExists(filename_info))
4216 setup_file_hash = loadSetupFileHash(filename_info);
4218 free(filename_prefix);
4219 free(filename_info);
4221 if (setup_file_hash == NULL)
4223 /* ---------- try to add file extension ---------- */
4225 filename_prefix = getStringCopy(filename_music);
4226 filename_info = getStringCat2(filename_prefix, ".txt");
4229 printf("trying to load file '%s'...\n", filename_info);
4232 if (fileExists(filename_info))
4233 setup_file_hash = loadSetupFileHash(filename_info);
4235 free(filename_prefix);
4236 free(filename_info);
4239 if (setup_file_hash == NULL)
4242 /* ---------- music file info found ---------- */
4244 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4246 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4248 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4250 *token_to_value_ptr[i].value_ptr =
4251 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4254 tmp_music_file_info.basename = getStringCopy(basename);
4255 tmp_music_file_info.music = music;
4256 tmp_music_file_info.is_sound = is_sound;
4258 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4259 *new_music_file_info = tmp_music_file_info;
4261 return new_music_file_info;
4264 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4266 return get_music_file_info_ext(basename, music, FALSE);
4269 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4271 return get_music_file_info_ext(basename, sound, TRUE);
4274 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4275 char *basename, boolean is_sound)
4277 for (; list != NULL; list = list->next)
4278 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4284 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4286 return music_info_listed_ext(list, basename, FALSE);
4289 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4291 return music_info_listed_ext(list, basename, TRUE);
4294 void LoadMusicInfo()
4296 char *music_directory = getCustomMusicDirectory();
4297 int num_music = getMusicListSize();
4298 int num_music_noconf = 0;
4299 int num_sounds = getSoundListSize();
4301 struct dirent *dir_entry;
4302 struct FileInfo *music, *sound;
4303 struct MusicFileInfo *next, **new;
4306 while (music_file_info != NULL)
4308 next = music_file_info->next;
4310 checked_free(music_file_info->basename);
4312 checked_free(music_file_info->title_header);
4313 checked_free(music_file_info->artist_header);
4314 checked_free(music_file_info->album_header);
4315 checked_free(music_file_info->year_header);
4317 checked_free(music_file_info->title);
4318 checked_free(music_file_info->artist);
4319 checked_free(music_file_info->album);
4320 checked_free(music_file_info->year);
4322 free(music_file_info);
4324 music_file_info = next;
4327 new = &music_file_info;
4330 printf("::: num_music == %d\n", num_music);
4333 for (i = 0; i < num_music; i++)
4335 music = getMusicListEntry(i);
4338 printf("::: %d [%08x]\n", i, music->filename);
4341 if (music->filename == NULL)
4344 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4347 /* a configured file may be not recognized as music */
4348 if (!FileIsMusic(music->filename))
4352 printf("::: -> '%s' (configured)\n", music->filename);
4355 if (!music_info_listed(music_file_info, music->filename))
4357 *new = get_music_file_info(music->filename, i);
4359 new = &(*new)->next;
4363 if ((dir = opendir(music_directory)) == NULL)
4365 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4369 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
4371 char *basename = dir_entry->d_name;
4372 boolean music_already_used = FALSE;
4375 /* skip all music files that are configured in music config file */
4376 for (i = 0; i < num_music; i++)
4378 music = getMusicListEntry(i);
4380 if (music->filename == NULL)
4383 if (strcmp(basename, music->filename) == 0)
4385 music_already_used = TRUE;
4390 if (music_already_used)
4393 if (!FileIsMusic(basename))
4397 printf("::: -> '%s' (found in directory)\n", basename);
4400 if (!music_info_listed(music_file_info, basename))
4402 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4404 new = &(*new)->next;
4412 for (i = 0; i < num_sounds; i++)
4414 sound = getSoundListEntry(i);
4416 if (sound->filename == NULL)
4419 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4422 /* a configured file may be not recognized as sound */
4423 if (!FileIsSound(sound->filename))
4427 printf("::: -> '%s' (configured)\n", sound->filename);
4430 if (!sound_info_listed(music_file_info, sound->filename))
4432 *new = get_sound_file_info(sound->filename, i);
4434 new = &(*new)->next;
4440 for (next = music_file_info; next != NULL; next = next->next)
4441 printf("::: title == '%s'\n", next->title);
4445 void add_helpanim_entry(int element, int action, int direction, int delay,
4446 int *num_list_entries)
4448 struct HelpAnimInfo *new_list_entry;
4449 (*num_list_entries)++;
4452 checked_realloc(helpanim_info,
4453 *num_list_entries * sizeof(struct HelpAnimInfo));
4454 new_list_entry = &helpanim_info[*num_list_entries - 1];
4456 new_list_entry->element = element;
4457 new_list_entry->action = action;
4458 new_list_entry->direction = direction;
4459 new_list_entry->delay = delay;
4462 void print_unknown_token(char *filename, char *token, int token_nr)
4466 Error(ERR_RETURN_LINE, "-");
4467 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4468 Error(ERR_RETURN, "- config file: '%s'", filename);
4471 Error(ERR_RETURN, "- token: '%s'", token);
4474 void print_unknown_token_end(int token_nr)
4477 Error(ERR_RETURN_LINE, "-");
4480 void LoadHelpAnimInfo()
4482 char *filename = getHelpAnimFilename();
4483 SetupFileList *setup_file_list = NULL, *list;
4484 SetupFileHash *element_hash, *action_hash, *direction_hash;
4485 int num_list_entries = 0;
4486 int num_unknown_tokens = 0;
4489 if (fileExists(filename))
4490 setup_file_list = loadSetupFileList(filename);
4492 if (setup_file_list == NULL)
4494 /* use reliable default values from static configuration */
4495 SetupFileList *insert_ptr;
4497 insert_ptr = setup_file_list =
4498 newSetupFileList(helpanim_config[0].token,
4499 helpanim_config[0].value);
4501 for (i = 1; helpanim_config[i].token; i++)
4502 insert_ptr = addListEntry(insert_ptr,
4503 helpanim_config[i].token,
4504 helpanim_config[i].value);
4507 element_hash = newSetupFileHash();
4508 action_hash = newSetupFileHash();
4509 direction_hash = newSetupFileHash();
4511 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4512 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4514 for (i = 0; i < NUM_ACTIONS; i++)
4515 setHashEntry(action_hash, element_action_info[i].suffix,
4516 i_to_a(element_action_info[i].value));
4518 /* do not store direction index (bit) here, but direction value! */
4519 for (i = 0; i < NUM_DIRECTIONS; i++)
4520 setHashEntry(direction_hash, element_direction_info[i].suffix,
4521 i_to_a(1 << element_direction_info[i].value));
4523 for (list = setup_file_list; list != NULL; list = list->next)
4525 char *element_token, *action_token, *direction_token;
4526 char *element_value, *action_value, *direction_value;
4527 int delay = atoi(list->value);
4529 if (strcmp(list->token, "end") == 0)
4531 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4536 /* first try to break element into element/action/direction parts;
4537 if this does not work, also accept combined "element[.act][.dir]"
4538 elements (like "dynamite.active"), which are unique elements */
4540 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4542 element_value = getHashEntry(element_hash, list->token);
4543 if (element_value != NULL) /* element found */
4544 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4548 /* no further suffixes found -- this is not an element */
4549 print_unknown_token(filename, list->token, num_unknown_tokens++);
4555 /* token has format "<prefix>.<something>" */
4557 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4558 direction_token = action_token; /* ... or direction */
4560 element_token = getStringCopy(list->token);
4561 *strchr(element_token, '.') = '\0';
4563 element_value = getHashEntry(element_hash, element_token);
4565 if (element_value == NULL) /* this is no element */
4567 element_value = getHashEntry(element_hash, list->token);
4568 if (element_value != NULL) /* combined element found */
4569 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4572 print_unknown_token(filename, list->token, num_unknown_tokens++);
4574 free(element_token);
4579 action_value = getHashEntry(action_hash, action_token);
4581 if (action_value != NULL) /* action found */
4583 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4586 free(element_token);
4591 direction_value = getHashEntry(direction_hash, direction_token);
4593 if (direction_value != NULL) /* direction found */
4595 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4598 free(element_token);
4603 if (strchr(action_token + 1, '.') == NULL)
4605 /* no further suffixes found -- this is not an action nor direction */
4607 element_value = getHashEntry(element_hash, list->token);
4608 if (element_value != NULL) /* combined element found */
4609 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4612 print_unknown_token(filename, list->token, num_unknown_tokens++);
4614 free(element_token);
4619 /* token has format "<prefix>.<suffix>.<something>" */
4621 direction_token = strchr(action_token + 1, '.');
4623 action_token = getStringCopy(action_token);
4624 *strchr(action_token + 1, '.') = '\0';
4626 action_value = getHashEntry(action_hash, action_token);
4628 if (action_value == NULL) /* this is no action */
4630 element_value = getHashEntry(element_hash, list->token);
4631 if (element_value != NULL) /* combined element found */
4632 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4635 print_unknown_token(filename, list->token, num_unknown_tokens++);
4637 free(element_token);
4643 direction_value = getHashEntry(direction_hash, direction_token);
4645 if (direction_value != NULL) /* direction found */
4647 add_helpanim_entry(atoi(element_value), atoi(action_value),
4648 atoi(direction_value), delay, &num_list_entries);
4650 free(element_token);
4656 /* this is no direction */
4658 element_value = getHashEntry(element_hash, list->token);
4659 if (element_value != NULL) /* combined element found */
4660 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4663 print_unknown_token(filename, list->token, num_unknown_tokens++);
4665 free(element_token);
4669 print_unknown_token_end(num_unknown_tokens);
4671 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4672 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4674 freeSetupFileList(setup_file_list);
4675 freeSetupFileHash(element_hash);
4676 freeSetupFileHash(action_hash);
4677 freeSetupFileHash(direction_hash);
4681 for (i = 0; i < num_list_entries; i++)
4682 printf("::: %d, %d, %d => %d\n",
4683 helpanim_info[i].element,
4684 helpanim_info[i].action,
4685 helpanim_info[i].direction,
4686 helpanim_info[i].delay);
4690 void LoadHelpTextInfo()
4692 char *filename = getHelpTextFilename();
4695 if (helptext_info != NULL)
4697 freeSetupFileHash(helptext_info);
4698 helptext_info = NULL;
4701 if (fileExists(filename))
4702 helptext_info = loadSetupFileHash(filename);
4704 if (helptext_info == NULL)
4706 /* use reliable default values from static configuration */
4707 helptext_info = newSetupFileHash();
4709 for (i = 0; helptext_config[i].token; i++)
4710 setHashEntry(helptext_info,
4711 helptext_config[i].token,
4712 helptext_config[i].value);
4717 BEGIN_HASH_ITERATION(helptext_info, itr)
4719 printf("::: '%s' => '%s'\n",
4720 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4722 END_HASH_ITERATION(hash, itr)