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;
264 BorderElement = EL_STEELWALL;
266 level->no_level_file = FALSE;
268 if (leveldir_current == NULL) /* only when dumping level */
271 /* try to determine better author name than 'anonymous' */
272 if (strcmp(leveldir_current->author, ANONYMOUS_NAME) != 0)
274 strncpy(level->author, leveldir_current->author, MAX_LEVEL_AUTHOR_LEN);
275 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
279 switch (LEVELCLASS(leveldir_current))
281 case LEVELCLASS_TUTORIAL:
282 strcpy(level->author, PROGRAM_AUTHOR_STRING);
285 case LEVELCLASS_CONTRIB:
286 strncpy(level->author, leveldir_current->name, MAX_LEVEL_AUTHOR_LEN);
287 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
290 case LEVELCLASS_PRIVATE:
291 strncpy(level->author, getRealName(), MAX_LEVEL_AUTHOR_LEN);
292 level->author[MAX_LEVEL_AUTHOR_LEN] = '\0';
296 /* keep default value */
302 static void setFileInfoToDefaults(struct LevelFileInfo *level_file_info)
304 level_file_info->nr = 0;
305 level_file_info->type = LEVEL_FILE_TYPE_UNKNOWN;
306 level_file_info->packed = FALSE;
307 level_file_info->filename = NULL;
310 static void ActivateLevelTemplate()
312 /* Currently there is no special action needed to activate the template
313 data, because 'element_info' and 'Properties' overwrite the original
314 level data, while all other variables do not change. */
317 static char *getLevelFilenameFromBasename(char *basename)
319 static char *filename = NULL;
321 checked_free(filename);
323 filename = getPath2(getCurrentLevelDir(), basename);
328 static char *getSingleLevelBasename(int nr, int type)
330 static char basename[MAX_FILENAME_LEN];
332 if (leveldir_current->filename == NULL)
333 leveldir_current->filename = getStringCat2("%%03d.%s",LEVELFILE_EXTENSION);
337 case LEVEL_FILE_TYPE_RND:
339 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
341 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
344 case LEVEL_FILE_TYPE_EM:
345 sprintf(basename, "%d", nr);
348 case LEVEL_FILE_TYPE_UNKNOWN:
350 sprintf(basename, leveldir_current->filename, nr);
357 static char *getPackedLevelBasename(int type)
359 static char basename[MAX_FILENAME_LEN];
364 strcpy(basename, UNDEFINED_FILENAME);
371 static char *getSingleLevelFilename(int nr, int type)
373 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
376 static char *getPackedLevelFilename(int type)
378 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
381 char *getDefaultLevelFilename(int nr)
383 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
386 static void setLevelFileInfo_Filename(struct LevelFileInfo *lfi)
388 /* special case: level number is negative => check for level template file */
391 lfi->type = LEVEL_FILE_TYPE_RND;
392 lfi->filename = getDefaultLevelFilename(nr);
397 if (leveldir_current->filename != NULL)
399 /* 1st try: check for file name/pattern specified in "levelinfo.conf" */
400 lfi->type = LEVEL_FILE_TYPE_UNKNOWN;
401 lfi->filename = getSingleLevelFilename(lfi->nr, lfi->type);
403 if (fileExists(lfi->filename))
407 /* 2nd try: check for native Rocks'n'Diamonds level file */
408 lfi->type = LEVEL_FILE_TYPE_RND;
409 lfi->filename = getSingleLevelFilename(lfi->nr, lfi->type);
411 if (fileExists(lfi->filename))
414 /* 3rd try: check for classic Emerald Mine level file */
415 lfi->type = LEVEL_FILE_TYPE_EM;
416 lfi->filename = getSingleLevelFilename(lfi->nr, lfi->type);
418 if (fileExists(lfi->filename))
421 /* no known level file found -- try to use default values */
422 lfi->type = LEVEL_FILE_TYPE_UNKNOWN;
423 lfi->filename = getSingleLevelFilename(lfi->nr, lfi->type);
426 static void setLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
428 struct stat file_status;
430 if (level_file_info.type != LEVEL_FILE_TYPE_UNKNOWN)
433 /* ---------- try to determine file type from filename ---------- */
435 if (strlen(lfi->filename) == 10 &&
436 (strncmp(lfi->filename, "levels.d", 8) == 0 ||
437 strncmp(lfi->filename, "LEVELS.D", 8) == 0) &&
438 lfi->filename[8] >= '0' && lfi->filename[8] <= '9' &&
439 lfi->filename[9] >= '0' && lfi->filename[9] <= '9')
441 /* this looks like a typical filename of a Supaplex level package file */
442 lfi->type = LEVEL_FILE_TYPE_SP;
447 /* ---------- try to determine file type from file status ---------- */
449 if (stat(lfi->filename, &file_status) == 0)
451 if (file_status.off_t == 170496)
453 /* this looks like a typical filesize of a Supaplex level package file */
454 lfi->type = LEVEL_FILE_TYPE_SP;
461 static struct LevelFileInfo *getLevelFileInfo(int nr)
463 static struct LevelFileInfo level_file_info;
465 /* always start with reliable default values */
466 setFileInfoToDefaults(&level_file_info);
468 level_file_info.nr = nr; /* set requested level number */
470 setLevelFileInfo_Filename(&level_file_info);
471 setLevelFileInfo_Filetype(&level_file_info);
473 return &level_file_info;
477 /* ------------------------------------------------------------------------- */
478 /* functions for loading R'n'D level */
479 /* ------------------------------------------------------------------------- */
481 int getMappedElement(int element)
483 /* map some (historic, now obsolete) elements */
488 case EL_PLAYER_OBSOLETE:
489 element = EL_PLAYER_1;
492 case EL_KEY_OBSOLETE:
495 case EL_EM_KEY_1_FILE_OBSOLETE:
496 element = EL_EM_KEY_1;
499 case EL_EM_KEY_2_FILE_OBSOLETE:
500 element = EL_EM_KEY_2;
503 case EL_EM_KEY_3_FILE_OBSOLETE:
504 element = EL_EM_KEY_3;
507 case EL_EM_KEY_4_FILE_OBSOLETE:
508 element = EL_EM_KEY_4;
511 case EL_ENVELOPE_OBSOLETE:
512 element = EL_ENVELOPE_1;
520 if (element >= NUM_FILE_ELEMENTS)
522 Error(ERR_WARN, "invalid level element %d", element);
524 element = EL_CHAR_QUESTION;
529 if (element >= NUM_FILE_ELEMENTS)
531 Error(ERR_WARN, "invalid level element %d", element);
533 element = EL_CHAR_QUESTION;
535 else if (element == EL_PLAYER_OBSOLETE)
536 element = EL_PLAYER_1;
537 else if (element == EL_KEY_OBSOLETE)
544 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
546 level->file_version = getFileVersion(file);
547 level->game_version = getFileVersion(file);
552 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
556 level->fieldx = getFile8Bit(file);
557 level->fieldy = getFile8Bit(file);
559 level->time = getFile16BitBE(file);
560 level->gems_needed = getFile16BitBE(file);
562 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
563 level->name[i] = getFile8Bit(file);
564 level->name[MAX_LEVEL_NAME_LEN] = 0;
566 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
567 level->score[i] = getFile8Bit(file);
569 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
570 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
571 for (y = 0; y < 3; y++)
572 for (x = 0; x < 3; x++)
573 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
575 level->amoeba_speed = getFile8Bit(file);
576 level->time_magic_wall = getFile8Bit(file);
577 level->time_wheel = getFile8Bit(file);
578 level->amoeba_content = getMappedElement(getFile8Bit(file));
579 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
580 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
581 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
582 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
584 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
586 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
591 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
595 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
596 level->author[i] = getFile8Bit(file);
597 level->author[MAX_LEVEL_NAME_LEN] = 0;
602 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
605 int chunk_size_expected = level->fieldx * level->fieldy;
607 /* Note: "chunk_size" was wrong before version 2.0 when elements are
608 stored with 16-bit encoding (and should be twice as big then).
609 Even worse, playfield data was stored 16-bit when only yamyam content
610 contained 16-bit elements and vice versa. */
612 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
613 chunk_size_expected *= 2;
615 if (chunk_size_expected != chunk_size)
617 ReadUnusedBytesFromFile(file, chunk_size);
618 return chunk_size_expected;
621 for (y = 0; y < level->fieldy; y++)
622 for (x = 0; x < level->fieldx; x++)
624 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
629 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
633 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
634 int chunk_size_expected = header_size + content_size;
636 /* Note: "chunk_size" was wrong before version 2.0 when elements are
637 stored with 16-bit encoding (and should be twice as big then).
638 Even worse, playfield data was stored 16-bit when only yamyam content
639 contained 16-bit elements and vice versa. */
641 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
642 chunk_size_expected += content_size;
644 if (chunk_size_expected != chunk_size)
646 ReadUnusedBytesFromFile(file, chunk_size);
647 return chunk_size_expected;
651 level->num_yamyam_contents = getFile8Bit(file);
655 /* correct invalid number of content fields -- should never happen */
656 if (level->num_yamyam_contents < 1 ||
657 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
658 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
660 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
661 for (y = 0; y < 3; y++)
662 for (x = 0; x < 3; x++)
663 level->yamyam_content[i][x][y] =
664 getMappedElement(level->encoding_16bit_field ?
665 getFile16BitBE(file) : getFile8Bit(file));
669 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
673 int num_contents, content_xsize, content_ysize;
674 int content_array[MAX_ELEMENT_CONTENTS][3][3];
676 element = getMappedElement(getFile16BitBE(file));
677 num_contents = getFile8Bit(file);
678 content_xsize = getFile8Bit(file);
679 content_ysize = getFile8Bit(file);
681 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
683 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
684 for (y = 0; y < 3; y++)
685 for (x = 0; x < 3; x++)
686 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
688 /* correct invalid number of content fields -- should never happen */
689 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
690 num_contents = STD_ELEMENT_CONTENTS;
692 if (element == EL_YAMYAM)
694 level->num_yamyam_contents = num_contents;
696 for (i = 0; i < num_contents; i++)
697 for (y = 0; y < 3; y++)
698 for (x = 0; x < 3; x++)
699 level->yamyam_content[i][x][y] = content_array[i][x][y];
701 else if (element == EL_BD_AMOEBA)
703 level->amoeba_content = content_array[0][0][0];
707 Error(ERR_WARN, "cannot load content for element '%d'", element);
713 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
719 int chunk_size_expected;
721 element = getMappedElement(getFile16BitBE(file));
722 if (!IS_ENVELOPE(element))
723 element = EL_ENVELOPE_1;
725 envelope_nr = element - EL_ENVELOPE_1;
727 envelope_len = getFile16BitBE(file);
729 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
730 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
732 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
734 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
735 if (chunk_size_expected != chunk_size)
737 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
738 return chunk_size_expected;
741 for (i = 0; i < envelope_len; i++)
742 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
747 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
749 int num_changed_custom_elements = getFile16BitBE(file);
750 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
753 if (chunk_size_expected != chunk_size)
755 ReadUnusedBytesFromFile(file, chunk_size - 2);
756 return chunk_size_expected;
759 for (i = 0; i < num_changed_custom_elements; i++)
761 int element = getFile16BitBE(file);
762 int properties = getFile32BitBE(file);
764 if (IS_CUSTOM_ELEMENT(element))
765 Properties[element][EP_BITFIELD_BASE] = properties;
767 Error(ERR_WARN, "invalid custom element number %d", element);
773 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
775 int num_changed_custom_elements = getFile16BitBE(file);
776 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
779 if (chunk_size_expected != chunk_size)
781 ReadUnusedBytesFromFile(file, chunk_size - 2);
782 return chunk_size_expected;
785 for (i = 0; i < num_changed_custom_elements; i++)
787 int element = getFile16BitBE(file);
788 int custom_target_element = getFile16BitBE(file);
790 if (IS_CUSTOM_ELEMENT(element))
791 element_info[element].change->target_element = custom_target_element;
793 Error(ERR_WARN, "invalid custom element number %d", element);
799 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
801 int num_changed_custom_elements = getFile16BitBE(file);
802 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
805 if (chunk_size_expected != chunk_size)
807 ReadUnusedBytesFromFile(file, chunk_size - 2);
808 return chunk_size_expected;
811 for (i = 0; i < num_changed_custom_elements; i++)
813 int element = getFile16BitBE(file);
815 if (!IS_CUSTOM_ELEMENT(element))
817 Error(ERR_WARN, "invalid custom element number %d", element);
819 element = EL_INTERNAL_DUMMY;
822 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
823 element_info[element].description[j] = getFile8Bit(file);
824 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
826 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
828 /* some free bytes for future properties and padding */
829 ReadUnusedBytesFromFile(file, 7);
831 element_info[element].use_gfx_element = getFile8Bit(file);
832 element_info[element].gfx_element =
833 getMappedElement(getFile16BitBE(file));
835 element_info[element].collect_score = getFile8Bit(file);
836 element_info[element].collect_count = getFile8Bit(file);
838 element_info[element].push_delay_fixed = getFile16BitBE(file);
839 element_info[element].push_delay_random = getFile16BitBE(file);
840 element_info[element].move_delay_fixed = getFile16BitBE(file);
841 element_info[element].move_delay_random = getFile16BitBE(file);
843 element_info[element].move_pattern = getFile16BitBE(file);
844 element_info[element].move_direction_initial = getFile8Bit(file);
845 element_info[element].move_stepsize = getFile8Bit(file);
847 for (y = 0; y < 3; y++)
848 for (x = 0; x < 3; x++)
849 element_info[element].content[x][y] =
850 getMappedElement(getFile16BitBE(file));
852 element_info[element].change->events = getFile32BitBE(file);
854 element_info[element].change->target_element =
855 getMappedElement(getFile16BitBE(file));
857 element_info[element].change->delay_fixed = getFile16BitBE(file);
858 element_info[element].change->delay_random = getFile16BitBE(file);
859 element_info[element].change->delay_frames = getFile16BitBE(file);
861 element_info[element].change->trigger_element =
862 getMappedElement(getFile16BitBE(file));
864 element_info[element].change->explode = getFile8Bit(file);
865 element_info[element].change->use_content = getFile8Bit(file);
866 element_info[element].change->only_complete = getFile8Bit(file);
867 element_info[element].change->use_random_change = getFile8Bit(file);
869 element_info[element].change->random = getFile8Bit(file);
870 element_info[element].change->power = getFile8Bit(file);
872 for (y = 0; y < 3; y++)
873 for (x = 0; x < 3; x++)
874 element_info[element].change->content[x][y] =
875 getMappedElement(getFile16BitBE(file));
877 element_info[element].slippery_type = getFile8Bit(file);
879 /* some free bytes for future properties and padding */
880 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
882 /* mark that this custom element has been modified */
883 element_info[element].modified_settings = TRUE;
889 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
891 struct ElementInfo *ei;
892 int chunk_size_expected;
896 element = getFile16BitBE(file);
898 if (!IS_CUSTOM_ELEMENT(element))
900 Error(ERR_WARN, "invalid custom element number %d", element);
902 ReadUnusedBytesFromFile(file, chunk_size - 2);
906 ei = &element_info[element];
908 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
909 ei->description[i] = getFile8Bit(file);
910 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
912 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
913 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
915 ei->num_change_pages = getFile8Bit(file);
917 /* some free bytes for future base property values and padding */
918 ReadUnusedBytesFromFile(file, 5);
920 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
921 if (chunk_size_expected != chunk_size)
923 ReadUnusedBytesFromFile(file, chunk_size - 48);
924 return chunk_size_expected;
927 /* read custom property values */
929 ei->use_gfx_element = getFile8Bit(file);
930 ei->gfx_element = getMappedElement(getFile16BitBE(file));
932 ei->collect_score = getFile8Bit(file);
933 ei->collect_count = getFile8Bit(file);
935 ei->push_delay_fixed = getFile16BitBE(file);
936 ei->push_delay_random = getFile16BitBE(file);
937 ei->move_delay_fixed = getFile16BitBE(file);
938 ei->move_delay_random = getFile16BitBE(file);
940 ei->move_pattern = getFile16BitBE(file);
941 ei->move_direction_initial = getFile8Bit(file);
942 ei->move_stepsize = getFile8Bit(file);
944 ei->slippery_type = getFile8Bit(file);
946 for (y = 0; y < 3; y++)
947 for (x = 0; x < 3; x++)
948 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
950 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
951 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
952 ei->move_leave_type = getFile8Bit(file);
954 /* some free bytes for future custom property values and padding */
955 ReadUnusedBytesFromFile(file, 7);
957 /* read change property values */
959 setElementChangePages(ei, ei->num_change_pages);
961 for (i = 0; i < ei->num_change_pages; i++)
963 struct ElementChangeInfo *change = &ei->change_page[i];
965 /* always start with reliable default values */
966 setElementChangeInfoToDefaults(change);
968 change->events = getFile32BitBE(file);
970 change->target_element = getMappedElement(getFile16BitBE(file));
972 change->delay_fixed = getFile16BitBE(file);
973 change->delay_random = getFile16BitBE(file);
974 change->delay_frames = getFile16BitBE(file);
976 change->trigger_element = getMappedElement(getFile16BitBE(file));
978 change->explode = getFile8Bit(file);
979 change->use_content = getFile8Bit(file);
980 change->only_complete = getFile8Bit(file);
981 change->use_random_change = getFile8Bit(file);
983 change->random = getFile8Bit(file);
984 change->power = getFile8Bit(file);
986 for (y = 0; y < 3; y++)
987 for (x = 0; x < 3; x++)
988 change->content[x][y] = getMappedElement(getFile16BitBE(file));
990 change->can_change = getFile8Bit(file);
992 change->sides = getFile8Bit(file);
994 if (change->sides == CH_SIDE_NONE) /* correct empty sides field */
995 change->sides = CH_SIDE_ANY;
997 /* some free bytes for future change property values and padding */
998 ReadUnusedBytesFromFile(file, 8);
1001 /* mark this custom element as modified */
1002 ei->modified_settings = TRUE;
1007 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1009 struct ElementInfo *ei;
1010 struct ElementGroupInfo *group;
1014 element = getFile16BitBE(file);
1016 if (!IS_GROUP_ELEMENT(element))
1018 Error(ERR_WARN, "invalid group element number %d", element);
1020 ReadUnusedBytesFromFile(file, chunk_size - 2);
1024 ei = &element_info[element];
1026 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1027 ei->description[i] = getFile8Bit(file);
1028 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1030 group = element_info[element].group;
1032 group->num_elements = getFile8Bit(file);
1034 ei->use_gfx_element = getFile8Bit(file);
1035 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1037 /* some free bytes for future values and padding */
1038 ReadUnusedBytesFromFile(file, 4);
1040 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1041 group->element[i] = getMappedElement(getFile16BitBE(file));
1043 /* mark this group element as modified */
1044 element_info[element].modified_settings = TRUE;
1049 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1050 struct LevelFileInfo *level_file_info)
1052 char *filename = level_file_info->filename;
1053 char cookie[MAX_LINE_LEN];
1054 char chunk_name[CHUNK_ID_LEN + 1];
1058 if (!(file = fopen(filename, MODE_READ)))
1060 level->no_level_file = TRUE;
1062 if (level != &level_template)
1063 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1068 getFileChunkBE(file, chunk_name, NULL);
1069 if (strcmp(chunk_name, "RND1") == 0)
1071 getFile32BitBE(file); /* not used */
1073 getFileChunkBE(file, chunk_name, NULL);
1074 if (strcmp(chunk_name, "CAVE") != 0)
1076 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1081 else /* check for pre-2.0 file format with cookie string */
1083 strcpy(cookie, chunk_name);
1084 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1085 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1086 cookie[strlen(cookie) - 1] = '\0';
1088 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1090 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1095 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1097 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1102 /* pre-2.0 level files have no game version, so use file version here */
1103 level->game_version = level->file_version;
1106 if (level->file_version < FILE_VERSION_1_2)
1108 /* level files from versions before 1.2.0 without chunk structure */
1109 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1110 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1118 int (*loader)(FILE *, int, struct LevelInfo *);
1122 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1123 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1124 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1125 { "BODY", -1, LoadLevel_BODY },
1126 { "CONT", -1, LoadLevel_CONT },
1127 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1128 { "CNT3", -1, LoadLevel_CNT3 },
1129 { "CUS1", -1, LoadLevel_CUS1 },
1130 { "CUS2", -1, LoadLevel_CUS2 },
1131 { "CUS3", -1, LoadLevel_CUS3 },
1132 { "CUS4", -1, LoadLevel_CUS4 },
1133 { "GRP1", -1, LoadLevel_GRP1 },
1137 while (getFileChunkBE(file, chunk_name, &chunk_size))
1141 while (chunk_info[i].name != NULL &&
1142 strcmp(chunk_name, chunk_info[i].name) != 0)
1145 if (chunk_info[i].name == NULL)
1147 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1148 chunk_name, filename);
1149 ReadUnusedBytesFromFile(file, chunk_size);
1151 else if (chunk_info[i].size != -1 &&
1152 chunk_info[i].size != chunk_size)
1154 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1155 chunk_size, chunk_name, filename);
1156 ReadUnusedBytesFromFile(file, chunk_size);
1160 /* call function to load this level chunk */
1161 int chunk_size_expected =
1162 (chunk_info[i].loader)(file, chunk_size, level);
1164 /* the size of some chunks cannot be checked before reading other
1165 chunks first (like "HEAD" and "BODY") that contain some header
1166 information, so check them here */
1167 if (chunk_size_expected != chunk_size)
1169 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1170 chunk_size, chunk_name, filename);
1179 /* ------------------------------------------------------------------------- */
1180 /* functions for loading EM level */
1181 /* ------------------------------------------------------------------------- */
1183 static int map_em_element_yam(int element)
1187 case 0x00: return EL_EMPTY;
1188 case 0x01: return EL_EMERALD;
1189 case 0x02: return EL_DIAMOND;
1190 case 0x03: return EL_ROCK;
1191 case 0x04: return EL_ROBOT;
1192 case 0x05: return EL_SPACESHIP_UP;
1193 case 0x06: return EL_BOMB;
1194 case 0x07: return EL_BUG_UP;
1195 case 0x08: return EL_AMOEBA_DROP;
1196 case 0x09: return EL_NUT;
1197 case 0x0a: return EL_YAMYAM;
1198 case 0x0b: return EL_QUICKSAND_FULL;
1199 case 0x0c: return EL_SAND;
1200 case 0x0d: return EL_WALL_SLIPPERY;
1201 case 0x0e: return EL_STEELWALL;
1202 case 0x0f: return EL_WALL;
1203 case 0x10: return EL_EM_KEY_1;
1204 case 0x11: return EL_EM_KEY_2;
1205 case 0x12: return EL_EM_KEY_4;
1206 case 0x13: return EL_EM_KEY_3;
1207 case 0x14: return EL_MAGIC_WALL;
1208 case 0x15: return EL_ROBOT_WHEEL;
1209 case 0x16: return EL_DYNAMITE;
1211 case 0x17: return EL_EM_KEY_1; /* EMC */
1212 case 0x18: return EL_BUG_UP; /* EMC */
1213 case 0x1a: return EL_DIAMOND; /* EMC */
1214 case 0x1b: return EL_EMERALD; /* EMC */
1215 case 0x25: return EL_NUT; /* EMC */
1216 case 0x80: return EL_EMPTY; /* EMC */
1217 case 0x85: return EL_EM_KEY_1; /* EMC */
1218 case 0x86: return EL_EM_KEY_2; /* EMC */
1219 case 0x87: return EL_EM_KEY_4; /* EMC */
1220 case 0x88: return EL_EM_KEY_3; /* EMC */
1221 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1222 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1223 case 0xaf: return EL_DYNAMITE; /* EMC */
1224 case 0xbd: return EL_SAND; /* EMC */
1227 Error(ERR_WARN, "invalid level element %d", element);
1228 return EL_CHAR_QUESTION;
1232 static int map_em_element_field(int element)
1234 if (element >= 0xc8 && element <= 0xe1)
1235 return EL_CHAR_A + (element - 0xc8);
1236 else if (element >= 0xe2 && element <= 0xeb)
1237 return EL_CHAR_0 + (element - 0xe2);
1241 case 0x00: return EL_ROCK;
1242 case 0x02: return EL_DIAMOND;
1243 case 0x03: return EL_DIAMOND;
1244 case 0x04: return EL_ROBOT;
1245 case 0x05: return EL_ROBOT; /* EMC */
1246 case 0x08: return EL_SPACESHIP_UP;
1247 case 0x09: return EL_SPACESHIP_RIGHT;
1248 case 0x0a: return EL_SPACESHIP_DOWN;
1249 case 0x0b: return EL_SPACESHIP_LEFT;
1250 case 0x0c: return EL_SPACESHIP_UP;
1251 case 0x0d: return EL_SPACESHIP_RIGHT;
1252 case 0x0e: return EL_SPACESHIP_DOWN;
1253 case 0x0f: return EL_SPACESHIP_LEFT;
1254 case 0x10: return EL_BOMB;
1255 case 0x12: return EL_EMERALD;
1256 case 0x13: return EL_EMERALD;
1257 case 0x14: return EL_BUG_UP;
1258 case 0x15: return EL_BUG_RIGHT;
1259 case 0x16: return EL_BUG_DOWN;
1260 case 0x17: return EL_BUG_LEFT;
1261 case 0x18: return EL_BUG_UP;
1262 case 0x19: return EL_BUG_RIGHT;
1263 case 0x1a: return EL_BUG_DOWN;
1264 case 0x1b: return EL_BUG_LEFT;
1265 case 0x1c: return EL_AMOEBA_DROP;
1266 case 0x20: return EL_ROCK;
1267 case 0x24: return EL_MAGIC_WALL;
1268 case 0x25: return EL_NUT;
1270 /* looks like magic wheel, but is _always_ activated */
1271 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1273 case 0x29: return EL_YAMYAM;
1274 case 0x2a: return EL_YAMYAM;
1275 case 0x2b: return EL_YAMYAM; /* EMC */
1276 case 0x2c: return EL_YAMYAM; /* EMC */
1277 case 0x2d: return EL_QUICKSAND_FULL;
1278 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1279 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1280 case 0x3b: return EL_DYNAMITE_ACTIVE;
1281 case 0x3c: return EL_DYNAMITE_ACTIVE;
1282 case 0x3d: return EL_DYNAMITE_ACTIVE;
1283 case 0x3e: return EL_DYNAMITE_ACTIVE;
1284 case 0x3f: return EL_ACID_POOL_BOTTOM;
1285 case 0x40: return EL_EXIT_OPEN;
1286 case 0x41: return EL_EXIT_OPEN;
1287 case 0x42: return EL_EXIT_OPEN;
1288 case 0x43: return EL_BALLOON;
1289 case 0x4e: return EL_INVISIBLE_WALL;
1290 case 0x65: return EL_ACID; /* EMC */
1291 case 0x73: return EL_SAND; /* EMC */
1292 case 0x74: return EL_STEELWALL;
1293 case 0x7b: return EL_ACID;
1294 case 0x80: return EL_EMPTY;
1295 case 0x81: return EL_WALL_SLIPPERY;
1296 case 0x82: return EL_SAND;
1297 case 0x83: return EL_STEELWALL;
1298 case 0x84: return EL_WALL;
1299 case 0x85: return EL_EM_KEY_1;
1300 case 0x86: return EL_EM_KEY_2;
1301 case 0x87: return EL_EM_KEY_4;
1302 case 0x88: return EL_EM_KEY_3;
1303 case 0x89: return EL_EM_GATE_1;
1304 case 0x8a: return EL_EM_GATE_2;
1305 case 0x8b: return EL_EM_GATE_4;
1306 case 0x8c: return EL_EM_GATE_3;
1307 case 0x8d: return EL_INVISIBLE_WALL; /* EMC */
1308 case 0x8e: return EL_EM_GATE_1_GRAY;
1309 case 0x8f: return EL_EM_GATE_2_GRAY;
1310 case 0x90: return EL_EM_GATE_4_GRAY;
1311 case 0x91: return EL_EM_GATE_3_GRAY;
1312 case 0x92: return EL_MAGIC_WALL;
1313 case 0x94: return EL_QUICKSAND_EMPTY;
1314 case 0x95: return EL_ACID_POOL_TOPLEFT;
1315 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1316 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1317 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1318 case 0x99: return EL_ACID;
1319 case 0x9a: return EL_AMOEBA_DEAD;
1320 case 0x9b: return EL_AMOEBA_DEAD;
1321 case 0x9c: return EL_AMOEBA_DEAD;
1322 case 0x9d: return EL_AMOEBA_DEAD;
1323 case 0x9e: return EL_EXIT_CLOSED;
1324 case 0x9f: return EL_CHAR_LESS; /* EMC */
1325 case 0x93: return EL_ROBOT_WHEEL;
1327 /* looks like normal dust, but behaves like wall */
1328 case 0xa0: return EL_WALL; /* EMC */
1330 case 0xa8: return EL_EMC_WALL_1; /* EMC */
1331 case 0xa9: return EL_EMC_WALL_2; /* EMC */
1332 case 0xaa: return EL_EMC_WALL_3; /* EMC */
1333 case 0xab: return EL_EMC_WALL_7; /* EMC */
1334 case 0xae: return EL_CHAR_MINUS; /* EMC */
1335 case 0xaf: return EL_DYNAMITE;
1336 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC */
1337 case 0xb1: return EL_EMC_WALL_8; /* EMC */
1339 /* (exact steel wall) */
1340 case 0xb3: return EL_STEELWALL; /* EMC */
1342 case 0xb4: return EL_WALL_SLIPPERY; /* EMC */
1343 case 0xb5: return EL_EMC_WALL_6; /* EMC */
1344 case 0xb6: return EL_EMC_WALL_5; /* EMC */
1345 case 0xb7: return EL_EMC_WALL_4; /* EMC */
1346 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1347 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1348 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1349 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1350 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1351 case 0xbd: return EL_SAND; /* EMC */
1352 case 0xec: return EL_CHAR_PERIOD;
1353 case 0xed: return EL_CHAR_EXCLAM;
1354 case 0xee: return EL_CHAR_COLON;
1355 case 0xef: return EL_CHAR_QUESTION;
1356 case 0xf0: return EL_CHAR_GREATER;
1357 case 0xf1: return EL_CHAR_COPYRIGHT;
1358 case 0xfe: return EL_PLAYER_1;
1359 case 0xff: return EL_PLAYER_2;
1362 Error(ERR_WARN, "invalid level element %d", element);
1363 return EL_CHAR_QUESTION;
1367 #define EM_LEVEL_SIZE 2106
1368 #define EM_LEVEL_XSIZE 64
1369 #define EM_LEVEL_YSIZE 32
1371 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1372 struct LevelFileInfo *level_file_info)
1374 char *filename = level_file_info->filename;
1376 unsigned char leveldata[EM_LEVEL_SIZE];
1377 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1378 unsigned char code0 = 0x65;
1379 unsigned char code1 = 0x11;
1380 boolean level_is_crypted = FALSE;
1381 int nr = level_file_info->nr;
1384 if (!(file = fopen(filename, MODE_READ)))
1386 level->no_level_file = TRUE;
1388 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1393 for(i = 0; i < EM_LEVEL_SIZE; i++)
1394 leveldata[i] = fgetc(file);
1398 /* check if level data is crypted by testing against known starting bytes
1399 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1401 if ((leveldata[0] == 0xf1 ||
1402 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1404 level_is_crypted = TRUE;
1406 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1407 leveldata[0] = 0xf1;
1410 if (level_is_crypted) /* decode crypted level data */
1412 for(i = 0; i < EM_LEVEL_SIZE; i++)
1414 leveldata[i] ^= code0;
1415 leveldata[i] -= code1;
1417 code0 = (code0 + 7) & 0xff;
1421 level->fieldx = EM_LEVEL_XSIZE;
1422 level->fieldy = EM_LEVEL_YSIZE;
1424 level->time = header[46] * 10;
1425 level->gems_needed = header[47];
1427 /* The original Emerald Mine levels have their level number stored
1428 at the second byte of the level file...
1429 Do not trust this information at other level files, e.g. EMC,
1430 but correct it anyway (normally the first row is completely
1431 steel wall, so the correction does not hurt anyway). */
1433 if (leveldata[1] == nr)
1434 leveldata[1] = leveldata[2]; /* correct level number field */
1436 sprintf(level->name, "Level %d", nr); /* set level name */
1438 level->score[SC_EMERALD] = header[36];
1439 level->score[SC_DIAMOND] = header[37];
1440 level->score[SC_ROBOT] = header[38];
1441 level->score[SC_SPACESHIP] = header[39];
1442 level->score[SC_BUG] = header[40];
1443 level->score[SC_YAMYAM] = header[41];
1444 level->score[SC_NUT] = header[42];
1445 level->score[SC_DYNAMITE] = header[43];
1446 level->score[SC_TIME_BONUS] = header[44];
1448 level->num_yamyam_contents = 4;
1450 for(i = 0; i < level->num_yamyam_contents; i++)
1451 for(y = 0; y < 3; y++)
1452 for(x = 0; x < 3; x++)
1453 level->yamyam_content[i][x][y] =
1454 map_em_element_yam(header[i * 9 + y * 3 + x]);
1456 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1457 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1458 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1459 level->amoeba_content = EL_DIAMOND;
1461 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1463 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1465 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1466 new_element = EL_AMOEBA_WET;
1468 level->field[x][y] = new_element;
1471 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1472 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1473 level->field[x][y] = EL_PLAYER_1;
1475 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1476 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1477 level->field[x][y] = EL_PLAYER_2;
1480 /* ------------------------------------------------------------------------- */
1481 /* functions for loading SP level */
1482 /* ------------------------------------------------------------------------- */
1484 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1485 #define SP_LEVEL_SIZE 1536
1486 #define SP_LEVEL_XSIZE 60
1487 #define SP_LEVEL_YSIZE 24
1488 #define SP_LEVEL_NAME_LEN 23
1490 static void LoadLevelFromFileStream_SP(struct LevelInfo *level, FILE *file)
1494 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1495 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1497 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1499 int element_old = fgetc(file);
1502 if (element_old <= 0x27)
1503 element_new = EL_SP_START + element_old;
1504 else if (element_old == 0x28)
1505 element_new = EL_INVISIBLE_WALL;
1508 Error(ERR_WARN, "in level %d, at position %d, %d:", l, x, y);
1509 Error(ERR_WARN, "invalid level element %d", element_old);
1511 element_new = EL_CHAR_FRAGE;
1514 level->field[x][y] = element_new;
1518 ReadUnusedBytesFromFile(file, 4);
1520 /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1521 level->gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1523 ReadUnusedBytesFromFile(file, 1);
1525 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1526 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1527 level->name[i] = fgetc(file);
1528 level->name[SP_LEVEL_NAME_LEN] = '\0';
1530 /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1531 ReadUnusedBytesFromFile(file, 1); /* !!! NOT SUPPORTED YET !!! */
1533 /* number of infotrons needed; 0 means that Supaplex will count the total
1534 amount of infotrons in the level and use the low byte of that number.
1535 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1536 level->gems_needed = fgetc(file);
1538 /* information about special gravity port entries */
1539 ReadUnusedBytesFromFile(file, 65); /* !!! NOT SUPPORTED YET !!! */
1541 level->fieldx = SP_LEVEL_XSIZE;
1542 level->fieldy = SP_LEVEL_YSIZE;
1544 level->time = 0; /* no time limit */
1545 level->amoeba_speed = 0;
1546 level->time_magic_wall = 0;
1547 level->time_wheel = 0;
1548 level->amoeba_content = EL_EMPTY;
1550 for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1551 level->score[i] = 0; /* !!! CORRECT THIS !!! */
1553 /* there are no yamyams in supaplex levels */
1554 for(i = 0; i < level->num_yamyam_contents; i++)
1555 for(y = 0; y < 3; y++)
1556 for(x = 0; x < 3; x++)
1557 level->yamyam_content[i][x][y] = EL_EMPTY;
1560 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1561 struct LevelFileInfo *level_file_info)
1563 char *filename = level_file_info->filename;
1565 int nr = level_file_info->nr;
1567 char name_first, name_last;
1568 struct LevelInfo multipart_level;
1569 int multipart_xpos, multipart_ypos;
1570 boolean is_multipart_level;
1571 boolean is_first_part;
1572 boolean reading_multipart_level = FALSE;
1573 boolean use_empty_level = FALSE;
1575 if (!(file = fopen(filename, MODE_READ)))
1577 level->no_level_file = TRUE;
1579 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1584 /* position file stream to the requested level inside the level package */
1585 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1587 level->no_level_file = TRUE;
1589 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1594 /* there exist Supaplex level package files with multi-part levels which
1595 can be detected as follows: instead of leading and trailing dashes ('-')
1596 to pad the level name, they have leading and trailing numbers which are
1597 the x and y coordinations of the current part of the multi-part level;
1598 if there are '?' characters instead of numbers on the left or right side
1599 of the level name, the multi-part level consists of only horizontal or
1602 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1604 LoadLevelFromFileStream_SP(level, file);
1606 /* check if this level is a part of a bigger multi-part level */
1608 name_first = level->name[0];
1609 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
1611 is_multipart_level =
1612 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1613 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
1616 ((name_first == '?' || name_first == '1') &&
1617 (name_last == '?' || name_last == '1'));
1619 /* correct leading multipart level meta information in level name */
1620 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1621 level->name[i] = '-';
1623 /* correct trailing multipart level meta information in level name */
1624 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1625 level->name[i] = '-';
1627 /* ---------- check for normal single level ---------- */
1629 if (!reading_multipart_level && !is_multipart_level)
1631 /* the current level is simply a normal single-part level, and we are
1632 not reading a multi-part level yet, so return the level as it is */
1637 /* ---------- check for empty level (unused multi-part) ---------- */
1639 if (!reading_multipart_level && is_multipart_level && !is_first_part)
1641 /* this is a part of a multi-part level, but not the first part
1642 (and we are not already reading parts of a multi-part level);
1643 in this case, use an empty level instead of the single part */
1645 use_empty_level = TRUE;
1650 /* ---------- check for finished multi-part level ---------- */
1652 if (reading_multipart_level &&
1653 (!is_multipart_level ||
1654 strcmp(level->name, multipart_level.name) != 0))
1656 /* we are already reading parts of a multi-part level, but this level is
1657 either not a multi-part level, or a part of a different multi-part
1658 level; in both cases, the multi-part level seems to be complete */
1663 /* ---------- here we have one part of a multi-part level ---------- */
1665 reading_multipart_level = TRUE;
1667 if (is_first_part) /* start with first part of new multi-part level */
1669 /* copy level info structure from first part */
1670 multipart_level = level;
1672 /* clear playfield of new multi-part level */
1673 for (y = 0; y < MAX_LEV_FIELDY; y++)
1674 for (x = 0; x < MAX_LEV_FIELDX; x++)
1675 multipart_level->field[x][y] = EL_EMPTY;
1678 if (name_first == '?')
1680 if (name_last == '?')
1683 multipart_xpos = (int)(name_first - '0');
1684 multipart_ypos = (int)(name_last - '0');
1687 printf("----------> Part (%d/%d) of multi-part level '%s'\n",
1688 multipart_xpos, multipart_ypos, multipart_level.name);
1691 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1692 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1694 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1699 multipart_level.fieldx = MAX(multipart_level.fieldx,
1700 multipart_xpos * SP_LEVEL_XSIZE);
1701 multipart_level.fieldy = MAX(multipart_level.fieldy,
1702 multipart_ypos * SP_LEVEL_YSIZE);
1704 /* copy level part at the right position of multi-part level */
1705 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1707 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1709 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1710 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1712 multipart_level->field[start_x + x][start_y + y] = level->field[x][y];
1719 if (use_empty_level)
1721 setLevelInfoToDefaults(level);
1723 level->fieldx = SP_LEVEL_XSIZE;
1724 level->fieldy = SP_LEVEL_YSIZE;
1726 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1727 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1728 level->field[x][y] = EL_EMPTY;
1730 strcpy(level->name, "-------- EMPTY --------");
1732 Error(ERR_WARN, "single part of multi-part level -- using empty level");
1735 if (reading_multipart_level)
1736 *level = multipart_level;
1739 /* ------------------------------------------------------------------------- */
1740 /* functions for loading generic level */
1741 /* ------------------------------------------------------------------------- */
1743 void LoadLevelFromFileInfo(struct LevelInfo *level,
1744 struct LevelFileInfo *level_file_info)
1746 /* always start with reliable default values */
1747 setLevelInfoToDefaults(level);
1749 switch (level_file_info->type)
1751 case LEVEL_FILE_TYPE_RND:
1752 LoadLevelFromFileInfo_RND(level, level_file_info);
1755 case LEVEL_FILE_TYPE_EM:
1756 LoadLevelFromFileInfo_EM(level, level_file_info);
1759 case LEVEL_FILE_TYPE_SP:
1760 LoadLevelFromFileInfo_SP(level, level_file_info);
1764 LoadLevelFromFileInfo_RND(level, level_file_info);
1769 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
1771 static struct LevelFileInfo level_file_info;
1773 /* always start with reliable default values */
1774 setFileInfoToDefaults(&level_file_info);
1776 level_file_info.nr = 0; /* unknown level number */
1777 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
1778 level_file_info.filename = filename;
1780 LoadLevelFromFileInfo(level, &level_file_info);
1783 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
1785 if (leveldir_current == NULL) /* only when dumping level */
1789 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
1792 /* determine correct game engine version of current level */
1794 if (!leveldir_current->latest_engine)
1796 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
1797 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
1798 IS_LEVELCLASS_UNDEFINED(leveldir_current))
1802 printf("\n::: This level is private or contributed: '%s'\n", filename);
1806 printf("\n::: Use the stored game engine version for this level\n");
1809 /* For all levels which are not forced to use the latest game engine
1810 version (normally user contributed, private and undefined levels),
1811 use the version of the game engine the levels were created for.
1813 Since 2.0.1, the game engine version is now directly stored
1814 in the level file (chunk "VERS"), so there is no need anymore
1815 to set the game version from the file version (except for old,
1816 pre-2.0 levels, where the game version is still taken from the
1817 file format version used to store the level -- see above). */
1819 /* do some special adjustments to support older level versions */
1820 if (level->file_version == FILE_VERSION_1_0)
1822 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
1823 Error(ERR_WARN, "using high speed movement for player");
1825 /* player was faster than monsters in (pre-)1.0 levels */
1826 level->double_speed = TRUE;
1829 /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */
1830 if (level->game_version == VERSION_IDENT(2,0,1,0))
1831 level->em_slippery_gems = TRUE;
1836 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
1837 leveldir_current->sort_priority, filename);
1841 printf("\n::: Use latest game engine version for this level.\n");
1844 /* For all levels which are forced to use the latest game engine version
1845 (normally all but user contributed, private and undefined levels), set
1846 the game engine version to the actual version; this allows for actual
1847 corrections in the game engine to take effect for existing, converted
1848 levels (from "classic" or other existing games) to make the emulation
1849 of the corresponding game more accurate, while (hopefully) not breaking
1850 existing levels created from other players. */
1853 printf("::: changing engine from %d to %d\n",
1854 level->game_version, GAME_VERSION_ACTUAL);
1857 level->game_version = GAME_VERSION_ACTUAL;
1859 /* Set special EM style gems behaviour: EM style gems slip down from
1860 normal, steel and growing wall. As this is a more fundamental change,
1861 it seems better to set the default behaviour to "off" (as it is more
1862 natural) and make it configurable in the level editor (as a property
1863 of gem style elements). Already existing converted levels (neither
1864 private nor contributed levels) are changed to the new behaviour. */
1866 if (level->file_version < FILE_VERSION_2_0)
1867 level->em_slippery_gems = TRUE;
1871 printf("::: => %d\n", level->game_version);
1875 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
1879 /* map custom element change events that have changed in newer versions
1880 (these following values were accidentally changed in version 3.0.1) */
1881 if (level->game_version <= VERSION_IDENT(3,0,0,0))
1883 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1885 int element = EL_CUSTOM_START + i;
1887 /* order of checking and copying events to be mapped is important */
1888 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
1890 if (HAS_CHANGE_EVENT(element, j - 2))
1892 SET_CHANGE_EVENT(element, j - 2, FALSE);
1893 SET_CHANGE_EVENT(element, j, TRUE);
1897 /* order of checking and copying events to be mapped is important */
1898 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
1900 if (HAS_CHANGE_EVENT(element, j - 1))
1902 SET_CHANGE_EVENT(element, j - 1, FALSE);
1903 SET_CHANGE_EVENT(element, j, TRUE);
1909 /* some custom element change events get mapped since version 3.0.3 */
1910 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1912 int element = EL_CUSTOM_START + i;
1914 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
1915 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
1917 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
1918 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
1920 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
1924 /* initialize "can_change" field for old levels with only one change page */
1925 if (level->game_version <= VERSION_IDENT(3,0,2,0))
1927 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1929 int element = EL_CUSTOM_START + i;
1931 if (CAN_CHANGE(element))
1932 element_info[element].change->can_change = TRUE;
1937 /* set default push delay values (corrected since version 3.0.7-1) */
1938 if (level->game_version < VERSION_IDENT(3,0,7,1))
1940 game.default_push_delay_fixed = 2;
1941 game.default_push_delay_random = 8;
1945 game.default_push_delay_fixed = 8;
1946 game.default_push_delay_random = 8;
1949 /* set uninitialized push delay values of custom elements in older levels */
1950 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1952 int element = EL_CUSTOM_START + i;
1954 if (element_info[element].push_delay_fixed == -1)
1955 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
1956 if (element_info[element].push_delay_random == -1)
1957 element_info[element].push_delay_random = game.default_push_delay_random;
1961 /* initialize element properties for level editor etc. */
1962 InitElementPropertiesEngine(level->game_version);
1965 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
1969 /* map elements that have changed in newer versions */
1970 for (y = 0; y < level->fieldy; y++)
1972 for (x = 0; x < level->fieldx; x++)
1974 int element = level->field[x][y];
1976 if (level->game_version <= VERSION_IDENT(2,2,0,0))
1978 /* map game font elements */
1979 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
1980 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
1981 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
1982 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
1985 if (level->game_version < VERSION_IDENT(3,0,0,0))
1987 /* map Supaplex gravity tube elements */
1988 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
1989 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
1990 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
1991 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
1995 level->field[x][y] = element;
1999 /* copy elements to runtime playfield array */
2000 for (x = 0; x < MAX_LEV_FIELDX; x++)
2001 for (y = 0; y < MAX_LEV_FIELDY; y++)
2002 Feld[x][y] = level->field[x][y];
2004 /* initialize level size variables for faster access */
2005 lev_fieldx = level->fieldx;
2006 lev_fieldy = level->fieldy;
2008 /* determine border element for this level */
2012 void LoadLevelTemplate(int nr)
2015 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2016 char *filename = level_file_info->filename;
2018 LoadLevelFromFileInfo(&level_template, level_file_info);
2020 char *filename = getDefaultLevelFilename(nr);
2022 LoadLevelFromFilename_RND(&level_template, filename);
2025 LoadLevel_InitVersion(&level, filename);
2026 LoadLevel_InitElements(&level, filename);
2028 ActivateLevelTemplate();
2031 void LoadLevel(int nr)
2034 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2035 char *filename = level_file_info->filename;
2037 LoadLevelFromFileInfo(&level, level_file_info);
2039 char *filename = getLevelFilename(nr);
2041 LoadLevelFromFilename_RND(&level, filename);
2044 if (level.use_custom_template)
2045 LoadLevelTemplate(-1);
2048 LoadLevel_InitVersion(&level, filename);
2049 LoadLevel_InitElements(&level, filename);
2050 LoadLevel_InitPlayfield(&level, filename);
2052 LoadLevel_InitLevel(&level, filename);
2056 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2058 putFileVersion(file, level->file_version);
2059 putFileVersion(file, level->game_version);
2062 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2066 putFile8Bit(file, level->fieldx);
2067 putFile8Bit(file, level->fieldy);
2069 putFile16BitBE(file, level->time);
2070 putFile16BitBE(file, level->gems_needed);
2072 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2073 putFile8Bit(file, level->name[i]);
2075 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2076 putFile8Bit(file, level->score[i]);
2078 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2079 for (y = 0; y < 3; y++)
2080 for (x = 0; x < 3; x++)
2081 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2082 level->yamyam_content[i][x][y]));
2083 putFile8Bit(file, level->amoeba_speed);
2084 putFile8Bit(file, level->time_magic_wall);
2085 putFile8Bit(file, level->time_wheel);
2086 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2087 level->amoeba_content));
2088 putFile8Bit(file, (level->double_speed ? 1 : 0));
2089 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2090 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2091 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2093 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2095 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2098 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2102 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2103 putFile8Bit(file, level->author[i]);
2106 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2110 for (y = 0; y < level->fieldy; y++)
2111 for (x = 0; x < level->fieldx; x++)
2112 if (level->encoding_16bit_field)
2113 putFile16BitBE(file, level->field[x][y]);
2115 putFile8Bit(file, level->field[x][y]);
2119 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2123 putFile8Bit(file, EL_YAMYAM);
2124 putFile8Bit(file, level->num_yamyam_contents);
2125 putFile8Bit(file, 0);
2126 putFile8Bit(file, 0);
2128 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2129 for (y = 0; y < 3; y++)
2130 for (x = 0; x < 3; x++)
2131 if (level->encoding_16bit_field)
2132 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2134 putFile8Bit(file, level->yamyam_content[i][x][y]);
2138 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2141 int num_contents, content_xsize, content_ysize;
2142 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2144 if (element == EL_YAMYAM)
2146 num_contents = level->num_yamyam_contents;
2150 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2151 for (y = 0; y < 3; y++)
2152 for (x = 0; x < 3; x++)
2153 content_array[i][x][y] = level->yamyam_content[i][x][y];
2155 else if (element == EL_BD_AMOEBA)
2161 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2162 for (y = 0; y < 3; y++)
2163 for (x = 0; x < 3; x++)
2164 content_array[i][x][y] = EL_EMPTY;
2165 content_array[0][0][0] = level->amoeba_content;
2169 /* chunk header already written -- write empty chunk data */
2170 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2172 Error(ERR_WARN, "cannot save content for element '%d'", element);
2176 putFile16BitBE(file, element);
2177 putFile8Bit(file, num_contents);
2178 putFile8Bit(file, content_xsize);
2179 putFile8Bit(file, content_ysize);
2181 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2183 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2184 for (y = 0; y < 3; y++)
2185 for (x = 0; x < 3; x++)
2186 putFile16BitBE(file, content_array[i][x][y]);
2189 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2192 int envelope_nr = element - EL_ENVELOPE_1;
2193 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2195 putFile16BitBE(file, element);
2196 putFile16BitBE(file, envelope_len);
2197 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2198 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2200 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2202 for (i = 0; i < envelope_len; i++)
2203 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2207 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2208 int num_changed_custom_elements)
2212 putFile16BitBE(file, num_changed_custom_elements);
2214 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2216 int element = EL_CUSTOM_START + i;
2218 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2220 if (check < num_changed_custom_elements)
2222 putFile16BitBE(file, element);
2223 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2230 if (check != num_changed_custom_elements) /* should not happen */
2231 Error(ERR_WARN, "inconsistent number of custom element properties");
2236 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2237 int num_changed_custom_elements)
2241 putFile16BitBE(file, num_changed_custom_elements);
2243 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2245 int element = EL_CUSTOM_START + i;
2247 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2249 if (check < num_changed_custom_elements)
2251 putFile16BitBE(file, element);
2252 putFile16BitBE(file, element_info[element].change->target_element);
2259 if (check != num_changed_custom_elements) /* should not happen */
2260 Error(ERR_WARN, "inconsistent number of custom target elements");
2265 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2266 int num_changed_custom_elements)
2268 int i, j, x, y, check = 0;
2270 putFile16BitBE(file, num_changed_custom_elements);
2272 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2274 int element = EL_CUSTOM_START + i;
2276 if (element_info[element].modified_settings)
2278 if (check < num_changed_custom_elements)
2280 putFile16BitBE(file, element);
2282 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2283 putFile8Bit(file, element_info[element].description[j]);
2285 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2287 /* some free bytes for future properties and padding */
2288 WriteUnusedBytesToFile(file, 7);
2290 putFile8Bit(file, element_info[element].use_gfx_element);
2291 putFile16BitBE(file, element_info[element].gfx_element);
2293 putFile8Bit(file, element_info[element].collect_score);
2294 putFile8Bit(file, element_info[element].collect_count);
2296 putFile16BitBE(file, element_info[element].push_delay_fixed);
2297 putFile16BitBE(file, element_info[element].push_delay_random);
2298 putFile16BitBE(file, element_info[element].move_delay_fixed);
2299 putFile16BitBE(file, element_info[element].move_delay_random);
2301 putFile16BitBE(file, element_info[element].move_pattern);
2302 putFile8Bit(file, element_info[element].move_direction_initial);
2303 putFile8Bit(file, element_info[element].move_stepsize);
2305 for (y = 0; y < 3; y++)
2306 for (x = 0; x < 3; x++)
2307 putFile16BitBE(file, element_info[element].content[x][y]);
2309 putFile32BitBE(file, element_info[element].change->events);
2311 putFile16BitBE(file, element_info[element].change->target_element);
2313 putFile16BitBE(file, element_info[element].change->delay_fixed);
2314 putFile16BitBE(file, element_info[element].change->delay_random);
2315 putFile16BitBE(file, element_info[element].change->delay_frames);
2317 putFile16BitBE(file, element_info[element].change->trigger_element);
2319 putFile8Bit(file, element_info[element].change->explode);
2320 putFile8Bit(file, element_info[element].change->use_content);
2321 putFile8Bit(file, element_info[element].change->only_complete);
2322 putFile8Bit(file, element_info[element].change->use_random_change);
2324 putFile8Bit(file, element_info[element].change->random);
2325 putFile8Bit(file, element_info[element].change->power);
2327 for (y = 0; y < 3; y++)
2328 for (x = 0; x < 3; x++)
2329 putFile16BitBE(file, element_info[element].change->content[x][y]);
2331 putFile8Bit(file, element_info[element].slippery_type);
2333 /* some free bytes for future properties and padding */
2334 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2341 if (check != num_changed_custom_elements) /* should not happen */
2342 Error(ERR_WARN, "inconsistent number of custom element properties");
2346 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2348 struct ElementInfo *ei = &element_info[element];
2351 putFile16BitBE(file, element);
2353 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2354 putFile8Bit(file, ei->description[i]);
2356 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2357 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
2359 putFile8Bit(file, ei->num_change_pages);
2361 /* some free bytes for future base property values and padding */
2362 WriteUnusedBytesToFile(file, 5);
2364 /* write custom property values */
2366 putFile8Bit(file, ei->use_gfx_element);
2367 putFile16BitBE(file, ei->gfx_element);
2369 putFile8Bit(file, ei->collect_score);
2370 putFile8Bit(file, ei->collect_count);
2372 putFile16BitBE(file, ei->push_delay_fixed);
2373 putFile16BitBE(file, ei->push_delay_random);
2374 putFile16BitBE(file, ei->move_delay_fixed);
2375 putFile16BitBE(file, ei->move_delay_random);
2377 putFile16BitBE(file, ei->move_pattern);
2378 putFile8Bit(file, ei->move_direction_initial);
2379 putFile8Bit(file, ei->move_stepsize);
2381 putFile8Bit(file, ei->slippery_type);
2383 for (y = 0; y < 3; y++)
2384 for (x = 0; x < 3; x++)
2385 putFile16BitBE(file, ei->content[x][y]);
2387 putFile16BitBE(file, ei->move_enter_element);
2388 putFile16BitBE(file, ei->move_leave_element);
2389 putFile8Bit(file, ei->move_leave_type);
2391 /* some free bytes for future custom property values and padding */
2392 WriteUnusedBytesToFile(file, 7);
2394 /* write change property values */
2396 for (i = 0; i < ei->num_change_pages; i++)
2398 struct ElementChangeInfo *change = &ei->change_page[i];
2400 putFile32BitBE(file, change->events);
2402 putFile16BitBE(file, change->target_element);
2404 putFile16BitBE(file, change->delay_fixed);
2405 putFile16BitBE(file, change->delay_random);
2406 putFile16BitBE(file, change->delay_frames);
2408 putFile16BitBE(file, change->trigger_element);
2410 putFile8Bit(file, change->explode);
2411 putFile8Bit(file, change->use_content);
2412 putFile8Bit(file, change->only_complete);
2413 putFile8Bit(file, change->use_random_change);
2415 putFile8Bit(file, change->random);
2416 putFile8Bit(file, change->power);
2418 for (y = 0; y < 3; y++)
2419 for (x = 0; x < 3; x++)
2420 putFile16BitBE(file, change->content[x][y]);
2422 putFile8Bit(file, change->can_change);
2424 putFile8Bit(file, change->sides);
2426 /* some free bytes for future change property values and padding */
2427 WriteUnusedBytesToFile(file, 8);
2431 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2433 struct ElementInfo *ei = &element_info[element];
2434 struct ElementGroupInfo *group = ei->group;
2437 putFile16BitBE(file, element);
2439 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2440 putFile8Bit(file, ei->description[i]);
2442 putFile8Bit(file, group->num_elements);
2444 putFile8Bit(file, ei->use_gfx_element);
2445 putFile16BitBE(file, ei->gfx_element);
2447 /* some free bytes for future values and padding */
2448 WriteUnusedBytesToFile(file, 4);
2450 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2451 putFile16BitBE(file, group->element[i]);
2454 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2456 int body_chunk_size;
2460 if (!(file = fopen(filename, MODE_WRITE)))
2462 Error(ERR_WARN, "cannot save level file '%s'", filename);
2466 level->file_version = FILE_VERSION_ACTUAL;
2467 level->game_version = GAME_VERSION_ACTUAL;
2469 /* check level field for 16-bit elements */
2470 level->encoding_16bit_field = FALSE;
2471 for (y = 0; y < level->fieldy; y++)
2472 for (x = 0; x < level->fieldx; x++)
2473 if (level->field[x][y] > 255)
2474 level->encoding_16bit_field = TRUE;
2476 /* check yamyam content for 16-bit elements */
2477 level->encoding_16bit_yamyam = FALSE;
2478 for (i = 0; i < level->num_yamyam_contents; i++)
2479 for (y = 0; y < 3; y++)
2480 for (x = 0; x < 3; x++)
2481 if (level->yamyam_content[i][x][y] > 255)
2482 level->encoding_16bit_yamyam = TRUE;
2484 /* check amoeba content for 16-bit elements */
2485 level->encoding_16bit_amoeba = FALSE;
2486 if (level->amoeba_content > 255)
2487 level->encoding_16bit_amoeba = TRUE;
2489 /* calculate size of "BODY" chunk */
2491 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2493 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2494 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2496 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2497 SaveLevel_VERS(file, level);
2499 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2500 SaveLevel_HEAD(file, level);
2502 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2503 SaveLevel_AUTH(file, level);
2505 putFileChunkBE(file, "BODY", body_chunk_size);
2506 SaveLevel_BODY(file, level);
2508 if (level->encoding_16bit_yamyam ||
2509 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2511 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2512 SaveLevel_CNT2(file, level, EL_YAMYAM);
2515 if (level->encoding_16bit_amoeba)
2517 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2518 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2521 /* check for envelope content */
2522 for (i = 0; i < 4; i++)
2524 if (strlen(level->envelope_text[i]) > 0)
2526 int envelope_len = strlen(level->envelope_text[i]) + 1;
2528 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2529 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2533 /* check for non-default custom elements (unless using template level) */
2534 if (!level->use_custom_template)
2536 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2538 int element = EL_CUSTOM_START + i;
2540 if (element_info[element].modified_settings)
2542 int num_change_pages = element_info[element].num_change_pages;
2544 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2545 SaveLevel_CUS4(file, level, element);
2550 /* check for non-default group elements (unless using template level) */
2551 if (!level->use_custom_template)
2553 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2555 int element = EL_GROUP_START + i;
2557 if (element_info[element].modified_settings)
2559 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2560 SaveLevel_GRP1(file, level, element);
2567 SetFilePermissions(filename, PERMS_PRIVATE);
2570 void SaveLevel(int nr)
2572 char *filename = getDefaultLevelFilename(nr);
2574 SaveLevelFromFilename(&level, filename);
2577 void SaveLevelTemplate()
2579 char *filename = getDefaultLevelFilename(-1);
2581 SaveLevelFromFilename(&level, filename);
2584 void DumpLevel(struct LevelInfo *level)
2586 printf_line("-", 79);
2587 printf("Level xxx (file version %08d, game version %08d)\n",
2588 level->file_version, level->game_version);
2589 printf_line("-", 79);
2591 printf("Level Author: '%s'\n", level->author);
2592 printf("Level Title: '%s'\n", level->name);
2594 printf("Playfield Size: %d x %d\n", level->fieldx, level->fieldy);
2596 printf("Level Time: %d seconds\n", level->time);
2597 printf("Gems needed: %d\n", level->gems_needed);
2599 printf("Time for Magic Wall: %d seconds\n", level->time_magic_wall);
2600 printf("Time for Wheel: %d seconds\n", level->time_wheel);
2601 printf("Time for Light: %d seconds\n", level->time_light);
2602 printf("Time for Timegate: %d seconds\n", level->time_timegate);
2604 printf("Amoeba Speed: %d\n", level->amoeba_speed);
2606 printf("Gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
2607 printf("Double Speed Movement: %s\n", (level->double_speed ? "yes" : "no"));
2608 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
2610 printf_line("-", 79);
2614 /* ========================================================================= */
2615 /* tape file functions */
2616 /* ========================================================================= */
2618 static void setTapeInfoToDefaults()
2622 /* always start with reliable default values (empty tape) */
2625 /* default values (also for pre-1.2 tapes) with only the first player */
2626 tape.player_participates[0] = TRUE;
2627 for (i = 1; i < MAX_PLAYERS; i++)
2628 tape.player_participates[i] = FALSE;
2630 /* at least one (default: the first) player participates in every tape */
2631 tape.num_participating_players = 1;
2633 tape.level_nr = level_nr;
2635 tape.changed = FALSE;
2637 tape.recording = FALSE;
2638 tape.playing = FALSE;
2639 tape.pausing = FALSE;
2642 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
2644 tape->file_version = getFileVersion(file);
2645 tape->game_version = getFileVersion(file);
2650 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
2654 tape->random_seed = getFile32BitBE(file);
2655 tape->date = getFile32BitBE(file);
2656 tape->length = getFile32BitBE(file);
2658 /* read header fields that are new since version 1.2 */
2659 if (tape->file_version >= FILE_VERSION_1_2)
2661 byte store_participating_players = getFile8Bit(file);
2664 /* since version 1.2, tapes store which players participate in the tape */
2665 tape->num_participating_players = 0;
2666 for (i = 0; i < MAX_PLAYERS; i++)
2668 tape->player_participates[i] = FALSE;
2670 if (store_participating_players & (1 << i))
2672 tape->player_participates[i] = TRUE;
2673 tape->num_participating_players++;
2677 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
2679 engine_version = getFileVersion(file);
2680 if (engine_version > 0)
2681 tape->engine_version = engine_version;
2683 tape->engine_version = tape->game_version;
2689 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
2691 int level_identifier_size;
2694 level_identifier_size = getFile16BitBE(file);
2696 tape->level_identifier =
2697 checked_realloc(tape->level_identifier, level_identifier_size);
2699 for (i = 0; i < level_identifier_size; i++)
2700 tape->level_identifier[i] = getFile8Bit(file);
2702 tape->level_nr = getFile16BitBE(file);
2704 chunk_size = 2 + level_identifier_size + 2;
2709 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
2712 int chunk_size_expected =
2713 (tape->num_participating_players + 1) * tape->length;
2715 if (chunk_size_expected != chunk_size)
2717 ReadUnusedBytesFromFile(file, chunk_size);
2718 return chunk_size_expected;
2721 for (i = 0; i < tape->length; i++)
2723 if (i >= MAX_TAPELEN)
2726 for (j = 0; j < MAX_PLAYERS; j++)
2728 tape->pos[i].action[j] = MV_NO_MOVING;
2730 if (tape->player_participates[j])
2731 tape->pos[i].action[j] = getFile8Bit(file);
2734 tape->pos[i].delay = getFile8Bit(file);
2736 if (tape->file_version == FILE_VERSION_1_0)
2738 /* eliminate possible diagonal moves in old tapes */
2739 /* this is only for backward compatibility */
2741 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
2742 byte action = tape->pos[i].action[0];
2743 int k, num_moves = 0;
2745 for (k = 0; k<4; k++)
2747 if (action & joy_dir[k])
2749 tape->pos[i + num_moves].action[0] = joy_dir[k];
2751 tape->pos[i + num_moves].delay = 0;
2760 tape->length += num_moves;
2763 else if (tape->file_version < FILE_VERSION_2_0)
2765 /* convert pre-2.0 tapes to new tape format */
2767 if (tape->pos[i].delay > 1)
2770 tape->pos[i + 1] = tape->pos[i];
2771 tape->pos[i + 1].delay = 1;
2774 for (j = 0; j < MAX_PLAYERS; j++)
2775 tape->pos[i].action[j] = MV_NO_MOVING;
2776 tape->pos[i].delay--;
2787 if (i != tape->length)
2788 chunk_size = (tape->num_participating_players + 1) * i;
2793 void LoadTapeFromFilename(char *filename)
2795 char cookie[MAX_LINE_LEN];
2796 char chunk_name[CHUNK_ID_LEN + 1];
2800 /* always start with reliable default values */
2801 setTapeInfoToDefaults();
2803 if (!(file = fopen(filename, MODE_READ)))
2806 getFileChunkBE(file, chunk_name, NULL);
2807 if (strcmp(chunk_name, "RND1") == 0)
2809 getFile32BitBE(file); /* not used */
2811 getFileChunkBE(file, chunk_name, NULL);
2812 if (strcmp(chunk_name, "TAPE") != 0)
2814 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
2819 else /* check for pre-2.0 file format with cookie string */
2821 strcpy(cookie, chunk_name);
2822 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
2823 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
2824 cookie[strlen(cookie) - 1] = '\0';
2826 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
2828 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
2833 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
2835 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
2840 /* pre-2.0 tape files have no game version, so use file version here */
2841 tape.game_version = tape.file_version;
2844 if (tape.file_version < FILE_VERSION_1_2)
2846 /* tape files from versions before 1.2.0 without chunk structure */
2847 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
2848 LoadTape_BODY(file, 2 * tape.length, &tape);
2856 int (*loader)(FILE *, int, struct TapeInfo *);
2860 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
2861 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
2862 { "INFO", -1, LoadTape_INFO },
2863 { "BODY", -1, LoadTape_BODY },
2867 while (getFileChunkBE(file, chunk_name, &chunk_size))
2871 while (chunk_info[i].name != NULL &&
2872 strcmp(chunk_name, chunk_info[i].name) != 0)
2875 if (chunk_info[i].name == NULL)
2877 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
2878 chunk_name, filename);
2879 ReadUnusedBytesFromFile(file, chunk_size);
2881 else if (chunk_info[i].size != -1 &&
2882 chunk_info[i].size != chunk_size)
2884 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
2885 chunk_size, chunk_name, filename);
2886 ReadUnusedBytesFromFile(file, chunk_size);
2890 /* call function to load this tape chunk */
2891 int chunk_size_expected =
2892 (chunk_info[i].loader)(file, chunk_size, &tape);
2894 /* the size of some chunks cannot be checked before reading other
2895 chunks first (like "HEAD" and "BODY") that contain some header
2896 information, so check them here */
2897 if (chunk_size_expected != chunk_size)
2899 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
2900 chunk_size, chunk_name, filename);
2908 tape.length_seconds = GetTapeLength();
2911 printf("::: tape game version: %d\n", tape.game_version);
2912 printf("::: tape engine version: %d\n", tape.engine_version);
2916 void LoadTape(int nr)
2918 char *filename = getTapeFilename(nr);
2920 LoadTapeFromFilename(filename);
2923 void LoadSolutionTape(int nr)
2925 char *filename = getSolutionTapeFilename(nr);
2927 LoadTapeFromFilename(filename);
2930 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
2932 putFileVersion(file, tape->file_version);
2933 putFileVersion(file, tape->game_version);
2936 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
2939 byte store_participating_players = 0;
2941 /* set bits for participating players for compact storage */
2942 for (i = 0; i < MAX_PLAYERS; i++)
2943 if (tape->player_participates[i])
2944 store_participating_players |= (1 << i);
2946 putFile32BitBE(file, tape->random_seed);
2947 putFile32BitBE(file, tape->date);
2948 putFile32BitBE(file, tape->length);
2950 putFile8Bit(file, store_participating_players);
2952 /* unused bytes not at the end here for 4-byte alignment of engine_version */
2953 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
2955 putFileVersion(file, tape->engine_version);
2958 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
2960 int level_identifier_size = strlen(tape->level_identifier) + 1;
2963 putFile16BitBE(file, level_identifier_size);
2965 for (i = 0; i < level_identifier_size; i++)
2966 putFile8Bit(file, tape->level_identifier[i]);
2968 putFile16BitBE(file, tape->level_nr);
2971 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
2975 for (i = 0; i < tape->length; i++)
2977 for (j = 0; j < MAX_PLAYERS; j++)
2978 if (tape->player_participates[j])
2979 putFile8Bit(file, tape->pos[i].action[j]);
2981 putFile8Bit(file, tape->pos[i].delay);
2985 void SaveTape(int nr)
2987 char *filename = getTapeFilename(nr);
2989 boolean new_tape = TRUE;
2990 int num_participating_players = 0;
2991 int info_chunk_size;
2992 int body_chunk_size;
2995 InitTapeDirectory(leveldir_current->filename);
2997 /* if a tape still exists, ask to overwrite it */
2998 if (access(filename, F_OK) == 0)
3001 if (!Request("Replace old tape ?", REQ_ASK))
3005 if (!(file = fopen(filename, MODE_WRITE)))
3007 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3011 tape.file_version = FILE_VERSION_ACTUAL;
3012 tape.game_version = GAME_VERSION_ACTUAL;
3014 /* count number of participating players */
3015 for (i = 0; i < MAX_PLAYERS; i++)
3016 if (tape.player_participates[i])
3017 num_participating_players++;
3019 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3020 body_chunk_size = (num_participating_players + 1) * tape.length;
3022 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3023 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3025 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3026 SaveTape_VERS(file, &tape);
3028 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3029 SaveTape_HEAD(file, &tape);
3031 putFileChunkBE(file, "INFO", info_chunk_size);
3032 SaveTape_INFO(file, &tape);
3034 putFileChunkBE(file, "BODY", body_chunk_size);
3035 SaveTape_BODY(file, &tape);
3039 SetFilePermissions(filename, PERMS_PRIVATE);
3041 tape.changed = FALSE;
3044 Request("tape saved !", REQ_CONFIRM);
3047 void DumpTape(struct TapeInfo *tape)
3051 if (TAPE_IS_EMPTY(*tape))
3053 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3057 printf_line("-", 79);
3058 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3059 tape->level_nr, tape->file_version, tape->game_version);
3060 printf("Level series identifier: '%s'\n", tape->level_identifier);
3061 printf_line("-", 79);
3063 for (i = 0; i < tape->length; i++)
3065 if (i >= MAX_TAPELEN)
3068 printf("%03d: ", i);
3070 for (j = 0; j < MAX_PLAYERS; j++)
3072 if (tape->player_participates[j])
3074 int action = tape->pos[i].action[j];
3076 printf("%d:%02x ", j, action);
3077 printf("[%c%c%c%c|%c%c] - ",
3078 (action & JOY_LEFT ? '<' : ' '),
3079 (action & JOY_RIGHT ? '>' : ' '),
3080 (action & JOY_UP ? '^' : ' '),
3081 (action & JOY_DOWN ? 'v' : ' '),
3082 (action & JOY_BUTTON_1 ? '1' : ' '),
3083 (action & JOY_BUTTON_2 ? '2' : ' '));
3087 printf("(%03d)\n", tape->pos[i].delay);
3090 printf_line("-", 79);
3094 /* ========================================================================= */
3095 /* score file functions */
3096 /* ========================================================================= */
3098 void LoadScore(int nr)
3101 char *filename = getScoreFilename(nr);
3102 char cookie[MAX_LINE_LEN];
3103 char line[MAX_LINE_LEN];
3107 /* always start with reliable default values */
3108 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3110 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3111 highscore[i].Score = 0;
3114 if (!(file = fopen(filename, MODE_READ)))
3117 /* check file identifier */
3118 fgets(cookie, MAX_LINE_LEN, file);
3119 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3120 cookie[strlen(cookie) - 1] = '\0';
3122 if (!checkCookieString(cookie, SCORE_COOKIE))
3124 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3129 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3131 fscanf(file, "%d", &highscore[i].Score);
3132 fgets(line, MAX_LINE_LEN, file);
3134 if (line[strlen(line) - 1] == '\n')
3135 line[strlen(line) - 1] = '\0';
3137 for (line_ptr = line; *line_ptr; line_ptr++)
3139 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3141 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3142 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3151 void SaveScore(int nr)
3154 char *filename = getScoreFilename(nr);
3157 InitScoreDirectory(leveldir_current->filename);
3159 if (!(file = fopen(filename, MODE_WRITE)))
3161 Error(ERR_WARN, "cannot save score for level %d", nr);
3165 fprintf(file, "%s\n\n", SCORE_COOKIE);
3167 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3168 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3172 SetFilePermissions(filename, PERMS_PUBLIC);
3176 /* ========================================================================= */
3177 /* setup file functions */
3178 /* ========================================================================= */
3180 #define TOKEN_STR_PLAYER_PREFIX "player_"
3183 #define SETUP_TOKEN_PLAYER_NAME 0
3184 #define SETUP_TOKEN_SOUND 1
3185 #define SETUP_TOKEN_SOUND_LOOPS 2
3186 #define SETUP_TOKEN_SOUND_MUSIC 3
3187 #define SETUP_TOKEN_SOUND_SIMPLE 4
3188 #define SETUP_TOKEN_TOONS 5
3189 #define SETUP_TOKEN_SCROLL_DELAY 6
3190 #define SETUP_TOKEN_SOFT_SCROLLING 7
3191 #define SETUP_TOKEN_FADING 8
3192 #define SETUP_TOKEN_AUTORECORD 9
3193 #define SETUP_TOKEN_QUICK_DOORS 10
3194 #define SETUP_TOKEN_TEAM_MODE 11
3195 #define SETUP_TOKEN_HANDICAP 12
3196 #define SETUP_TOKEN_TIME_LIMIT 13
3197 #define SETUP_TOKEN_FULLSCREEN 14
3198 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3199 #define SETUP_TOKEN_GRAPHICS_SET 16
3200 #define SETUP_TOKEN_SOUNDS_SET 17
3201 #define SETUP_TOKEN_MUSIC_SET 18
3202 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3203 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3204 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3206 #define NUM_GLOBAL_SETUP_TOKENS 22
3209 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3210 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3211 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3212 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3213 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3214 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3215 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3216 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3217 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3218 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3219 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3220 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3222 #define NUM_EDITOR_SETUP_TOKENS 12
3224 /* shortcut setup */
3225 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3226 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3227 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3229 #define NUM_SHORTCUT_SETUP_TOKENS 3
3232 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3233 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3234 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3235 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3236 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3237 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3238 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3239 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3240 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3241 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3242 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3243 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3244 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3245 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3246 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3247 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3249 #define NUM_PLAYER_SETUP_TOKENS 16
3252 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
3253 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
3255 #define NUM_SYSTEM_SETUP_TOKENS 2
3258 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
3260 #define NUM_OPTIONS_SETUP_TOKENS 1
3263 static struct SetupInfo si;
3264 static struct SetupEditorInfo sei;
3265 static struct SetupShortcutInfo ssi;
3266 static struct SetupInputInfo sii;
3267 static struct SetupSystemInfo syi;
3268 static struct OptionInfo soi;
3270 static struct TokenInfo global_setup_tokens[] =
3272 { TYPE_STRING, &si.player_name, "player_name" },
3273 { TYPE_SWITCH, &si.sound, "sound" },
3274 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
3275 { TYPE_SWITCH, &si.sound_music, "background_music" },
3276 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
3277 { TYPE_SWITCH, &si.toons, "toons" },
3278 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
3279 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
3280 { TYPE_SWITCH, &si.fading, "screen_fading" },
3281 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
3282 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
3283 { TYPE_SWITCH, &si.team_mode, "team_mode" },
3284 { TYPE_SWITCH, &si.handicap, "handicap" },
3285 { TYPE_SWITCH, &si.time_limit, "time_limit" },
3286 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
3287 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
3288 { TYPE_STRING, &si.graphics_set, "graphics_set" },
3289 { TYPE_STRING, &si.sounds_set, "sounds_set" },
3290 { TYPE_STRING, &si.music_set, "music_set" },
3291 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3292 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
3293 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
3296 static struct TokenInfo editor_setup_tokens[] =
3298 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
3299 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
3300 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
3301 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
3302 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
3303 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
3304 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
3305 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
3306 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
3307 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
3308 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
3309 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
3312 static struct TokenInfo shortcut_setup_tokens[] =
3314 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
3315 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
3316 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
3319 static struct TokenInfo player_setup_tokens[] =
3321 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
3322 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
3323 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
3324 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
3325 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
3326 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
3327 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
3328 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
3329 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
3330 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
3331 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
3332 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
3333 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
3334 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
3335 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
3336 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
3339 static struct TokenInfo system_setup_tokens[] =
3341 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
3342 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3345 static struct TokenInfo options_setup_tokens[] =
3347 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
3350 static char *get_corrected_login_name(char *login_name)
3352 /* needed because player name must be a fixed length string */
3353 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3355 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3356 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3358 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
3359 if (strchr(login_name_new, ' '))
3360 *strchr(login_name_new, ' ') = '\0';
3362 return login_name_new;
3365 static void setSetupInfoToDefaults(struct SetupInfo *si)
3369 si->player_name = get_corrected_login_name(getLoginName());
3372 si->sound_loops = TRUE;
3373 si->sound_music = TRUE;
3374 si->sound_simple = TRUE;
3376 si->double_buffering = TRUE;
3377 si->direct_draw = !si->double_buffering;
3378 si->scroll_delay = TRUE;
3379 si->soft_scrolling = TRUE;
3381 si->autorecord = TRUE;
3382 si->quick_doors = FALSE;
3383 si->team_mode = FALSE;
3384 si->handicap = TRUE;
3385 si->time_limit = TRUE;
3386 si->fullscreen = FALSE;
3387 si->ask_on_escape = TRUE;
3389 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3390 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3391 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3392 si->override_level_graphics = FALSE;
3393 si->override_level_sounds = FALSE;
3394 si->override_level_music = FALSE;
3396 si->editor.el_boulderdash = TRUE;
3397 si->editor.el_emerald_mine = TRUE;
3398 si->editor.el_more = TRUE;
3399 si->editor.el_sokoban = TRUE;
3400 si->editor.el_supaplex = TRUE;
3401 si->editor.el_diamond_caves = TRUE;
3402 si->editor.el_dx_boulderdash = TRUE;
3403 si->editor.el_chars = TRUE;
3404 si->editor.el_custom = TRUE;
3405 si->editor.el_custom_more = FALSE;
3407 si->editor.el_headlines = TRUE;
3408 si->editor.el_user_defined = FALSE;
3410 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3411 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3412 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3414 for (i = 0; i < MAX_PLAYERS; i++)
3416 si->input[i].use_joystick = FALSE;
3417 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3418 si->input[i].joy.xleft = JOYSTICK_XLEFT;
3419 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3420 si->input[i].joy.xright = JOYSTICK_XRIGHT;
3421 si->input[i].joy.yupper = JOYSTICK_YUPPER;
3422 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3423 si->input[i].joy.ylower = JOYSTICK_YLOWER;
3424 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
3425 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
3426 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
3427 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3428 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
3429 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
3430 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
3431 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
3434 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3435 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3437 si->options.verbose = FALSE;
3440 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3444 if (!setup_file_hash)
3449 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3450 setSetupInfo(global_setup_tokens, i,
3451 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3456 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3457 setSetupInfo(editor_setup_tokens, i,
3458 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3461 /* shortcut setup */
3462 ssi = setup.shortcut;
3463 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3464 setSetupInfo(shortcut_setup_tokens, i,
3465 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3466 setup.shortcut = ssi;
3469 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3473 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3475 sii = setup.input[pnr];
3476 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3478 char full_token[100];
3480 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3481 setSetupInfo(player_setup_tokens, i,
3482 getHashEntry(setup_file_hash, full_token));
3484 setup.input[pnr] = sii;
3489 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3490 setSetupInfo(system_setup_tokens, i,
3491 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3495 soi = setup.options;
3496 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3497 setSetupInfo(options_setup_tokens, i,
3498 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3499 setup.options = soi;
3504 char *filename = getSetupFilename();
3505 SetupFileHash *setup_file_hash = NULL;
3507 /* always start with reliable default values */
3508 setSetupInfoToDefaults(&setup);
3510 setup_file_hash = loadSetupFileHash(filename);
3512 if (setup_file_hash)
3514 char *player_name_new;
3516 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3517 decodeSetupFileHash(setup_file_hash);
3519 setup.direct_draw = !setup.double_buffering;
3521 freeSetupFileHash(setup_file_hash);
3523 /* needed to work around problems with fixed length strings */
3524 player_name_new = get_corrected_login_name(setup.player_name);
3525 free(setup.player_name);
3526 setup.player_name = player_name_new;
3529 Error(ERR_WARN, "using default setup values");
3534 char *filename = getSetupFilename();
3538 InitUserDataDirectory();
3540 if (!(file = fopen(filename, MODE_WRITE)))
3542 Error(ERR_WARN, "cannot write setup file '%s'", filename);
3546 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3547 getCookie("SETUP")));
3548 fprintf(file, "\n");
3552 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3554 /* just to make things nicer :) */
3555 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3556 i == SETUP_TOKEN_GRAPHICS_SET)
3557 fprintf(file, "\n");
3559 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3564 fprintf(file, "\n");
3565 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3566 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3568 /* shortcut setup */
3569 ssi = setup.shortcut;
3570 fprintf(file, "\n");
3571 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3572 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3575 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3579 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3580 fprintf(file, "\n");
3582 sii = setup.input[pnr];
3583 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3584 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
3589 fprintf(file, "\n");
3590 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3591 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
3594 soi = setup.options;
3595 fprintf(file, "\n");
3596 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3597 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
3601 SetFilePermissions(filename, PERMS_PRIVATE);
3604 void LoadCustomElementDescriptions()
3606 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3607 SetupFileHash *setup_file_hash;
3610 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3612 if (element_info[i].custom_description != NULL)
3614 free(element_info[i].custom_description);
3615 element_info[i].custom_description = NULL;
3619 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3622 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3624 char *token = getStringCat2(element_info[i].token_name, ".name");
3625 char *value = getHashEntry(setup_file_hash, token);
3628 element_info[i].custom_description = getStringCopy(value);
3633 freeSetupFileHash(setup_file_hash);
3636 void LoadSpecialMenuDesignSettings()
3638 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3639 SetupFileHash *setup_file_hash;
3642 /* always start with reliable default values from default config */
3643 for (i = 0; image_config_vars[i].token != NULL; i++)
3644 for (j = 0; image_config[j].token != NULL; j++)
3645 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
3646 *image_config_vars[i].value =
3647 get_auto_parameter_value(image_config_vars[i].token,
3648 image_config[j].value);
3650 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3653 /* special case: initialize with default values that may be overwritten */
3654 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
3656 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
3657 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
3658 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
3660 if (value_x != NULL)
3661 menu.draw_xoffset[i] = get_integer_from_string(value_x);
3662 if (value_y != NULL)
3663 menu.draw_yoffset[i] = get_integer_from_string(value_y);
3664 if (list_size != NULL)
3665 menu.list_size[i] = get_integer_from_string(list_size);
3668 /* read (and overwrite with) values that may be specified in config file */
3669 for (i = 0; image_config_vars[i].token != NULL; i++)
3671 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
3674 *image_config_vars[i].value =
3675 get_auto_parameter_value(image_config_vars[i].token, value);
3678 freeSetupFileHash(setup_file_hash);
3681 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
3683 char *filename = getEditorSetupFilename();
3684 SetupFileList *setup_file_list, *list;
3685 SetupFileHash *element_hash;
3686 int num_unknown_tokens = 0;
3689 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3692 element_hash = newSetupFileHash();
3694 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3695 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
3697 /* determined size may be larger than needed (due to unknown elements) */
3699 for (list = setup_file_list; list != NULL; list = list->next)
3702 /* add space for up to 3 more elements for padding that may be needed */
3705 *elements = checked_malloc(*num_elements * sizeof(int));
3708 for (list = setup_file_list; list != NULL; list = list->next)
3710 char *value = getHashEntry(element_hash, list->token);
3714 (*elements)[(*num_elements)++] = atoi(value);
3718 if (num_unknown_tokens == 0)
3720 Error(ERR_RETURN_LINE, "-");
3721 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
3722 Error(ERR_RETURN, "- config file: '%s'", filename);
3724 num_unknown_tokens++;
3727 Error(ERR_RETURN, "- token: '%s'", list->token);
3731 if (num_unknown_tokens > 0)
3732 Error(ERR_RETURN_LINE, "-");
3734 while (*num_elements % 4) /* pad with empty elements, if needed */
3735 (*elements)[(*num_elements)++] = EL_EMPTY;
3737 freeSetupFileList(setup_file_list);
3738 freeSetupFileHash(element_hash);
3742 for (i = 0; i < *num_elements; i++)
3743 printf("editor: element '%s' [%d]\n",
3744 element_info[(*elements)[i]].token_name, (*elements)[i]);
3748 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
3751 SetupFileHash *setup_file_hash = NULL;
3752 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
3753 char *filename_music, *filename_prefix, *filename_info;
3759 token_to_value_ptr[] =
3761 { "title_header", &tmp_music_file_info.title_header },
3762 { "artist_header", &tmp_music_file_info.artist_header },
3763 { "album_header", &tmp_music_file_info.album_header },
3764 { "year_header", &tmp_music_file_info.year_header },
3766 { "title", &tmp_music_file_info.title },
3767 { "artist", &tmp_music_file_info.artist },
3768 { "album", &tmp_music_file_info.album },
3769 { "year", &tmp_music_file_info.year },
3775 filename_music = (is_sound ? getCustomSoundFilename(basename) :
3776 getCustomMusicFilename(basename));
3778 if (filename_music == NULL)
3781 /* ---------- try to replace file extension ---------- */
3783 filename_prefix = getStringCopy(filename_music);
3784 if (strrchr(filename_prefix, '.') != NULL)
3785 *strrchr(filename_prefix, '.') = '\0';
3786 filename_info = getStringCat2(filename_prefix, ".txt");
3789 printf("trying to load file '%s'...\n", filename_info);
3792 if (fileExists(filename_info))
3793 setup_file_hash = loadSetupFileHash(filename_info);
3795 free(filename_prefix);
3796 free(filename_info);
3798 if (setup_file_hash == NULL)
3800 /* ---------- try to add file extension ---------- */
3802 filename_prefix = getStringCopy(filename_music);
3803 filename_info = getStringCat2(filename_prefix, ".txt");
3806 printf("trying to load file '%s'...\n", filename_info);
3809 if (fileExists(filename_info))
3810 setup_file_hash = loadSetupFileHash(filename_info);
3812 free(filename_prefix);
3813 free(filename_info);
3816 if (setup_file_hash == NULL)
3819 /* ---------- music file info found ---------- */
3821 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
3823 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
3825 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
3827 *token_to_value_ptr[i].value_ptr =
3828 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
3831 tmp_music_file_info.basename = getStringCopy(basename);
3832 tmp_music_file_info.music = music;
3833 tmp_music_file_info.is_sound = is_sound;
3835 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
3836 *new_music_file_info = tmp_music_file_info;
3838 return new_music_file_info;
3841 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
3843 return get_music_file_info_ext(basename, music, FALSE);
3846 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
3848 return get_music_file_info_ext(basename, sound, TRUE);
3851 static boolean music_info_listed_ext(struct MusicFileInfo *list,
3852 char *basename, boolean is_sound)
3854 for (; list != NULL; list = list->next)
3855 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
3861 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
3863 return music_info_listed_ext(list, basename, FALSE);
3866 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
3868 return music_info_listed_ext(list, basename, TRUE);
3871 void LoadMusicInfo()
3873 char *music_directory = getCustomMusicDirectory();
3874 int num_music = getMusicListSize();
3875 int num_music_noconf = 0;
3876 int num_sounds = getSoundListSize();
3878 struct dirent *dir_entry;
3879 struct FileInfo *music, *sound;
3880 struct MusicFileInfo *next, **new;
3883 while (music_file_info != NULL)
3885 next = music_file_info->next;
3887 checked_free(music_file_info->basename);
3889 checked_free(music_file_info->title_header);
3890 checked_free(music_file_info->artist_header);
3891 checked_free(music_file_info->album_header);
3892 checked_free(music_file_info->year_header);
3894 checked_free(music_file_info->title);
3895 checked_free(music_file_info->artist);
3896 checked_free(music_file_info->album);
3897 checked_free(music_file_info->year);
3899 free(music_file_info);
3901 music_file_info = next;
3904 new = &music_file_info;
3907 printf("::: num_music == %d\n", num_music);
3910 for (i = 0; i < num_music; i++)
3912 music = getMusicListEntry(i);
3915 printf("::: %d [%08x]\n", i, music->filename);
3918 if (music->filename == NULL)
3921 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
3924 /* a configured file may be not recognized as music */
3925 if (!FileIsMusic(music->filename))
3929 printf("::: -> '%s' (configured)\n", music->filename);
3932 if (!music_info_listed(music_file_info, music->filename))
3934 *new = get_music_file_info(music->filename, i);
3936 new = &(*new)->next;
3940 if ((dir = opendir(music_directory)) == NULL)
3942 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
3946 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
3948 char *basename = dir_entry->d_name;
3949 boolean music_already_used = FALSE;
3952 /* skip all music files that are configured in music config file */
3953 for (i = 0; i < num_music; i++)
3955 music = getMusicListEntry(i);
3957 if (music->filename == NULL)
3960 if (strcmp(basename, music->filename) == 0)
3962 music_already_used = TRUE;
3967 if (music_already_used)
3970 if (!FileIsMusic(basename))
3974 printf("::: -> '%s' (found in directory)\n", basename);
3977 if (!music_info_listed(music_file_info, basename))
3979 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
3981 new = &(*new)->next;
3989 for (i = 0; i < num_sounds; i++)
3991 sound = getSoundListEntry(i);
3993 if (sound->filename == NULL)
3996 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
3999 /* a configured file may be not recognized as sound */
4000 if (!FileIsSound(sound->filename))
4004 printf("::: -> '%s' (configured)\n", sound->filename);
4007 if (!sound_info_listed(music_file_info, sound->filename))
4009 *new = get_sound_file_info(sound->filename, i);
4011 new = &(*new)->next;
4017 for (next = music_file_info; next != NULL; next = next->next)
4018 printf("::: title == '%s'\n", next->title);
4022 void add_helpanim_entry(int element, int action, int direction, int delay,
4023 int *num_list_entries)
4025 struct HelpAnimInfo *new_list_entry;
4026 (*num_list_entries)++;
4029 checked_realloc(helpanim_info,
4030 *num_list_entries * sizeof(struct HelpAnimInfo));
4031 new_list_entry = &helpanim_info[*num_list_entries - 1];
4033 new_list_entry->element = element;
4034 new_list_entry->action = action;
4035 new_list_entry->direction = direction;
4036 new_list_entry->delay = delay;
4039 void print_unknown_token(char *filename, char *token, int token_nr)
4043 Error(ERR_RETURN_LINE, "-");
4044 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4045 Error(ERR_RETURN, "- config file: '%s'", filename);
4048 Error(ERR_RETURN, "- token: '%s'", token);
4051 void print_unknown_token_end(int token_nr)
4054 Error(ERR_RETURN_LINE, "-");
4057 void LoadHelpAnimInfo()
4059 char *filename = getHelpAnimFilename();
4060 SetupFileList *setup_file_list = NULL, *list;
4061 SetupFileHash *element_hash, *action_hash, *direction_hash;
4062 int num_list_entries = 0;
4063 int num_unknown_tokens = 0;
4066 if (fileExists(filename))
4067 setup_file_list = loadSetupFileList(filename);
4069 if (setup_file_list == NULL)
4071 /* use reliable default values from static configuration */
4072 SetupFileList *insert_ptr;
4074 insert_ptr = setup_file_list =
4075 newSetupFileList(helpanim_config[0].token,
4076 helpanim_config[0].value);
4078 for (i = 1; helpanim_config[i].token; i++)
4079 insert_ptr = addListEntry(insert_ptr,
4080 helpanim_config[i].token,
4081 helpanim_config[i].value);
4084 element_hash = newSetupFileHash();
4085 action_hash = newSetupFileHash();
4086 direction_hash = newSetupFileHash();
4088 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4089 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4091 for (i = 0; i < NUM_ACTIONS; i++)
4092 setHashEntry(action_hash, element_action_info[i].suffix,
4093 i_to_a(element_action_info[i].value));
4095 /* do not store direction index (bit) here, but direction value! */
4096 for (i = 0; i < NUM_DIRECTIONS; i++)
4097 setHashEntry(direction_hash, element_direction_info[i].suffix,
4098 i_to_a(1 << element_direction_info[i].value));
4100 for (list = setup_file_list; list != NULL; list = list->next)
4102 char *element_token, *action_token, *direction_token;
4103 char *element_value, *action_value, *direction_value;
4104 int delay = atoi(list->value);
4106 if (strcmp(list->token, "end") == 0)
4108 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4113 /* first try to break element into element/action/direction parts;
4114 if this does not work, also accept combined "element[.act][.dir]"
4115 elements (like "dynamite.active"), which are unique elements */
4117 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4119 element_value = getHashEntry(element_hash, list->token);
4120 if (element_value != NULL) /* element found */
4121 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4125 /* no further suffixes found -- this is not an element */
4126 print_unknown_token(filename, list->token, num_unknown_tokens++);
4132 /* token has format "<prefix>.<something>" */
4134 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4135 direction_token = action_token; /* ... or direction */
4137 element_token = getStringCopy(list->token);
4138 *strchr(element_token, '.') = '\0';
4140 element_value = getHashEntry(element_hash, element_token);
4142 if (element_value == NULL) /* this is no element */
4144 element_value = getHashEntry(element_hash, list->token);
4145 if (element_value != NULL) /* combined element found */
4146 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4149 print_unknown_token(filename, list->token, num_unknown_tokens++);
4151 free(element_token);
4156 action_value = getHashEntry(action_hash, action_token);
4158 if (action_value != NULL) /* action found */
4160 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4163 free(element_token);
4168 direction_value = getHashEntry(direction_hash, direction_token);
4170 if (direction_value != NULL) /* direction found */
4172 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4175 free(element_token);
4180 if (strchr(action_token + 1, '.') == NULL)
4182 /* no further suffixes found -- this is not an action nor direction */
4184 element_value = getHashEntry(element_hash, list->token);
4185 if (element_value != NULL) /* combined element found */
4186 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4189 print_unknown_token(filename, list->token, num_unknown_tokens++);
4191 free(element_token);
4196 /* token has format "<prefix>.<suffix>.<something>" */
4198 direction_token = strchr(action_token + 1, '.');
4200 action_token = getStringCopy(action_token);
4201 *strchr(action_token + 1, '.') = '\0';
4203 action_value = getHashEntry(action_hash, action_token);
4205 if (action_value == NULL) /* this is no action */
4207 element_value = getHashEntry(element_hash, list->token);
4208 if (element_value != NULL) /* combined element found */
4209 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4212 print_unknown_token(filename, list->token, num_unknown_tokens++);
4214 free(element_token);
4220 direction_value = getHashEntry(direction_hash, direction_token);
4222 if (direction_value != NULL) /* direction found */
4224 add_helpanim_entry(atoi(element_value), atoi(action_value),
4225 atoi(direction_value), delay, &num_list_entries);
4227 free(element_token);
4233 /* this is no direction */
4235 element_value = getHashEntry(element_hash, list->token);
4236 if (element_value != NULL) /* combined element found */
4237 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4240 print_unknown_token(filename, list->token, num_unknown_tokens++);
4242 free(element_token);
4246 print_unknown_token_end(num_unknown_tokens);
4248 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4249 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4251 freeSetupFileList(setup_file_list);
4252 freeSetupFileHash(element_hash);
4253 freeSetupFileHash(action_hash);
4254 freeSetupFileHash(direction_hash);
4258 for (i = 0; i < num_list_entries; i++)
4259 printf("::: %d, %d, %d => %d\n",
4260 helpanim_info[i].element,
4261 helpanim_info[i].action,
4262 helpanim_info[i].direction,
4263 helpanim_info[i].delay);
4267 void LoadHelpTextInfo()
4269 char *filename = getHelpTextFilename();
4272 if (helptext_info != NULL)
4274 freeSetupFileHash(helptext_info);
4275 helptext_info = NULL;
4278 if (fileExists(filename))
4279 helptext_info = loadSetupFileHash(filename);
4281 if (helptext_info == NULL)
4283 /* use reliable default values from static configuration */
4284 helptext_info = newSetupFileHash();
4286 for (i = 0; helptext_config[i].token; i++)
4287 setHashEntry(helptext_info,
4288 helptext_config[i].token,
4289 helptext_config[i].value);
4294 BEGIN_HASH_ITERATION(helptext_info, itr)
4296 printf("::: '%s' => '%s'\n",
4297 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4299 END_HASH_ITERATION(hash, itr)