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 13 /* unused level header bytes */
33 #define LEVEL_CHUNK_CNT2_SIZE 160 /* size of level CNT2 chunk */
34 #define LEVEL_CHUNK_CNT2_UNUSED 11 /* unused CNT2 chunk bytes */
35 #define LEVEL_CHUNK_CNT3_HEADER 16 /* size of level CNT3 header */
36 #define LEVEL_CHUNK_CNT3_UNUSED 10 /* unused CNT3 chunk bytes */
37 #define LEVEL_CPART_CUS3_SIZE 134 /* size of CUS3 chunk part */
38 #define LEVEL_CPART_CUS3_UNUSED 15 /* unused CUS3 bytes / part */
39 #define LEVEL_CHUNK_GRP1_SIZE 74 /* size of level GRP1 chunk */
40 #define TAPE_HEADER_SIZE 20 /* size of tape file header */
41 #define TAPE_HEADER_UNUSED 3 /* unused tape header bytes */
43 #define LEVEL_CHUNK_CNT3_SIZE(x) (LEVEL_CHUNK_CNT3_HEADER + (x))
44 #define LEVEL_CHUNK_CUS3_SIZE(x) (2 + (x) * LEVEL_CPART_CUS3_SIZE)
45 #define LEVEL_CHUNK_CUS4_SIZE(x) (48 + 48 + (x) * 48)
47 /* file identifier strings */
48 #define LEVEL_COOKIE_TMPL "ROCKSNDIAMONDS_LEVEL_FILE_VERSION_x.x"
49 #define TAPE_COOKIE_TMPL "ROCKSNDIAMONDS_TAPE_FILE_VERSION_x.x"
50 #define SCORE_COOKIE "ROCKSNDIAMONDS_SCORE_FILE_VERSION_1.2"
52 /* values for level file type identifier */
53 #define LEVEL_FILE_TYPE_UNKNOWN 0
54 #define LEVEL_FILE_TYPE_RND 1
55 #define LEVEL_FILE_TYPE_BD 2
56 #define LEVEL_FILE_TYPE_EM 3
57 #define LEVEL_FILE_TYPE_SP 4
58 #define LEVEL_FILE_TYPE_DX 5
59 #define LEVEL_FILE_TYPE_SB 6
60 #define LEVEL_FILE_TYPE_DC 7
62 #define LEVEL_FILE_TYPE_RND_PACKED (10 + LEVEL_FILE_TYPE_RND)
63 #define LEVEL_FILE_TYPE_EM_PACKED (10 + LEVEL_FILE_TYPE_EM)
65 #define IS_SINGLE_LEVEL_FILE(x) (x < 10)
66 #define IS_PACKED_LEVEL_FILE(x) (x > 10)
69 /* ========================================================================= */
70 /* level file functions */
71 /* ========================================================================= */
73 void setElementChangePages(struct ElementInfo *ei, int change_pages)
75 int change_page_size = sizeof(struct ElementChangeInfo);
77 ei->num_change_pages = MAX(1, change_pages);
80 checked_realloc(ei->change_page, ei->num_change_pages * change_page_size);
82 if (ei->current_change_page >= ei->num_change_pages)
83 ei->current_change_page = ei->num_change_pages - 1;
85 ei->change = &ei->change_page[ei->current_change_page];
88 void setElementChangeInfoToDefaults(struct ElementChangeInfo *change)
92 change->can_change = FALSE;
94 change->events = CE_BITMASK_DEFAULT;
95 change->sides = CH_SIDE_ANY;
97 change->target_element = EL_EMPTY_SPACE;
99 change->delay_fixed = 0;
100 change->delay_random = 0;
101 change->delay_frames = 1;
103 change->trigger_element = EL_EMPTY_SPACE;
105 change->explode = FALSE;
106 change->use_content = FALSE;
107 change->only_complete = FALSE;
108 change->use_random_change = FALSE;
109 change->random = 100;
110 change->power = CP_NON_DESTRUCTIVE;
112 for (x = 0; x < 3; x++)
113 for (y = 0; y < 3; y++)
114 change->content[x][y] = EL_EMPTY_SPACE;
116 change->direct_action = 0;
117 change->other_action = 0;
119 change->pre_change_function = NULL;
120 change->change_function = NULL;
121 change->post_change_function = NULL;
124 static void setLevelInfoToDefaults(struct LevelInfo *level)
128 level->file_version = FILE_VERSION_ACTUAL;
129 level->game_version = GAME_VERSION_ACTUAL;
131 level->encoding_16bit_field = FALSE; /* default: only 8-bit elements */
132 level->encoding_16bit_yamyam = FALSE; /* default: only 8-bit elements */
133 level->encoding_16bit_amoeba = FALSE; /* default: only 8-bit elements */
135 level->fieldx = STD_LEV_FIELDX;
136 level->fieldy = STD_LEV_FIELDY;
138 for (x = 0; x < MAX_LEV_FIELDX; x++)
139 for (y = 0; y < MAX_LEV_FIELDY; y++)
140 level->field[x][y] = EL_SAND;
143 level->gems_needed = 0;
144 level->amoeba_speed = 10;
145 level->time_magic_wall = 10;
146 level->time_wheel = 10;
147 level->time_light = 10;
148 level->time_timegate = 10;
149 level->amoeba_content = EL_DIAMOND;
150 level->double_speed = FALSE;
151 level->initial_gravity = FALSE;
152 level->em_slippery_gems = FALSE;
154 level->use_custom_template = FALSE;
156 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
157 level->name[i] = '\0';
158 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
159 level->author[i] = '\0';
161 strcpy(level->name, NAMELESS_LEVEL_NAME);
162 strcpy(level->author, ANONYMOUS_NAME);
164 for (i = 0; i < 4; i++)
166 level->envelope_text[i][0] = '\0';
167 level->envelope_xsize[i] = MAX_ENVELOPE_XSIZE;
168 level->envelope_ysize[i] = MAX_ENVELOPE_YSIZE;
171 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
172 level->score[i] = 10;
174 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
175 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
176 for (x = 0; x < 3; x++)
177 for (y = 0; y < 3; y++)
178 level->yamyam_content[i][x][y] =
179 (i < STD_ELEMENT_CONTENTS ? EL_ROCK : EL_EMPTY);
181 level->field[0][0] = EL_PLAYER_1;
182 level->field[STD_LEV_FIELDX - 1][STD_LEV_FIELDY - 1] = EL_EXIT_CLOSED;
184 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
188 setElementChangePages(&element_info[element], 1);
189 setElementChangeInfoToDefaults(element_info[element].change);
191 if (IS_CUSTOM_ELEMENT(element) || IS_GROUP_ELEMENT(element))
193 for (j = 0; j < MAX_ELEMENT_NAME_LEN + 1; j++)
194 element_info[element].description[j] = '\0';
196 if (element_info[element].custom_description != NULL)
197 strncpy(element_info[element].description,
198 element_info[element].custom_description,MAX_ELEMENT_NAME_LEN);
200 strcpy(element_info[element].description,
201 element_info[element].editor_description);
203 element_info[element].use_gfx_element = FALSE;
204 element_info[element].gfx_element = EL_EMPTY_SPACE;
207 if (IS_CUSTOM_ELEMENT(element))
209 element_info[element].collect_score = 10; /* special default */
210 element_info[element].collect_count = 1; /* special default */
212 element_info[element].push_delay_fixed = -1; /* initialize later */
213 element_info[element].push_delay_random = -1; /* initialize later */
214 element_info[element].move_delay_fixed = 0;
215 element_info[element].move_delay_random = 0;
217 element_info[element].move_pattern = MV_ALL_DIRECTIONS;
218 element_info[element].move_direction_initial = MV_AUTOMATIC;
219 element_info[element].move_stepsize = TILEX / 8;
220 element_info[element].move_enter_element = EL_EMPTY_SPACE;
221 element_info[element].move_leave_element = EL_EMPTY_SPACE;
222 element_info[element].move_leave_type = LEAVE_TYPE_UNLIMITED;
224 element_info[element].slippery_type = SLIPPERY_ANY_RANDOM;
226 for (x = 0; x < 3; x++)
227 for (y = 0; y < 3; y++)
228 element_info[element].content[x][y] = EL_EMPTY_SPACE;
230 element_info[element].access_type = 0;
231 element_info[element].access_layer = 0;
232 element_info[element].walk_to_action = 0;
233 element_info[element].smash_targets = 0;
234 element_info[element].deadliness = 0;
235 element_info[element].consistency = 0;
237 element_info[element].can_explode_by_fire = FALSE;
238 element_info[element].can_explode_smashed = FALSE;
239 element_info[element].can_explode_impact = FALSE;
241 element_info[element].current_change_page = 0;
243 /* start with no properties at all */
244 for (j = 0; j < NUM_EP_BITFIELDS; j++)
245 Properties[element][j] = EP_BITMASK_DEFAULT;
247 element_info[element].modified_settings = FALSE;
249 else if (IS_GROUP_ELEMENT(element) || element == EL_INTERNAL_EDITOR)
251 /* initialize memory for list of elements in group */
252 if (element_info[element].group == NULL)
253 element_info[element].group =
254 checked_malloc(sizeof(struct ElementGroupInfo));
256 for (j = 0; j < MAX_ELEMENTS_IN_GROUP; j++)
257 element_info[element].group->element[j] = EL_EMPTY_SPACE;
259 /* default: only one element in group */
260 element_info[element].group->num_elements = 1;
262 element_info[element].group->choice_mode = ANIM_RANDOM;
266 BorderElement = EL_STEELWALL;
268 level->no_level_file = FALSE;
270 if (leveldir_current == NULL) /* only when dumping level */
273 /* try to determine better author name than 'anonymous' */
274 if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
276 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
277 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
281 switch (LEVELCLASS(leveldir_current))
283 case LEVELCLASS_TUTORIAL:
284 strcpy(level->author, PROGRAM_AUTHOR_STRING);
287 case LEVELCLASS_CONTRIB:
288 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
289 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
292 case LEVELCLASS_PRIVATE:
293 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
294 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
298 /* keep default value */
304 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
306 level_file_info->nr = 0;
307 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
308 level_file_info->packed = FALSE;
309 level_file_info->basename = NULL;
310 level_file_info->filename = NULL;
313 static void ActivateLevelTemplate()
315 /* Currently there is no special action needed to activate the template
316 data, because 'element_info' and 'Properties' overwrite the original
317 level data, while all other variables do not change. */
320 static char *getLevelFilenameFromBasename(char *basename)
322 static char *filename = NULL;
324 checked_free(filename);
326 filename = getPath2(getCurrentLevelDir(), basename);
331 static int getFileTypeFromBasename(char *basename)
333 static char *filename = NULL;
334 struct stat file_status;
336 /* ---------- try to determine file type from filename ---------- */
338 /* check for typical filename of a Supaplex level package file */
339 if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
340 strncmp(basename, "LEVELS.D", 8) == 0))
341 return LEVEL_FILE_TYPE_SP;
343 /* ---------- try to determine file type from filesize ---------- */
345 checked_free(filename);
346 filename = getPath2(getCurrentLevelDir(), basename);
348 if (stat(filename, &file_status) == 0)
350 /* check for typical filesize of a Supaplex level package file */
351 if (file_status.st_size == 170496)
352 return LEVEL_FILE_TYPE_SP;
355 return LEVEL_FILE_TYPE_UNKNOWN;
358 static char *getSingleLevelBasename(int nr, int type)
360 static char basename[MAX_FILENAME_LEN];
361 char *level_filename = getStringCopy(leveldir_current->level_filename);
363 if (level_filename == NULL)
364 level_filename = getStringCat2("%03d.", LEVELFILE_EXTENSION);
368 case LEVEL_FILE_TYPE_RND:
370 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
372 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
375 case LEVEL_FILE_TYPE_EM:
376 sprintf(basename, "%d", nr);
379 case LEVEL_FILE_TYPE_UNKNOWN:
381 sprintf(basename, level_filename, nr);
385 free(level_filename);
390 static char *getPackedLevelBasename(int type)
392 static char basename[MAX_FILENAME_LEN];
393 char *directory = getCurrentLevelDir();
395 struct dirent *dir_entry;
397 strcpy(basename, UNDEFINED_FILENAME); /* default: undefined file */
399 if ((dir = opendir(directory)) == NULL)
401 Error(ERR_WARN, "cannot read current level directory '%s'", directory);
406 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
408 char *entry_basename = dir_entry->d_name;
409 int entry_type = getFileTypeFromBasename(entry_basename);
411 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) /* found valid level package */
413 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
416 strcpy(basename, entry_basename);
428 static char *getSingleLevelFilename(int nr, int type)
430 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
434 static char *getPackedLevelFilename(int type)
436 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
440 char *getDefaultLevelFilename(int nr)
442 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
445 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
450 lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
451 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
454 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
459 lfi->basename = getPackedLevelBasename(lfi->type);
460 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
463 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
465 /* special case: level number is negative => check for level template file */
468 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
473 if (leveldir_current->level_filename != NULL)
475 /* check for file name/pattern specified in "levelinfo.conf" */
476 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
477 if (fileExists(lfi->filename))
481 /* check for native Rocks'n'Diamonds level file */
482 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
483 if (fileExists(lfi->filename))
486 /* check for classic Emerald Mine level file */
487 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
488 if (fileExists(lfi->filename))
491 /* check for various packed level file formats */
492 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
493 if (fileExists(lfi->filename))
496 /* no known level file found -- try to use default values */
497 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
500 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
502 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
503 lfi->type = getFileTypeFromBasename(lfi->basename);
506 static struct LevelFileInfo *getLevelFileInfo(int nr)
508 static struct LevelFileInfo level_file_info;
510 /* always start with reliable default values */
511 setFileInfoToDefaults(&level_file_info);
513 level_file_info.nr = nr; /* set requested level number */
515 determineLevelFileInfo_Filename(&level_file_info);
516 determineLevelFileInfo_Filetype(&level_file_info);
518 return &level_file_info;
522 /* ------------------------------------------------------------------------- */
523 /* functions for loading R'n'D level */
524 /* ------------------------------------------------------------------------- */
526 int getMappedElement(int element)
528 /* map some (historic, now obsolete) elements */
533 case EL_PLAYER_OBSOLETE:
534 element = EL_PLAYER_1;
537 case EL_KEY_OBSOLETE:
540 case EL_EM_KEY_1_FILE_OBSOLETE:
541 element = EL_EM_KEY_1;
544 case EL_EM_KEY_2_FILE_OBSOLETE:
545 element = EL_EM_KEY_2;
548 case EL_EM_KEY_3_FILE_OBSOLETE:
549 element = EL_EM_KEY_3;
552 case EL_EM_KEY_4_FILE_OBSOLETE:
553 element = EL_EM_KEY_4;
556 case EL_ENVELOPE_OBSOLETE:
557 element = EL_ENVELOPE_1;
565 if (element >= NUM_FILE_ELEMENTS)
567 Error(ERR_WARN, "invalid level element %d", element);
569 element = EL_CHAR_QUESTION;
574 if (element >= NUM_FILE_ELEMENTS)
576 Error(ERR_WARN, "invalid level element %d", element);
578 element = EL_CHAR_QUESTION;
580 else if (element == EL_PLAYER_OBSOLETE)
581 element = EL_PLAYER_1;
582 else if (element == EL_KEY_OBSOLETE)
589 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
591 level->file_version = getFileVersion(file);
592 level->game_version = getFileVersion(file);
597 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
601 level->fieldx = getFile8Bit(file);
602 level->fieldy = getFile8Bit(file);
604 level->time = getFile16BitBE(file);
605 level->gems_needed = getFile16BitBE(file);
607 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
608 level->name[i] = getFile8Bit(file);
609 level->name[MAX_LEVEL_NAME_LEN] = 0;
611 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
612 level->score[i] = getFile8Bit(file);
614 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
615 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
616 for (y = 0; y < 3; y++)
617 for (x = 0; x < 3; x++)
618 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
620 level->amoeba_speed = getFile8Bit(file);
621 level->time_magic_wall = getFile8Bit(file);
622 level->time_wheel = getFile8Bit(file);
623 level->amoeba_content = getMappedElement(getFile8Bit(file));
624 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
625 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
626 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
627 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
629 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
631 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
636 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
640 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
641 level->author[i] = getFile8Bit(file);
642 level->author[MAX_LEVEL_NAME_LEN] = 0;
647 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
650 int chunk_size_expected = level->fieldx * level->fieldy;
652 /* Note: "chunk_size" was wrong before version 2.0 when elements are
653 stored with 16-bit encoding (and should be twice as big then).
654 Even worse, playfield data was stored 16-bit when only yamyam content
655 contained 16-bit elements and vice versa. */
657 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
658 chunk_size_expected *= 2;
660 if (chunk_size_expected != chunk_size)
662 ReadUnusedBytesFromFile(file, chunk_size);
663 return chunk_size_expected;
666 for (y = 0; y < level->fieldy; y++)
667 for (x = 0; x < level->fieldx; x++)
669 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
674 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
678 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
679 int chunk_size_expected = header_size + content_size;
681 /* Note: "chunk_size" was wrong before version 2.0 when elements are
682 stored with 16-bit encoding (and should be twice as big then).
683 Even worse, playfield data was stored 16-bit when only yamyam content
684 contained 16-bit elements and vice versa. */
686 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
687 chunk_size_expected += content_size;
689 if (chunk_size_expected != chunk_size)
691 ReadUnusedBytesFromFile(file, chunk_size);
692 return chunk_size_expected;
696 level->num_yamyam_contents = getFile8Bit(file);
700 /* correct invalid number of content fields -- should never happen */
701 if (level->num_yamyam_contents < 1 ||
702 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
703 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
705 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
706 for (y = 0; y < 3; y++)
707 for (x = 0; x < 3; x++)
708 level->yamyam_content[i][x][y] =
709 getMappedElement(level->encoding_16bit_field ?
710 getFile16BitBE(file) : getFile8Bit(file));
714 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
718 int num_contents, content_xsize, content_ysize;
719 int content_array[MAX_ELEMENT_CONTENTS][3][3];
721 element = getMappedElement(getFile16BitBE(file));
722 num_contents = getFile8Bit(file);
723 content_xsize = getFile8Bit(file);
724 content_ysize = getFile8Bit(file);
726 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
728 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
729 for (y = 0; y < 3; y++)
730 for (x = 0; x < 3; x++)
731 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
733 /* correct invalid number of content fields -- should never happen */
734 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
735 num_contents = STD_ELEMENT_CONTENTS;
737 if (element == EL_YAMYAM)
739 level->num_yamyam_contents = num_contents;
741 for (i = 0; i < num_contents; i++)
742 for (y = 0; y < 3; y++)
743 for (x = 0; x < 3; x++)
744 level->yamyam_content[i][x][y] = content_array[i][x][y];
746 else if (element == EL_BD_AMOEBA)
748 level->amoeba_content = content_array[0][0][0];
752 Error(ERR_WARN, "cannot load content for element '%d'", element);
758 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
764 int chunk_size_expected;
766 element = getMappedElement(getFile16BitBE(file));
767 if (!IS_ENVELOPE(element))
768 element = EL_ENVELOPE_1;
770 envelope_nr = element - EL_ENVELOPE_1;
772 envelope_len = getFile16BitBE(file);
774 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
775 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
777 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
779 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
780 if (chunk_size_expected != chunk_size)
782 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
783 return chunk_size_expected;
786 for (i = 0; i < envelope_len; i++)
787 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
792 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
794 int num_changed_custom_elements = getFile16BitBE(file);
795 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
798 if (chunk_size_expected != chunk_size)
800 ReadUnusedBytesFromFile(file, chunk_size - 2);
801 return chunk_size_expected;
804 for (i = 0; i < num_changed_custom_elements; i++)
806 int element = getFile16BitBE(file);
807 int properties = getFile32BitBE(file);
809 if (IS_CUSTOM_ELEMENT(element))
810 Properties[element][EP_BITFIELD_BASE] = properties;
812 Error(ERR_WARN, "invalid custom element number %d", element);
818 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
820 int num_changed_custom_elements = getFile16BitBE(file);
821 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
824 if (chunk_size_expected != chunk_size)
826 ReadUnusedBytesFromFile(file, chunk_size - 2);
827 return chunk_size_expected;
830 for (i = 0; i < num_changed_custom_elements; i++)
832 int element = getFile16BitBE(file);
833 int custom_target_element = getFile16BitBE(file);
835 if (IS_CUSTOM_ELEMENT(element))
836 element_info[element].change->target_element = custom_target_element;
838 Error(ERR_WARN, "invalid custom element number %d", element);
844 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
846 int num_changed_custom_elements = getFile16BitBE(file);
847 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
850 if (chunk_size_expected != chunk_size)
852 ReadUnusedBytesFromFile(file, chunk_size - 2);
853 return chunk_size_expected;
856 for (i = 0; i < num_changed_custom_elements; i++)
858 int element = getFile16BitBE(file);
860 if (!IS_CUSTOM_ELEMENT(element))
862 Error(ERR_WARN, "invalid custom element number %d", element);
864 element = EL_INTERNAL_DUMMY;
867 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
868 element_info[element].description[j] = getFile8Bit(file);
869 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
871 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
873 /* some free bytes for future properties and padding */
874 ReadUnusedBytesFromFile(file, 7);
876 element_info[element].use_gfx_element = getFile8Bit(file);
877 element_info[element].gfx_element =
878 getMappedElement(getFile16BitBE(file));
880 element_info[element].collect_score = getFile8Bit(file);
881 element_info[element].collect_count = getFile8Bit(file);
883 element_info[element].push_delay_fixed = getFile16BitBE(file);
884 element_info[element].push_delay_random = getFile16BitBE(file);
885 element_info[element].move_delay_fixed = getFile16BitBE(file);
886 element_info[element].move_delay_random = getFile16BitBE(file);
888 element_info[element].move_pattern = getFile16BitBE(file);
889 element_info[element].move_direction_initial = getFile8Bit(file);
890 element_info[element].move_stepsize = getFile8Bit(file);
892 for (y = 0; y < 3; y++)
893 for (x = 0; x < 3; x++)
894 element_info[element].content[x][y] =
895 getMappedElement(getFile16BitBE(file));
897 element_info[element].change->events = getFile32BitBE(file);
899 element_info[element].change->target_element =
900 getMappedElement(getFile16BitBE(file));
902 element_info[element].change->delay_fixed = getFile16BitBE(file);
903 element_info[element].change->delay_random = getFile16BitBE(file);
904 element_info[element].change->delay_frames = getFile16BitBE(file);
906 element_info[element].change->trigger_element =
907 getMappedElement(getFile16BitBE(file));
909 element_info[element].change->explode = getFile8Bit(file);
910 element_info[element].change->use_content = getFile8Bit(file);
911 element_info[element].change->only_complete = getFile8Bit(file);
912 element_info[element].change->use_random_change = getFile8Bit(file);
914 element_info[element].change->random = getFile8Bit(file);
915 element_info[element].change->power = getFile8Bit(file);
917 for (y = 0; y < 3; y++)
918 for (x = 0; x < 3; x++)
919 element_info[element].change->content[x][y] =
920 getMappedElement(getFile16BitBE(file));
922 element_info[element].slippery_type = getFile8Bit(file);
924 /* some free bytes for future properties and padding */
925 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
927 /* mark that this custom element has been modified */
928 element_info[element].modified_settings = TRUE;
934 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
936 struct ElementInfo *ei;
937 int chunk_size_expected;
941 element = getFile16BitBE(file);
943 if (!IS_CUSTOM_ELEMENT(element))
945 Error(ERR_WARN, "invalid custom element number %d", element);
947 ReadUnusedBytesFromFile(file, chunk_size - 2);
951 ei = &element_info[element];
953 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
954 ei->description[i] = getFile8Bit(file);
955 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
957 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
958 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
960 ei->num_change_pages = getFile8Bit(file);
962 /* some free bytes for future base property values and padding */
963 ReadUnusedBytesFromFile(file, 5);
965 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
966 if (chunk_size_expected != chunk_size)
968 ReadUnusedBytesFromFile(file, chunk_size - 48);
969 return chunk_size_expected;
972 /* read custom property values */
974 ei->use_gfx_element = getFile8Bit(file);
975 ei->gfx_element = getMappedElement(getFile16BitBE(file));
977 ei->collect_score = getFile8Bit(file);
978 ei->collect_count = getFile8Bit(file);
980 ei->push_delay_fixed = getFile16BitBE(file);
981 ei->push_delay_random = getFile16BitBE(file);
982 ei->move_delay_fixed = getFile16BitBE(file);
983 ei->move_delay_random = getFile16BitBE(file);
985 ei->move_pattern = getFile16BitBE(file);
986 ei->move_direction_initial = getFile8Bit(file);
987 ei->move_stepsize = getFile8Bit(file);
989 ei->slippery_type = getFile8Bit(file);
991 for (y = 0; y < 3; y++)
992 for (x = 0; x < 3; x++)
993 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
995 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
996 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
997 ei->move_leave_type = getFile8Bit(file);
999 /* some free bytes for future custom property values and padding */
1000 ReadUnusedBytesFromFile(file, 7);
1002 /* read change property values */
1004 setElementChangePages(ei, ei->num_change_pages);
1006 for (i = 0; i < ei->num_change_pages; i++)
1008 struct ElementChangeInfo *change = &ei->change_page[i];
1010 /* always start with reliable default values */
1011 setElementChangeInfoToDefaults(change);
1013 change->events = getFile32BitBE(file);
1015 change->target_element = getMappedElement(getFile16BitBE(file));
1017 change->delay_fixed = getFile16BitBE(file);
1018 change->delay_random = getFile16BitBE(file);
1019 change->delay_frames = getFile16BitBE(file);
1021 change->trigger_element = getMappedElement(getFile16BitBE(file));
1023 change->explode = getFile8Bit(file);
1024 change->use_content = getFile8Bit(file);
1025 change->only_complete = getFile8Bit(file);
1026 change->use_random_change = getFile8Bit(file);
1028 change->random = getFile8Bit(file);
1029 change->power = getFile8Bit(file);
1031 for (y = 0; y < 3; y++)
1032 for (x = 0; x < 3; x++)
1033 change->content[x][y] = getMappedElement(getFile16BitBE(file));
1035 change->can_change = getFile8Bit(file);
1037 change->sides = getFile8Bit(file);
1039 if (change->sides == CH_SIDE_NONE) /* correct empty sides field */
1040 change->sides = CH_SIDE_ANY;
1042 /* some free bytes for future change property values and padding */
1043 ReadUnusedBytesFromFile(file, 8);
1046 /* mark this custom element as modified */
1047 ei->modified_settings = TRUE;
1052 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1054 struct ElementInfo *ei;
1055 struct ElementGroupInfo *group;
1059 element = getFile16BitBE(file);
1061 if (!IS_GROUP_ELEMENT(element))
1063 Error(ERR_WARN, "invalid group element number %d", element);
1065 ReadUnusedBytesFromFile(file, chunk_size - 2);
1069 ei = &element_info[element];
1071 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1072 ei->description[i] = getFile8Bit(file);
1073 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1075 group = element_info[element].group;
1077 group->num_elements = getFile8Bit(file);
1079 ei->use_gfx_element = getFile8Bit(file);
1080 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1082 group->choice_mode = getFile8Bit(file);
1084 /* some free bytes for future values and padding */
1085 ReadUnusedBytesFromFile(file, 3);
1087 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1088 group->element[i] = getMappedElement(getFile16BitBE(file));
1090 /* mark this group element as modified */
1091 element_info[element].modified_settings = TRUE;
1096 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1097 struct LevelFileInfo *level_file_info)
1099 char *filename = level_file_info->filename;
1100 char cookie[MAX_LINE_LEN];
1101 char chunk_name[CHUNK_ID_LEN + 1];
1105 if (!(file = fopen(filename, MODE_READ)))
1107 level->no_level_file = TRUE;
1109 if (level != &level_template)
1110 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1115 getFileChunkBE(file, chunk_name, NULL);
1116 if (strcmp(chunk_name, "RND1") == 0)
1118 getFile32BitBE(file); /* not used */
1120 getFileChunkBE(file, chunk_name, NULL);
1121 if (strcmp(chunk_name, "CAVE") != 0)
1123 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1128 else /* check for pre-2.0 file format with cookie string */
1130 strcpy(cookie, chunk_name);
1131 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1132 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1133 cookie[strlen(cookie) - 1] = '\0';
1135 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1137 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1142 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1144 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1149 /* pre-2.0 level files have no game version, so use file version here */
1150 level->game_version = level->file_version;
1153 if (level->file_version < FILE_VERSION_1_2)
1155 /* level files from versions before 1.2.0 without chunk structure */
1156 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1157 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1165 int (*loader)(FILE *, int, struct LevelInfo *);
1169 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1170 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1171 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1172 { "BODY", -1, LoadLevel_BODY },
1173 { "CONT", -1, LoadLevel_CONT },
1174 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1175 { "CNT3", -1, LoadLevel_CNT3 },
1176 { "CUS1", -1, LoadLevel_CUS1 },
1177 { "CUS2", -1, LoadLevel_CUS2 },
1178 { "CUS3", -1, LoadLevel_CUS3 },
1179 { "CUS4", -1, LoadLevel_CUS4 },
1180 { "GRP1", -1, LoadLevel_GRP1 },
1184 while (getFileChunkBE(file, chunk_name, &chunk_size))
1188 while (chunk_info[i].name != NULL &&
1189 strcmp(chunk_name, chunk_info[i].name) != 0)
1192 if (chunk_info[i].name == NULL)
1194 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1195 chunk_name, filename);
1196 ReadUnusedBytesFromFile(file, chunk_size);
1198 else if (chunk_info[i].size != -1 &&
1199 chunk_info[i].size != chunk_size)
1201 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1202 chunk_size, chunk_name, filename);
1203 ReadUnusedBytesFromFile(file, chunk_size);
1207 /* call function to load this level chunk */
1208 int chunk_size_expected =
1209 (chunk_info[i].loader)(file, chunk_size, level);
1211 /* the size of some chunks cannot be checked before reading other
1212 chunks first (like "HEAD" and "BODY") that contain some header
1213 information, so check them here */
1214 if (chunk_size_expected != chunk_size)
1216 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1217 chunk_size, chunk_name, filename);
1226 /* ------------------------------------------------------------------------- */
1227 /* functions for loading EM level */
1228 /* ------------------------------------------------------------------------- */
1230 static int map_em_element_yam(int element)
1234 case 0x00: return EL_EMPTY;
1235 case 0x01: return EL_EMERALD;
1236 case 0x02: return EL_DIAMOND;
1237 case 0x03: return EL_ROCK;
1238 case 0x04: return EL_ROBOT;
1239 case 0x05: return EL_SPACESHIP_UP;
1240 case 0x06: return EL_BOMB;
1241 case 0x07: return EL_BUG_UP;
1242 case 0x08: return EL_AMOEBA_DROP;
1243 case 0x09: return EL_NUT;
1244 case 0x0a: return EL_YAMYAM;
1245 case 0x0b: return EL_QUICKSAND_FULL;
1246 case 0x0c: return EL_SAND;
1247 case 0x0d: return EL_WALL_SLIPPERY;
1248 case 0x0e: return EL_STEELWALL;
1249 case 0x0f: return EL_WALL;
1250 case 0x10: return EL_EM_KEY_1;
1251 case 0x11: return EL_EM_KEY_2;
1252 case 0x12: return EL_EM_KEY_4;
1253 case 0x13: return EL_EM_KEY_3;
1254 case 0x14: return EL_MAGIC_WALL;
1255 case 0x15: return EL_ROBOT_WHEEL;
1256 case 0x16: return EL_DYNAMITE;
1258 case 0x17: return EL_EM_KEY_1; /* EMC */
1259 case 0x18: return EL_BUG_UP; /* EMC */
1260 case 0x1a: return EL_DIAMOND; /* EMC */
1261 case 0x1b: return EL_EMERALD; /* EMC */
1262 case 0x25: return EL_NUT; /* EMC */
1263 case 0x80: return EL_EMPTY; /* EMC */
1264 case 0x85: return EL_EM_KEY_1; /* EMC */
1265 case 0x86: return EL_EM_KEY_2; /* EMC */
1266 case 0x87: return EL_EM_KEY_4; /* EMC */
1267 case 0x88: return EL_EM_KEY_3; /* EMC */
1268 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1269 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1270 case 0xaf: return EL_DYNAMITE; /* EMC */
1271 case 0xbd: return EL_SAND; /* EMC */
1274 Error(ERR_WARN, "invalid level element %d", element);
1275 return EL_CHAR_QUESTION;
1279 static int map_em_element_field(int element)
1281 if (element >= 0xc8 && element <= 0xe1)
1282 return EL_CHAR_A + (element - 0xc8);
1283 else if (element >= 0xe2 && element <= 0xeb)
1284 return EL_CHAR_0 + (element - 0xe2);
1288 case 0x00: return EL_ROCK;
1289 case 0x02: return EL_DIAMOND;
1290 case 0x03: return EL_DIAMOND;
1291 case 0x04: return EL_ROBOT;
1292 case 0x05: return EL_ROBOT; /* EMC */
1293 case 0x08: return EL_SPACESHIP_UP;
1294 case 0x09: return EL_SPACESHIP_RIGHT;
1295 case 0x0a: return EL_SPACESHIP_DOWN;
1296 case 0x0b: return EL_SPACESHIP_LEFT;
1297 case 0x0c: return EL_SPACESHIP_UP;
1298 case 0x0d: return EL_SPACESHIP_RIGHT;
1299 case 0x0e: return EL_SPACESHIP_DOWN;
1300 case 0x0f: return EL_SPACESHIP_LEFT;
1301 case 0x10: return EL_BOMB;
1302 case 0x12: return EL_EMERALD;
1303 case 0x13: return EL_EMERALD;
1304 case 0x14: return EL_BUG_UP;
1305 case 0x15: return EL_BUG_RIGHT;
1306 case 0x16: return EL_BUG_DOWN;
1307 case 0x17: return EL_BUG_LEFT;
1308 case 0x18: return EL_BUG_UP;
1309 case 0x19: return EL_BUG_RIGHT;
1310 case 0x1a: return EL_BUG_DOWN;
1311 case 0x1b: return EL_BUG_LEFT;
1312 case 0x1c: return EL_AMOEBA_DROP;
1313 case 0x20: return EL_ROCK;
1314 case 0x24: return EL_MAGIC_WALL;
1315 case 0x25: return EL_NUT;
1317 /* looks like magic wheel, but is _always_ activated */
1318 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1320 case 0x29: return EL_YAMYAM;
1321 case 0x2a: return EL_YAMYAM;
1322 case 0x2b: return EL_YAMYAM; /* EMC */
1323 case 0x2c: return EL_YAMYAM; /* EMC */
1324 case 0x2d: return EL_QUICKSAND_FULL;
1325 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1326 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1327 case 0x3b: return EL_DYNAMITE_ACTIVE;
1328 case 0x3c: return EL_DYNAMITE_ACTIVE;
1329 case 0x3d: return EL_DYNAMITE_ACTIVE;
1330 case 0x3e: return EL_DYNAMITE_ACTIVE;
1331 case 0x3f: return EL_ACID_POOL_BOTTOM;
1332 case 0x40: return EL_EXIT_OPEN;
1333 case 0x41: return EL_EXIT_OPEN;
1334 case 0x42: return EL_EXIT_OPEN;
1335 case 0x43: return EL_BALLOON;
1336 case 0x4e: return EL_INVISIBLE_WALL;
1337 case 0x65: return EL_ACID; /* EMC */
1338 case 0x73: return EL_SAND; /* EMC */
1339 case 0x74: return EL_STEELWALL;
1340 case 0x7b: return EL_ACID;
1341 case 0x80: return EL_EMPTY;
1342 case 0x81: return EL_WALL_SLIPPERY;
1343 case 0x82: return EL_SAND;
1344 case 0x83: return EL_STEELWALL;
1345 case 0x84: return EL_WALL;
1346 case 0x85: return EL_EM_KEY_1;
1347 case 0x86: return EL_EM_KEY_2;
1348 case 0x87: return EL_EM_KEY_4;
1349 case 0x88: return EL_EM_KEY_3;
1350 case 0x89: return EL_EM_GATE_1;
1351 case 0x8a: return EL_EM_GATE_2;
1352 case 0x8b: return EL_EM_GATE_4;
1353 case 0x8c: return EL_EM_GATE_3;
1354 case 0x8d: return EL_INVISIBLE_WALL; /* EMC */
1355 case 0x8e: return EL_EM_GATE_1_GRAY;
1356 case 0x8f: return EL_EM_GATE_2_GRAY;
1357 case 0x90: return EL_EM_GATE_4_GRAY;
1358 case 0x91: return EL_EM_GATE_3_GRAY;
1359 case 0x92: return EL_MAGIC_WALL;
1360 case 0x94: return EL_QUICKSAND_EMPTY;
1361 case 0x95: return EL_ACID_POOL_TOPLEFT;
1362 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1363 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1364 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1365 case 0x99: return EL_ACID;
1366 case 0x9a: return EL_AMOEBA_DEAD;
1367 case 0x9b: return EL_AMOEBA_DEAD;
1368 case 0x9c: return EL_AMOEBA_DEAD;
1369 case 0x9d: return EL_AMOEBA_DEAD;
1370 case 0x9e: return EL_EXIT_CLOSED;
1371 case 0x9f: return EL_CHAR_LESS; /* EMC */
1372 case 0x93: return EL_ROBOT_WHEEL;
1374 /* looks like normal dust, but behaves like wall */
1375 case 0xa0: return EL_WALL; /* EMC */
1377 case 0xa8: return EL_EMC_WALL_1; /* EMC */
1378 case 0xa9: return EL_EMC_WALL_2; /* EMC */
1379 case 0xaa: return EL_EMC_WALL_3; /* EMC */
1380 case 0xab: return EL_EMC_WALL_7; /* EMC */
1381 case 0xae: return EL_CHAR_MINUS; /* EMC */
1382 case 0xaf: return EL_DYNAMITE;
1383 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC */
1384 case 0xb1: return EL_EMC_WALL_8; /* EMC */
1386 /* (exact steel wall) */
1387 case 0xb3: return EL_STEELWALL; /* EMC */
1389 case 0xb4: return EL_WALL_SLIPPERY; /* EMC */
1390 case 0xb5: return EL_EMC_WALL_6; /* EMC */
1391 case 0xb6: return EL_EMC_WALL_5; /* EMC */
1392 case 0xb7: return EL_EMC_WALL_4; /* EMC */
1393 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1394 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1395 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1396 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1397 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1398 case 0xbd: return EL_SAND; /* EMC */
1399 case 0xec: return EL_CHAR_PERIOD;
1400 case 0xed: return EL_CHAR_EXCLAM;
1401 case 0xee: return EL_CHAR_COLON;
1402 case 0xef: return EL_CHAR_QUESTION;
1403 case 0xf0: return EL_CHAR_GREATER;
1404 case 0xf1: return EL_CHAR_COPYRIGHT;
1405 case 0xfe: return EL_PLAYER_1;
1406 case 0xff: return EL_PLAYER_2;
1409 Error(ERR_WARN, "invalid level element %d", element);
1410 return EL_CHAR_QUESTION;
1414 #define EM_LEVEL_SIZE 2106
1415 #define EM_LEVEL_XSIZE 64
1416 #define EM_LEVEL_YSIZE 32
1418 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1419 struct LevelFileInfo *level_file_info)
1421 char *filename = level_file_info->filename;
1423 unsigned char leveldata[EM_LEVEL_SIZE];
1424 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1425 unsigned char code0 = 0x65;
1426 unsigned char code1 = 0x11;
1427 boolean level_is_crypted = FALSE;
1428 int nr = level_file_info->nr;
1431 if (!(file = fopen(filename, MODE_READ)))
1433 level->no_level_file = TRUE;
1435 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1440 for(i = 0; i < EM_LEVEL_SIZE; i++)
1441 leveldata[i] = fgetc(file);
1445 /* check if level data is crypted by testing against known starting bytes
1446 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1448 if ((leveldata[0] == 0xf1 ||
1449 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1451 level_is_crypted = TRUE;
1453 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1454 leveldata[0] = 0xf1;
1457 if (level_is_crypted) /* decode crypted level data */
1459 for(i = 0; i < EM_LEVEL_SIZE; i++)
1461 leveldata[i] ^= code0;
1462 leveldata[i] -= code1;
1464 code0 = (code0 + 7) & 0xff;
1468 level->fieldx = EM_LEVEL_XSIZE;
1469 level->fieldy = EM_LEVEL_YSIZE;
1471 level->time = header[46] * 10;
1472 level->gems_needed = header[47];
1474 /* The original Emerald Mine levels have their level number stored
1475 at the second byte of the level file...
1476 Do not trust this information at other level files, e.g. EMC,
1477 but correct it anyway (normally the first row is completely
1478 steel wall, so the correction does not hurt anyway). */
1480 if (leveldata[1] == nr)
1481 leveldata[1] = leveldata[2]; /* correct level number field */
1483 sprintf(level->name, "Level %d", nr); /* set level name */
1485 level->score[SC_EMERALD] = header[36];
1486 level->score[SC_DIAMOND] = header[37];
1487 level->score[SC_ROBOT] = header[38];
1488 level->score[SC_SPACESHIP] = header[39];
1489 level->score[SC_BUG] = header[40];
1490 level->score[SC_YAMYAM] = header[41];
1491 level->score[SC_NUT] = header[42];
1492 level->score[SC_DYNAMITE] = header[43];
1493 level->score[SC_TIME_BONUS] = header[44];
1495 level->num_yamyam_contents = 4;
1497 for(i = 0; i < level->num_yamyam_contents; i++)
1498 for(y = 0; y < 3; y++)
1499 for(x = 0; x < 3; x++)
1500 level->yamyam_content[i][x][y] =
1501 map_em_element_yam(header[i * 9 + y * 3 + x]);
1503 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1504 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1505 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1506 level->amoeba_content = EL_DIAMOND;
1508 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1510 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1512 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1513 new_element = EL_AMOEBA_WET;
1515 level->field[x][y] = new_element;
1518 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1519 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1520 level->field[x][y] = EL_PLAYER_1;
1522 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1523 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1524 level->field[x][y] = EL_PLAYER_2;
1527 /* ------------------------------------------------------------------------- */
1528 /* functions for loading SP level */
1529 /* ------------------------------------------------------------------------- */
1531 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1532 #define SP_LEVEL_SIZE 1536
1533 #define SP_LEVEL_XSIZE 60
1534 #define SP_LEVEL_YSIZE 24
1535 #define SP_LEVEL_NAME_LEN 23
1537 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1542 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1543 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1545 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1547 int element_old = fgetc(file);
1550 if (element_old <= 0x27)
1551 element_new = getMappedElement(EL_SP_START + element_old);
1552 else if (element_old == 0x28)
1553 element_new = EL_INVISIBLE_WALL;
1556 Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1557 Error(ERR_WARN, "invalid level element %d", element_old);
1559 element_new = EL_CHAR_QUESTION;
1562 level->field[x][y] = element_new;
1566 ReadUnusedBytesFromFile(file, 4);
1568 /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1569 level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1571 ReadUnusedBytesFromFile(file, 1);
1573 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1574 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1575 level->name[i] = fgetc(file);
1576 level->name[SP_LEVEL_NAME_LEN] = '\0';
1578 /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1579 ReadUnusedBytesFromFile(file, 1); /* !!! NOT SUPPORTED YET !!! */
1581 /* number of infotrons needed; 0 means that Supaplex will count the total
1582 amount of infotrons in the level and use the low byte of that number.
1583 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1584 level->gems_needed = fgetc(file);
1586 /* information about special gravity port entries */
1587 ReadUnusedBytesFromFile(file, 65); /* !!! NOT SUPPORTED YET !!! */
1589 level->fieldx = SP_LEVEL_XSIZE;
1590 level->fieldy = SP_LEVEL_YSIZE;
1592 level->time = 0; /* no time limit */
1593 level->amoeba_speed = 0;
1594 level->time_magic_wall = 0;
1595 level->time_wheel = 0;
1596 level->amoeba_content = EL_EMPTY;
1598 for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1599 level->score[i] = 0; /* !!! CORRECT THIS !!! */
1601 /* there are no yamyams in supaplex levels */
1602 for(i = 0; i < level->num_yamyam_contents; i++)
1603 for(y = 0; y < 3; y++)
1604 for(x = 0; x < 3; x++)
1605 level->yamyam_content[i][x][y] = EL_EMPTY;
1608 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1609 struct LevelFileInfo *level_file_info)
1611 char *filename = level_file_info->filename;
1613 int nr = level_file_info->nr - leveldir_current->first_level;
1615 char name_first, name_last;
1616 struct LevelInfo multipart_level;
1617 int multipart_xpos, multipart_ypos;
1618 boolean is_multipart_level;
1619 boolean is_first_part;
1620 boolean reading_multipart_level = FALSE;
1621 boolean use_empty_level = FALSE;
1623 if (!(file = fopen(filename, MODE_READ)))
1625 level->no_level_file = TRUE;
1627 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1632 /* position file stream to the requested level inside the level package */
1633 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1635 level->no_level_file = TRUE;
1637 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1642 /* there exist Supaplex level package files with multi-part levels which
1643 can be detected as follows: instead of leading and trailing dashes ('-')
1644 to pad the level name, they have leading and trailing numbers which are
1645 the x and y coordinations of the current part of the multi-part level;
1646 if there are '?' characters instead of numbers on the left or right side
1647 of the level name, the multi-part level consists of only horizontal or
1650 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1652 LoadLevelFromFileStream_SP(file, level, l);
1654 /* check if this level is a part of a bigger multi-part level */
1656 name_first = level->name[0];
1657 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
1659 is_multipart_level =
1660 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1661 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
1664 ((name_first == '?' || name_first == '1') &&
1665 (name_last == '?' || name_last == '1'));
1667 /* correct leading multipart level meta information in level name */
1668 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1669 level->name[i] = '-';
1671 /* correct trailing multipart level meta information in level name */
1672 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1673 level->name[i] = '-';
1675 /* ---------- check for normal single level ---------- */
1677 if (!reading_multipart_level && !is_multipart_level)
1679 /* the current level is simply a normal single-part level, and we are
1680 not reading a multi-part level yet, so return the level as it is */
1685 /* ---------- check for empty level (unused multi-part) ---------- */
1687 if (!reading_multipart_level && is_multipart_level && !is_first_part)
1689 /* this is a part of a multi-part level, but not the first part
1690 (and we are not already reading parts of a multi-part level);
1691 in this case, use an empty level instead of the single part */
1693 use_empty_level = TRUE;
1698 /* ---------- check for finished multi-part level ---------- */
1700 if (reading_multipart_level &&
1701 (!is_multipart_level ||
1702 strcmp(level->name, multipart_level.name) != 0))
1704 /* we are already reading parts of a multi-part level, but this level is
1705 either not a multi-part level, or a part of a different multi-part
1706 level; in both cases, the multi-part level seems to be complete */
1711 /* ---------- here we have one part of a multi-part level ---------- */
1713 reading_multipart_level = TRUE;
1715 if (is_first_part) /* start with first part of new multi-part level */
1717 /* copy level info structure from first part */
1718 multipart_level = *level;
1720 /* clear playfield of new multi-part level */
1721 for (y = 0; y < MAX_LEV_FIELDY; y++)
1722 for (x = 0; x < MAX_LEV_FIELDX; x++)
1723 multipart_level.field[x][y] = EL_EMPTY;
1726 if (name_first == '?')
1728 if (name_last == '?')
1731 multipart_xpos = (int)(name_first - '0');
1732 multipart_ypos = (int)(name_last - '0');
1735 printf("----------> part (%d/%d) of multi-part level '%s'\n",
1736 multipart_xpos, multipart_ypos, multipart_level.name);
1739 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1740 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1742 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1747 multipart_level.fieldx = MAX(multipart_level.fieldx,
1748 multipart_xpos * SP_LEVEL_XSIZE);
1749 multipart_level.fieldy = MAX(multipart_level.fieldy,
1750 multipart_ypos * SP_LEVEL_YSIZE);
1752 /* copy level part at the right position of multi-part level */
1753 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1755 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1757 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1758 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1760 multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
1767 if (use_empty_level)
1769 setLevelInfoToDefaults(level);
1771 level->fieldx = SP_LEVEL_XSIZE;
1772 level->fieldy = SP_LEVEL_YSIZE;
1774 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1775 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1776 level->field[x][y] = EL_EMPTY;
1778 strcpy(level->name, "-------- EMPTY --------");
1780 Error(ERR_WARN, "single part of multi-part level -- using empty level");
1783 if (reading_multipart_level)
1784 *level = multipart_level;
1787 /* ------------------------------------------------------------------------- */
1788 /* functions for loading generic level */
1789 /* ------------------------------------------------------------------------- */
1791 void LoadLevelFromFileInfo(struct LevelInfo *level,
1792 struct LevelFileInfo *level_file_info)
1794 /* always start with reliable default values */
1795 setLevelInfoToDefaults(level);
1797 switch (level_file_info->type)
1799 case LEVEL_FILE_TYPE_RND:
1800 LoadLevelFromFileInfo_RND(level, level_file_info);
1803 case LEVEL_FILE_TYPE_EM:
1804 LoadLevelFromFileInfo_EM(level, level_file_info);
1807 case LEVEL_FILE_TYPE_SP:
1808 LoadLevelFromFileInfo_SP(level, level_file_info);
1812 LoadLevelFromFileInfo_RND(level, level_file_info);
1817 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
1819 static struct LevelFileInfo level_file_info;
1821 /* always start with reliable default values */
1822 setFileInfoToDefaults(&level_file_info);
1824 level_file_info.nr = 0; /* unknown level number */
1825 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
1826 level_file_info.filename = filename;
1828 LoadLevelFromFileInfo(level, &level_file_info);
1831 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
1833 if (leveldir_current == NULL) /* only when dumping level */
1837 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
1840 /* determine correct game engine version of current level */
1842 if (!leveldir_current->latest_engine)
1844 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
1845 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
1846 IS_LEVELCLASS_UNDEFINED(leveldir_current))
1850 printf("\n::: This level is private or contributed: '%s'\n", filename);
1854 printf("\n::: Use the stored game engine version for this level\n");
1857 /* For all levels which are not forced to use the latest game engine
1858 version (normally user contributed, private and undefined levels),
1859 use the version of the game engine the levels were created for.
1861 Since 2.0.1, the game engine version is now directly stored
1862 in the level file (chunk "VERS"), so there is no need anymore
1863 to set the game version from the file version (except for old,
1864 pre-2.0 levels, where the game version is still taken from the
1865 file format version used to store the level -- see above). */
1867 /* do some special adjustments to support older level versions */
1868 if (level->file_version == FILE_VERSION_1_0)
1870 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
1871 Error(ERR_WARN, "using high speed movement for player");
1873 /* player was faster than monsters in (pre-)1.0 levels */
1874 level->double_speed = TRUE;
1877 /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */
1878 if (level->game_version == VERSION_IDENT(2,0,1,0))
1879 level->em_slippery_gems = TRUE;
1884 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
1885 leveldir_current->sort_priority, filename);
1889 printf("\n::: Use latest game engine version for this level.\n");
1892 /* For all levels which are forced to use the latest game engine version
1893 (normally all but user contributed, private and undefined levels), set
1894 the game engine version to the actual version; this allows for actual
1895 corrections in the game engine to take effect for existing, converted
1896 levels (from "classic" or other existing games) to make the emulation
1897 of the corresponding game more accurate, while (hopefully) not breaking
1898 existing levels created from other players. */
1901 printf("::: changing engine from %d to %d\n",
1902 level->game_version, GAME_VERSION_ACTUAL);
1905 level->game_version = GAME_VERSION_ACTUAL;
1907 /* Set special EM style gems behaviour: EM style gems slip down from
1908 normal, steel and growing wall. As this is a more fundamental change,
1909 it seems better to set the default behaviour to "off" (as it is more
1910 natural) and make it configurable in the level editor (as a property
1911 of gem style elements). Already existing converted levels (neither
1912 private nor contributed levels) are changed to the new behaviour. */
1914 if (level->file_version < FILE_VERSION_2_0)
1915 level->em_slippery_gems = TRUE;
1919 printf("::: => %d\n", level->game_version);
1923 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
1927 /* map custom element change events that have changed in newer versions
1928 (these following values were accidentally changed in version 3.0.1) */
1929 if (level->game_version <= VERSION_IDENT(3,0,0,0))
1931 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1933 int element = EL_CUSTOM_START + i;
1935 /* order of checking and copying events to be mapped is important */
1936 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
1938 if (HAS_CHANGE_EVENT(element, j - 2))
1940 SET_CHANGE_EVENT(element, j - 2, FALSE);
1941 SET_CHANGE_EVENT(element, j, TRUE);
1945 /* order of checking and copying events to be mapped is important */
1946 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
1948 if (HAS_CHANGE_EVENT(element, j - 1))
1950 SET_CHANGE_EVENT(element, j - 1, FALSE);
1951 SET_CHANGE_EVENT(element, j, TRUE);
1957 /* some custom element change events get mapped since version 3.0.3 */
1958 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1960 int element = EL_CUSTOM_START + i;
1962 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
1963 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
1965 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
1966 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
1968 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
1972 /* initialize "can_change" field for old levels with only one change page */
1973 if (level->game_version <= VERSION_IDENT(3,0,2,0))
1975 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1977 int element = EL_CUSTOM_START + i;
1979 if (CAN_CHANGE(element))
1980 element_info[element].change->can_change = TRUE;
1985 /* set default push delay values (corrected since version 3.0.7-1) */
1986 if (level->game_version < VERSION_IDENT(3,0,7,1))
1988 game.default_push_delay_fixed = 2;
1989 game.default_push_delay_random = 8;
1993 game.default_push_delay_fixed = 8;
1994 game.default_push_delay_random = 8;
1997 /* set uninitialized push delay values of custom elements in older levels */
1998 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2000 int element = EL_CUSTOM_START + i;
2002 if (element_info[element].push_delay_fixed == -1)
2003 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
2004 if (element_info[element].push_delay_random == -1)
2005 element_info[element].push_delay_random = game.default_push_delay_random;
2009 /* initialize element properties for level editor etc. */
2010 InitElementPropertiesEngine(level->game_version);
2013 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2017 /* map elements that have changed in newer versions */
2018 for (y = 0; y < level->fieldy; y++)
2020 for (x = 0; x < level->fieldx; x++)
2022 int element = level->field[x][y];
2024 if (level->game_version <= VERSION_IDENT(2,2,0,0))
2026 /* map game font elements */
2027 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2028 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2029 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2030 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2033 if (level->game_version < VERSION_IDENT(3,0,0,0))
2035 /* map Supaplex gravity tube elements */
2036 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2037 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2038 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2039 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2043 level->field[x][y] = element;
2047 /* copy elements to runtime playfield array */
2048 for (x = 0; x < MAX_LEV_FIELDX; x++)
2049 for (y = 0; y < MAX_LEV_FIELDY; y++)
2050 Feld[x][y] = level->field[x][y];
2052 /* initialize level size variables for faster access */
2053 lev_fieldx = level->fieldx;
2054 lev_fieldy = level->fieldy;
2056 /* determine border element for this level */
2060 void LoadLevelTemplate(int nr)
2063 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2064 char *filename = level_file_info->filename;
2066 LoadLevelFromFileInfo(&level_template, level_file_info);
2068 char *filename = getDefaultLevelFilename(nr);
2070 LoadLevelFromFilename_RND(&level_template, filename);
2073 LoadLevel_InitVersion(&level, filename);
2074 LoadLevel_InitElements(&level, filename);
2076 ActivateLevelTemplate();
2079 void LoadLevel(int nr)
2082 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2083 char *filename = level_file_info->filename;
2085 LoadLevelFromFileInfo(&level, level_file_info);
2087 char *filename = getLevelFilename(nr);
2089 LoadLevelFromFilename_RND(&level, filename);
2092 if (level.use_custom_template)
2093 LoadLevelTemplate(-1);
2096 LoadLevel_InitVersion(&level, filename);
2097 LoadLevel_InitElements(&level, filename);
2098 LoadLevel_InitPlayfield(&level, filename);
2100 LoadLevel_InitLevel(&level, filename);
2104 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2106 putFileVersion(file, level->file_version);
2107 putFileVersion(file, level->game_version);
2110 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2114 putFile8Bit(file, level->fieldx);
2115 putFile8Bit(file, level->fieldy);
2117 putFile16BitBE(file, level->time);
2118 putFile16BitBE(file, level->gems_needed);
2120 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2121 putFile8Bit(file, level->name[i]);
2123 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2124 putFile8Bit(file, level->score[i]);
2126 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2127 for (y = 0; y < 3; y++)
2128 for (x = 0; x < 3; x++)
2129 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2130 level->yamyam_content[i][x][y]));
2131 putFile8Bit(file, level->amoeba_speed);
2132 putFile8Bit(file, level->time_magic_wall);
2133 putFile8Bit(file, level->time_wheel);
2134 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2135 level->amoeba_content));
2136 putFile8Bit(file, (level->double_speed ? 1 : 0));
2137 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2138 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2139 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2141 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2143 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2146 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2150 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2151 putFile8Bit(file, level->author[i]);
2154 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2158 for (y = 0; y < level->fieldy; y++)
2159 for (x = 0; x < level->fieldx; x++)
2160 if (level->encoding_16bit_field)
2161 putFile16BitBE(file, level->field[x][y]);
2163 putFile8Bit(file, level->field[x][y]);
2167 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2171 putFile8Bit(file, EL_YAMYAM);
2172 putFile8Bit(file, level->num_yamyam_contents);
2173 putFile8Bit(file, 0);
2174 putFile8Bit(file, 0);
2176 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2177 for (y = 0; y < 3; y++)
2178 for (x = 0; x < 3; x++)
2179 if (level->encoding_16bit_field)
2180 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2182 putFile8Bit(file, level->yamyam_content[i][x][y]);
2186 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2189 int num_contents, content_xsize, content_ysize;
2190 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2192 if (element == EL_YAMYAM)
2194 num_contents = level->num_yamyam_contents;
2198 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2199 for (y = 0; y < 3; y++)
2200 for (x = 0; x < 3; x++)
2201 content_array[i][x][y] = level->yamyam_content[i][x][y];
2203 else if (element == EL_BD_AMOEBA)
2209 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2210 for (y = 0; y < 3; y++)
2211 for (x = 0; x < 3; x++)
2212 content_array[i][x][y] = EL_EMPTY;
2213 content_array[0][0][0] = level->amoeba_content;
2217 /* chunk header already written -- write empty chunk data */
2218 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2220 Error(ERR_WARN, "cannot save content for element '%d'", element);
2224 putFile16BitBE(file, element);
2225 putFile8Bit(file, num_contents);
2226 putFile8Bit(file, content_xsize);
2227 putFile8Bit(file, content_ysize);
2229 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2231 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2232 for (y = 0; y < 3; y++)
2233 for (x = 0; x < 3; x++)
2234 putFile16BitBE(file, content_array[i][x][y]);
2237 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2240 int envelope_nr = element - EL_ENVELOPE_1;
2241 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2243 putFile16BitBE(file, element);
2244 putFile16BitBE(file, envelope_len);
2245 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2246 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2248 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2250 for (i = 0; i < envelope_len; i++)
2251 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2255 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2256 int num_changed_custom_elements)
2260 putFile16BitBE(file, num_changed_custom_elements);
2262 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2264 int element = EL_CUSTOM_START + i;
2266 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2268 if (check < num_changed_custom_elements)
2270 putFile16BitBE(file, element);
2271 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2278 if (check != num_changed_custom_elements) /* should not happen */
2279 Error(ERR_WARN, "inconsistent number of custom element properties");
2284 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2285 int num_changed_custom_elements)
2289 putFile16BitBE(file, num_changed_custom_elements);
2291 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2293 int element = EL_CUSTOM_START + i;
2295 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2297 if (check < num_changed_custom_elements)
2299 putFile16BitBE(file, element);
2300 putFile16BitBE(file, element_info[element].change->target_element);
2307 if (check != num_changed_custom_elements) /* should not happen */
2308 Error(ERR_WARN, "inconsistent number of custom target elements");
2313 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2314 int num_changed_custom_elements)
2316 int i, j, x, y, check = 0;
2318 putFile16BitBE(file, num_changed_custom_elements);
2320 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2322 int element = EL_CUSTOM_START + i;
2324 if (element_info[element].modified_settings)
2326 if (check < num_changed_custom_elements)
2328 putFile16BitBE(file, element);
2330 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2331 putFile8Bit(file, element_info[element].description[j]);
2333 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2335 /* some free bytes for future properties and padding */
2336 WriteUnusedBytesToFile(file, 7);
2338 putFile8Bit(file, element_info[element].use_gfx_element);
2339 putFile16BitBE(file, element_info[element].gfx_element);
2341 putFile8Bit(file, element_info[element].collect_score);
2342 putFile8Bit(file, element_info[element].collect_count);
2344 putFile16BitBE(file, element_info[element].push_delay_fixed);
2345 putFile16BitBE(file, element_info[element].push_delay_random);
2346 putFile16BitBE(file, element_info[element].move_delay_fixed);
2347 putFile16BitBE(file, element_info[element].move_delay_random);
2349 putFile16BitBE(file, element_info[element].move_pattern);
2350 putFile8Bit(file, element_info[element].move_direction_initial);
2351 putFile8Bit(file, element_info[element].move_stepsize);
2353 for (y = 0; y < 3; y++)
2354 for (x = 0; x < 3; x++)
2355 putFile16BitBE(file, element_info[element].content[x][y]);
2357 putFile32BitBE(file, element_info[element].change->events);
2359 putFile16BitBE(file, element_info[element].change->target_element);
2361 putFile16BitBE(file, element_info[element].change->delay_fixed);
2362 putFile16BitBE(file, element_info[element].change->delay_random);
2363 putFile16BitBE(file, element_info[element].change->delay_frames);
2365 putFile16BitBE(file, element_info[element].change->trigger_element);
2367 putFile8Bit(file, element_info[element].change->explode);
2368 putFile8Bit(file, element_info[element].change->use_content);
2369 putFile8Bit(file, element_info[element].change->only_complete);
2370 putFile8Bit(file, element_info[element].change->use_random_change);
2372 putFile8Bit(file, element_info[element].change->random);
2373 putFile8Bit(file, element_info[element].change->power);
2375 for (y = 0; y < 3; y++)
2376 for (x = 0; x < 3; x++)
2377 putFile16BitBE(file, element_info[element].change->content[x][y]);
2379 putFile8Bit(file, element_info[element].slippery_type);
2381 /* some free bytes for future properties and padding */
2382 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2389 if (check != num_changed_custom_elements) /* should not happen */
2390 Error(ERR_WARN, "inconsistent number of custom element properties");
2394 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2396 struct ElementInfo *ei = &element_info[element];
2399 putFile16BitBE(file, element);
2401 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2402 putFile8Bit(file, ei->description[i]);
2404 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2405 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
2407 putFile8Bit(file, ei->num_change_pages);
2409 /* some free bytes for future base property values and padding */
2410 WriteUnusedBytesToFile(file, 5);
2412 /* write custom property values */
2414 putFile8Bit(file, ei->use_gfx_element);
2415 putFile16BitBE(file, ei->gfx_element);
2417 putFile8Bit(file, ei->collect_score);
2418 putFile8Bit(file, ei->collect_count);
2420 putFile16BitBE(file, ei->push_delay_fixed);
2421 putFile16BitBE(file, ei->push_delay_random);
2422 putFile16BitBE(file, ei->move_delay_fixed);
2423 putFile16BitBE(file, ei->move_delay_random);
2425 putFile16BitBE(file, ei->move_pattern);
2426 putFile8Bit(file, ei->move_direction_initial);
2427 putFile8Bit(file, ei->move_stepsize);
2429 putFile8Bit(file, ei->slippery_type);
2431 for (y = 0; y < 3; y++)
2432 for (x = 0; x < 3; x++)
2433 putFile16BitBE(file, ei->content[x][y]);
2435 putFile16BitBE(file, ei->move_enter_element);
2436 putFile16BitBE(file, ei->move_leave_element);
2437 putFile8Bit(file, ei->move_leave_type);
2439 /* some free bytes for future custom property values and padding */
2440 WriteUnusedBytesToFile(file, 7);
2442 /* write change property values */
2444 for (i = 0; i < ei->num_change_pages; i++)
2446 struct ElementChangeInfo *change = &ei->change_page[i];
2448 putFile32BitBE(file, change->events);
2450 putFile16BitBE(file, change->target_element);
2452 putFile16BitBE(file, change->delay_fixed);
2453 putFile16BitBE(file, change->delay_random);
2454 putFile16BitBE(file, change->delay_frames);
2456 putFile16BitBE(file, change->trigger_element);
2458 putFile8Bit(file, change->explode);
2459 putFile8Bit(file, change->use_content);
2460 putFile8Bit(file, change->only_complete);
2461 putFile8Bit(file, change->use_random_change);
2463 putFile8Bit(file, change->random);
2464 putFile8Bit(file, change->power);
2466 for (y = 0; y < 3; y++)
2467 for (x = 0; x < 3; x++)
2468 putFile16BitBE(file, change->content[x][y]);
2470 putFile8Bit(file, change->can_change);
2472 putFile8Bit(file, change->sides);
2474 /* some free bytes for future change property values and padding */
2475 WriteUnusedBytesToFile(file, 8);
2479 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2481 struct ElementInfo *ei = &element_info[element];
2482 struct ElementGroupInfo *group = ei->group;
2485 putFile16BitBE(file, element);
2487 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2488 putFile8Bit(file, ei->description[i]);
2490 putFile8Bit(file, group->num_elements);
2492 putFile8Bit(file, ei->use_gfx_element);
2493 putFile16BitBE(file, ei->gfx_element);
2495 putFile8Bit(file, group->choice_mode);
2497 /* some free bytes for future values and padding */
2498 WriteUnusedBytesToFile(file, 3);
2500 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2501 putFile16BitBE(file, group->element[i]);
2504 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2506 int body_chunk_size;
2510 if (!(file = fopen(filename, MODE_WRITE)))
2512 Error(ERR_WARN, "cannot save level file '%s'", filename);
2516 level->file_version = FILE_VERSION_ACTUAL;
2517 level->game_version = GAME_VERSION_ACTUAL;
2519 /* check level field for 16-bit elements */
2520 level->encoding_16bit_field = FALSE;
2521 for (y = 0; y < level->fieldy; y++)
2522 for (x = 0; x < level->fieldx; x++)
2523 if (level->field[x][y] > 255)
2524 level->encoding_16bit_field = TRUE;
2526 /* check yamyam content for 16-bit elements */
2527 level->encoding_16bit_yamyam = FALSE;
2528 for (i = 0; i < level->num_yamyam_contents; i++)
2529 for (y = 0; y < 3; y++)
2530 for (x = 0; x < 3; x++)
2531 if (level->yamyam_content[i][x][y] > 255)
2532 level->encoding_16bit_yamyam = TRUE;
2534 /* check amoeba content for 16-bit elements */
2535 level->encoding_16bit_amoeba = FALSE;
2536 if (level->amoeba_content > 255)
2537 level->encoding_16bit_amoeba = TRUE;
2539 /* calculate size of "BODY" chunk */
2541 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2543 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2544 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2546 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2547 SaveLevel_VERS(file, level);
2549 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2550 SaveLevel_HEAD(file, level);
2552 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2553 SaveLevel_AUTH(file, level);
2555 putFileChunkBE(file, "BODY", body_chunk_size);
2556 SaveLevel_BODY(file, level);
2558 if (level->encoding_16bit_yamyam ||
2559 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2561 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2562 SaveLevel_CNT2(file, level, EL_YAMYAM);
2565 if (level->encoding_16bit_amoeba)
2567 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2568 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2571 /* check for envelope content */
2572 for (i = 0; i < 4; i++)
2574 if (strlen(level->envelope_text[i]) > 0)
2576 int envelope_len = strlen(level->envelope_text[i]) + 1;
2578 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2579 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2583 /* check for non-default custom elements (unless using template level) */
2584 if (!level->use_custom_template)
2586 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2588 int element = EL_CUSTOM_START + i;
2590 if (element_info[element].modified_settings)
2592 int num_change_pages = element_info[element].num_change_pages;
2594 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2595 SaveLevel_CUS4(file, level, element);
2600 /* check for non-default group elements (unless using template level) */
2601 if (!level->use_custom_template)
2603 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2605 int element = EL_GROUP_START + i;
2607 if (element_info[element].modified_settings)
2609 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2610 SaveLevel_GRP1(file, level, element);
2617 SetFilePermissions(filename, PERMS_PRIVATE);
2620 void SaveLevel(int nr)
2622 char *filename = getDefaultLevelFilename(nr);
2624 SaveLevelFromFilename(&level, filename);
2627 void SaveLevelTemplate()
2629 char *filename = getDefaultLevelFilename(-1);
2631 SaveLevelFromFilename(&level, filename);
2634 void DumpLevel(struct LevelInfo *level)
2636 printf_line("-", 79);
2637 printf("Level xxx (file version %08d, game version %08d)\n",
2638 level->file_version, level->game_version);
2639 printf_line("-", 79);
2641 printf("Level Author: '%s'\n", level->author);
2642 printf("Level Title: '%s'\n", level->name);
2644 printf("Playfield Size: %d x %d\n", level->fieldx, level->fieldy);
2646 printf("Level Time: %d seconds\n", level->time);
2647 printf("Gems needed: %d\n", level->gems_needed);
2649 printf("Time for Magic Wall: %d seconds\n", level->time_magic_wall);
2650 printf("Time for Wheel: %d seconds\n", level->time_wheel);
2651 printf("Time for Light: %d seconds\n", level->time_light);
2652 printf("Time for Timegate: %d seconds\n", level->time_timegate);
2654 printf("Amoeba Speed: %d\n", level->amoeba_speed);
2656 printf("Gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
2657 printf("Double Speed Movement: %s\n", (level->double_speed ? "yes" : "no"));
2658 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
2660 printf_line("-", 79);
2664 /* ========================================================================= */
2665 /* tape file functions */
2666 /* ========================================================================= */
2668 static void setTapeInfoToDefaults()
2672 /* always start with reliable default values (empty tape) */
2675 /* default values (also for pre-1.2 tapes) with only the first player */
2676 tape.player_participates[0] = TRUE;
2677 for (i = 1; i < MAX_PLAYERS; i++)
2678 tape.player_participates[i] = FALSE;
2680 /* at least one (default: the first) player participates in every tape */
2681 tape.num_participating_players = 1;
2683 tape.level_nr = level_nr;
2685 tape.changed = FALSE;
2687 tape.recording = FALSE;
2688 tape.playing = FALSE;
2689 tape.pausing = FALSE;
2692 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
2694 tape->file_version = getFileVersion(file);
2695 tape->game_version = getFileVersion(file);
2700 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
2704 tape->random_seed = getFile32BitBE(file);
2705 tape->date = getFile32BitBE(file);
2706 tape->length = getFile32BitBE(file);
2708 /* read header fields that are new since version 1.2 */
2709 if (tape->file_version >= FILE_VERSION_1_2)
2711 byte store_participating_players = getFile8Bit(file);
2714 /* since version 1.2, tapes store which players participate in the tape */
2715 tape->num_participating_players = 0;
2716 for (i = 0; i < MAX_PLAYERS; i++)
2718 tape->player_participates[i] = FALSE;
2720 if (store_participating_players & (1 << i))
2722 tape->player_participates[i] = TRUE;
2723 tape->num_participating_players++;
2727 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
2729 engine_version = getFileVersion(file);
2730 if (engine_version > 0)
2731 tape->engine_version = engine_version;
2733 tape->engine_version = tape->game_version;
2739 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
2741 int level_identifier_size;
2744 level_identifier_size = getFile16BitBE(file);
2746 tape->level_identifier =
2747 checked_realloc(tape->level_identifier, level_identifier_size);
2749 for (i = 0; i < level_identifier_size; i++)
2750 tape->level_identifier[i] = getFile8Bit(file);
2752 tape->level_nr = getFile16BitBE(file);
2754 chunk_size = 2 + level_identifier_size + 2;
2759 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
2762 int chunk_size_expected =
2763 (tape->num_participating_players + 1) * tape->length;
2765 if (chunk_size_expected != chunk_size)
2767 ReadUnusedBytesFromFile(file, chunk_size);
2768 return chunk_size_expected;
2771 for (i = 0; i < tape->length; i++)
2773 if (i >= MAX_TAPELEN)
2776 for (j = 0; j < MAX_PLAYERS; j++)
2778 tape->pos[i].action[j] = MV_NO_MOVING;
2780 if (tape->player_participates[j])
2781 tape->pos[i].action[j] = getFile8Bit(file);
2784 tape->pos[i].delay = getFile8Bit(file);
2786 if (tape->file_version == FILE_VERSION_1_0)
2788 /* eliminate possible diagonal moves in old tapes */
2789 /* this is only for backward compatibility */
2791 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
2792 byte action = tape->pos[i].action[0];
2793 int k, num_moves = 0;
2795 for (k = 0; k<4; k++)
2797 if (action & joy_dir[k])
2799 tape->pos[i + num_moves].action[0] = joy_dir[k];
2801 tape->pos[i + num_moves].delay = 0;
2810 tape->length += num_moves;
2813 else if (tape->file_version < FILE_VERSION_2_0)
2815 /* convert pre-2.0 tapes to new tape format */
2817 if (tape->pos[i].delay > 1)
2820 tape->pos[i + 1] = tape->pos[i];
2821 tape->pos[i + 1].delay = 1;
2824 for (j = 0; j < MAX_PLAYERS; j++)
2825 tape->pos[i].action[j] = MV_NO_MOVING;
2826 tape->pos[i].delay--;
2837 if (i != tape->length)
2838 chunk_size = (tape->num_participating_players + 1) * i;
2843 void LoadTapeFromFilename(char *filename)
2845 char cookie[MAX_LINE_LEN];
2846 char chunk_name[CHUNK_ID_LEN + 1];
2850 /* always start with reliable default values */
2851 setTapeInfoToDefaults();
2853 if (!(file = fopen(filename, MODE_READ)))
2856 getFileChunkBE(file, chunk_name, NULL);
2857 if (strcmp(chunk_name, "RND1") == 0)
2859 getFile32BitBE(file); /* not used */
2861 getFileChunkBE(file, chunk_name, NULL);
2862 if (strcmp(chunk_name, "TAPE") != 0)
2864 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
2869 else /* check for pre-2.0 file format with cookie string */
2871 strcpy(cookie, chunk_name);
2872 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
2873 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
2874 cookie[strlen(cookie) - 1] = '\0';
2876 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
2878 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
2883 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
2885 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
2890 /* pre-2.0 tape files have no game version, so use file version here */
2891 tape.game_version = tape.file_version;
2894 if (tape.file_version < FILE_VERSION_1_2)
2896 /* tape files from versions before 1.2.0 without chunk structure */
2897 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
2898 LoadTape_BODY(file, 2 * tape.length, &tape);
2906 int (*loader)(FILE *, int, struct TapeInfo *);
2910 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
2911 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
2912 { "INFO", -1, LoadTape_INFO },
2913 { "BODY", -1, LoadTape_BODY },
2917 while (getFileChunkBE(file, chunk_name, &chunk_size))
2921 while (chunk_info[i].name != NULL &&
2922 strcmp(chunk_name, chunk_info[i].name) != 0)
2925 if (chunk_info[i].name == NULL)
2927 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
2928 chunk_name, filename);
2929 ReadUnusedBytesFromFile(file, chunk_size);
2931 else if (chunk_info[i].size != -1 &&
2932 chunk_info[i].size != chunk_size)
2934 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
2935 chunk_size, chunk_name, filename);
2936 ReadUnusedBytesFromFile(file, chunk_size);
2940 /* call function to load this tape chunk */
2941 int chunk_size_expected =
2942 (chunk_info[i].loader)(file, chunk_size, &tape);
2944 /* the size of some chunks cannot be checked before reading other
2945 chunks first (like "HEAD" and "BODY") that contain some header
2946 information, so check them here */
2947 if (chunk_size_expected != chunk_size)
2949 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
2950 chunk_size, chunk_name, filename);
2958 tape.length_seconds = GetTapeLength();
2961 printf("::: tape game version: %d\n", tape.game_version);
2962 printf("::: tape engine version: %d\n", tape.engine_version);
2966 void LoadTape(int nr)
2968 char *filename = getTapeFilename(nr);
2970 LoadTapeFromFilename(filename);
2973 void LoadSolutionTape(int nr)
2975 char *filename = getSolutionTapeFilename(nr);
2977 LoadTapeFromFilename(filename);
2980 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
2982 putFileVersion(file, tape->file_version);
2983 putFileVersion(file, tape->game_version);
2986 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
2989 byte store_participating_players = 0;
2991 /* set bits for participating players for compact storage */
2992 for (i = 0; i < MAX_PLAYERS; i++)
2993 if (tape->player_participates[i])
2994 store_participating_players |= (1 << i);
2996 putFile32BitBE(file, tape->random_seed);
2997 putFile32BitBE(file, tape->date);
2998 putFile32BitBE(file, tape->length);
3000 putFile8Bit(file, store_participating_players);
3002 /* unused bytes not at the end here for 4-byte alignment of engine_version */
3003 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
3005 putFileVersion(file, tape->engine_version);
3008 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
3010 int level_identifier_size = strlen(tape->level_identifier) + 1;
3013 putFile16BitBE(file, level_identifier_size);
3015 for (i = 0; i < level_identifier_size; i++)
3016 putFile8Bit(file, tape->level_identifier[i]);
3018 putFile16BitBE(file, tape->level_nr);
3021 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3025 for (i = 0; i < tape->length; i++)
3027 for (j = 0; j < MAX_PLAYERS; j++)
3028 if (tape->player_participates[j])
3029 putFile8Bit(file, tape->pos[i].action[j]);
3031 putFile8Bit(file, tape->pos[i].delay);
3035 void SaveTape(int nr)
3037 char *filename = getTapeFilename(nr);
3039 boolean new_tape = TRUE;
3040 int num_participating_players = 0;
3041 int info_chunk_size;
3042 int body_chunk_size;
3045 InitTapeDirectory(leveldir_current->subdir);
3047 /* if a tape still exists, ask to overwrite it */
3048 if (access(filename, F_OK) == 0)
3051 if (!Request("Replace old tape ?", REQ_ASK))
3055 if (!(file = fopen(filename, MODE_WRITE)))
3057 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3061 tape.file_version = FILE_VERSION_ACTUAL;
3062 tape.game_version = GAME_VERSION_ACTUAL;
3064 /* count number of participating players */
3065 for (i = 0; i < MAX_PLAYERS; i++)
3066 if (tape.player_participates[i])
3067 num_participating_players++;
3069 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3070 body_chunk_size = (num_participating_players + 1) * tape.length;
3072 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3073 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3075 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3076 SaveTape_VERS(file, &tape);
3078 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3079 SaveTape_HEAD(file, &tape);
3081 putFileChunkBE(file, "INFO", info_chunk_size);
3082 SaveTape_INFO(file, &tape);
3084 putFileChunkBE(file, "BODY", body_chunk_size);
3085 SaveTape_BODY(file, &tape);
3089 SetFilePermissions(filename, PERMS_PRIVATE);
3091 tape.changed = FALSE;
3094 Request("tape saved !", REQ_CONFIRM);
3097 void DumpTape(struct TapeInfo *tape)
3101 if (TAPE_IS_EMPTY(*tape))
3103 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3107 printf_line("-", 79);
3108 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3109 tape->level_nr, tape->file_version, tape->game_version);
3110 printf("Level series identifier: '%s'\n", tape->level_identifier);
3111 printf_line("-", 79);
3113 for (i = 0; i < tape->length; i++)
3115 if (i >= MAX_TAPELEN)
3118 printf("%03d: ", i);
3120 for (j = 0; j < MAX_PLAYERS; j++)
3122 if (tape->player_participates[j])
3124 int action = tape->pos[i].action[j];
3126 printf("%d:%02x ", j, action);
3127 printf("[%c%c%c%c|%c%c] - ",
3128 (action & JOY_LEFT ? '<' : ' '),
3129 (action & JOY_RIGHT ? '>' : ' '),
3130 (action & JOY_UP ? '^' : ' '),
3131 (action & JOY_DOWN ? 'v' : ' '),
3132 (action & JOY_BUTTON_1 ? '1' : ' '),
3133 (action & JOY_BUTTON_2 ? '2' : ' '));
3137 printf("(%03d)\n", tape->pos[i].delay);
3140 printf_line("-", 79);
3144 /* ========================================================================= */
3145 /* score file functions */
3146 /* ========================================================================= */
3148 void LoadScore(int nr)
3151 char *filename = getScoreFilename(nr);
3152 char cookie[MAX_LINE_LEN];
3153 char line[MAX_LINE_LEN];
3157 /* always start with reliable default values */
3158 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3160 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3161 highscore[i].Score = 0;
3164 if (!(file = fopen(filename, MODE_READ)))
3167 /* check file identifier */
3168 fgets(cookie, MAX_LINE_LEN, file);
3169 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3170 cookie[strlen(cookie) - 1] = '\0';
3172 if (!checkCookieString(cookie, SCORE_COOKIE))
3174 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3179 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3181 fscanf(file, "%d", &highscore[i].Score);
3182 fgets(line, MAX_LINE_LEN, file);
3184 if (line[strlen(line) - 1] == '\n')
3185 line[strlen(line) - 1] = '\0';
3187 for (line_ptr = line; *line_ptr; line_ptr++)
3189 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3191 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3192 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3201 void SaveScore(int nr)
3204 char *filename = getScoreFilename(nr);
3207 InitScoreDirectory(leveldir_current->subdir);
3209 if (!(file = fopen(filename, MODE_WRITE)))
3211 Error(ERR_WARN, "cannot save score for level %d", nr);
3215 fprintf(file, "%s\n\n", SCORE_COOKIE);
3217 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3218 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3222 SetFilePermissions(filename, PERMS_PUBLIC);
3226 /* ========================================================================= */
3227 /* setup file functions */
3228 /* ========================================================================= */
3230 #define TOKEN_STR_PLAYER_PREFIX "player_"
3233 #define SETUP_TOKEN_PLAYER_NAME 0
3234 #define SETUP_TOKEN_SOUND 1
3235 #define SETUP_TOKEN_SOUND_LOOPS 2
3236 #define SETUP_TOKEN_SOUND_MUSIC 3
3237 #define SETUP_TOKEN_SOUND_SIMPLE 4
3238 #define SETUP_TOKEN_TOONS 5
3239 #define SETUP_TOKEN_SCROLL_DELAY 6
3240 #define SETUP_TOKEN_SOFT_SCROLLING 7
3241 #define SETUP_TOKEN_FADING 8
3242 #define SETUP_TOKEN_AUTORECORD 9
3243 #define SETUP_TOKEN_QUICK_DOORS 10
3244 #define SETUP_TOKEN_TEAM_MODE 11
3245 #define SETUP_TOKEN_HANDICAP 12
3246 #define SETUP_TOKEN_TIME_LIMIT 13
3247 #define SETUP_TOKEN_FULLSCREEN 14
3248 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3249 #define SETUP_TOKEN_GRAPHICS_SET 16
3250 #define SETUP_TOKEN_SOUNDS_SET 17
3251 #define SETUP_TOKEN_MUSIC_SET 18
3252 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3253 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3254 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3256 #define NUM_GLOBAL_SETUP_TOKENS 22
3259 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3260 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3261 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3262 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3263 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3264 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3265 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3266 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3267 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3268 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3269 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3270 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3272 #define NUM_EDITOR_SETUP_TOKENS 12
3274 /* shortcut setup */
3275 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3276 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3277 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3279 #define NUM_SHORTCUT_SETUP_TOKENS 3
3282 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3283 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3284 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3285 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3286 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3287 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3288 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3289 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3290 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3291 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3292 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3293 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3294 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3295 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3296 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3297 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3299 #define NUM_PLAYER_SETUP_TOKENS 16
3302 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
3303 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
3305 #define NUM_SYSTEM_SETUP_TOKENS 2
3308 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
3310 #define NUM_OPTIONS_SETUP_TOKENS 1
3313 static struct SetupInfo si;
3314 static struct SetupEditorInfo sei;
3315 static struct SetupShortcutInfo ssi;
3316 static struct SetupInputInfo sii;
3317 static struct SetupSystemInfo syi;
3318 static struct OptionInfo soi;
3320 static struct TokenInfo global_setup_tokens[] =
3322 { TYPE_STRING, &si.player_name, "player_name" },
3323 { TYPE_SWITCH, &si.sound, "sound" },
3324 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
3325 { TYPE_SWITCH, &si.sound_music, "background_music" },
3326 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
3327 { TYPE_SWITCH, &si.toons, "toons" },
3328 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
3329 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
3330 { TYPE_SWITCH, &si.fading, "screen_fading" },
3331 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
3332 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
3333 { TYPE_SWITCH, &si.team_mode, "team_mode" },
3334 { TYPE_SWITCH, &si.handicap, "handicap" },
3335 { TYPE_SWITCH, &si.time_limit, "time_limit" },
3336 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
3337 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
3338 { TYPE_STRING, &si.graphics_set, "graphics_set" },
3339 { TYPE_STRING, &si.sounds_set, "sounds_set" },
3340 { TYPE_STRING, &si.music_set, "music_set" },
3341 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3342 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
3343 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
3346 static struct TokenInfo editor_setup_tokens[] =
3348 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
3349 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
3350 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
3351 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
3352 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
3353 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
3354 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
3355 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
3356 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
3357 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
3358 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
3359 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
3362 static struct TokenInfo shortcut_setup_tokens[] =
3364 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
3365 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
3366 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
3369 static struct TokenInfo player_setup_tokens[] =
3371 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
3372 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
3373 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
3374 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
3375 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
3376 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
3377 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
3378 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
3379 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
3380 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
3381 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
3382 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
3383 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
3384 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
3385 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
3386 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
3389 static struct TokenInfo system_setup_tokens[] =
3391 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
3392 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3395 static struct TokenInfo options_setup_tokens[] =
3397 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
3400 static char *get_corrected_login_name(char *login_name)
3402 /* needed because player name must be a fixed length string */
3403 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3405 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3406 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3408 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
3409 if (strchr(login_name_new, ' '))
3410 *strchr(login_name_new, ' ') = '\0';
3412 return login_name_new;
3415 static void setSetupInfoToDefaults(struct SetupInfo *si)
3419 si->player_name = get_corrected_login_name(getLoginName());
3422 si->sound_loops = TRUE;
3423 si->sound_music = TRUE;
3424 si->sound_simple = TRUE;
3426 si->double_buffering = TRUE;
3427 si->direct_draw = !si->double_buffering;
3428 si->scroll_delay = TRUE;
3429 si->soft_scrolling = TRUE;
3431 si->autorecord = TRUE;
3432 si->quick_doors = FALSE;
3433 si->team_mode = FALSE;
3434 si->handicap = TRUE;
3435 si->time_limit = TRUE;
3436 si->fullscreen = FALSE;
3437 si->ask_on_escape = TRUE;
3439 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3440 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3441 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3442 si->override_level_graphics = FALSE;
3443 si->override_level_sounds = FALSE;
3444 si->override_level_music = FALSE;
3446 si->editor.el_boulderdash = TRUE;
3447 si->editor.el_emerald_mine = TRUE;
3448 si->editor.el_more = TRUE;
3449 si->editor.el_sokoban = TRUE;
3450 si->editor.el_supaplex = TRUE;
3451 si->editor.el_diamond_caves = TRUE;
3452 si->editor.el_dx_boulderdash = TRUE;
3453 si->editor.el_chars = TRUE;
3454 si->editor.el_custom = TRUE;
3455 si->editor.el_custom_more = FALSE;
3457 si->editor.el_headlines = TRUE;
3458 si->editor.el_user_defined = FALSE;
3460 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3461 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3462 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3464 for (i = 0; i < MAX_PLAYERS; i++)
3466 si->input[i].use_joystick = FALSE;
3467 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3468 si->input[i].joy.xleft = JOYSTICK_XLEFT;
3469 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3470 si->input[i].joy.xright = JOYSTICK_XRIGHT;
3471 si->input[i].joy.yupper = JOYSTICK_YUPPER;
3472 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3473 si->input[i].joy.ylower = JOYSTICK_YLOWER;
3474 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
3475 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
3476 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
3477 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3478 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
3479 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
3480 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
3481 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
3484 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3485 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3487 si->options.verbose = FALSE;
3490 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3494 if (!setup_file_hash)
3499 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3500 setSetupInfo(global_setup_tokens, i,
3501 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3506 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3507 setSetupInfo(editor_setup_tokens, i,
3508 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3511 /* shortcut setup */
3512 ssi = setup.shortcut;
3513 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3514 setSetupInfo(shortcut_setup_tokens, i,
3515 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3516 setup.shortcut = ssi;
3519 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3523 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3525 sii = setup.input[pnr];
3526 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3528 char full_token[100];
3530 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3531 setSetupInfo(player_setup_tokens, i,
3532 getHashEntry(setup_file_hash, full_token));
3534 setup.input[pnr] = sii;
3539 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3540 setSetupInfo(system_setup_tokens, i,
3541 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3545 soi = setup.options;
3546 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3547 setSetupInfo(options_setup_tokens, i,
3548 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3549 setup.options = soi;
3554 char *filename = getSetupFilename();
3555 SetupFileHash *setup_file_hash = NULL;
3557 /* always start with reliable default values */
3558 setSetupInfoToDefaults(&setup);
3560 setup_file_hash = loadSetupFileHash(filename);
3562 if (setup_file_hash)
3564 char *player_name_new;
3566 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3567 decodeSetupFileHash(setup_file_hash);
3569 setup.direct_draw = !setup.double_buffering;
3571 freeSetupFileHash(setup_file_hash);
3573 /* needed to work around problems with fixed length strings */
3574 player_name_new = get_corrected_login_name(setup.player_name);
3575 free(setup.player_name);
3576 setup.player_name = player_name_new;
3579 Error(ERR_WARN, "using default setup values");
3584 char *filename = getSetupFilename();
3588 InitUserDataDirectory();
3590 if (!(file = fopen(filename, MODE_WRITE)))
3592 Error(ERR_WARN, "cannot write setup file '%s'", filename);
3596 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3597 getCookie("SETUP")));
3598 fprintf(file, "\n");
3602 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3604 /* just to make things nicer :) */
3605 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3606 i == SETUP_TOKEN_GRAPHICS_SET)
3607 fprintf(file, "\n");
3609 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3614 fprintf(file, "\n");
3615 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3616 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3618 /* shortcut setup */
3619 ssi = setup.shortcut;
3620 fprintf(file, "\n");
3621 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3622 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3625 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3629 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3630 fprintf(file, "\n");
3632 sii = setup.input[pnr];
3633 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3634 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
3639 fprintf(file, "\n");
3640 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3641 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
3644 soi = setup.options;
3645 fprintf(file, "\n");
3646 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3647 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
3651 SetFilePermissions(filename, PERMS_PRIVATE);
3654 void LoadCustomElementDescriptions()
3656 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3657 SetupFileHash *setup_file_hash;
3660 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3662 if (element_info[i].custom_description != NULL)
3664 free(element_info[i].custom_description);
3665 element_info[i].custom_description = NULL;
3669 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3672 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3674 char *token = getStringCat2(element_info[i].token_name, ".name");
3675 char *value = getHashEntry(setup_file_hash, token);
3678 element_info[i].custom_description = getStringCopy(value);
3683 freeSetupFileHash(setup_file_hash);
3686 void LoadSpecialMenuDesignSettings()
3688 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3689 SetupFileHash *setup_file_hash;
3692 /* always start with reliable default values from default config */
3693 for (i = 0; image_config_vars[i].token != NULL; i++)
3694 for (j = 0; image_config[j].token != NULL; j++)
3695 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
3696 *image_config_vars[i].value =
3697 get_auto_parameter_value(image_config_vars[i].token,
3698 image_config[j].value);
3700 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3703 /* special case: initialize with default values that may be overwritten */
3704 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
3706 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
3707 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
3708 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
3710 if (value_x != NULL)
3711 menu.draw_xoffset[i] = get_integer_from_string(value_x);
3712 if (value_y != NULL)
3713 menu.draw_yoffset[i] = get_integer_from_string(value_y);
3714 if (list_size != NULL)
3715 menu.list_size[i] = get_integer_from_string(list_size);
3718 /* read (and overwrite with) values that may be specified in config file */
3719 for (i = 0; image_config_vars[i].token != NULL; i++)
3721 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
3724 *image_config_vars[i].value =
3725 get_auto_parameter_value(image_config_vars[i].token, value);
3728 freeSetupFileHash(setup_file_hash);
3731 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
3733 char *filename = getEditorSetupFilename();
3734 SetupFileList *setup_file_list, *list;
3735 SetupFileHash *element_hash;
3736 int num_unknown_tokens = 0;
3739 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3742 element_hash = newSetupFileHash();
3744 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3745 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
3747 /* determined size may be larger than needed (due to unknown elements) */
3749 for (list = setup_file_list; list != NULL; list = list->next)
3752 /* add space for up to 3 more elements for padding that may be needed */
3755 *elements = checked_malloc(*num_elements * sizeof(int));
3758 for (list = setup_file_list; list != NULL; list = list->next)
3760 char *value = getHashEntry(element_hash, list->token);
3764 (*elements)[(*num_elements)++] = atoi(value);
3768 if (num_unknown_tokens == 0)
3770 Error(ERR_RETURN_LINE, "-");
3771 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
3772 Error(ERR_RETURN, "- config file: '%s'", filename);
3774 num_unknown_tokens++;
3777 Error(ERR_RETURN, "- token: '%s'", list->token);
3781 if (num_unknown_tokens > 0)
3782 Error(ERR_RETURN_LINE, "-");
3784 while (*num_elements % 4) /* pad with empty elements, if needed */
3785 (*elements)[(*num_elements)++] = EL_EMPTY;
3787 freeSetupFileList(setup_file_list);
3788 freeSetupFileHash(element_hash);
3792 for (i = 0; i < *num_elements; i++)
3793 printf("editor: element '%s' [%d]\n",
3794 element_info[(*elements)[i]].token_name, (*elements)[i]);
3798 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
3801 SetupFileHash *setup_file_hash = NULL;
3802 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
3803 char *filename_music, *filename_prefix, *filename_info;
3809 token_to_value_ptr[] =
3811 { "title_header", &tmp_music_file_info.title_header },
3812 { "artist_header", &tmp_music_file_info.artist_header },
3813 { "album_header", &tmp_music_file_info.album_header },
3814 { "year_header", &tmp_music_file_info.year_header },
3816 { "title", &tmp_music_file_info.title },
3817 { "artist", &tmp_music_file_info.artist },
3818 { "album", &tmp_music_file_info.album },
3819 { "year", &tmp_music_file_info.year },
3825 filename_music = (is_sound ? getCustomSoundFilename(basename) :
3826 getCustomMusicFilename(basename));
3828 if (filename_music == NULL)
3831 /* ---------- try to replace file extension ---------- */
3833 filename_prefix = getStringCopy(filename_music);
3834 if (strrchr(filename_prefix, '.') != NULL)
3835 *strrchr(filename_prefix, '.') = '\0';
3836 filename_info = getStringCat2(filename_prefix, ".txt");
3839 printf("trying to load file '%s'...\n", filename_info);
3842 if (fileExists(filename_info))
3843 setup_file_hash = loadSetupFileHash(filename_info);
3845 free(filename_prefix);
3846 free(filename_info);
3848 if (setup_file_hash == NULL)
3850 /* ---------- try to add file extension ---------- */
3852 filename_prefix = getStringCopy(filename_music);
3853 filename_info = getStringCat2(filename_prefix, ".txt");
3856 printf("trying to load file '%s'...\n", filename_info);
3859 if (fileExists(filename_info))
3860 setup_file_hash = loadSetupFileHash(filename_info);
3862 free(filename_prefix);
3863 free(filename_info);
3866 if (setup_file_hash == NULL)
3869 /* ---------- music file info found ---------- */
3871 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
3873 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
3875 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
3877 *token_to_value_ptr[i].value_ptr =
3878 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
3881 tmp_music_file_info.basename = getStringCopy(basename);
3882 tmp_music_file_info.music = music;
3883 tmp_music_file_info.is_sound = is_sound;
3885 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
3886 *new_music_file_info = tmp_music_file_info;
3888 return new_music_file_info;
3891 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
3893 return get_music_file_info_ext(basename, music, FALSE);
3896 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
3898 return get_music_file_info_ext(basename, sound, TRUE);
3901 static boolean music_info_listed_ext(struct MusicFileInfo *list,
3902 char *basename, boolean is_sound)
3904 for (; list != NULL; list = list->next)
3905 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
3911 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
3913 return music_info_listed_ext(list, basename, FALSE);
3916 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
3918 return music_info_listed_ext(list, basename, TRUE);
3921 void LoadMusicInfo()
3923 char *music_directory = getCustomMusicDirectory();
3924 int num_music = getMusicListSize();
3925 int num_music_noconf = 0;
3926 int num_sounds = getSoundListSize();
3928 struct dirent *dir_entry;
3929 struct FileInfo *music, *sound;
3930 struct MusicFileInfo *next, **new;
3933 while (music_file_info != NULL)
3935 next = music_file_info->next;
3937 checked_free(music_file_info->basename);
3939 checked_free(music_file_info->title_header);
3940 checked_free(music_file_info->artist_header);
3941 checked_free(music_file_info->album_header);
3942 checked_free(music_file_info->year_header);
3944 checked_free(music_file_info->title);
3945 checked_free(music_file_info->artist);
3946 checked_free(music_file_info->album);
3947 checked_free(music_file_info->year);
3949 free(music_file_info);
3951 music_file_info = next;
3954 new = &music_file_info;
3957 printf("::: num_music == %d\n", num_music);
3960 for (i = 0; i < num_music; i++)
3962 music = getMusicListEntry(i);
3965 printf("::: %d [%08x]\n", i, music->filename);
3968 if (music->filename == NULL)
3971 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
3974 /* a configured file may be not recognized as music */
3975 if (!FileIsMusic(music->filename))
3979 printf("::: -> '%s' (configured)\n", music->filename);
3982 if (!music_info_listed(music_file_info, music->filename))
3984 *new = get_music_file_info(music->filename, i);
3986 new = &(*new)->next;
3990 if ((dir = opendir(music_directory)) == NULL)
3992 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
3996 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
3998 char *basename = dir_entry->d_name;
3999 boolean music_already_used = FALSE;
4002 /* skip all music files that are configured in music config file */
4003 for (i = 0; i < num_music; i++)
4005 music = getMusicListEntry(i);
4007 if (music->filename == NULL)
4010 if (strcmp(basename, music->filename) == 0)
4012 music_already_used = TRUE;
4017 if (music_already_used)
4020 if (!FileIsMusic(basename))
4024 printf("::: -> '%s' (found in directory)\n", basename);
4027 if (!music_info_listed(music_file_info, basename))
4029 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4031 new = &(*new)->next;
4039 for (i = 0; i < num_sounds; i++)
4041 sound = getSoundListEntry(i);
4043 if (sound->filename == NULL)
4046 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4049 /* a configured file may be not recognized as sound */
4050 if (!FileIsSound(sound->filename))
4054 printf("::: -> '%s' (configured)\n", sound->filename);
4057 if (!sound_info_listed(music_file_info, sound->filename))
4059 *new = get_sound_file_info(sound->filename, i);
4061 new = &(*new)->next;
4067 for (next = music_file_info; next != NULL; next = next->next)
4068 printf("::: title == '%s'\n", next->title);
4072 void add_helpanim_entry(int element, int action, int direction, int delay,
4073 int *num_list_entries)
4075 struct HelpAnimInfo *new_list_entry;
4076 (*num_list_entries)++;
4079 checked_realloc(helpanim_info,
4080 *num_list_entries * sizeof(struct HelpAnimInfo));
4081 new_list_entry = &helpanim_info[*num_list_entries - 1];
4083 new_list_entry->element = element;
4084 new_list_entry->action = action;
4085 new_list_entry->direction = direction;
4086 new_list_entry->delay = delay;
4089 void print_unknown_token(char *filename, char *token, int token_nr)
4093 Error(ERR_RETURN_LINE, "-");
4094 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4095 Error(ERR_RETURN, "- config file: '%s'", filename);
4098 Error(ERR_RETURN, "- token: '%s'", token);
4101 void print_unknown_token_end(int token_nr)
4104 Error(ERR_RETURN_LINE, "-");
4107 void LoadHelpAnimInfo()
4109 char *filename = getHelpAnimFilename();
4110 SetupFileList *setup_file_list = NULL, *list;
4111 SetupFileHash *element_hash, *action_hash, *direction_hash;
4112 int num_list_entries = 0;
4113 int num_unknown_tokens = 0;
4116 if (fileExists(filename))
4117 setup_file_list = loadSetupFileList(filename);
4119 if (setup_file_list == NULL)
4121 /* use reliable default values from static configuration */
4122 SetupFileList *insert_ptr;
4124 insert_ptr = setup_file_list =
4125 newSetupFileList(helpanim_config[0].token,
4126 helpanim_config[0].value);
4128 for (i = 1; helpanim_config[i].token; i++)
4129 insert_ptr = addListEntry(insert_ptr,
4130 helpanim_config[i].token,
4131 helpanim_config[i].value);
4134 element_hash = newSetupFileHash();
4135 action_hash = newSetupFileHash();
4136 direction_hash = newSetupFileHash();
4138 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4139 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4141 for (i = 0; i < NUM_ACTIONS; i++)
4142 setHashEntry(action_hash, element_action_info[i].suffix,
4143 i_to_a(element_action_info[i].value));
4145 /* do not store direction index (bit) here, but direction value! */
4146 for (i = 0; i < NUM_DIRECTIONS; i++)
4147 setHashEntry(direction_hash, element_direction_info[i].suffix,
4148 i_to_a(1 << element_direction_info[i].value));
4150 for (list = setup_file_list; list != NULL; list = list->next)
4152 char *element_token, *action_token, *direction_token;
4153 char *element_value, *action_value, *direction_value;
4154 int delay = atoi(list->value);
4156 if (strcmp(list->token, "end") == 0)
4158 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4163 /* first try to break element into element/action/direction parts;
4164 if this does not work, also accept combined "element[.act][.dir]"
4165 elements (like "dynamite.active"), which are unique elements */
4167 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4169 element_value = getHashEntry(element_hash, list->token);
4170 if (element_value != NULL) /* element found */
4171 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4175 /* no further suffixes found -- this is not an element */
4176 print_unknown_token(filename, list->token, num_unknown_tokens++);
4182 /* token has format "<prefix>.<something>" */
4184 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4185 direction_token = action_token; /* ... or direction */
4187 element_token = getStringCopy(list->token);
4188 *strchr(element_token, '.') = '\0';
4190 element_value = getHashEntry(element_hash, element_token);
4192 if (element_value == NULL) /* this is no element */
4194 element_value = getHashEntry(element_hash, list->token);
4195 if (element_value != NULL) /* combined element found */
4196 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4199 print_unknown_token(filename, list->token, num_unknown_tokens++);
4201 free(element_token);
4206 action_value = getHashEntry(action_hash, action_token);
4208 if (action_value != NULL) /* action found */
4210 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4213 free(element_token);
4218 direction_value = getHashEntry(direction_hash, direction_token);
4220 if (direction_value != NULL) /* direction found */
4222 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4225 free(element_token);
4230 if (strchr(action_token + 1, '.') == NULL)
4232 /* no further suffixes found -- this is not an action nor direction */
4234 element_value = getHashEntry(element_hash, list->token);
4235 if (element_value != NULL) /* combined element found */
4236 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4239 print_unknown_token(filename, list->token, num_unknown_tokens++);
4241 free(element_token);
4246 /* token has format "<prefix>.<suffix>.<something>" */
4248 direction_token = strchr(action_token + 1, '.');
4250 action_token = getStringCopy(action_token);
4251 *strchr(action_token + 1, '.') = '\0';
4253 action_value = getHashEntry(action_hash, action_token);
4255 if (action_value == NULL) /* this is no action */
4257 element_value = getHashEntry(element_hash, list->token);
4258 if (element_value != NULL) /* combined element found */
4259 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4262 print_unknown_token(filename, list->token, num_unknown_tokens++);
4264 free(element_token);
4270 direction_value = getHashEntry(direction_hash, direction_token);
4272 if (direction_value != NULL) /* direction found */
4274 add_helpanim_entry(atoi(element_value), atoi(action_value),
4275 atoi(direction_value), delay, &num_list_entries);
4277 free(element_token);
4283 /* this is no direction */
4285 element_value = getHashEntry(element_hash, list->token);
4286 if (element_value != NULL) /* combined element found */
4287 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4290 print_unknown_token(filename, list->token, num_unknown_tokens++);
4292 free(element_token);
4296 print_unknown_token_end(num_unknown_tokens);
4298 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4299 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4301 freeSetupFileList(setup_file_list);
4302 freeSetupFileHash(element_hash);
4303 freeSetupFileHash(action_hash);
4304 freeSetupFileHash(direction_hash);
4308 for (i = 0; i < num_list_entries; i++)
4309 printf("::: %d, %d, %d => %d\n",
4310 helpanim_info[i].element,
4311 helpanim_info[i].action,
4312 helpanim_info[i].direction,
4313 helpanim_info[i].delay);
4317 void LoadHelpTextInfo()
4319 char *filename = getHelpTextFilename();
4322 if (helptext_info != NULL)
4324 freeSetupFileHash(helptext_info);
4325 helptext_info = NULL;
4328 if (fileExists(filename))
4329 helptext_info = loadSetupFileHash(filename);
4331 if (helptext_info == NULL)
4333 /* use reliable default values from static configuration */
4334 helptext_info = newSetupFileHash();
4336 for (i = 0; helptext_config[i].token; i++)
4337 setHashEntry(helptext_info,
4338 helptext_config[i].token,
4339 helptext_config[i].value);
4344 BEGIN_HASH_ITERATION(helptext_info, itr)
4346 printf("::: '%s' => '%s'\n",
4347 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4349 END_HASH_ITERATION(hash, itr)