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 0 /* 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"
53 /* ========================================================================= */
54 /* level file functions */
55 /* ========================================================================= */
57 void setElementChangePages(struct ElementInfo *ei, int change_pages)
59 int change_page_size = sizeof(struct ElementChangeInfo);
61 ei->num_change_pages = MAX(1, change_pages);
64 checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
66 if (ei->current_change_page >= ei->num_change_pages)
67 ei->current_change_page = ei->num_change_pages - 1;
69 ei->change = &ei->change_page[ei->current_change_page];
72 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
76 change->can_change = FALSE;
78 change->events = CE_BITMASK_DEFAULT;
80 change->trigger_player = CH_PLAYER_ANY;
81 change->trigger_side = CH_SIDE_ANY;
82 change->trigger_page = CH_PAGE_ANY;
84 change->target_element = EL_EMPTY_SPACE;
86 change->delay_fixed = 0;
87 change->delay_random = 0;
88 change->delay_frames = 1;
90 change->trigger_element = EL_EMPTY_SPACE;
92 change->explode = FALSE;
93 change->use_target_content = FALSE;
94 change->only_if_complete = FALSE;
95 change->use_random_replace = FALSE;
96 change->random_percentage = 100;
97 change->replace_when = CP_WHEN_EMPTY;
99 for (x = 0; x < 3; x++)
100 for (y = 0; y < 3; y++)
101 change->target_content[x][y] = EL_EMPTY_SPACE;
103 change->direct_action = 0;
104 change->other_action = 0;
106 change->pre_change_function = NULL;
107 change->change_function = NULL;
108 change->post_change_function = NULL;
111 static void setLevelInfoToDefaults(struct LevelInfo *level)
113 static boolean clipboard_elements_initialized = FALSE;
117 level->native_em_level = &native_em_level;
119 level->game_engine_type = GAME_ENGINE_TYPE_RND;
121 level->file_version = FILE_VERSION_ACTUAL;
122 level->game_version = GAME_VERSION_ACTUAL;
124 level->encoding_16bit_field = FALSE; /* default: only 8-bit elements */
125 level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
126 level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
128 level->fieldx = STD_LEV_FIELDX;
129 level->fieldy = STD_LEV_FIELDY;
131 for (x = 0; x < MAX_LEV_FIELDX; x++)
132 for (y = 0; y < MAX_LEV_FIELDY; y++)
133 level->field[x][y] = EL_SAND;
136 level->gems_needed = 0;
138 level->amoeba_speed = 10;
140 level->time_magic_wall = 10;
141 level->time_wheel = 10;
142 level->time_light = 10;
143 level->time_timegate = 10;
145 level->amoeba_content = EL_DIAMOND;
147 level->double_speed = FALSE;
148 level->initial_gravity = FALSE;
149 level->em_slippery_gems = FALSE;
150 level->instant_relocation = FALSE;
151 level->can_pass_to_walkable = FALSE;
152 level->grow_into_diggable = TRUE;
154 level->block_last_field = FALSE; /* EM does not block by default */
155 level->sp_block_last_field = TRUE; /* SP blocks the last field */
156 level->block_delay = 8; /* when blocking, block 8 frames */
157 level->sp_block_delay = 9; /* SP indeed blocks 9 frames, not 8 */
159 level->can_move_into_acid_bits = ~0; /* everything can move into acid */
160 level->dont_collide_with_bits = ~0; /* always deadly when colliding */
162 level->use_spring_bug = FALSE;
163 level->use_step_counter = FALSE;
165 level->use_custom_template = FALSE;
167 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
168 level->name[i] = '\0';
169 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
170 level->author[i] = '\0';
172 strcpy(level->name, NAMELESS_LEVEL_NAME);
173 strcpy(level->author, ANONYMOUS_NAME);
175 for (i = 0; i < 4; i++)
177 level->envelope_text[i][0] = '\0';
178 level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
179 level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
182 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
183 level->score[i] = 10;
185 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
186 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
187 for (x = 0; x < 3; x++)
188 for (y = 0; y < 3; y++)
189 level->yamyam_content[i][x][y] =
190 (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
192 level->field[0][0] = EL_PLAYER_1;
193 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
195 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
199 /* never initialize clipboard elements after the very first time */
200 if (IS_CLIPBOARD_ELEMENT(element) && clipboard_elements_initialized)
203 setElementChangePages(&element_info[element], 1);
204 setElementChangeInfoToDefaults(element_info[element].change);
206 if (IS_CUSTOM_ELEMENT(element) ||
207 IS_GROUP_ELEMENT(element) ||
208 IS_INTERNAL_ELEMENT(element))
210 for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
211 element_info[element].description[j] = '\0';
213 if (element_info[element].custom_description != NULL)
214 strncpy(element_info[element].description,
215 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
217 strcpy(element_info[element].description,
218 element_info[element].editor_description);
220 element_info[element].use_gfx_element = FALSE;
221 element_info[element].gfx_element = EL_EMPTY_SPACE;
223 element_info[element].modified_settings = FALSE;
226 if (IS_CUSTOM_ELEMENT(element) ||
227 IS_INTERNAL_ELEMENT(element))
229 element_info[element].access_direction = MV_ALL_DIRECTIONS;
231 element_info[element].collect_score = 10; /* special default */
232 element_info[element].collect_count = 1; /* special default */
234 element_info[element].push_delay_fixed = -1; /* initialize later */
235 element_info[element].push_delay_random = -1; /* initialize later */
236 element_info[element].drop_delay_fixed = 0;
237 element_info[element].drop_delay_random = 0;
238 element_info[element].move_delay_fixed = 0;
239 element_info[element].move_delay_random = 0;
241 element_info[element].move_pattern = MV_ALL_DIRECTIONS;
242 element_info[element].move_direction_initial = MV_START_AUTOMATIC;
243 element_info[element].move_stepsize = TILEX / 8;
245 element_info[element].move_enter_element = EL_EMPTY_SPACE;
246 element_info[element].move_leave_element = EL_EMPTY_SPACE;
247 element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
249 element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
251 element_info[element].explosion_type = EXPLODES_3X3;
252 element_info[element].explosion_delay = 16;
253 element_info[element].ignition_delay = 8;
255 for (x = 0; x < 3; x++)
256 for (y = 0; y < 3; y++)
257 element_info[element].content[x][y] = EL_EMPTY_SPACE;
259 element_info[element].access_type = 0;
260 element_info[element].access_layer = 0;
261 element_info[element].access_protected = 0;
262 element_info[element].walk_to_action = 0;
263 element_info[element].smash_targets = 0;
264 element_info[element].deadliness = 0;
266 element_info[element].can_explode_by_fire = FALSE;
267 element_info[element].can_explode_smashed = FALSE;
268 element_info[element].can_explode_impact = FALSE;
270 element_info[element].current_change_page = 0;
272 /* start with no properties at all */
273 for (j = 0; j < NUM_EP_BITFIELDS; j++)
274 Properties[element][j] = EP_BITMASK_DEFAULT;
276 /* now set default properties */
277 SET_PROPERTY(element, EP_CAN_MOVE_INTO_ACID, TRUE);
280 if (IS_GROUP_ELEMENT(element) ||
281 IS_INTERNAL_ELEMENT(element))
283 /* initialize memory for list of elements in group */
284 if (element_info[element].group == NULL)
285 element_info[element].group =
286 checked_malloc(sizeof(struct ElementGroupInfo));
288 for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
289 element_info[element].group->element[j] = EL_EMPTY_SPACE;
291 /* default: only one element in group */
292 element_info[element].group->num_elements = 1;
294 element_info[element].group->choice_mode = ANIM_RANDOM;
298 clipboard_elements_initialized = TRUE;
300 BorderElement = EL_STEELWALL;
302 level->no_valid_file = FALSE;
304 level->changed = FALSE;
306 if (leveldir_current == NULL) /* only when dumping level */
309 /* try to determine better author name than 'anonymous' */
310 if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
312 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
313 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
317 switch (LEVELCLASS(leveldir_current))
319 case LEVELCLASS_TUTORIAL:
320 strcpy(level->author, PROGRAM_AUTHOR_STRING);
323 case LEVELCLASS_CONTRIB:
324 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
325 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
328 case LEVELCLASS_PRIVATE:
329 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
330 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
334 /* keep default value */
340 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
342 level_file_info->nr = 0;
343 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
344 level_file_info->packed = FALSE;
345 level_file_info->basename = NULL;
346 level_file_info->filename = NULL;
349 static void ActivateLevelTemplate()
351 /* Currently there is no special action needed to activate the template
352 data, because 'element_info' and 'Properties' overwrite the original
353 level data, while all other variables do not change. */
356 static char *getLevelFilenameFromBasename(char *basename)
358 static char *filename = NULL;
360 checked_free(filename);
362 filename = getPath2(getCurrentLevelDir(), basename);
367 static int getFileTypeFromBasename(char *basename)
369 static char *filename = NULL;
370 struct stat file_status;
372 /* ---------- try to determine file type from filename ---------- */
374 /* check for typical filename of a Supaplex level package file */
375 if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
376 strncmp(basename, "LEVELS.D", 8) == 0))
377 return LEVEL_FILE_TYPE_SP;
379 /* ---------- try to determine file type from filesize ---------- */
381 checked_free(filename);
382 filename = getPath2(getCurrentLevelDir(), basename);
384 if (stat(filename, &file_status) == 0)
386 /* check for typical filesize of a Supaplex level package file */
387 if (file_status.st_size == 170496)
388 return LEVEL_FILE_TYPE_SP;
391 return LEVEL_FILE_TYPE_UNKNOWN;
394 static char *getSingleLevelBasename(int nr, int type)
396 static char basename[MAX_FILENAME_LEN];
397 char *level_filename = getStringCopy(leveldir_current->level_filename);
399 if (level_filename == NULL)
400 level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
404 case LEVEL_FILE_TYPE_RND:
406 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
408 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
411 case LEVEL_FILE_TYPE_EM:
412 sprintf(basename, "%d", nr);
415 case LEVEL_FILE_TYPE_UNKNOWN:
417 sprintf(basename, level_filename, nr);
421 free(level_filename);
426 static char *getPackedLevelBasename(int type)
428 static char basename[MAX_FILENAME_LEN];
429 char *directory = getCurrentLevelDir();
431 struct dirent *dir_entry;
433 strcpy(basename, UNDEFINED_FILENAME); /* default: undefined file */
435 if ((dir = opendir(directory)) == NULL)
437 Error(ERR_WARN, "cannot read current level directory '%s'", directory);
442 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
444 char *entry_basename = dir_entry->d_name;
445 int entry_type = getFileTypeFromBasename(entry_basename);
447 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) /* found valid level package */
449 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
452 strcpy(basename, entry_basename);
464 static char *getSingleLevelFilename(int nr, int type)
466 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
470 static char *getPackedLevelFilename(int type)
472 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
476 char *getDefaultLevelFilename(int nr)
478 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
481 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
486 lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
487 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
490 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
495 lfi->basename = getPackedLevelBasename(lfi->type);
496 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
499 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
501 /* special case: level number is negative => check for level template file */
504 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
509 if (leveldir_current->level_filename != NULL)
511 /* check for file name/pattern specified in "levelinfo.conf" */
512 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
513 if (fileExists(lfi->filename))
517 /* check for native Rocks'n'Diamonds level file */
518 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
519 if (fileExists(lfi->filename))
522 /* check for classic Emerald Mine level file */
523 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
524 if (fileExists(lfi->filename))
527 /* check for various packed level file formats */
528 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
529 if (fileExists(lfi->filename))
532 /* no known level file found -- try to use default values */
533 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
536 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
538 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
539 lfi->type = getFileTypeFromBasename(lfi->basename);
543 static void setLevelFileInfo(struct LevelFileInfo *level_file_info, int nr)
545 /* always start with reliable default values */
546 setFileInfoToDefaults(level_file_info);
548 level_file_info->nr = nr; /* set requested level number */
550 determineLevelFileInfo_Filename(level_file_info);
551 determineLevelFileInfo_Filetype(level_file_info);
556 static struct LevelFileInfo *getLevelFileInfo(int nr)
558 static struct LevelFileInfo level_file_info;
560 /* always start with reliable default values */
561 setFileInfoToDefaults(&level_file_info);
563 level_file_info.nr = nr; /* set requested level number */
565 determineLevelFileInfo_Filename(&level_file_info);
566 determineLevelFileInfo_Filetype(&level_file_info);
568 return &level_file_info;
572 /* ------------------------------------------------------------------------- */
573 /* functions for loading R'n'D level */
574 /* ------------------------------------------------------------------------- */
576 int getMappedElement(int element)
578 /* remap some (historic, now obsolete) elements */
583 case EL_PLAYER_OBSOLETE:
584 element = EL_PLAYER_1;
587 case EL_KEY_OBSOLETE:
590 case EL_EM_KEY_1_FILE_OBSOLETE:
591 element = EL_EM_KEY_1;
594 case EL_EM_KEY_2_FILE_OBSOLETE:
595 element = EL_EM_KEY_2;
598 case EL_EM_KEY_3_FILE_OBSOLETE:
599 element = EL_EM_KEY_3;
602 case EL_EM_KEY_4_FILE_OBSOLETE:
603 element = EL_EM_KEY_4;
606 case EL_ENVELOPE_OBSOLETE:
607 element = EL_ENVELOPE_1;
615 if (element >= NUM_FILE_ELEMENTS)
617 Error(ERR_WARN, "invalid level element %d", element);
619 element = EL_UNKNOWN;
624 if (element >= NUM_FILE_ELEMENTS)
626 Error(ERR_WARN, "invalid level element %d", element);
628 element = EL_UNKNOWN;
630 else if (element == EL_PLAYER_OBSOLETE)
631 element = EL_PLAYER_1;
632 else if (element == EL_KEY_OBSOLETE)
639 int getMappedElementByVersion(int element, int game_version)
641 /* remap some elements due to certain game version */
643 if (game_version <= VERSION_IDENT(2,2,0,0))
645 /* map game font elements */
646 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
647 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
648 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
649 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
652 if (game_version < VERSION_IDENT(3,0,0,0))
654 /* map Supaplex gravity tube elements */
655 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
656 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
657 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
658 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
665 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
667 level->file_version = getFileVersion(file);
668 level->game_version = getFileVersion(file);
673 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
677 level->fieldx = getFile8Bit(file);
678 level->fieldy = getFile8Bit(file);
680 level->time = getFile16BitBE(file);
681 level->gems_needed = getFile16BitBE(file);
683 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
684 level->name[i] = getFile8Bit(file);
685 level->name[MAX_LEVEL_NAME_LEN] = 0;
687 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
688 level->score[i] = getFile8Bit(file);
690 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
691 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
692 for (y = 0; y < 3; y++)
693 for (x = 0; x < 3; x++)
694 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
696 level->amoeba_speed = getFile8Bit(file);
697 level->time_magic_wall = getFile8Bit(file);
698 level->time_wheel = getFile8Bit(file);
699 level->amoeba_content = getMappedElement(getFile8Bit(file));
700 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
701 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
702 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
703 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
705 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
707 level->block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
708 level->sp_block_last_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
709 level->can_move_into_acid_bits = getFile32BitBE(file);
710 level->dont_collide_with_bits = getFile8Bit(file);
712 level->use_spring_bug = (getFile8Bit(file) == 1 ? TRUE : FALSE);
713 level->use_step_counter = (getFile8Bit(file) == 1 ? TRUE : FALSE);
715 level->instant_relocation = (getFile8Bit(file) == 1 ? TRUE : FALSE);
716 level->can_pass_to_walkable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
717 level->grow_into_diggable = (getFile8Bit(file) == 1 ? TRUE : FALSE);
719 level->game_engine_type = getFile8Bit(file);
721 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
726 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
730 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
731 level->author[i] = getFile8Bit(file);
732 level->author[MAX_LEVEL_NAME_LEN] = 0;
737 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
740 int chunk_size_expected = level->fieldx * level->fieldy;
742 /* Note: "chunk_size" was wrong before version 2.0 when elements are
743 stored with 16-bit encoding (and should be twice as big then).
744 Even worse, playfield data was stored 16-bit when only yamyam content
745 contained 16-bit elements and vice versa. */
747 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
748 chunk_size_expected *= 2;
750 if (chunk_size_expected != chunk_size)
752 ReadUnusedBytesFromFile(file, chunk_size);
753 return chunk_size_expected;
756 for (y = 0; y < level->fieldy; y++)
757 for (x = 0; x < level->fieldx; x++)
759 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
764 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
768 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
769 int chunk_size_expected = header_size + content_size;
771 /* Note: "chunk_size" was wrong before version 2.0 when elements are
772 stored with 16-bit encoding (and should be twice as big then).
773 Even worse, playfield data was stored 16-bit when only yamyam content
774 contained 16-bit elements and vice versa. */
776 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
777 chunk_size_expected += content_size;
779 if (chunk_size_expected != chunk_size)
781 ReadUnusedBytesFromFile(file, chunk_size);
782 return chunk_size_expected;
786 level->num_yamyam_contents = getFile8Bit(file);
790 /* correct invalid number of content fields -- should never happen */
791 if (level->num_yamyam_contents < 1 ||
792 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
793 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
795 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
796 for (y = 0; y < 3; y++)
797 for (x = 0; x < 3; x++)
798 level->yamyam_content[i][x][y] =
799 getMappedElement(level->encoding_16bit_field ?
800 getFile16BitBE(file) : getFile8Bit(file));
804 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
808 int num_contents, content_xsize, content_ysize;
809 int content_array[MAX_ELEMENT_CONTENTS][3][3];
811 element = getMappedElement(getFile16BitBE(file));
812 num_contents = getFile8Bit(file);
813 content_xsize = getFile8Bit(file);
814 content_ysize = getFile8Bit(file);
816 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
818 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
819 for (y = 0; y < 3; y++)
820 for (x = 0; x < 3; x++)
821 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
823 /* correct invalid number of content fields -- should never happen */
824 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
825 num_contents = STD_ELEMENT_CONTENTS;
827 if (element == EL_YAMYAM)
829 level->num_yamyam_contents = num_contents;
831 for (i = 0; i < num_contents; i++)
832 for (y = 0; y < 3; y++)
833 for (x = 0; x < 3; x++)
834 level->yamyam_content[i][x][y] = content_array[i][x][y];
836 else if (element == EL_BD_AMOEBA)
838 level->amoeba_content = content_array[0][0][0];
842 Error(ERR_WARN, "cannot load content for element '%d'", element);
848 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
854 int chunk_size_expected;
856 element = getMappedElement(getFile16BitBE(file));
857 if (!IS_ENVELOPE(element))
858 element = EL_ENVELOPE_1;
860 envelope_nr = element - EL_ENVELOPE_1;
862 envelope_len = getFile16BitBE(file);
864 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
865 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
867 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
869 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
870 if (chunk_size_expected != chunk_size)
872 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
873 return chunk_size_expected;
876 for (i = 0; i < envelope_len; i++)
877 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
882 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
884 int num_changed_custom_elements = getFile16BitBE(file);
885 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
888 if (chunk_size_expected != chunk_size)
890 ReadUnusedBytesFromFile(file, chunk_size - 2);
891 return chunk_size_expected;
894 for (i = 0; i < num_changed_custom_elements; i++)
896 int element = getFile16BitBE(file);
897 int properties = getFile32BitBE(file);
899 if (IS_CUSTOM_ELEMENT(element))
900 Properties[element][EP_BITFIELD_BASE] = properties;
902 Error(ERR_WARN, "invalid custom element number %d", element);
908 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
910 int num_changed_custom_elements = getFile16BitBE(file);
911 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
914 if (chunk_size_expected != chunk_size)
916 ReadUnusedBytesFromFile(file, chunk_size - 2);
917 return chunk_size_expected;
920 for (i = 0; i < num_changed_custom_elements; i++)
922 int element = getFile16BitBE(file);
923 int custom_target_element = getFile16BitBE(file);
925 if (IS_CUSTOM_ELEMENT(element))
926 element_info[element].change->target_element = custom_target_element;
928 Error(ERR_WARN, "invalid custom element number %d", element);
934 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
936 int num_changed_custom_elements = getFile16BitBE(file);
937 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
940 if (chunk_size_expected != chunk_size)
942 ReadUnusedBytesFromFile(file, chunk_size - 2);
943 return chunk_size_expected;
946 for (i = 0; i < num_changed_custom_elements; i++)
948 int element = getFile16BitBE(file);
950 if (!IS_CUSTOM_ELEMENT(element))
952 Error(ERR_WARN, "invalid custom element number %d", element);
954 element = EL_INTERNAL_DUMMY;
957 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
958 element_info[element].description[j] = getFile8Bit(file);
959 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
961 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
963 /* some free bytes for future properties and padding */
964 ReadUnusedBytesFromFile(file, 7);
966 element_info[element].use_gfx_element = getFile8Bit(file);
967 element_info[element].gfx_element =
968 getMappedElement(getFile16BitBE(file));
970 element_info[element].collect_score = getFile8Bit(file);
971 element_info[element].collect_count = getFile8Bit(file);
973 element_info[element].push_delay_fixed = getFile16BitBE(file);
974 element_info[element].push_delay_random = getFile16BitBE(file);
975 element_info[element].move_delay_fixed = getFile16BitBE(file);
976 element_info[element].move_delay_random = getFile16BitBE(file);
978 element_info[element].move_pattern = getFile16BitBE(file);
979 element_info[element].move_direction_initial = getFile8Bit(file);
980 element_info[element].move_stepsize = getFile8Bit(file);
982 for (y = 0; y < 3; y++)
983 for (x = 0; x < 3; x++)
984 element_info[element].content[x][y] =
985 getMappedElement(getFile16BitBE(file));
987 element_info[element].change->events = getFile32BitBE(file);
989 element_info[element].change->target_element =
990 getMappedElement(getFile16BitBE(file));
992 element_info[element].change->delay_fixed = getFile16BitBE(file);
993 element_info[element].change->delay_random = getFile16BitBE(file);
994 element_info[element].change->delay_frames = getFile16BitBE(file);
996 element_info[element].change->trigger_element =
997 getMappedElement(getFile16BitBE(file));
999 element_info[element].change->explode = getFile8Bit(file);
1000 element_info[element].change->use_target_content = getFile8Bit(file);
1001 element_info[element].change->only_if_complete = getFile8Bit(file);
1002 element_info[element].change->use_random_replace = getFile8Bit(file);
1004 element_info[element].change->random_percentage = getFile8Bit(file);
1005 element_info[element].change->replace_when = getFile8Bit(file);
1007 for (y = 0; y < 3; y++)
1008 for (x = 0; x < 3; x++)
1009 element_info[element].change->target_content[x][y] =
1010 getMappedElement(getFile16BitBE(file));
1012 element_info[element].slippery_type = getFile8Bit(file);
1014 /* some free bytes for future properties and padding */
1015 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
1017 /* mark that this custom element has been modified */
1018 element_info[element].modified_settings = TRUE;
1024 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
1026 struct ElementInfo *ei;
1027 int chunk_size_expected;
1031 element = getFile16BitBE(file);
1033 if (!IS_CUSTOM_ELEMENT(element))
1035 Error(ERR_WARN, "invalid custom element number %d", element);
1037 ReadUnusedBytesFromFile(file, chunk_size - 2);
1041 ei = &element_info[element];
1043 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1044 ei->description[i] = getFile8Bit(file);
1045 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1047 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
1048 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
1050 ei->num_change_pages = getFile8Bit(file);
1052 /* some free bytes for future base property values and padding */
1053 ReadUnusedBytesFromFile(file, 5);
1055 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
1056 if (chunk_size_expected != chunk_size)
1058 ReadUnusedBytesFromFile(file, chunk_size - 48);
1059 return chunk_size_expected;
1062 /* read custom property values */
1064 ei->use_gfx_element = getFile8Bit(file);
1065 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1067 ei->collect_score = getFile8Bit(file);
1068 ei->collect_count = getFile8Bit(file);
1070 ei->drop_delay_fixed = getFile8Bit(file);
1071 ei->push_delay_fixed = getFile8Bit(file);
1072 ei->drop_delay_random = getFile8Bit(file);
1073 ei->push_delay_random = getFile8Bit(file);
1074 ei->move_delay_fixed = getFile16BitBE(file);
1075 ei->move_delay_random = getFile16BitBE(file);
1077 /* bits 0 - 15 of "move_pattern" ... */
1078 ei->move_pattern = getFile16BitBE(file);
1079 ei->move_direction_initial = getFile8Bit(file);
1080 ei->move_stepsize = getFile8Bit(file);
1082 ei->slippery_type = getFile8Bit(file);
1084 for (y = 0; y < 3; y++)
1085 for (x = 0; x < 3; x++)
1086 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
1088 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
1089 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
1090 ei->move_leave_type = getFile8Bit(file);
1092 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
1093 ei->move_pattern |= (getFile16BitBE(file) << 16);
1095 ei->access_direction = getFile8Bit(file);
1097 ei->explosion_delay = getFile8Bit(file);
1098 ei->ignition_delay = getFile8Bit(file);
1099 ei->explosion_type = getFile8Bit(file);
1101 /* some free bytes for future custom property values and padding */
1102 ReadUnusedBytesFromFile(file, 1);
1104 /* read change property values */
1106 setElementChangePages(ei, ei->num_change_pages);
1108 for (i = 0; i < ei->num_change_pages; i++)
1110 struct ElementChangeInfo *change = &ei->change_page[i];
1112 /* always start with reliable default values */
1113 setElementChangeInfoToDefaults(change);
1115 change->events = getFile32BitBE(file);
1117 change->target_element = getMappedElement(getFile16BitBE(file));
1119 change->delay_fixed = getFile16BitBE(file);
1120 change->delay_random = getFile16BitBE(file);
1121 change->delay_frames = getFile16BitBE(file);
1123 change->trigger_element = getMappedElement(getFile16BitBE(file));
1125 change->explode = getFile8Bit(file);
1126 change->use_target_content = getFile8Bit(file);
1127 change->only_if_complete = getFile8Bit(file);
1128 change->use_random_replace = getFile8Bit(file);
1130 change->random_percentage = getFile8Bit(file);
1131 change->replace_when = getFile8Bit(file);
1133 for (y = 0; y < 3; y++)
1134 for (x = 0; x < 3; x++)
1135 change->target_content[x][y] = getMappedElement(getFile16BitBE(file));
1137 change->can_change = getFile8Bit(file);
1139 change->trigger_side = getFile8Bit(file);
1142 change->trigger_player = getFile8Bit(file);
1143 change->trigger_page = getFile8Bit(file);
1145 change->trigger_page = (change->trigger_page == CH_PAGE_ANY_FILE ?
1146 CH_PAGE_ANY : (1 << change->trigger_page));
1148 /* some free bytes for future change property values and padding */
1149 ReadUnusedBytesFromFile(file, 6);
1153 /* some free bytes for future change property values and padding */
1154 ReadUnusedBytesFromFile(file, 8);
1158 /* mark this custom element as modified */
1159 ei->modified_settings = TRUE;
1164 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1166 struct ElementInfo *ei;
1167 struct ElementGroupInfo *group;
1171 element = getFile16BitBE(file);
1173 if (!IS_GROUP_ELEMENT(element))
1175 Error(ERR_WARN, "invalid group element number %d", element);
1177 ReadUnusedBytesFromFile(file, chunk_size - 2);
1181 ei = &element_info[element];
1183 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1184 ei->description[i] = getFile8Bit(file);
1185 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1187 group = element_info[element].group;
1189 group->num_elements = getFile8Bit(file);
1191 ei->use_gfx_element = getFile8Bit(file);
1192 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1194 group->choice_mode = getFile8Bit(file);
1196 /* some free bytes for future values and padding */
1197 ReadUnusedBytesFromFile(file, 3);
1199 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1200 group->element[i] = getMappedElement(getFile16BitBE(file));
1202 /* mark this group element as modified */
1203 element_info[element].modified_settings = TRUE;
1208 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1209 struct LevelFileInfo *level_file_info)
1211 char *filename = level_file_info->filename;
1212 char cookie[MAX_LINE_LEN];
1213 char chunk_name[CHUNK_ID_LEN + 1];
1217 if (!(file = fopen(filename, MODE_READ)))
1219 level->no_valid_file = TRUE;
1221 if (level != &level_template)
1222 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1227 getFileChunkBE(file, chunk_name, NULL);
1228 if (strcmp(chunk_name, "RND1") == 0)
1230 getFile32BitBE(file); /* not used */
1232 getFileChunkBE(file, chunk_name, NULL);
1233 if (strcmp(chunk_name, "CAVE") != 0)
1235 level->no_valid_file = TRUE;
1237 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1242 else /* check for pre-2.0 file format with cookie string */
1244 strcpy(cookie, chunk_name);
1245 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1246 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1247 cookie[strlen(cookie) - 1] = '\0';
1249 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1251 level->no_valid_file = TRUE;
1253 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1258 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1260 level->no_valid_file = TRUE;
1262 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1267 /* pre-2.0 level files have no game version, so use file version here */
1268 level->game_version = level->file_version;
1271 if (level->file_version < FILE_VERSION_1_2)
1273 /* level files from versions before 1.2.0 without chunk structure */
1274 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1275 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1283 int (*loader)(FILE *, int, struct LevelInfo *);
1287 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1288 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1289 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1290 { "BODY", -1, LoadLevel_BODY },
1291 { "CONT", -1, LoadLevel_CONT },
1292 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1293 { "CNT3", -1, LoadLevel_CNT3 },
1294 { "CUS1", -1, LoadLevel_CUS1 },
1295 { "CUS2", -1, LoadLevel_CUS2 },
1296 { "CUS3", -1, LoadLevel_CUS3 },
1297 { "CUS4", -1, LoadLevel_CUS4 },
1298 { "GRP1", -1, LoadLevel_GRP1 },
1302 while (getFileChunkBE(file, chunk_name, &chunk_size))
1306 while (chunk_info[i].name != NULL &&
1307 strcmp(chunk_name, chunk_info[i].name) != 0)
1310 if (chunk_info[i].name == NULL)
1312 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1313 chunk_name, filename);
1314 ReadUnusedBytesFromFile(file, chunk_size);
1316 else if (chunk_info[i].size != -1 &&
1317 chunk_info[i].size != chunk_size)
1319 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1320 chunk_size, chunk_name, filename);
1321 ReadUnusedBytesFromFile(file, chunk_size);
1325 /* call function to load this level chunk */
1326 int chunk_size_expected =
1327 (chunk_info[i].loader)(file, chunk_size, level);
1329 /* the size of some chunks cannot be checked before reading other
1330 chunks first (like "HEAD" and "BODY") that contain some header
1331 information, so check them here */
1332 if (chunk_size_expected != chunk_size)
1334 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1335 chunk_size, chunk_name, filename);
1344 /* ------------------------------------------------------------------------- */
1345 /* functions for loading EM level */
1346 /* ------------------------------------------------------------------------- */
1350 static int map_em_element_yam(int element)
1354 case 0x00: return EL_EMPTY;
1355 case 0x01: return EL_EMERALD;
1356 case 0x02: return EL_DIAMOND;
1357 case 0x03: return EL_ROCK;
1358 case 0x04: return EL_ROBOT;
1359 case 0x05: return EL_SPACESHIP_UP;
1360 case 0x06: return EL_BOMB;
1361 case 0x07: return EL_BUG_UP;
1362 case 0x08: return EL_AMOEBA_DROP;
1363 case 0x09: return EL_NUT;
1364 case 0x0a: return EL_YAMYAM;
1365 case 0x0b: return EL_QUICKSAND_FULL;
1366 case 0x0c: return EL_SAND;
1367 case 0x0d: return EL_WALL_SLIPPERY;
1368 case 0x0e: return EL_STEELWALL;
1369 case 0x0f: return EL_WALL;
1370 case 0x10: return EL_EM_KEY_1;
1371 case 0x11: return EL_EM_KEY_2;
1372 case 0x12: return EL_EM_KEY_4;
1373 case 0x13: return EL_EM_KEY_3;
1374 case 0x14: return EL_MAGIC_WALL;
1375 case 0x15: return EL_ROBOT_WHEEL;
1376 case 0x16: return EL_DYNAMITE;
1378 case 0x17: return EL_EM_KEY_1; /* EMC */
1379 case 0x18: return EL_BUG_UP; /* EMC */
1380 case 0x1a: return EL_DIAMOND; /* EMC */
1381 case 0x1b: return EL_EMERALD; /* EMC */
1382 case 0x25: return EL_NUT; /* EMC */
1383 case 0x80: return EL_EMPTY; /* EMC */
1384 case 0x85: return EL_EM_KEY_1; /* EMC */
1385 case 0x86: return EL_EM_KEY_2; /* EMC */
1386 case 0x87: return EL_EM_KEY_4; /* EMC */
1387 case 0x88: return EL_EM_KEY_3; /* EMC */
1388 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1389 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1390 case 0xaf: return EL_DYNAMITE; /* EMC */
1391 case 0xbd: return EL_SAND; /* EMC */
1394 Error(ERR_WARN, "invalid level element %d", element);
1399 static int map_em_element_field(int element)
1401 if (element >= 0xc8 && element <= 0xe1)
1402 return EL_CHAR_A + (element - 0xc8);
1403 else if (element >= 0xe2 && element <= 0xeb)
1404 return EL_CHAR_0 + (element - 0xe2);
1408 case 0x00: return EL_ROCK;
1409 case 0x01: return EL_ROCK; /* EMC */
1410 case 0x02: return EL_DIAMOND;
1411 case 0x03: return EL_DIAMOND;
1412 case 0x04: return EL_ROBOT;
1413 case 0x05: return EL_ROBOT; /* EMC */
1414 case 0x06: return EL_EMPTY_SPACE; /* EMC */
1415 case 0x07: return EL_EMPTY_SPACE; /* EMC */
1416 case 0x08: return EL_SPACESHIP_UP;
1417 case 0x09: return EL_SPACESHIP_RIGHT;
1418 case 0x0a: return EL_SPACESHIP_DOWN;
1419 case 0x0b: return EL_SPACESHIP_LEFT;
1420 case 0x0c: return EL_SPACESHIP_UP;
1421 case 0x0d: return EL_SPACESHIP_RIGHT;
1422 case 0x0e: return EL_SPACESHIP_DOWN;
1423 case 0x0f: return EL_SPACESHIP_LEFT;
1425 case 0x10: return EL_BOMB;
1426 case 0x11: return EL_BOMB; /* EMC */
1427 case 0x12: return EL_EMERALD;
1428 case 0x13: return EL_EMERALD;
1429 case 0x14: return EL_BUG_UP;
1430 case 0x15: return EL_BUG_RIGHT;
1431 case 0x16: return EL_BUG_DOWN;
1432 case 0x17: return EL_BUG_LEFT;
1433 case 0x18: return EL_BUG_UP;
1434 case 0x19: return EL_BUG_RIGHT;
1435 case 0x1a: return EL_BUG_DOWN;
1436 case 0x1b: return EL_BUG_LEFT;
1437 case 0x1c: return EL_AMOEBA_DROP;
1438 case 0x1d: return EL_AMOEBA_DROP; /* EMC */
1439 case 0x1e: return EL_AMOEBA_DROP; /* EMC */
1440 case 0x1f: return EL_AMOEBA_DROP; /* EMC */
1442 case 0x20: return EL_ROCK;
1443 case 0x21: return EL_BOMB; /* EMC */
1444 case 0x22: return EL_DIAMOND; /* EMC */
1445 case 0x23: return EL_EMERALD; /* EMC */
1446 case 0x24: return EL_MAGIC_WALL;
1447 case 0x25: return EL_NUT;
1448 case 0x26: return EL_NUT; /* EMC */
1449 case 0x27: return EL_NUT; /* EMC */
1451 /* looks like magic wheel, but is _always_ activated */
1452 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1454 case 0x29: return EL_YAMYAM; /* up */
1455 case 0x2a: return EL_YAMYAM; /* down */
1456 case 0x2b: return EL_YAMYAM; /* left */ /* EMC */
1457 case 0x2c: return EL_YAMYAM; /* right */ /* EMC */
1458 case 0x2d: return EL_QUICKSAND_FULL;
1459 case 0x2e: return EL_EMPTY_SPACE; /* EMC */
1460 case 0x2f: return EL_EMPTY_SPACE; /* EMC */
1462 case 0x30: return EL_EMPTY_SPACE; /* EMC */
1463 case 0x31: return EL_SAND; /* EMC */
1464 case 0x32: return EL_SAND; /* EMC */
1465 case 0x33: return EL_SAND; /* EMC */
1466 case 0x34: return EL_QUICKSAND_FULL; /* EMC */
1467 case 0x35: return EL_QUICKSAND_FULL; /* EMC */
1468 case 0x36: return EL_QUICKSAND_FULL; /* EMC */
1469 case 0x37: return EL_SAND; /* EMC */
1470 case 0x38: return EL_ROCK; /* EMC */
1471 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1472 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1473 case 0x3b: return EL_DYNAMITE_ACTIVE; /* 1 */
1474 case 0x3c: return EL_DYNAMITE_ACTIVE; /* 2 */
1475 case 0x3d: return EL_DYNAMITE_ACTIVE; /* 3 */
1476 case 0x3e: return EL_DYNAMITE_ACTIVE; /* 4 */
1477 case 0x3f: return EL_ACID_POOL_BOTTOM;
1479 case 0x40: return EL_EXIT_OPEN; /* 1 */
1480 case 0x41: return EL_EXIT_OPEN; /* 2 */
1481 case 0x42: return EL_EXIT_OPEN; /* 3 */
1482 case 0x43: return EL_BALLOON; /* EMC */
1483 case 0x44: return EL_UNKNOWN; /* EMC ("plant") */
1484 case 0x45: return EL_SPRING; /* EMC */
1485 case 0x46: return EL_SPRING; /* falling */ /* EMC */
1486 case 0x47: return EL_SPRING; /* left */ /* EMC */
1487 case 0x48: return EL_SPRING; /* right */ /* EMC */
1488 case 0x49: return EL_UNKNOWN; /* EMC ("ball 1") */
1489 case 0x4a: return EL_UNKNOWN; /* EMC ("ball 2") */
1490 case 0x4b: return EL_UNKNOWN; /* EMC ("android") */
1491 case 0x4c: return EL_EMPTY_SPACE; /* EMC */
1492 case 0x4d: return EL_UNKNOWN; /* EMC ("android") */
1493 case 0x4e: return EL_INVISIBLE_WALL; /* EMC (? "android") */
1494 case 0x4f: return EL_UNKNOWN; /* EMC ("android") */
1496 case 0x50: return EL_UNKNOWN; /* EMC ("android") */
1497 case 0x51: return EL_UNKNOWN; /* EMC ("android") */
1498 case 0x52: return EL_UNKNOWN; /* EMC ("android") */
1499 case 0x53: return EL_UNKNOWN; /* EMC ("android") */
1500 case 0x54: return EL_UNKNOWN; /* EMC ("android") */
1501 case 0x55: return EL_EMPTY_SPACE; /* EMC */
1502 case 0x56: return EL_EMPTY_SPACE; /* EMC */
1503 case 0x57: return EL_EMPTY_SPACE; /* EMC */
1504 case 0x58: return EL_EMPTY_SPACE; /* EMC */
1505 case 0x59: return EL_EMPTY_SPACE; /* EMC */
1506 case 0x5a: return EL_EMPTY_SPACE; /* EMC */
1507 case 0x5b: return EL_EMPTY_SPACE; /* EMC */
1508 case 0x5c: return EL_EMPTY_SPACE; /* EMC */
1509 case 0x5d: return EL_EMPTY_SPACE; /* EMC */
1510 case 0x5e: return EL_EMPTY_SPACE; /* EMC */
1511 case 0x5f: return EL_EMPTY_SPACE; /* EMC */
1513 case 0x60: return EL_EMPTY_SPACE; /* EMC */
1514 case 0x61: return EL_EMPTY_SPACE; /* EMC */
1515 case 0x62: return EL_EMPTY_SPACE; /* EMC */
1516 case 0x63: return EL_SPRING; /* left */ /* EMC */
1517 case 0x64: return EL_SPRING; /* right */ /* EMC */
1518 case 0x65: return EL_ACID; /* 1 */ /* EMC */
1519 case 0x66: return EL_ACID; /* 2 */ /* EMC */
1520 case 0x67: return EL_ACID; /* 3 */ /* EMC */
1521 case 0x68: return EL_ACID; /* 4 */ /* EMC */
1522 case 0x69: return EL_ACID; /* 5 */ /* EMC */
1523 case 0x6a: return EL_ACID; /* 6 */ /* EMC */
1524 case 0x6b: return EL_ACID; /* 7 */ /* EMC */
1525 case 0x6c: return EL_ACID; /* 8 */ /* EMC */
1526 case 0x6d: return EL_EMPTY_SPACE; /* EMC */
1527 case 0x6e: return EL_EMPTY_SPACE; /* EMC */
1528 case 0x6f: return EL_EMPTY_SPACE; /* EMC */
1530 case 0x70: return EL_EMPTY_SPACE; /* EMC */
1531 case 0x71: return EL_EMPTY_SPACE; /* EMC */
1532 case 0x72: return EL_NUT; /* left */ /* EMC */
1533 case 0x73: return EL_SAND; /* EMC (? "nut") */
1534 case 0x74: return EL_STEELWALL;
1535 case 0x75: return EL_EMPTY_SPACE; /* EMC */
1536 case 0x76: return EL_EMPTY_SPACE; /* EMC */
1537 case 0x77: return EL_BOMB; /* left */ /* EMC */
1538 case 0x78: return EL_BOMB; /* right */ /* EMC */
1539 case 0x79: return EL_ROCK; /* left */ /* EMC */
1540 case 0x7a: return EL_ROCK; /* right */ /* EMC */
1541 case 0x7b: return EL_ACID; /* (? EMC "blank") */
1542 case 0x7c: return EL_EMPTY_SPACE; /* EMC */
1543 case 0x7d: return EL_EMPTY_SPACE; /* EMC */
1544 case 0x7e: return EL_EMPTY_SPACE; /* EMC */
1545 case 0x7f: return EL_EMPTY_SPACE; /* EMC */
1547 case 0x80: return EL_EMPTY;
1548 case 0x81: return EL_WALL_SLIPPERY;
1549 case 0x82: return EL_SAND;
1550 case 0x83: return EL_STEELWALL;
1551 case 0x84: return EL_WALL;
1552 case 0x85: return EL_EM_KEY_1;
1553 case 0x86: return EL_EM_KEY_2;
1554 case 0x87: return EL_EM_KEY_4;
1555 case 0x88: return EL_EM_KEY_3;
1556 case 0x89: return EL_EM_GATE_1;
1557 case 0x8a: return EL_EM_GATE_2;
1558 case 0x8b: return EL_EM_GATE_4;
1559 case 0x8c: return EL_EM_GATE_3;
1560 case 0x8d: return EL_INVISIBLE_WALL; /* EMC (? "dripper") */
1561 case 0x8e: return EL_EM_GATE_1_GRAY;
1562 case 0x8f: return EL_EM_GATE_2_GRAY;
1564 case 0x90: return EL_EM_GATE_4_GRAY;
1565 case 0x91: return EL_EM_GATE_3_GRAY;
1566 case 0x92: return EL_MAGIC_WALL;
1567 case 0x93: return EL_ROBOT_WHEEL;
1568 case 0x94: return EL_QUICKSAND_EMPTY; /* (? EMC "sand") */
1569 case 0x95: return EL_ACID_POOL_TOPLEFT;
1570 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1571 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1572 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1573 case 0x99: return EL_ACID; /* (? EMC "fake blank") */
1574 case 0x9a: return EL_AMOEBA_DEAD; /* 1 */
1575 case 0x9b: return EL_AMOEBA_DEAD; /* 2 */
1576 case 0x9c: return EL_AMOEBA_DEAD; /* 3 */
1577 case 0x9d: return EL_AMOEBA_DEAD; /* 4 */
1578 case 0x9e: return EL_EXIT_CLOSED;
1579 case 0x9f: return EL_CHAR_LESS; /* arrow left */
1581 /* looks like normal sand, but behaves like wall */
1582 case 0xa0: return EL_UNKNOWN; /* EMC ("fake grass") */
1583 case 0xa1: return EL_UNKNOWN; /* EMC ("lenses") */
1584 case 0xa2: return EL_UNKNOWN; /* EMC ("magnify") */
1585 case 0xa3: return EL_UNKNOWN; /* EMC ("fake blank") */
1586 case 0xa4: return EL_UNKNOWN; /* EMC ("fake grass") */
1587 case 0xa5: return EL_UNKNOWN; /* EMC ("switch") */
1588 case 0xa6: return EL_UNKNOWN; /* EMC ("switch") */
1589 case 0xa7: return EL_EMPTY_SPACE; /* EMC */
1590 case 0xa8: return EL_EMC_WALL_1; /* EMC ("decor 8") */
1591 case 0xa9: return EL_EMC_WALL_2; /* EMC ("decor 9") */
1592 case 0xaa: return EL_EMC_WALL_3; /* EMC ("decor 10") */
1593 case 0xab: return EL_EMC_WALL_7; /* EMC ("decor 5") */
1594 case 0xac: return EL_CHAR_COMMA; /* EMC */
1595 case 0xad: return EL_CHAR_QUOTEDBL; /* EMC */
1596 case 0xae: return EL_CHAR_MINUS; /* EMC */
1597 case 0xaf: return EL_DYNAMITE;
1599 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC ("steel 3") */
1600 case 0xb1: return EL_EMC_WALL_8; /* EMC ("decor 6") */
1601 case 0xb2: return EL_UNKNOWN; /* EMC ("decor 7") */
1602 case 0xb3: return EL_STEELWALL; /* 2 */ /* EMC */
1603 case 0xb4: return EL_WALL_SLIPPERY; /* 2 */ /* EMC */
1604 case 0xb5: return EL_EMC_WALL_6; /* EMC ("decor 2") */
1605 case 0xb6: return EL_EMC_WALL_5; /* EMC ("decor 4") */
1606 case 0xb7: return EL_EMC_WALL_4; /* EMC ("decor 3") */
1607 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1608 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1609 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1610 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1611 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1612 case 0xbd: return EL_SAND; /* EMC ("dirt") */
1613 case 0xbe: return EL_UNKNOWN; /* EMC ("plant") */
1614 case 0xbf: return EL_UNKNOWN; /* EMC ("key 5") */
1616 case 0xc0: return EL_UNKNOWN; /* EMC ("key 6") */
1617 case 0xc1: return EL_UNKNOWN; /* EMC ("key 7") */
1618 case 0xc2: return EL_UNKNOWN; /* EMC ("key 8") */
1619 case 0xc3: return EL_UNKNOWN; /* EMC ("door 5") */
1620 case 0xc4: return EL_UNKNOWN; /* EMC ("door 6") */
1621 case 0xc5: return EL_UNKNOWN; /* EMC ("door 7") */
1622 case 0xc6: return EL_UNKNOWN; /* EMC ("door 8") */
1623 case 0xc7: return EL_UNKNOWN; /* EMC ("bumper") */
1625 /* characters: see above */
1627 case 0xec: return EL_CHAR_PERIOD;
1628 case 0xed: return EL_CHAR_EXCLAM;
1629 case 0xee: return EL_CHAR_COLON;
1630 case 0xef: return EL_CHAR_QUESTION;
1632 case 0xf0: return EL_CHAR_GREATER; /* arrow right */
1633 case 0xf1: return EL_CHAR_COPYRIGHT; /* EMC: "decor 1" */
1634 case 0xf2: return EL_UNKNOWN; /* EMC ("fake door 5") */
1635 case 0xf3: return EL_UNKNOWN; /* EMC ("fake door 6") */
1636 case 0xf4: return EL_UNKNOWN; /* EMC ("fake door 7") */
1637 case 0xf5: return EL_UNKNOWN; /* EMC ("fake door 8") */
1638 case 0xf6: return EL_EMPTY_SPACE; /* EMC */
1639 case 0xf7: return EL_EMPTY_SPACE; /* EMC */
1641 case 0xf8: return EL_EMPTY_SPACE; /* EMC */
1642 case 0xf9: return EL_EMPTY_SPACE; /* EMC */
1643 case 0xfa: return EL_EMPTY_SPACE; /* EMC */
1644 case 0xfb: return EL_EMPTY_SPACE; /* EMC */
1645 case 0xfc: return EL_EMPTY_SPACE; /* EMC */
1646 case 0xfd: return EL_EMPTY_SPACE; /* EMC */
1648 case 0xfe: return EL_PLAYER_1; /* EMC: "blank" */
1649 case 0xff: return EL_PLAYER_2; /* EMC: "blank" */
1652 /* should never happen (all 8-bit value cases should be handled) */
1653 Error(ERR_WARN, "invalid level element %d", element);
1658 #define EM_LEVEL_SIZE 2106
1659 #define EM_LEVEL_XSIZE 64
1660 #define EM_LEVEL_YSIZE 32
1662 static void OLD_LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1663 struct LevelFileInfo *level_file_info)
1665 char *filename = level_file_info->filename;
1667 unsigned char leveldata[EM_LEVEL_SIZE];
1668 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1669 int nr = level_file_info->nr;
1672 if (!(file = fopen(filename, MODE_READ)))
1674 level->no_valid_file = TRUE;
1676 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1681 for (i = 0; i < EM_LEVEL_SIZE; i++)
1682 leveldata[i] = fgetc(file);
1686 /* check if level data is crypted by testing against known starting bytes
1687 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1689 if ((leveldata[0] == 0xf1 ||
1690 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1692 unsigned char code0 = 0x65;
1693 unsigned char code1 = 0x11;
1695 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1696 leveldata[0] = 0xf1;
1698 /* decode crypted level data */
1700 for (i = 0; i < EM_LEVEL_SIZE; i++)
1702 leveldata[i] ^= code0;
1703 leveldata[i] -= code1;
1705 code0 = (code0 + 7) & 0xff;
1709 level->fieldx = EM_LEVEL_XSIZE;
1710 level->fieldy = EM_LEVEL_YSIZE;
1712 level->time = header[46] * 10;
1713 level->gems_needed = header[47];
1715 /* The original Emerald Mine levels have their level number stored
1716 at the second byte of the level file...
1717 Do not trust this information at other level files, e.g. EMC,
1718 but correct it anyway (normally the first row is completely
1719 steel wall, so the correction does not hurt anyway). */
1721 if (leveldata[1] == nr)
1722 leveldata[1] = leveldata[2]; /* correct level number field */
1724 sprintf(level->name, "Level %d", nr); /* set level name */
1726 level->score[SC_EMERALD] = header[36];
1727 level->score[SC_DIAMOND] = header[37];
1728 level->score[SC_ROBOT] = header[38];
1729 level->score[SC_SPACESHIP] = header[39];
1730 level->score[SC_BUG] = header[40];
1731 level->score[SC_YAMYAM] = header[41];
1732 level->score[SC_NUT] = header[42];
1733 level->score[SC_DYNAMITE] = header[43];
1734 level->score[SC_TIME_BONUS] = header[44];
1736 level->num_yamyam_contents = 4;
1738 for (i = 0; i < level->num_yamyam_contents; i++)
1739 for (y = 0; y < 3; y++)
1740 for (x = 0; x < 3; x++)
1741 level->yamyam_content[i][x][y] =
1742 map_em_element_yam(header[i * 9 + y * 3 + x]);
1744 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1745 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1746 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1747 level->amoeba_content = EL_DIAMOND;
1749 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1751 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1753 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1754 new_element = EL_AMOEBA_WET;
1756 level->field[x][y] = new_element;
1759 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1760 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1761 level->field[x][y] = EL_PLAYER_1;
1763 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1764 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1765 level->field[x][y] = EL_PLAYER_2;
1770 void CopyNativeLevel_RND_to_EM(struct LevelInfo *level)
1772 struct LevelInfo_EM *level_em = level->native_em_level;
1773 struct LEVEL *lev = level_em->lev;
1774 struct PLAYER *ply1 = level_em->ply1;
1775 struct PLAYER *ply2 = level_em->ply2;
1778 lev->width = MIN(level->fieldx, EM_MAX_CAVE_WIDTH);
1779 lev->height = MIN(level->fieldy, EM_MAX_CAVE_HEIGHT);
1781 lev->time_initial = level->time;
1782 lev->required_initial = level->gems_needed;
1784 lev->emerald_score = level->score[SC_EMERALD];
1785 lev->diamond_score = level->score[SC_DIAMOND];
1786 lev->alien_score = level->score[SC_ROBOT];
1787 lev->tank_score = level->score[SC_SPACESHIP];
1788 lev->bug_score = level->score[SC_BUG];
1789 lev->eater_score = level->score[SC_YAMYAM];
1790 lev->nut_score = level->score[SC_NUT];
1791 lev->dynamite_score = level->score[SC_DYNAMITE];
1792 lev->key_score = level->score[SC_TIME_BONUS]; /* ??? CHECK THIS */
1794 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
1795 for (y = 0; y < 3; y++)
1796 for (x = 0; x < 3; x++)
1797 lev->eater_array[i][y * 3 + x] =
1798 map_element_RND_to_EM(level->yamyam_content[i][x][y]);
1800 lev->amoeba_time = level->amoeba_speed;
1801 lev->wonderwall_time_initial = level->time_magic_wall;
1802 lev->wheel_time = level->time_wheel;
1804 /* first fill the complete playfield with the default border element */
1805 for (y = 0; y < EM_MAX_CAVE_HEIGHT; y++)
1806 for (x = 0; x < EM_MAX_CAVE_WIDTH; x++)
1807 level_em->cave[x][y] = ZBORDER;
1809 /* then copy the real level contents from level file into the playfield */
1810 for (y = 0; y < lev->height; y++) for (x = 0; x < lev->width; x++)
1812 int new_element = map_element_RND_to_EM(level->field[x][y]);
1814 level_em->cave[x + 1][y + 1] = new_element;
1817 ply1->x_initial = 0;
1818 ply1->y_initial = 0;
1820 ply2->x_initial = 0;
1821 ply2->y_initial = 0;
1823 /* at last, set the two players at their positions in the playfield */
1824 for (y = 0; y < lev->height; y++) for (x = 0; x < lev->width; x++)
1826 if (level->field[x][y] == EL_PLAYER_1)
1828 ply1->x_initial = x + 1;
1829 ply1->y_initial = y + 1;
1831 else if (level->field[x][y] == EL_PLAYER_2)
1833 ply2->x_initial = x + 1;
1834 ply2->y_initial = y + 1;
1839 void CopyNativeLevel_EM_to_RND(struct LevelInfo *level)
1841 struct LevelInfo_EM *level_em = level->native_em_level;
1842 struct LEVEL *lev = level_em->lev;
1843 struct PLAYER *ply1 = level_em->ply1;
1844 struct PLAYER *ply2 = level_em->ply2;
1847 level->fieldx = MIN(lev->width, MAX_LEV_FIELDX);
1848 level->fieldy = MIN(lev->height, MAX_LEV_FIELDY);
1850 level->time = lev->time_initial;
1851 level->gems_needed = lev->required_initial;
1853 sprintf(level->name, "Level %d", level->file_info.nr);
1855 level->score[SC_EMERALD] = lev->emerald_score;
1856 level->score[SC_DIAMOND] = lev->diamond_score;
1857 level->score[SC_ROBOT] = lev->alien_score;
1858 level->score[SC_SPACESHIP] = lev->tank_score;
1859 level->score[SC_BUG] = lev->bug_score;
1860 level->score[SC_YAMYAM] = lev->eater_score;
1861 level->score[SC_NUT] = lev->nut_score;
1862 level->score[SC_DYNAMITE] = lev->dynamite_score;
1863 level->score[SC_TIME_BONUS] = lev->key_score; /* ??? CHECK THIS */
1865 level->num_yamyam_contents = MAX_ELEMENT_CONTENTS;
1867 for (i = 0; i < level->num_yamyam_contents; i++)
1868 for (y = 0; y < 3; y++)
1869 for (x = 0; x < 3; x++)
1870 level->yamyam_content[i][x][y] =
1871 map_element_EM_to_RND(lev->eater_array[i][y * 3 + x]);
1873 level->amoeba_speed = lev->amoeba_time;
1874 level->time_magic_wall = lev->wonderwall_time_initial;
1875 level->time_wheel = lev->wheel_time;
1877 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1879 int new_element = map_element_EM_to_RND(level_em->cave[x + 1][y + 1]);
1881 if (new_element == EL_AMOEBA_WET && level->amoeba_speed == 0)
1882 new_element = EL_AMOEBA_DEAD;
1884 level->field[x][y] = new_element;
1887 level->field[ply1->x_initial - 1][ply1->y_initial - 1] = EL_PLAYER_1;
1888 level->field[ply2->x_initial - 1][ply2->y_initial - 1] = EL_PLAYER_2;
1891 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1892 struct LevelFileInfo *level_file_info)
1894 if (!LoadNativeLevel_EM(level_file_info->filename))
1895 level->no_valid_file = TRUE;
1900 void CopyNativeLevel_RND_to_Native(struct LevelInfo *level)
1902 if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
1903 CopyNativeLevel_RND_to_EM(level);
1906 void CopyNativeLevel_Native_to_RND(struct LevelInfo *level)
1908 if (level->game_engine_type == GAME_ENGINE_TYPE_EM)
1909 CopyNativeLevel_EM_to_RND(level);
1913 /* ------------------------------------------------------------------------- */
1914 /* functions for loading SP level */
1915 /* ------------------------------------------------------------------------- */
1917 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1918 #define SP_LEVEL_SIZE 1536
1919 #define SP_LEVEL_XSIZE 60
1920 #define SP_LEVEL_YSIZE 24
1921 #define SP_LEVEL_NAME_LEN 23
1923 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1926 int num_special_ports;
1929 /* for details of the Supaplex level format, see Herman Perk's Supaplex
1930 documentation file "SPFIX63.DOC" from his Supaplex "SpeedFix" package */
1932 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1933 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1935 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1937 int element_old = fgetc(file);
1940 if (element_old <= 0x27)
1941 element_new = getMappedElement(EL_SP_START + element_old);
1942 else if (element_old == 0x28)
1943 element_new = EL_INVISIBLE_WALL;
1946 Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1947 Error(ERR_WARN, "invalid level element %d", element_old);
1949 element_new = EL_UNKNOWN;
1952 level->field[x][y] = element_new;
1956 ReadUnusedBytesFromFile(file, 4); /* (not used by Supaplex engine) */
1958 /* initial gravity: 1 == "on", anything else (0) == "off" */
1959 level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1961 ReadUnusedBytesFromFile(file, 1); /* (not used by Supaplex engine) */
1963 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1964 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1965 level->name[i] = fgetc(file);
1966 level->name[SP_LEVEL_NAME_LEN] = '\0';
1968 /* initial "freeze zonks": 2 == "on", anything else (0, 1) == "off" */
1969 ReadUnusedBytesFromFile(file, 1); /* (not used by R'n'D engine) */
1971 /* number of infotrons needed; 0 means that Supaplex will count the total
1972 amount of infotrons in the level and use the low byte of that number
1973 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1974 level->gems_needed = fgetc(file);
1976 /* number of special ("gravity") port entries below (maximum 10 allowed) */
1977 num_special_ports = fgetc(file);
1979 /* database of properties of up to 10 special ports (6 bytes per port) */
1980 for (i = 0; i < 10; i++)
1982 int port_location, port_x, port_y, port_element;
1985 /* high and low byte of the location of a special port; if (x, y) are the
1986 coordinates of a port in the field and (0, 0) is the top-left corner,
1987 the 16 bit value here calculates as 2 * (x + (y * 60)) (this is twice
1988 of what may be expected: Supaplex works with a game field in memory
1989 which is 2 bytes per tile) */
1990 port_location = getFile16BitBE(file);
1992 /* change gravity: 1 == "turn on", anything else (0) == "turn off" */
1993 gravity = fgetc(file);
1995 /* "freeze zonks": 2 == "turn on", anything else (0, 1) == "turn off" */
1996 ReadUnusedBytesFromFile(file, 1); /* (not used by R'n'D engine) */
1998 /* "freeze enemies": 1 == "turn on", anything else (0) == "turn off" */
1999 ReadUnusedBytesFromFile(file, 1); /* (not used by R'n'D engine) */
2001 ReadUnusedBytesFromFile(file, 1); /* (not used by Supaplex engine) */
2003 if (i >= num_special_ports)
2006 port_x = (port_location / 2) % SP_LEVEL_XSIZE;
2007 port_y = (port_location / 2) / SP_LEVEL_XSIZE;
2009 if (port_x < 0 || port_x >= SP_LEVEL_XSIZE ||
2010 port_y < 0 || port_y >= SP_LEVEL_YSIZE)
2012 Error(ERR_WARN, "special port position (%d, %d) out of bounds",
2018 port_element = level->field[port_x][port_y];
2020 if (port_element < EL_SP_GRAVITY_PORT_RIGHT ||
2021 port_element > EL_SP_GRAVITY_PORT_UP)
2023 Error(ERR_WARN, "no special port at position (%d, %d)", port_x, port_y);
2028 /* change previous (wrong) gravity inverting special port to either
2029 gravity enabling special port or gravity disabling special port */
2030 level->field[port_x][port_y] +=
2031 (gravity == 1 ? EL_SP_GRAVITY_ON_PORT_RIGHT :
2032 EL_SP_GRAVITY_OFF_PORT_RIGHT) - EL_SP_GRAVITY_PORT_RIGHT;
2035 ReadUnusedBytesFromFile(file, 4); /* (not used by Supaplex engine) */
2037 /* change special gravity ports without database entries to normal ports */
2038 for (y = 0; y < SP_LEVEL_YSIZE; y++)
2039 for (x = 0; x < SP_LEVEL_XSIZE; x++)
2040 if (level->field[x][y] >= EL_SP_GRAVITY_PORT_RIGHT &&
2041 level->field[x][y] <= EL_SP_GRAVITY_PORT_UP)
2042 level->field[x][y] += EL_SP_PORT_RIGHT - EL_SP_GRAVITY_PORT_RIGHT;
2044 /* auto-determine number of infotrons if it was stored as "0" -- see above */
2045 if (level->gems_needed == 0)
2047 for (y = 0; y < SP_LEVEL_YSIZE; y++)
2048 for (x = 0; x < SP_LEVEL_XSIZE; x++)
2049 if (level->field[x][y] == EL_SP_INFOTRON)
2050 level->gems_needed++;
2052 level->gems_needed &= 0xff; /* only use low byte -- see above */
2055 level->fieldx = SP_LEVEL_XSIZE;
2056 level->fieldy = SP_LEVEL_YSIZE;
2058 level->time = 0; /* no time limit */
2059 level->amoeba_speed = 0;
2060 level->time_magic_wall = 0;
2061 level->time_wheel = 0;
2062 level->amoeba_content = EL_EMPTY;
2064 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2065 level->score[i] = 0; /* !!! CORRECT THIS !!! */
2067 /* there are no yamyams in supaplex levels */
2068 for (i = 0; i < level->num_yamyam_contents; i++)
2069 for (y = 0; y < 3; y++)
2070 for (x = 0; x < 3; x++)
2071 level->yamyam_content[i][x][y] = EL_EMPTY;
2074 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
2075 struct LevelFileInfo *level_file_info)
2077 char *filename = level_file_info->filename;
2079 int nr = level_file_info->nr - leveldir_current->first_level;
2081 char name_first, name_last;
2082 struct LevelInfo multipart_level;
2083 int multipart_xpos, multipart_ypos;
2084 boolean is_multipart_level;
2085 boolean is_first_part;
2086 boolean reading_multipart_level = FALSE;
2087 boolean use_empty_level = FALSE;
2089 if (!(file = fopen(filename, MODE_READ)))
2091 level->no_valid_file = TRUE;
2093 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
2098 /* position file stream to the requested level inside the level package */
2099 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
2101 level->no_valid_file = TRUE;
2103 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
2108 /* there exist Supaplex level package files with multi-part levels which
2109 can be detected as follows: instead of leading and trailing dashes ('-')
2110 to pad the level name, they have leading and trailing numbers which are
2111 the x and y coordinations of the current part of the multi-part level;
2112 if there are '?' characters instead of numbers on the left or right side
2113 of the level name, the multi-part level consists of only horizontal or
2116 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
2118 LoadLevelFromFileStream_SP(file, level, l);
2120 /* check if this level is a part of a bigger multi-part level */
2122 name_first = level->name[0];
2123 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
2125 is_multipart_level =
2126 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
2127 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
2130 ((name_first == '?' || name_first == '1') &&
2131 (name_last == '?' || name_last == '1'));
2133 /* correct leading multipart level meta information in level name */
2134 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
2135 level->name[i] = '-';
2137 /* correct trailing multipart level meta information in level name */
2138 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
2139 level->name[i] = '-';
2141 /* ---------- check for normal single level ---------- */
2143 if (!reading_multipart_level && !is_multipart_level)
2145 /* the current level is simply a normal single-part level, and we are
2146 not reading a multi-part level yet, so return the level as it is */
2151 /* ---------- check for empty level (unused multi-part) ---------- */
2153 if (!reading_multipart_level && is_multipart_level && !is_first_part)
2155 /* this is a part of a multi-part level, but not the first part
2156 (and we are not already reading parts of a multi-part level);
2157 in this case, use an empty level instead of the single part */
2159 use_empty_level = TRUE;
2164 /* ---------- check for finished multi-part level ---------- */
2166 if (reading_multipart_level &&
2167 (!is_multipart_level ||
2168 strcmp(level->name, multipart_level.name) != 0))
2170 /* we are already reading parts of a multi-part level, but this level is
2171 either not a multi-part level, or a part of a different multi-part
2172 level; in both cases, the multi-part level seems to be complete */
2177 /* ---------- here we have one part of a multi-part level ---------- */
2179 reading_multipart_level = TRUE;
2181 if (is_first_part) /* start with first part of new multi-part level */
2183 /* copy level info structure from first part */
2184 multipart_level = *level;
2186 /* clear playfield of new multi-part level */
2187 for (y = 0; y < MAX_LEV_FIELDY; y++)
2188 for (x = 0; x < MAX_LEV_FIELDX; x++)
2189 multipart_level.field[x][y] = EL_EMPTY;
2192 if (name_first == '?')
2194 if (name_last == '?')
2197 multipart_xpos = (int)(name_first - '0');
2198 multipart_ypos = (int)(name_last - '0');
2201 printf("----------> part (%d/%d) of multi-part level '%s'\n",
2202 multipart_xpos, multipart_ypos, multipart_level.name);
2205 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
2206 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
2208 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
2213 multipart_level.fieldx = MAX(multipart_level.fieldx,
2214 multipart_xpos * SP_LEVEL_XSIZE);
2215 multipart_level.fieldy = MAX(multipart_level.fieldy,
2216 multipart_ypos * SP_LEVEL_YSIZE);
2218 /* copy level part at the right position of multi-part level */
2219 for (y = 0; y < SP_LEVEL_YSIZE; y++)
2221 for (x = 0; x < SP_LEVEL_XSIZE; x++)
2223 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
2224 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
2226 multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
2233 if (use_empty_level)
2235 setLevelInfoToDefaults(level);
2237 level->fieldx = SP_LEVEL_XSIZE;
2238 level->fieldy = SP_LEVEL_YSIZE;
2240 for (y = 0; y < SP_LEVEL_YSIZE; y++)
2241 for (x = 0; x < SP_LEVEL_XSIZE; x++)
2242 level->field[x][y] = EL_EMPTY;
2244 strcpy(level->name, "-------- EMPTY --------");
2246 Error(ERR_WARN, "single part of multi-part level -- using empty level");
2249 if (reading_multipart_level)
2250 *level = multipart_level;
2253 /* ------------------------------------------------------------------------- */
2254 /* functions for loading generic level */
2255 /* ------------------------------------------------------------------------- */
2257 void LoadLevelFromFileInfo(struct LevelInfo *level,
2258 struct LevelFileInfo *level_file_info)
2260 /* always start with reliable default values */
2261 setLevelInfoToDefaults(level);
2263 switch (level_file_info->type)
2265 case LEVEL_FILE_TYPE_RND:
2266 LoadLevelFromFileInfo_RND(level, level_file_info);
2269 case LEVEL_FILE_TYPE_EM:
2270 LoadLevelFromFileInfo_EM(level, level_file_info);
2271 level->game_engine_type = GAME_ENGINE_TYPE_EM;
2274 case LEVEL_FILE_TYPE_SP:
2275 LoadLevelFromFileInfo_SP(level, level_file_info);
2279 LoadLevelFromFileInfo_RND(level, level_file_info);
2283 if (level->game_engine_type == GAME_ENGINE_TYPE_UNKNOWN)
2284 level->game_engine_type = GAME_ENGINE_TYPE_RND;
2286 CopyNativeLevel_Native_to_RND(level);
2289 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
2291 static struct LevelFileInfo level_file_info;
2293 /* always start with reliable default values */
2294 setFileInfoToDefaults(&level_file_info);
2296 level_file_info.nr = 0; /* unknown level number */
2297 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
2298 level_file_info.filename = filename;
2300 LoadLevelFromFileInfo(level, &level_file_info);
2303 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
2305 if (leveldir_current == NULL) /* only when dumping level */
2309 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
2312 /* determine correct game engine version of current level */
2314 if (!leveldir_current->latest_engine)
2316 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
2317 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
2318 IS_LEVELCLASS_UNDEFINED(leveldir_current))
2322 printf("\n::: This level is private or contributed: '%s'\n", filename);
2326 printf("\n::: Use the stored game engine version for this level\n");
2329 /* For all levels which are not forced to use the latest game engine
2330 version (normally user contributed, private and undefined levels),
2331 use the version of the game engine the levels were created for.
2333 Since 2.0.1, the game engine version is now directly stored
2334 in the level file (chunk "VERS"), so there is no need anymore
2335 to set the game version from the file version (except for old,
2336 pre-2.0 levels, where the game version is still taken from the
2337 file format version used to store the level -- see above). */
2340 /* player was faster than enemies in 1.0.0 and before */
2341 if (level->file_version == FILE_VERSION_1_0)
2342 level->double_speed = TRUE;
2344 /* do some special adjustments to support older level versions */
2345 if (level->file_version == FILE_VERSION_1_0)
2347 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
2348 Error(ERR_WARN, "using high speed movement for player");
2350 /* player was faster than monsters in (pre-)1.0 levels */
2351 level->double_speed = TRUE;
2355 /* default behaviour for EM style gems was "slippery" only in 2.0.1 */
2356 if (level->game_version == VERSION_IDENT(2,0,1,0))
2357 level->em_slippery_gems = TRUE;
2359 /* springs could be pushed over pits before (pre-release version) 2.2.0 */
2360 if (level->game_version < VERSION_IDENT(2,2,0,0))
2361 level->use_spring_bug = TRUE;
2363 /* only few elements were able to actively move into acid before 3.1.0 */
2364 if (level->game_version < VERSION_IDENT(3,1,0,0))
2368 level->can_move_into_acid_bits = 0; /* nothing can move into acid */
2369 level->dont_collide_with_bits = 0; /* nothing is deadly when colliding */
2371 setMoveIntoAcidProperty(level, EL_ROBOT, TRUE);
2372 setMoveIntoAcidProperty(level, EL_SATELLITE, TRUE);
2373 setMoveIntoAcidProperty(level, EL_PENGUIN, TRUE);
2374 setMoveIntoAcidProperty(level, EL_BALLOON, TRUE);
2376 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2377 SET_PROPERTY(EL_CUSTOM_START + i, EP_CAN_MOVE_INTO_ACID, TRUE);
2379 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2381 int element = EL_CUSTOM_START + i;
2382 struct ElementInfo *ei = &element_info[element];
2384 for (j = 0; j < ei->num_change_pages; j++)
2386 struct ElementChangeInfo *change = &ei->change_page[j];
2388 change->trigger_player = CH_PLAYER_ANY;
2389 change->trigger_page = CH_PAGE_ANY;
2394 #if 1 /* USE_NEW_BLOCK_STYLE */
2395 /* blocking the last field when moving was corrected in version 3.1.1 */
2396 if (level->game_version < VERSION_IDENT(3,1,1,0))
2399 printf("::: %d\n", level->block_last_field);
2402 /* even "not blocking" was blocking the last field for one frame */
2403 level->block_delay = (level->block_last_field ? 7 : 1);
2404 level->sp_block_delay = (level->sp_block_last_field ? 7 : 1);
2406 level->block_last_field = TRUE;
2407 level->sp_block_last_field = TRUE;
2411 else /* always use the latest game engine version */
2414 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
2415 leveldir_current->sort_priority, filename);
2419 printf("\n::: Use latest game engine version for this level.\n");
2422 /* For all levels which are forced to use the latest game engine version
2423 (normally all but user contributed, private and undefined levels), set
2424 the game engine version to the actual version; this allows for actual
2425 corrections in the game engine to take effect for existing, converted
2426 levels (from "classic" or other existing games) to make the emulation
2427 of the corresponding game more accurate, while (hopefully) not breaking
2428 existing levels created from other players. */
2431 printf("::: changing engine from %d to %d\n",
2432 level->game_version, GAME_VERSION_ACTUAL);
2435 level->game_version = GAME_VERSION_ACTUAL;
2437 /* Set special EM style gems behaviour: EM style gems slip down from
2438 normal, steel and growing wall. As this is a more fundamental change,
2439 it seems better to set the default behaviour to "off" (as it is more
2440 natural) and make it configurable in the level editor (as a property
2441 of gem style elements). Already existing converted levels (neither
2442 private nor contributed levels) are changed to the new behaviour. */
2444 if (level->file_version < FILE_VERSION_2_0)
2445 level->em_slippery_gems = TRUE;
2449 printf("::: => %d\n", level->game_version);
2453 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
2457 /* map custom element change events that have changed in newer versions
2458 (these following values were accidentally changed in version 3.0.1) */
2459 if (level->game_version <= VERSION_IDENT(3,0,0,0))
2461 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2463 int element = EL_CUSTOM_START + i;
2465 /* order of checking and copying events to be mapped is important */
2466 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
2468 if (HAS_CHANGE_EVENT(element, j - 2))
2470 SET_CHANGE_EVENT(element, j - 2, FALSE);
2471 SET_CHANGE_EVENT(element, j, TRUE);
2475 /* order of checking and copying events to be mapped is important */
2476 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
2478 if (HAS_CHANGE_EVENT(element, j - 1))
2480 SET_CHANGE_EVENT(element, j - 1, FALSE);
2481 SET_CHANGE_EVENT(element, j, TRUE);
2487 /* some custom element change events get mapped since version 3.0.3 */
2488 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2490 int element = EL_CUSTOM_START + i;
2492 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
2493 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
2495 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
2496 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
2498 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
2502 /* initialize "can_change" field for old levels with only one change page */
2503 if (level->game_version <= VERSION_IDENT(3,0,2,0))
2505 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2507 int element = EL_CUSTOM_START + i;
2509 if (CAN_CHANGE(element))
2510 element_info[element].change->can_change = TRUE;
2514 /* correct custom element values (for old levels without these options) */
2515 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2517 int element = EL_CUSTOM_START + i;
2518 struct ElementInfo *ei = &element_info[element];
2520 if (ei->access_direction == MV_NO_MOVING)
2521 ei->access_direction = MV_ALL_DIRECTIONS;
2523 for (j = 0; j < ei->num_change_pages; j++)
2525 struct ElementChangeInfo *change = &ei->change_page[j];
2527 if (change->trigger_side == CH_SIDE_NONE)
2528 change->trigger_side = CH_SIDE_ANY;
2532 /* initialize "can_explode" field for old levels which did not store this */
2533 /* !!! CHECK THIS -- "<= 3,1,0,0" IS PROBABLY WRONG !!! */
2534 if (level->game_version <= VERSION_IDENT(3,1,0,0))
2536 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2538 int element = EL_CUSTOM_START + i;
2540 if (EXPLODES_1X1_OLD(element))
2541 element_info[element].explosion_type = EXPLODES_1X1;
2543 SET_PROPERTY(element, EP_CAN_EXPLODE, (EXPLODES_BY_FIRE(element) ||
2544 EXPLODES_SMASHED(element) ||
2545 EXPLODES_IMPACT(element)));
2549 /* correct previously hard-coded move delay values for maze runner style */
2550 if (level->game_version < VERSION_IDENT(3,1,1,0))
2552 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2554 int element = EL_CUSTOM_START + i;
2556 if (element_info[element].move_pattern & MV_MAZE_RUNNER_STYLE)
2558 /* previously hard-coded and therefore ignored */
2559 element_info[element].move_delay_fixed = 9;
2560 element_info[element].move_delay_random = 0;
2566 /* set default push delay values (corrected since version 3.0.7-1) */
2567 if (level->game_version < VERSION_IDENT(3,0,7,1))
2569 game.default_push_delay_fixed = 2;
2570 game.default_push_delay_random = 8;
2574 game.default_push_delay_fixed = 8;
2575 game.default_push_delay_random = 8;
2578 /* set uninitialized push delay values of custom elements in older levels */
2579 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2581 int element = EL_CUSTOM_START + i;
2583 if (element_info[element].push_delay_fixed == -1)
2584 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2585 if (element_info[element].push_delay_random == -1)
2586 element_info[element].push_delay_random = game.default_push_delay_random;
2590 /* map elements that have changed in newer versions */
2591 level->amoeba_content = getMappedElementByVersion(level->amoeba_content,
2592 level->game_version);
2593 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2594 for (x = 0; x < 3; x++)
2595 for (y = 0; y < 3; y++)
2596 level->yamyam_content[i][x][y] =
2597 getMappedElementByVersion(level->yamyam_content[i][x][y],
2598 level->game_version);
2600 /* initialize element properties for level editor etc. */
2601 InitElementPropertiesEngine(level->game_version);
2604 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2608 /* map elements that have changed in newer versions */
2609 for (y = 0; y < level->fieldy; y++)
2611 for (x = 0; x < level->fieldx; x++)
2613 int element = level->field[x][y];
2616 element = getMappedElementByVersion(element, level->game_version);
2618 if (level->game_version <= VERSION_IDENT(2,2,0,0))
2620 /* map game font elements */
2621 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2622 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2623 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2624 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2627 if (level->game_version < VERSION_IDENT(3,0,0,0))
2629 /* map Supaplex gravity tube elements */
2630 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2631 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2632 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2633 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2638 level->field[x][y] = element;
2642 /* copy elements to runtime playfield array */
2643 for (x = 0; x < MAX_LEV_FIELDX; x++)
2644 for (y = 0; y < MAX_LEV_FIELDY; y++)
2645 Feld[x][y] = level->field[x][y];
2647 /* initialize level size variables for faster access */
2648 lev_fieldx = level->fieldx;
2649 lev_fieldy = level->fieldy;
2651 /* determine border element for this level */
2655 void LoadLevelTemplate(int nr)
2660 setLevelFileInfo(&level_template.file_info, nr);
2661 filename = level_template.file_info.filename;
2663 LoadLevelFromFileInfo(&level_template, &level_template.file_info);
2668 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2669 char *filename = level_file_info->filename;
2671 LoadLevelFromFileInfo(&level_template, level_file_info);
2673 char *filename = getDefaultLevelFilename(nr);
2675 LoadLevelFromFilename_RND(&level_template, filename);
2680 LoadLevel_InitVersion(&level_template, filename);
2681 LoadLevel_InitElements(&level_template, filename);
2683 LoadLevel_InitVersion(&level, filename);
2684 LoadLevel_InitElements(&level, filename);
2687 ActivateLevelTemplate();
2690 void LoadLevel(int nr)
2695 setLevelFileInfo(&level.file_info, nr);
2696 filename = level.file_info.filename;
2698 LoadLevelFromFileInfo(&level, &level.file_info);
2703 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2704 char *filename = level_file_info->filename;
2706 LoadLevelFromFileInfo(&level, level_file_info);
2708 char *filename = getLevelFilename(nr);
2710 LoadLevelFromFilename_RND(&level, filename);
2714 if (level.use_custom_template)
2715 LoadLevelTemplate(-1);
2718 LoadLevel_InitVersion(&level, filename);
2719 LoadLevel_InitElements(&level, filename);
2720 LoadLevel_InitPlayfield(&level, filename);
2722 LoadLevel_InitLevel(&level, filename);
2726 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2728 putFileVersion(file, level->file_version);
2729 putFileVersion(file, level->game_version);
2732 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2736 putFile8Bit(file, level->fieldx);
2737 putFile8Bit(file, level->fieldy);
2739 putFile16BitBE(file, level->time);
2740 putFile16BitBE(file, level->gems_needed);
2742 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2743 putFile8Bit(file, level->name[i]);
2745 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2746 putFile8Bit(file, level->score[i]);
2748 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2749 for (y = 0; y < 3; y++)
2750 for (x = 0; x < 3; x++)
2751 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2752 level->yamyam_content[i][x][y]));
2753 putFile8Bit(file, level->amoeba_speed);
2754 putFile8Bit(file, level->time_magic_wall);
2755 putFile8Bit(file, level->time_wheel);
2756 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2757 level->amoeba_content));
2758 putFile8Bit(file, (level->double_speed ? 1 : 0));
2759 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2760 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2761 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2763 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2765 putFile8Bit(file, (level->block_last_field ? 1 : 0));
2766 putFile8Bit(file, (level->sp_block_last_field ? 1 : 0));
2767 putFile32BitBE(file, level->can_move_into_acid_bits);
2768 putFile8Bit(file, level->dont_collide_with_bits);
2770 putFile8Bit(file, (level->use_spring_bug ? 1 : 0));
2771 putFile8Bit(file, (level->use_step_counter ? 1 : 0));
2773 putFile8Bit(file, (level->instant_relocation ? 1 : 0));
2774 putFile8Bit(file, (level->can_pass_to_walkable ? 1 : 0));
2775 putFile8Bit(file, (level->grow_into_diggable ? 1 : 0));
2777 putFile8Bit(file, level->game_engine_type);
2779 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2782 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2786 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2787 putFile8Bit(file, level->author[i]);
2790 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2794 for (y = 0; y < level->fieldy; y++)
2795 for (x = 0; x < level->fieldx; x++)
2796 if (level->encoding_16bit_field)
2797 putFile16BitBE(file, level->field[x][y]);
2799 putFile8Bit(file, level->field[x][y]);
2803 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2807 putFile8Bit(file, EL_YAMYAM);
2808 putFile8Bit(file, level->num_yamyam_contents);
2809 putFile8Bit(file, 0);
2810 putFile8Bit(file, 0);
2812 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2813 for (y = 0; y < 3; y++)
2814 for (x = 0; x < 3; x++)
2815 if (level->encoding_16bit_field)
2816 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2818 putFile8Bit(file, level->yamyam_content[i][x][y]);
2822 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2825 int num_contents, content_xsize, content_ysize;
2826 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2828 if (element == EL_YAMYAM)
2830 num_contents = level->num_yamyam_contents;
2834 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2835 for (y = 0; y < 3; y++)
2836 for (x = 0; x < 3; x++)
2837 content_array[i][x][y] = level->yamyam_content[i][x][y];
2839 else if (element == EL_BD_AMOEBA)
2845 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2846 for (y = 0; y < 3; y++)
2847 for (x = 0; x < 3; x++)
2848 content_array[i][x][y] = EL_EMPTY;
2849 content_array[0][0][0] = level->amoeba_content;
2853 /* chunk header already written -- write empty chunk data */
2854 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2856 Error(ERR_WARN, "cannot save content for element '%d'", element);
2860 putFile16BitBE(file, element);
2861 putFile8Bit(file, num_contents);
2862 putFile8Bit(file, content_xsize);
2863 putFile8Bit(file, content_ysize);
2865 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2867 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2868 for (y = 0; y < 3; y++)
2869 for (x = 0; x < 3; x++)
2870 putFile16BitBE(file, content_array[i][x][y]);
2873 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2876 int envelope_nr = element - EL_ENVELOPE_1;
2877 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2879 putFile16BitBE(file, element);
2880 putFile16BitBE(file, envelope_len);
2881 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2882 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2884 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2886 for (i = 0; i < envelope_len; i++)
2887 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2891 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2892 int num_changed_custom_elements)
2896 putFile16BitBE(file, num_changed_custom_elements);
2898 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2900 int element = EL_CUSTOM_START + i;
2902 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2904 if (check < num_changed_custom_elements)
2906 putFile16BitBE(file, element);
2907 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2914 if (check != num_changed_custom_elements) /* should not happen */
2915 Error(ERR_WARN, "inconsistent number of custom element properties");
2920 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2921 int num_changed_custom_elements)
2925 putFile16BitBE(file, num_changed_custom_elements);
2927 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2929 int element = EL_CUSTOM_START + i;
2931 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2933 if (check < num_changed_custom_elements)
2935 putFile16BitBE(file, element);
2936 putFile16BitBE(file, element_info[element].change->target_element);
2943 if (check != num_changed_custom_elements) /* should not happen */
2944 Error(ERR_WARN, "inconsistent number of custom target elements");
2949 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2950 int num_changed_custom_elements)
2952 int i, j, x, y, check = 0;
2954 putFile16BitBE(file, num_changed_custom_elements);
2956 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2958 int element = EL_CUSTOM_START + i;
2960 if (element_info[element].modified_settings)
2962 if (check < num_changed_custom_elements)
2964 putFile16BitBE(file, element);
2966 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2967 putFile8Bit(file, element_info[element].description[j]);
2969 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2971 /* some free bytes for future properties and padding */
2972 WriteUnusedBytesToFile(file, 7);
2974 putFile8Bit(file, element_info[element].use_gfx_element);
2975 putFile16BitBE(file, element_info[element].gfx_element);
2977 putFile8Bit(file, element_info[element].collect_score);
2978 putFile8Bit(file, element_info[element].collect_count);
2980 putFile16BitBE(file, element_info[element].push_delay_fixed);
2981 putFile16BitBE(file, element_info[element].push_delay_random);
2982 putFile16BitBE(file, element_info[element].move_delay_fixed);
2983 putFile16BitBE(file, element_info[element].move_delay_random);
2985 putFile16BitBE(file, element_info[element].move_pattern);
2986 putFile8Bit(file, element_info[element].move_direction_initial);
2987 putFile8Bit(file, element_info[element].move_stepsize);
2989 for (y = 0; y < 3; y++)
2990 for (x = 0; x < 3; x++)
2991 putFile16BitBE(file, element_info[element].content[x][y]);
2993 putFile32BitBE(file, element_info[element].change->events);
2995 putFile16BitBE(file, element_info[element].change->target_element);
2997 putFile16BitBE(file, element_info[element].change->delay_fixed);
2998 putFile16BitBE(file, element_info[element].change->delay_random);
2999 putFile16BitBE(file, element_info[element].change->delay_frames);
3001 putFile16BitBE(file, element_info[element].change->trigger_element);
3003 putFile8Bit(file, element_info[element].change->explode);
3004 putFile8Bit(file, element_info[element].change->use_target_content);
3005 putFile8Bit(file, element_info[element].change->only_if_complete);
3006 putFile8Bit(file, element_info[element].change->use_random_replace);
3008 putFile8Bit(file, element_info[element].change->random_percentage);
3009 putFile8Bit(file, element_info[element].change->replace_when);
3011 for (y = 0; y < 3; y++)
3012 for (x = 0; x < 3; x++)
3013 putFile16BitBE(file, element_info[element].change->content[x][y]);
3015 putFile8Bit(file, element_info[element].slippery_type);
3017 /* some free bytes for future properties and padding */
3018 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
3025 if (check != num_changed_custom_elements) /* should not happen */
3026 Error(ERR_WARN, "inconsistent number of custom element properties");
3030 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
3032 struct ElementInfo *ei = &element_info[element];
3035 putFile16BitBE(file, element);
3037 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3038 putFile8Bit(file, ei->description[i]);
3040 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
3041 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
3043 putFile8Bit(file, ei->num_change_pages);
3045 /* some free bytes for future base property values and padding */
3046 WriteUnusedBytesToFile(file, 5);
3048 /* write custom property values */
3050 putFile8Bit(file, ei->use_gfx_element);
3051 putFile16BitBE(file, ei->gfx_element);
3053 putFile8Bit(file, ei->collect_score);
3054 putFile8Bit(file, ei->collect_count);
3056 putFile8Bit(file, ei->drop_delay_fixed);
3057 putFile8Bit(file, ei->push_delay_fixed);
3058 putFile8Bit(file, ei->drop_delay_random);
3059 putFile8Bit(file, ei->push_delay_random);
3060 putFile16BitBE(file, ei->move_delay_fixed);
3061 putFile16BitBE(file, ei->move_delay_random);
3063 /* bits 0 - 15 of "move_pattern" ... */
3064 putFile16BitBE(file, ei->move_pattern & 0xffff);
3065 putFile8Bit(file, ei->move_direction_initial);
3066 putFile8Bit(file, ei->move_stepsize);
3068 putFile8Bit(file, ei->slippery_type);
3070 for (y = 0; y < 3; y++)
3071 for (x = 0; x < 3; x++)
3072 putFile16BitBE(file, ei->content[x][y]);
3074 putFile16BitBE(file, ei->move_enter_element);
3075 putFile16BitBE(file, ei->move_leave_element);
3076 putFile8Bit(file, ei->move_leave_type);
3078 /* ... bits 16 - 31 of "move_pattern" (not nice, but downward compatible) */
3079 putFile16BitBE(file, (ei->move_pattern >> 16) & 0xffff);
3081 putFile8Bit(file, ei->access_direction);
3083 putFile8Bit(file, ei->explosion_delay);
3084 putFile8Bit(file, ei->ignition_delay);
3085 putFile8Bit(file, ei->explosion_type);
3087 /* some free bytes for future custom property values and padding */
3088 WriteUnusedBytesToFile(file, 1);
3090 /* write change property values */
3092 for (i = 0; i < ei->num_change_pages; i++)
3094 struct ElementChangeInfo *change = &ei->change_page[i];
3096 putFile32BitBE(file, change->events);
3098 putFile16BitBE(file, change->target_element);
3100 putFile16BitBE(file, change->delay_fixed);
3101 putFile16BitBE(file, change->delay_random);
3102 putFile16BitBE(file, change->delay_frames);
3104 putFile16BitBE(file, change->trigger_element);
3106 putFile8Bit(file, change->explode);
3107 putFile8Bit(file, change->use_target_content);
3108 putFile8Bit(file, change->only_if_complete);
3109 putFile8Bit(file, change->use_random_replace);
3111 putFile8Bit(file, change->random_percentage);
3112 putFile8Bit(file, change->replace_when);
3114 for (y = 0; y < 3; y++)
3115 for (x = 0; x < 3; x++)
3116 putFile16BitBE(file, change->target_content[x][y]);
3118 putFile8Bit(file, change->can_change);
3120 putFile8Bit(file, change->trigger_side);
3123 putFile8Bit(file, change->trigger_player);
3124 putFile8Bit(file, (change->trigger_page == CH_PAGE_ANY ? CH_PAGE_ANY_FILE :
3125 log_2(change->trigger_page)));
3127 /* some free bytes for future change property values and padding */
3128 WriteUnusedBytesToFile(file, 6);
3132 /* some free bytes for future change property values and padding */
3133 WriteUnusedBytesToFile(file, 8);
3138 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
3140 struct ElementInfo *ei = &element_info[element];
3141 struct ElementGroupInfo *group = ei->group;
3144 putFile16BitBE(file, element);
3146 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
3147 putFile8Bit(file, ei->description[i]);
3149 putFile8Bit(file, group->num_elements);
3151 putFile8Bit(file, ei->use_gfx_element);
3152 putFile16BitBE(file, ei->gfx_element);
3154 putFile8Bit(file, group->choice_mode);
3156 /* some free bytes for future values and padding */
3157 WriteUnusedBytesToFile(file, 3);
3159 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
3160 putFile16BitBE(file, group->element[i]);
3163 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
3165 int body_chunk_size;
3169 if (!(file = fopen(filename, MODE_WRITE)))
3171 Error(ERR_WARN, "cannot save level file '%s'", filename);
3175 level->file_version = FILE_VERSION_ACTUAL;
3176 level->game_version = GAME_VERSION_ACTUAL;
3178 /* check level field for 16-bit elements */
3179 level->encoding_16bit_field = FALSE;
3180 for (y = 0; y < level->fieldy; y++)
3181 for (x = 0; x < level->fieldx; x++)
3182 if (level->field[x][y] > 255)
3183 level->encoding_16bit_field = TRUE;
3185 /* check yamyam content for 16-bit elements */
3186 level->encoding_16bit_yamyam = FALSE;
3187 for (i = 0; i < level->num_yamyam_contents; i++)
3188 for (y = 0; y < 3; y++)
3189 for (x = 0; x < 3; x++)
3190 if (level->yamyam_content[i][x][y] > 255)
3191 level->encoding_16bit_yamyam = TRUE;
3193 /* check amoeba content for 16-bit elements */
3194 level->encoding_16bit_amoeba = FALSE;
3195 if (level->amoeba_content > 255)
3196 level->encoding_16bit_amoeba = TRUE;
3198 /* calculate size of "BODY" chunk */
3200 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
3202 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3203 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
3205 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3206 SaveLevel_VERS(file, level);
3208 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
3209 SaveLevel_HEAD(file, level);
3211 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
3212 SaveLevel_AUTH(file, level);
3214 putFileChunkBE(file, "BODY", body_chunk_size);
3215 SaveLevel_BODY(file, level);
3217 if (level->encoding_16bit_yamyam ||
3218 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
3220 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3221 SaveLevel_CNT2(file, level, EL_YAMYAM);
3224 if (level->encoding_16bit_amoeba)
3226 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
3227 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
3230 /* check for envelope content */
3231 for (i = 0; i < 4; i++)
3233 if (strlen(level->envelope_text[i]) > 0)
3235 int envelope_len = strlen(level->envelope_text[i]) + 1;
3237 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
3238 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
3242 /* check for non-default custom elements (unless using template level) */
3243 if (!level->use_custom_template)
3245 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
3247 int element = EL_CUSTOM_START + i;
3249 if (element_info[element].modified_settings)
3251 int num_change_pages = element_info[element].num_change_pages;
3253 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
3254 SaveLevel_CUS4(file, level, element);
3259 /* check for non-default group elements (unless using template level) */
3260 if (!level->use_custom_template)
3262 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
3264 int element = EL_GROUP_START + i;
3266 if (element_info[element].modified_settings)
3268 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
3269 SaveLevel_GRP1(file, level, element);
3276 SetFilePermissions(filename, PERMS_PRIVATE);
3279 void SaveLevel(int nr)
3281 char *filename = getDefaultLevelFilename(nr);
3283 SaveLevelFromFilename(&level, filename);
3286 void SaveLevelTemplate()
3288 char *filename = getDefaultLevelFilename(-1);
3290 SaveLevelFromFilename(&level, filename);
3293 void DumpLevel(struct LevelInfo *level)
3295 if (level->no_valid_file)
3297 Error(ERR_WARN, "cannot dump -- no valid level file found");
3302 printf_line("-", 79);
3303 printf("Level xxx (file version %08d, game version %08d)\n",
3304 level->file_version, level->game_version);
3305 printf_line("-", 79);
3307 printf("Level author: '%s'\n", level->author);
3308 printf("Level title: '%s'\n", level->name);
3310 printf("Playfield size: %d x %d\n", level->fieldx, level->fieldy);
3312 printf("Level time: %d seconds\n", level->time);
3313 printf("Gems needed: %d\n", level->gems_needed);
3315 printf("Time for magic wall: %d seconds\n", level->time_magic_wall);
3316 printf("Time for wheel: %d seconds\n", level->time_wheel);
3317 printf("Time for light: %d seconds\n", level->time_light);
3318 printf("Time for timegate: %d seconds\n", level->time_timegate);
3320 printf("Amoeba speed: %d\n", level->amoeba_speed);
3322 printf("Initial gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
3323 printf("Double speed movement: %s\n", (level->double_speed ? "yes" : "no"));
3324 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
3325 printf("Player blocks last field: %s\n", (level->block_last_field ? "yes" : "no"));
3326 printf("SP player blocks last field: %s\n", (level->sp_block_last_field ? "yes" : "no"));
3327 printf("use spring bug: %s\n", (level->use_spring_bug ? "yes" : "no"));
3328 printf("use step counter: %s\n", (level->use_step_counter ? "yes" : "no"));
3330 printf_line("-", 79);
3334 /* ========================================================================= */
3335 /* tape file functions */
3336 /* ========================================================================= */
3338 static void setTapeInfoToDefaults()
3342 /* always start with reliable default values (empty tape) */
3345 /* default values (also for pre-1.2 tapes) with only the first player */
3346 tape.player_participates[0] = TRUE;
3347 for (i = 1; i < MAX_PLAYERS; i++)
3348 tape.player_participates[i] = FALSE;
3350 /* at least one (default: the first) player participates in every tape */
3351 tape.num_participating_players = 1;
3353 tape.level_nr = level_nr;
3355 tape.changed = FALSE;
3357 tape.recording = FALSE;
3358 tape.playing = FALSE;
3359 tape.pausing = FALSE;
3361 tape.no_valid_file = FALSE;
3364 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
3366 tape->file_version = getFileVersion(file);
3367 tape->game_version = getFileVersion(file);
3372 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
3376 tape->random_seed = getFile32BitBE(file);
3377 tape->date = getFile32BitBE(file);
3378 tape->length = getFile32BitBE(file);
3380 /* read header fields that are new since version 1.2 */
3381 if (tape->file_version >= FILE_VERSION_1_2)
3383 byte store_participating_players = getFile8Bit(file);
3386 /* since version 1.2, tapes store which players participate in the tape */
3387 tape->num_participating_players = 0;
3388 for (i = 0; i < MAX_PLAYERS; i++)
3390 tape->player_participates[i] = FALSE;
3392 if (store_participating_players & (1 << i))
3394 tape->player_participates[i] = TRUE;
3395 tape->num_participating_players++;
3399 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
3401 engine_version = getFileVersion(file);
3402 if (engine_version > 0)
3403 tape->engine_version = engine_version;
3405 tape->engine_version = tape->game_version;
3411 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
3413 int level_identifier_size;
3416 level_identifier_size = getFile16BitBE(file);
3418 tape->level_identifier =
3419 checked_realloc(tape->level_identifier, level_identifier_size);
3421 for (i = 0; i < level_identifier_size; i++)
3422 tape->level_identifier[i] = getFile8Bit(file);
3424 tape->level_nr = getFile16BitBE(file);
3426 chunk_size = 2 + level_identifier_size + 2;
3431 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
3434 int chunk_size_expected =
3435 (tape->num_participating_players + 1) * tape->length;
3437 if (chunk_size_expected != chunk_size)
3439 ReadUnusedBytesFromFile(file, chunk_size);
3440 return chunk_size_expected;
3443 for (i = 0; i < tape->length; i++)
3445 if (i >= MAX_TAPELEN)
3448 for (j = 0; j < MAX_PLAYERS; j++)
3450 tape->pos[i].action[j] = MV_NO_MOVING;
3452 if (tape->player_participates[j])
3453 tape->pos[i].action[j] = getFile8Bit(file);
3456 tape->pos[i].delay = getFile8Bit(file);
3458 if (tape->file_version == FILE_VERSION_1_0)
3460 /* eliminate possible diagonal moves in old tapes */
3461 /* this is only for backward compatibility */
3463 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
3464 byte action = tape->pos[i].action[0];
3465 int k, num_moves = 0;
3467 for (k = 0; k<4; k++)
3469 if (action & joy_dir[k])
3471 tape->pos[i + num_moves].action[0] = joy_dir[k];
3473 tape->pos[i + num_moves].delay = 0;
3482 tape->length += num_moves;
3485 else if (tape->file_version < FILE_VERSION_2_0)
3487 /* convert pre-2.0 tapes to new tape format */
3489 if (tape->pos[i].delay > 1)
3492 tape->pos[i + 1] = tape->pos[i];
3493 tape->pos[i + 1].delay = 1;
3496 for (j = 0; j < MAX_PLAYERS; j++)
3497 tape->pos[i].action[j] = MV_NO_MOVING;
3498 tape->pos[i].delay--;
3509 if (i != tape->length)
3510 chunk_size = (tape->num_participating_players + 1) * i;
3515 void LoadTapeFromFilename(char *filename)
3517 char cookie[MAX_LINE_LEN];
3518 char chunk_name[CHUNK_ID_LEN + 1];
3522 /* always start with reliable default values */
3523 setTapeInfoToDefaults();
3525 if (!(file = fopen(filename, MODE_READ)))
3527 tape.no_valid_file = TRUE;
3530 Error(ERR_WARN, "cannot read tape '%s' -- using empty tape", filename);
3536 getFileChunkBE(file, chunk_name, NULL);
3537 if (strcmp(chunk_name, "RND1") == 0)
3539 getFile32BitBE(file); /* not used */
3541 getFileChunkBE(file, chunk_name, NULL);
3542 if (strcmp(chunk_name, "TAPE") != 0)
3544 tape.no_valid_file = TRUE;
3546 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3551 else /* check for pre-2.0 file format with cookie string */
3553 strcpy(cookie, chunk_name);
3554 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
3555 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3556 cookie[strlen(cookie) - 1] = '\0';
3558 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
3560 tape.no_valid_file = TRUE;
3562 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
3567 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
3569 tape.no_valid_file = TRUE;
3571 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
3576 /* pre-2.0 tape files have no game version, so use file version here */
3577 tape.game_version = tape.file_version;
3580 if (tape.file_version < FILE_VERSION_1_2)
3582 /* tape files from versions before 1.2.0 without chunk structure */
3583 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
3584 LoadTape_BODY(file, 2 * tape.length, &tape);
3592 int (*loader)(FILE *, int, struct TapeInfo *);
3596 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
3597 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
3598 { "INFO", -1, LoadTape_INFO },
3599 { "BODY", -1, LoadTape_BODY },
3603 while (getFileChunkBE(file, chunk_name, &chunk_size))
3607 while (chunk_info[i].name != NULL &&
3608 strcmp(chunk_name, chunk_info[i].name) != 0)
3611 if (chunk_info[i].name == NULL)
3613 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
3614 chunk_name, filename);
3615 ReadUnusedBytesFromFile(file, chunk_size);
3617 else if (chunk_info[i].size != -1 &&
3618 chunk_info[i].size != chunk_size)
3620 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3621 chunk_size, chunk_name, filename);
3622 ReadUnusedBytesFromFile(file, chunk_size);
3626 /* call function to load this tape chunk */
3627 int chunk_size_expected =
3628 (chunk_info[i].loader)(file, chunk_size, &tape);
3630 /* the size of some chunks cannot be checked before reading other
3631 chunks first (like "HEAD" and "BODY") that contain some header
3632 information, so check them here */
3633 if (chunk_size_expected != chunk_size)
3635 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
3636 chunk_size, chunk_name, filename);
3644 tape.length_seconds = GetTapeLength();
3647 printf("::: tape game version: %d\n", tape.game_version);
3648 printf("::: tape engine version: %d\n", tape.engine_version);
3652 void LoadTape(int nr)
3654 char *filename = getTapeFilename(nr);
3656 LoadTapeFromFilename(filename);
3659 void LoadSolutionTape(int nr)
3661 char *filename = getSolutionTapeFilename(nr);
3663 LoadTapeFromFilename(filename);
3666 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
3668 putFileVersion(file, tape->file_version);
3669 putFileVersion(file, tape->game_version);
3672 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
3675 byte store_participating_players = 0;
3677 /* set bits for participating players for compact storage */
3678 for (i = 0; i < MAX_PLAYERS; i++)
3679 if (tape->player_participates[i])
3680 store_participating_players |= (1 << i);
3682 putFile32BitBE(file, tape->random_seed);
3683 putFile32BitBE(file, tape->date);
3684 putFile32BitBE(file, tape->length);
3686 putFile8Bit(file, store_participating_players);
3688 /* unused bytes not at the end here for 4-byte alignment of engine_version */
3689 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3691 putFileVersion(file, tape->engine_version);
3694 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3696 int level_identifier_size = strlen(tape->level_identifier) + 1;
3699 putFile16BitBE(file, level_identifier_size);
3701 for (i = 0; i < level_identifier_size; i++)
3702 putFile8Bit(file, tape->level_identifier[i]);
3704 putFile16BitBE(file, tape->level_nr);
3707 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3711 for (i = 0; i < tape->length; i++)
3713 for (j = 0; j < MAX_PLAYERS; j++)
3714 if (tape->player_participates[j])
3715 putFile8Bit(file, tape->pos[i].action[j]);
3717 putFile8Bit(file, tape->pos[i].delay);
3721 void SaveTape(int nr)
3723 char *filename = getTapeFilename(nr);
3725 boolean new_tape = TRUE;
3726 int num_participating_players = 0;
3727 int info_chunk_size;
3728 int body_chunk_size;
3731 InitTapeDirectory(leveldir_current->subdir);
3733 /* if a tape still exists, ask to overwrite it */
3734 if (access(filename, F_OK) == 0)
3737 if (!Request("Replace old tape ?", REQ_ASK))
3741 if (!(file = fopen(filename, MODE_WRITE)))
3743 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3747 tape.file_version = FILE_VERSION_ACTUAL;
3748 tape.game_version = GAME_VERSION_ACTUAL;
3750 /* count number of participating players */
3751 for (i = 0; i < MAX_PLAYERS; i++)
3752 if (tape.player_participates[i])
3753 num_participating_players++;
3755 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3756 body_chunk_size = (num_participating_players + 1) * tape.length;
3758 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3759 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3761 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3762 SaveTape_VERS(file, &tape);
3764 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3765 SaveTape_HEAD(file, &tape);
3767 putFileChunkBE(file, "INFO", info_chunk_size);
3768 SaveTape_INFO(file, &tape);
3770 putFileChunkBE(file, "BODY", body_chunk_size);
3771 SaveTape_BODY(file, &tape);
3775 SetFilePermissions(filename, PERMS_PRIVATE);
3777 tape.changed = FALSE;
3780 Request("tape saved !", REQ_CONFIRM);
3783 void DumpTape(struct TapeInfo *tape)
3788 if (tape->no_valid_file)
3790 Error(ERR_WARN, "cannot dump -- no valid tape file found");
3795 if (TAPE_IS_EMPTY(*tape))
3797 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3803 printf_line("-", 79);
3804 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3805 tape->level_nr, tape->file_version, tape->game_version);
3806 printf(" (effective engine version %08d)\n",
3807 tape->engine_version);
3808 printf("Level series identifier: '%s'\n", tape->level_identifier);
3809 printf_line("-", 79);
3811 for (i = 0; i < tape->length; i++)
3813 if (i >= MAX_TAPELEN)
3816 printf("%03d: ", i);
3818 for (j = 0; j < MAX_PLAYERS; j++)
3820 if (tape->player_participates[j])
3822 int action = tape->pos[i].action[j];
3824 printf("%d:%02x ", j, action);
3825 printf("[%c%c%c%c|%c%c] - ",
3826 (action & JOY_LEFT ? '<' : ' '),
3827 (action & JOY_RIGHT ? '>' : ' '),
3828 (action & JOY_UP ? '^' : ' '),
3829 (action & JOY_DOWN ? 'v' : ' '),
3830 (action & JOY_BUTTON_1 ? '1' : ' '),
3831 (action & JOY_BUTTON_2 ? '2' : ' '));
3835 printf("(%03d)\n", tape->pos[i].delay);
3838 printf_line("-", 79);
3842 /* ========================================================================= */
3843 /* score file functions */
3844 /* ========================================================================= */
3846 void LoadScore(int nr)
3849 char *filename = getScoreFilename(nr);
3850 char cookie[MAX_LINE_LEN];
3851 char line[MAX_LINE_LEN];
3855 /* always start with reliable default values */
3856 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3858 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3859 highscore[i].Score = 0;
3862 if (!(file = fopen(filename, MODE_READ)))
3865 /* check file identifier */
3866 fgets(cookie, MAX_LINE_LEN, file);
3867 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3868 cookie[strlen(cookie) - 1] = '\0';
3870 if (!checkCookieString(cookie, SCORE_COOKIE))
3872 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3877 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3879 fscanf(file, "%d", &highscore[i].Score);
3880 fgets(line, MAX_LINE_LEN, file);
3882 if (line[strlen(line) - 1] == '\n')
3883 line[strlen(line) - 1] = '\0';
3885 for (line_ptr = line; *line_ptr; line_ptr++)
3887 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3889 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3890 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3899 void SaveScore(int nr)
3902 char *filename = getScoreFilename(nr);
3905 InitScoreDirectory(leveldir_current->subdir);
3907 if (!(file = fopen(filename, MODE_WRITE)))
3909 Error(ERR_WARN, "cannot save score for level %d", nr);
3913 fprintf(file, "%s\n\n", SCORE_COOKIE);
3915 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3916 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3920 SetFilePermissions(filename, PERMS_PUBLIC);
3924 /* ========================================================================= */
3925 /* setup file functions */
3926 /* ========================================================================= */
3928 #define TOKEN_STR_PLAYER_PREFIX "player_"
3931 #define SETUP_TOKEN_PLAYER_NAME 0
3932 #define SETUP_TOKEN_SOUND 1
3933 #define SETUP_TOKEN_SOUND_LOOPS 2
3934 #define SETUP_TOKEN_SOUND_MUSIC 3
3935 #define SETUP_TOKEN_SOUND_SIMPLE 4
3936 #define SETUP_TOKEN_TOONS 5
3937 #define SETUP_TOKEN_SCROLL_DELAY 6
3938 #define SETUP_TOKEN_SOFT_SCROLLING 7
3939 #define SETUP_TOKEN_FADING 8
3940 #define SETUP_TOKEN_AUTORECORD 9
3941 #define SETUP_TOKEN_QUICK_DOORS 10
3942 #define SETUP_TOKEN_TEAM_MODE 11
3943 #define SETUP_TOKEN_HANDICAP 12
3944 #define SETUP_TOKEN_TIME_LIMIT 13
3945 #define SETUP_TOKEN_FULLSCREEN 14
3946 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3947 #define SETUP_TOKEN_GRAPHICS_SET 16
3948 #define SETUP_TOKEN_SOUNDS_SET 17
3949 #define SETUP_TOKEN_MUSIC_SET 18
3950 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3951 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3952 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3954 #define NUM_GLOBAL_SETUP_TOKENS 22
3957 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3958 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3959 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3960 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3961 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3962 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3963 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3964 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3965 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3966 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3967 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3968 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3970 #define NUM_EDITOR_SETUP_TOKENS 12
3972 /* shortcut setup */
3973 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3974 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3975 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3977 #define NUM_SHORTCUT_SETUP_TOKENS 3
3980 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3981 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3982 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3983 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3984 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3985 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3986 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3987 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3988 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3989 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3990 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3991 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3992 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3993 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3994 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3995 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3997 #define NUM_PLAYER_SETUP_TOKENS 16
4000 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
4001 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
4003 #define NUM_SYSTEM_SETUP_TOKENS 2
4006 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
4008 #define NUM_OPTIONS_SETUP_TOKENS 1
4011 static struct SetupInfo si;
4012 static struct SetupEditorInfo sei;
4013 static struct SetupShortcutInfo ssi;
4014 static struct SetupInputInfo sii;
4015 static struct SetupSystemInfo syi;
4016 static struct OptionInfo soi;
4018 static struct TokenInfo global_setup_tokens[] =
4020 { TYPE_STRING, &si.player_name, "player_name" },
4021 { TYPE_SWITCH, &si.sound, "sound" },
4022 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
4023 { TYPE_SWITCH, &si.sound_music, "background_music" },
4024 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
4025 { TYPE_SWITCH, &si.toons, "toons" },
4026 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
4027 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
4028 { TYPE_SWITCH, &si.fading, "screen_fading" },
4029 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
4030 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
4031 { TYPE_SWITCH, &si.team_mode, "team_mode" },
4032 { TYPE_SWITCH, &si.handicap, "handicap" },
4033 { TYPE_SWITCH, &si.time_limit, "time_limit" },
4034 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
4035 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
4036 { TYPE_STRING, &si.graphics_set, "graphics_set" },
4037 { TYPE_STRING, &si.sounds_set, "sounds_set" },
4038 { TYPE_STRING, &si.music_set, "music_set" },
4039 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
4040 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
4041 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
4044 static struct TokenInfo editor_setup_tokens[] =
4046 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
4047 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
4048 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
4049 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
4050 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
4051 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
4052 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
4053 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
4054 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
4055 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
4056 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
4057 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
4060 static struct TokenInfo shortcut_setup_tokens[] =
4062 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
4063 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
4064 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
4067 static struct TokenInfo player_setup_tokens[] =
4069 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
4070 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
4071 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
4072 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
4073 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
4074 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
4075 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
4076 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
4077 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
4078 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
4079 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
4080 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
4081 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
4082 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
4083 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
4084 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
4087 static struct TokenInfo system_setup_tokens[] =
4089 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
4090 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
4093 static struct TokenInfo options_setup_tokens[] =
4095 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
4098 static char *get_corrected_login_name(char *login_name)
4100 /* needed because player name must be a fixed length string */
4101 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
4103 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
4104 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
4106 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
4107 if (strchr(login_name_new, ' '))
4108 *strchr(login_name_new, ' ') = '\0';
4110 return login_name_new;
4113 static void setSetupInfoToDefaults(struct SetupInfo *si)
4117 si->player_name = get_corrected_login_name(getLoginName());
4120 si->sound_loops = TRUE;
4121 si->sound_music = TRUE;
4122 si->sound_simple = TRUE;
4124 si->double_buffering = TRUE;
4125 si->direct_draw = !si->double_buffering;
4126 si->scroll_delay = TRUE;
4127 si->soft_scrolling = TRUE;
4129 si->autorecord = TRUE;
4130 si->quick_doors = FALSE;
4131 si->team_mode = FALSE;
4132 si->handicap = TRUE;
4133 si->time_limit = TRUE;
4134 si->fullscreen = FALSE;
4135 si->ask_on_escape = TRUE;
4137 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
4138 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
4139 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
4140 si->override_level_graphics = FALSE;
4141 si->override_level_sounds = FALSE;
4142 si->override_level_music = FALSE;
4144 si->editor.el_boulderdash = TRUE;
4145 si->editor.el_emerald_mine = TRUE;
4146 si->editor.el_more = TRUE;
4147 si->editor.el_sokoban = TRUE;
4148 si->editor.el_supaplex = TRUE;
4149 si->editor.el_diamond_caves = TRUE;
4150 si->editor.el_dx_boulderdash = TRUE;
4151 si->editor.el_chars = TRUE;
4152 si->editor.el_custom = TRUE;
4153 si->editor.el_custom_more = FALSE;
4155 si->editor.el_headlines = TRUE;
4156 si->editor.el_user_defined = FALSE;
4158 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
4159 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
4160 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
4162 for (i = 0; i < MAX_PLAYERS; i++)
4164 si->input[i].use_joystick = FALSE;
4165 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
4166 si->input[i].joy.xleft = JOYSTICK_XLEFT;
4167 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
4168 si->input[i].joy.xright = JOYSTICK_XRIGHT;
4169 si->input[i].joy.yupper = JOYSTICK_YUPPER;
4170 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
4171 si->input[i].joy.ylower = JOYSTICK_YLOWER;
4172 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
4173 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
4174 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
4175 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
4176 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
4177 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
4178 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
4179 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
4182 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
4183 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
4185 si->options.verbose = FALSE;
4188 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
4192 if (!setup_file_hash)
4197 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
4198 setSetupInfo(global_setup_tokens, i,
4199 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
4204 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4205 setSetupInfo(editor_setup_tokens, i,
4206 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
4209 /* shortcut setup */
4210 ssi = setup.shortcut;
4211 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4212 setSetupInfo(shortcut_setup_tokens, i,
4213 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
4214 setup.shortcut = ssi;
4217 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4221 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4223 sii = setup.input[pnr];
4224 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4226 char full_token[100];
4228 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
4229 setSetupInfo(player_setup_tokens, i,
4230 getHashEntry(setup_file_hash, full_token));
4232 setup.input[pnr] = sii;
4237 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4238 setSetupInfo(system_setup_tokens, i,
4239 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
4243 soi = setup.options;
4244 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4245 setSetupInfo(options_setup_tokens, i,
4246 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
4247 setup.options = soi;
4252 char *filename = getSetupFilename();
4253 SetupFileHash *setup_file_hash = NULL;
4255 /* always start with reliable default values */
4256 setSetupInfoToDefaults(&setup);
4258 setup_file_hash = loadSetupFileHash(filename);
4260 if (setup_file_hash)
4262 char *player_name_new;
4264 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
4265 decodeSetupFileHash(setup_file_hash);
4267 setup.direct_draw = !setup.double_buffering;
4269 freeSetupFileHash(setup_file_hash);
4271 /* needed to work around problems with fixed length strings */
4272 player_name_new = get_corrected_login_name(setup.player_name);
4273 free(setup.player_name);
4274 setup.player_name = player_name_new;
4277 Error(ERR_WARN, "using default setup values");
4282 char *filename = getSetupFilename();
4286 InitUserDataDirectory();
4288 if (!(file = fopen(filename, MODE_WRITE)))
4290 Error(ERR_WARN, "cannot write setup file '%s'", filename);
4294 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
4295 getCookie("SETUP")));
4296 fprintf(file, "\n");
4300 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
4302 /* just to make things nicer :) */
4303 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
4304 i == SETUP_TOKEN_GRAPHICS_SET)
4305 fprintf(file, "\n");
4307 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
4312 fprintf(file, "\n");
4313 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
4314 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
4316 /* shortcut setup */
4317 ssi = setup.shortcut;
4318 fprintf(file, "\n");
4319 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
4320 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
4323 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
4327 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
4328 fprintf(file, "\n");
4330 sii = setup.input[pnr];
4331 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
4332 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
4337 fprintf(file, "\n");
4338 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
4339 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
4342 soi = setup.options;
4343 fprintf(file, "\n");
4344 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
4345 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
4349 SetFilePermissions(filename, PERMS_PRIVATE);
4352 void LoadCustomElementDescriptions()
4354 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4355 SetupFileHash *setup_file_hash;
4358 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4360 if (element_info[i].custom_description != NULL)
4362 free(element_info[i].custom_description);
4363 element_info[i].custom_description = NULL;
4367 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4370 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4372 char *token = getStringCat2(element_info[i].token_name, ".name");
4373 char *value = getHashEntry(setup_file_hash, token);
4376 element_info[i].custom_description = getStringCopy(value);
4381 freeSetupFileHash(setup_file_hash);
4384 void LoadSpecialMenuDesignSettings()
4386 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
4387 SetupFileHash *setup_file_hash;
4390 /* always start with reliable default values from default config */
4391 for (i = 0; image_config_vars[i].token != NULL; i++)
4392 for (j = 0; image_config[j].token != NULL; j++)
4393 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
4394 *image_config_vars[i].value =
4395 get_auto_parameter_value(image_config_vars[i].token,
4396 image_config[j].value);
4398 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
4401 /* special case: initialize with default values that may be overwritten */
4402 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
4404 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
4405 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
4406 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
4408 if (value_x != NULL)
4409 menu.draw_xoffset[i] = get_integer_from_string(value_x);
4410 if (value_y != NULL)
4411 menu.draw_yoffset[i] = get_integer_from_string(value_y);
4412 if (list_size != NULL)
4413 menu.list_size[i] = get_integer_from_string(list_size);
4416 /* read (and overwrite with) values that may be specified in config file */
4417 for (i = 0; image_config_vars[i].token != NULL; i++)
4419 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
4422 *image_config_vars[i].value =
4423 get_auto_parameter_value(image_config_vars[i].token, value);
4426 freeSetupFileHash(setup_file_hash);
4429 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
4431 char *filename = getEditorSetupFilename();
4432 SetupFileList *setup_file_list, *list;
4433 SetupFileHash *element_hash;
4434 int num_unknown_tokens = 0;
4437 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
4440 element_hash = newSetupFileHash();
4442 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
4443 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4445 /* determined size may be larger than needed (due to unknown elements) */
4447 for (list = setup_file_list; list != NULL; list = list->next)
4450 /* add space for up to 3 more elements for padding that may be needed */
4453 *elements = checked_malloc(*num_elements * sizeof(int));
4456 for (list = setup_file_list; list != NULL; list = list->next)
4458 char *value = getHashEntry(element_hash, list->token);
4462 (*elements)[(*num_elements)++] = atoi(value);
4466 if (num_unknown_tokens == 0)
4468 Error(ERR_RETURN_LINE, "-");
4469 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4470 Error(ERR_RETURN, "- config file: '%s'", filename);
4472 num_unknown_tokens++;
4475 Error(ERR_RETURN, "- token: '%s'", list->token);
4479 if (num_unknown_tokens > 0)
4480 Error(ERR_RETURN_LINE, "-");
4482 while (*num_elements % 4) /* pad with empty elements, if needed */
4483 (*elements)[(*num_elements)++] = EL_EMPTY;
4485 freeSetupFileList(setup_file_list);
4486 freeSetupFileHash(element_hash);
4490 for (i = 0; i < *num_elements; i++)
4491 printf("editor: element '%s' [%d]\n",
4492 element_info[(*elements)[i]].token_name, (*elements)[i]);
4496 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
4499 SetupFileHash *setup_file_hash = NULL;
4500 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
4501 char *filename_music, *filename_prefix, *filename_info;
4507 token_to_value_ptr[] =
4509 { "title_header", &tmp_music_file_info.title_header },
4510 { "artist_header", &tmp_music_file_info.artist_header },
4511 { "album_header", &tmp_music_file_info.album_header },
4512 { "year_header", &tmp_music_file_info.year_header },
4514 { "title", &tmp_music_file_info.title },
4515 { "artist", &tmp_music_file_info.artist },
4516 { "album", &tmp_music_file_info.album },
4517 { "year", &tmp_music_file_info.year },
4523 filename_music = (is_sound ? getCustomSoundFilename(basename) :
4524 getCustomMusicFilename(basename));
4526 if (filename_music == NULL)
4529 /* ---------- try to replace file extension ---------- */
4531 filename_prefix = getStringCopy(filename_music);
4532 if (strrchr(filename_prefix, '.') != NULL)
4533 *strrchr(filename_prefix, '.') = '\0';
4534 filename_info = getStringCat2(filename_prefix, ".txt");
4537 printf("trying to load file '%s'...\n", filename_info);
4540 if (fileExists(filename_info))
4541 setup_file_hash = loadSetupFileHash(filename_info);
4543 free(filename_prefix);
4544 free(filename_info);
4546 if (setup_file_hash == NULL)
4548 /* ---------- try to add file extension ---------- */
4550 filename_prefix = getStringCopy(filename_music);
4551 filename_info = getStringCat2(filename_prefix, ".txt");
4554 printf("trying to load file '%s'...\n", filename_info);
4557 if (fileExists(filename_info))
4558 setup_file_hash = loadSetupFileHash(filename_info);
4560 free(filename_prefix);
4561 free(filename_info);
4564 if (setup_file_hash == NULL)
4567 /* ---------- music file info found ---------- */
4569 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
4571 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
4573 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
4575 *token_to_value_ptr[i].value_ptr =
4576 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
4579 tmp_music_file_info.basename = getStringCopy(basename);
4580 tmp_music_file_info.music = music;
4581 tmp_music_file_info.is_sound = is_sound;
4583 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
4584 *new_music_file_info = tmp_music_file_info;
4586 return new_music_file_info;
4589 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
4591 return get_music_file_info_ext(basename, music, FALSE);
4594 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
4596 return get_music_file_info_ext(basename, sound, TRUE);
4599 static boolean music_info_listed_ext(struct MusicFileInfo *list,
4600 char *basename, boolean is_sound)
4602 for (; list != NULL; list = list->next)
4603 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
4609 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
4611 return music_info_listed_ext(list, basename, FALSE);
4614 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
4616 return music_info_listed_ext(list, basename, TRUE);
4619 void LoadMusicInfo()
4621 char *music_directory = getCustomMusicDirectory();
4622 int num_music = getMusicListSize();
4623 int num_music_noconf = 0;
4624 int num_sounds = getSoundListSize();
4626 struct dirent *dir_entry;
4627 struct FileInfo *music, *sound;
4628 struct MusicFileInfo *next, **new;
4631 while (music_file_info != NULL)
4633 next = music_file_info->next;
4635 checked_free(music_file_info->basename);
4637 checked_free(music_file_info->title_header);
4638 checked_free(music_file_info->artist_header);
4639 checked_free(music_file_info->album_header);
4640 checked_free(music_file_info->year_header);
4642 checked_free(music_file_info->title);
4643 checked_free(music_file_info->artist);
4644 checked_free(music_file_info->album);
4645 checked_free(music_file_info->year);
4647 free(music_file_info);
4649 music_file_info = next;
4652 new = &music_file_info;
4655 printf("::: num_music == %d\n", num_music);
4658 for (i = 0; i < num_music; i++)
4660 music = getMusicListEntry(i);
4663 printf("::: %d [%08x]\n", i, music->filename);
4666 if (music->filename == NULL)
4669 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
4672 /* a configured file may be not recognized as music */
4673 if (!FileIsMusic(music->filename))
4677 printf("::: -> '%s' (configured)\n", music->filename);
4680 if (!music_info_listed(music_file_info, music->filename))
4682 *new = get_music_file_info(music->filename, i);
4684 new = &(*new)->next;
4688 if ((dir = opendir(music_directory)) == NULL)
4690 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
4694 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
4696 char *basename = dir_entry->d_name;
4697 boolean music_already_used = FALSE;
4700 /* skip all music files that are configured in music config file */
4701 for (i = 0; i < num_music; i++)
4703 music = getMusicListEntry(i);
4705 if (music->filename == NULL)
4708 if (strcmp(basename, music->filename) == 0)
4710 music_already_used = TRUE;
4715 if (music_already_used)
4718 if (!FileIsMusic(basename))
4722 printf("::: -> '%s' (found in directory)\n", basename);
4725 if (!music_info_listed(music_file_info, basename))
4727 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4729 new = &(*new)->next;
4737 for (i = 0; i < num_sounds; i++)
4739 sound = getSoundListEntry(i);
4741 if (sound->filename == NULL)
4744 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4747 /* a configured file may be not recognized as sound */
4748 if (!FileIsSound(sound->filename))
4752 printf("::: -> '%s' (configured)\n", sound->filename);
4755 if (!sound_info_listed(music_file_info, sound->filename))
4757 *new = get_sound_file_info(sound->filename, i);
4759 new = &(*new)->next;
4765 for (next = music_file_info; next != NULL; next = next->next)
4766 printf("::: title == '%s'\n", next->title);
4770 void add_helpanim_entry(int element, int action, int direction, int delay,
4771 int *num_list_entries)
4773 struct HelpAnimInfo *new_list_entry;
4774 (*num_list_entries)++;
4777 checked_realloc(helpanim_info,
4778 *num_list_entries * sizeof(struct HelpAnimInfo));
4779 new_list_entry = &helpanim_info[*num_list_entries - 1];
4781 new_list_entry->element = element;
4782 new_list_entry->action = action;
4783 new_list_entry->direction = direction;
4784 new_list_entry->delay = delay;
4787 void print_unknown_token(char *filename, char *token, int token_nr)
4791 Error(ERR_RETURN_LINE, "-");
4792 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4793 Error(ERR_RETURN, "- config file: '%s'", filename);
4796 Error(ERR_RETURN, "- token: '%s'", token);
4799 void print_unknown_token_end(int token_nr)
4802 Error(ERR_RETURN_LINE, "-");
4805 void LoadHelpAnimInfo()
4807 char *filename = getHelpAnimFilename();
4808 SetupFileList *setup_file_list = NULL, *list;
4809 SetupFileHash *element_hash, *action_hash, *direction_hash;
4810 int num_list_entries = 0;
4811 int num_unknown_tokens = 0;
4814 if (fileExists(filename))
4815 setup_file_list = loadSetupFileList(filename);
4817 if (setup_file_list == NULL)
4819 /* use reliable default values from static configuration */
4820 SetupFileList *insert_ptr;
4822 insert_ptr = setup_file_list =
4823 newSetupFileList(helpanim_config[0].token,
4824 helpanim_config[0].value);
4826 for (i = 1; helpanim_config[i].token; i++)
4827 insert_ptr = addListEntry(insert_ptr,
4828 helpanim_config[i].token,
4829 helpanim_config[i].value);
4832 element_hash = newSetupFileHash();
4833 action_hash = newSetupFileHash();
4834 direction_hash = newSetupFileHash();
4836 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4837 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4839 for (i = 0; i < NUM_ACTIONS; i++)
4840 setHashEntry(action_hash, element_action_info[i].suffix,
4841 i_to_a(element_action_info[i].value));
4843 /* do not store direction index (bit) here, but direction value! */
4844 for (i = 0; i < NUM_DIRECTIONS; i++)
4845 setHashEntry(direction_hash, element_direction_info[i].suffix,
4846 i_to_a(1 << element_direction_info[i].value));
4848 for (list = setup_file_list; list != NULL; list = list->next)
4850 char *element_token, *action_token, *direction_token;
4851 char *element_value, *action_value, *direction_value;
4852 int delay = atoi(list->value);
4854 if (strcmp(list->token, "end") == 0)
4856 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4861 /* first try to break element into element/action/direction parts;
4862 if this does not work, also accept combined "element[.act][.dir]"
4863 elements (like "dynamite.active"), which are unique elements */
4865 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4867 element_value = getHashEntry(element_hash, list->token);
4868 if (element_value != NULL) /* element found */
4869 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4873 /* no further suffixes found -- this is not an element */
4874 print_unknown_token(filename, list->token, num_unknown_tokens++);
4880 /* token has format "<prefix>.<something>" */
4882 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4883 direction_token = action_token; /* ... or direction */
4885 element_token = getStringCopy(list->token);
4886 *strchr(element_token, '.') = '\0';
4888 element_value = getHashEntry(element_hash, element_token);
4890 if (element_value == NULL) /* this is no element */
4892 element_value = getHashEntry(element_hash, list->token);
4893 if (element_value != NULL) /* combined element found */
4894 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4897 print_unknown_token(filename, list->token, num_unknown_tokens++);
4899 free(element_token);
4904 action_value = getHashEntry(action_hash, action_token);
4906 if (action_value != NULL) /* action found */
4908 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4911 free(element_token);
4916 direction_value = getHashEntry(direction_hash, direction_token);
4918 if (direction_value != NULL) /* direction found */
4920 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4923 free(element_token);
4928 if (strchr(action_token + 1, '.') == NULL)
4930 /* no further suffixes found -- this is not an action nor direction */
4932 element_value = getHashEntry(element_hash, list->token);
4933 if (element_value != NULL) /* combined element found */
4934 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4937 print_unknown_token(filename, list->token, num_unknown_tokens++);
4939 free(element_token);
4944 /* token has format "<prefix>.<suffix>.<something>" */
4946 direction_token = strchr(action_token + 1, '.');
4948 action_token = getStringCopy(action_token);
4949 *strchr(action_token + 1, '.') = '\0';
4951 action_value = getHashEntry(action_hash, action_token);
4953 if (action_value == NULL) /* this is no action */
4955 element_value = getHashEntry(element_hash, list->token);
4956 if (element_value != NULL) /* combined element found */
4957 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4960 print_unknown_token(filename, list->token, num_unknown_tokens++);
4962 free(element_token);
4968 direction_value = getHashEntry(direction_hash, direction_token);
4970 if (direction_value != NULL) /* direction found */
4972 add_helpanim_entry(atoi(element_value), atoi(action_value),
4973 atoi(direction_value), delay, &num_list_entries);
4975 free(element_token);
4981 /* this is no direction */
4983 element_value = getHashEntry(element_hash, list->token);
4984 if (element_value != NULL) /* combined element found */
4985 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4988 print_unknown_token(filename, list->token, num_unknown_tokens++);
4990 free(element_token);
4994 print_unknown_token_end(num_unknown_tokens);
4996 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4997 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4999 freeSetupFileList(setup_file_list);
5000 freeSetupFileHash(element_hash);
5001 freeSetupFileHash(action_hash);
5002 freeSetupFileHash(direction_hash);
5006 for (i = 0; i < num_list_entries; i++)
5007 printf("::: %d, %d, %d => %d\n",
5008 helpanim_info[i].element,
5009 helpanim_info[i].action,
5010 helpanim_info[i].direction,
5011 helpanim_info[i].delay);
5015 void LoadHelpTextInfo()
5017 char *filename = getHelpTextFilename();
5020 if (helptext_info != NULL)
5022 freeSetupFileHash(helptext_info);
5023 helptext_info = NULL;
5026 if (fileExists(filename))
5027 helptext_info = loadSetupFileHash(filename);
5029 if (helptext_info == NULL)
5031 /* use reliable default values from static configuration */
5032 helptext_info = newSetupFileHash();
5034 for (i = 0; helptext_config[i].token; i++)
5035 setHashEntry(helptext_info,
5036 helptext_config[i].token,
5037 helptext_config[i].value);
5042 BEGIN_HASH_ITERATION(helptext_info, itr)
5044 printf("::: '%s' => '%s'\n",
5045 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
5047 END_HASH_ITERATION(hash, itr)
5052 /* ------------------------------------------------------------------------- *
5054 * ------------------------------------------------------------------------- */
5056 #define MAX_NUM_CONVERT_LEVELS 1000
5058 void ConvertLevels()
5060 static LevelDirTree *convert_leveldir = NULL;
5061 static int convert_level_nr = -1;
5062 static int num_levels_handled = 0;
5063 static int num_levels_converted = 0;
5064 static boolean levels_failed[MAX_NUM_CONVERT_LEVELS];
5067 convert_leveldir = getTreeInfoFromIdentifier(leveldir_first,
5068 global.convert_leveldir);
5070 if (convert_leveldir == NULL)
5071 Error(ERR_EXIT, "no such level identifier: '%s'",
5072 global.convert_leveldir);
5074 leveldir_current = convert_leveldir;
5076 if (global.convert_level_nr != -1)
5078 convert_leveldir->first_level = global.convert_level_nr;
5079 convert_leveldir->last_level = global.convert_level_nr;
5082 convert_level_nr = convert_leveldir->first_level;
5084 printf_line("=", 79);
5085 printf("Converting levels\n");
5086 printf_line("-", 79);
5087 printf("Level series identifier: '%s'\n", convert_leveldir->identifier);
5088 printf("Level series name: '%s'\n", convert_leveldir->name);
5089 printf("Level series author: '%s'\n", convert_leveldir->author);
5090 printf("Number of levels: %d\n", convert_leveldir->levels);
5091 printf_line("=", 79);
5094 for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
5095 levels_failed[i] = FALSE;
5097 while (convert_level_nr <= convert_leveldir->last_level)
5099 char *level_filename;
5102 level_nr = convert_level_nr++;
5104 printf("Level %03d: ", level_nr);
5106 LoadLevel(level_nr);
5107 if (level.no_valid_file)
5109 printf("(no level)\n");
5113 printf("converting level ... ");
5115 level_filename = getDefaultLevelFilename(level_nr);
5116 new_level = !fileExists(level_filename);
5120 SaveLevel(level_nr);
5122 num_levels_converted++;
5124 printf("converted.\n");
5128 if (level_nr >= 0 && level_nr < MAX_NUM_CONVERT_LEVELS)
5129 levels_failed[level_nr] = TRUE;
5131 printf("NOT CONVERTED -- LEVEL ALREADY EXISTS.\n");
5134 num_levels_handled++;
5138 printf_line("=", 79);
5139 printf("Number of levels handled: %d\n", num_levels_handled);
5140 printf("Number of levels converted: %d (%d%%)\n", num_levels_converted,
5141 (num_levels_handled ?
5142 num_levels_converted * 100 / num_levels_handled : 0));
5143 printf_line("-", 79);
5144 printf("Summary (for automatic parsing by scripts):\n");
5145 printf("LEVELDIR '%s', CONVERTED %d/%d (%d%%)",
5146 convert_leveldir->identifier, num_levels_converted,
5148 (num_levels_handled ?
5149 num_levels_converted * 100 / num_levels_handled : 0));
5151 if (num_levels_handled != num_levels_converted)
5153 printf(", FAILED:");
5154 for (i = 0; i < MAX_NUM_CONVERT_LEVELS; i++)
5155 if (levels_failed[i])
5160 printf_line("=", 79);