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->basename = NULL;
308 level_file_info->filename = NULL;
311 static void ActivateLevelTemplate()
313 /* Currently there is no special action needed to activate the template
314 data, because 'element_info' and 'Properties' overwrite the original
315 level data, while all other variables do not change. */
318 static char *getLevelFilenameFromBasename(char *basename)
320 static char *filename = NULL;
322 checked_free(filename);
324 filename = getPath2(getCurrentLevelDir(), basename);
329 static int getFileTypeFromBasename(char *basename)
331 char *filename = getLevelFilenameFromBasename(basename);
332 struct stat file_status;
334 /* ---------- try to determine file type from filename ---------- */
336 /* check for typical filename of a Supaplex level package file */
337 if (strlen(basename) == 10 && (strncmp(basename, "levels.d", 8) == 0 ||
338 strncmp(basename, "LEVELS.D", 8) == 0))
339 return LEVEL_FILE_TYPE_SP;
341 /* ---------- try to determine file type from filesize ---------- */
343 if (stat(filename, &file_status) == 0)
345 /* check for typical filesize of a Supaplex level package file */
346 if (file_status.st_size == 170496)
347 return LEVEL_FILE_TYPE_SP;
350 return LEVEL_FILE_TYPE_UNKNOWN;
353 static char *getSingleLevelBasename(int nr, int type)
355 static char basename[MAX_FILENAME_LEN];
357 if (leveldir_current->level_filename == NULL)
358 leveldir_current->level_filename =
359 getStringCat2("%03d.", LEVELFILE_EXTENSION);
363 case LEVEL_FILE_TYPE_RND:
365 sprintf(basename, "template.%s", LEVELFILE_EXTENSION);
367 sprintf(basename, "%03d.%s", nr, LEVELFILE_EXTENSION);
370 case LEVEL_FILE_TYPE_EM:
371 sprintf(basename, "%d", nr);
374 case LEVEL_FILE_TYPE_UNKNOWN:
376 sprintf(basename, leveldir_current->level_filename, nr);
383 static char *getPackedLevelBasename(int type)
385 static char basename[MAX_FILENAME_LEN];
386 char *directory = getCurrentLevelDir();
388 struct dirent *dir_entry;
390 strcpy(basename, UNDEFINED_FILENAME); /* default: undefined file */
392 if ((dir = opendir(directory)) == NULL)
394 Error(ERR_WARN, "cannot read current level directory '%s'", directory);
399 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
401 char *entry_basename = dir_entry->d_name;
402 int entry_type = getFileTypeFromBasename(entry_basename);
404 if (entry_type != LEVEL_FILE_TYPE_UNKNOWN) /* found valid level package */
406 if (type == LEVEL_FILE_TYPE_UNKNOWN ||
409 strcpy(basename, entry_basename);
421 static char *getSingleLevelFilename(int nr, int type)
423 return getLevelFilenameFromBasename(getSingleLevelBasename(nr, type));
427 static char *getPackedLevelFilename(int type)
429 return getLevelFilenameFromBasename(getPackedLevelBasename(type));
433 char *getDefaultLevelFilename(int nr)
435 return getSingleLevelFilename(nr, LEVEL_FILE_TYPE_RND);
438 static void setLevelFileInfo_SingleLevelFilename(struct LevelFileInfo *lfi,
443 lfi->basename = getSingleLevelBasename(lfi->nr, lfi->type);
444 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
447 static void setLevelFileInfo_PackedLevelFilename(struct LevelFileInfo *lfi,
452 lfi->basename = getPackedLevelBasename(lfi->type);
453 lfi->filename = getLevelFilenameFromBasename(lfi->basename);
456 static void determineLevelFileInfo_Filename(struct LevelFileInfo *lfi)
458 /* special case: level number is negative => check for level template file */
461 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
466 if (leveldir_current->level_filename != NULL)
468 /* check for file name/pattern specified in "levelinfo.conf" */
469 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
470 if (fileExists(lfi->filename))
474 /* check for native Rocks'n'Diamonds level file */
475 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_RND);
476 if (fileExists(lfi->filename))
479 /* check for classic Emerald Mine level file */
480 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_EM);
481 if (fileExists(lfi->filename))
484 /* check for various packed level file formats */
485 setLevelFileInfo_PackedLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
486 if (fileExists(lfi->filename))
489 /* no known level file found -- try to use default values */
490 setLevelFileInfo_SingleLevelFilename(lfi, LEVEL_FILE_TYPE_UNKNOWN);
493 static void determineLevelFileInfo_Filetype(struct LevelFileInfo *lfi)
495 if (lfi->type == LEVEL_FILE_TYPE_UNKNOWN)
496 lfi->type = getFileTypeFromBasename(lfi->basename);
499 static struct LevelFileInfo *getLevelFileInfo(int nr)
501 static struct LevelFileInfo level_file_info;
503 /* always start with reliable default values */
504 setFileInfoToDefaults(&level_file_info);
506 level_file_info.nr = nr; /* set requested level number */
508 determineLevelFileInfo_Filename(&level_file_info);
509 determineLevelFileInfo_Filetype(&level_file_info);
511 return &level_file_info;
515 /* ------------------------------------------------------------------------- */
516 /* functions for loading R'n'D level */
517 /* ------------------------------------------------------------------------- */
519 int getMappedElement(int element)
521 /* map some (historic, now obsolete) elements */
526 case EL_PLAYER_OBSOLETE:
527 element = EL_PLAYER_1;
530 case EL_KEY_OBSOLETE:
533 case EL_EM_KEY_1_FILE_OBSOLETE:
534 element = EL_EM_KEY_1;
537 case EL_EM_KEY_2_FILE_OBSOLETE:
538 element = EL_EM_KEY_2;
541 case EL_EM_KEY_3_FILE_OBSOLETE:
542 element = EL_EM_KEY_3;
545 case EL_EM_KEY_4_FILE_OBSOLETE:
546 element = EL_EM_KEY_4;
549 case EL_ENVELOPE_OBSOLETE:
550 element = EL_ENVELOPE_1;
558 if (element >= NUM_FILE_ELEMENTS)
560 Error(ERR_WARN, "invalid level element %d", element);
562 element = EL_CHAR_QUESTION;
567 if (element >= NUM_FILE_ELEMENTS)
569 Error(ERR_WARN, "invalid level element %d", element);
571 element = EL_CHAR_QUESTION;
573 else if (element == EL_PLAYER_OBSOLETE)
574 element = EL_PLAYER_1;
575 else if (element == EL_KEY_OBSOLETE)
582 static int LoadLevel_VERS(FILE *file, int chunk_size, struct LevelInfo *level)
584 level->file_version = getFileVersion(file);
585 level->game_version = getFileVersion(file);
590 static int LoadLevel_HEAD(FILE *file, int chunk_size, struct LevelInfo *level)
594 level->fieldx = getFile8Bit(file);
595 level->fieldy = getFile8Bit(file);
597 level->time = getFile16BitBE(file);
598 level->gems_needed = getFile16BitBE(file);
600 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
601 level->name[i] = getFile8Bit(file);
602 level->name[MAX_LEVEL_NAME_LEN] = 0;
604 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
605 level->score[i] = getFile8Bit(file);
607 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
608 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
609 for (y = 0; y < 3; y++)
610 for (x = 0; x < 3; x++)
611 level->yamyam_content[i][x][y] = getMappedElement(getFile8Bit(file));
613 level->amoeba_speed = getFile8Bit(file);
614 level->time_magic_wall = getFile8Bit(file);
615 level->time_wheel = getFile8Bit(file);
616 level->amoeba_content = getMappedElement(getFile8Bit(file));
617 level->double_speed = (getFile8Bit(file) == 1 ? TRUE : FALSE);
618 level->initial_gravity = (getFile8Bit(file) == 1 ? TRUE : FALSE);
619 level->encoding_16bit_field = (getFile8Bit(file) == 1 ? TRUE : FALSE);
620 level->em_slippery_gems = (getFile8Bit(file) == 1 ? TRUE : FALSE);
622 level->use_custom_template = (getFile8Bit(file) == 1 ? TRUE : FALSE);
624 ReadUnusedBytesFromFile(file, LEVEL_HEADER_UNUSED);
629 static int LoadLevel_AUTH(FILE *file, int chunk_size, struct LevelInfo *level)
633 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
634 level->author[i] = getFile8Bit(file);
635 level->author[MAX_LEVEL_NAME_LEN] = 0;
640 static int LoadLevel_BODY(FILE *file, int chunk_size, struct LevelInfo *level)
643 int chunk_size_expected = level->fieldx * level->fieldy;
645 /* Note: "chunk_size" was wrong before version 2.0 when elements are
646 stored with 16-bit encoding (and should be twice as big then).
647 Even worse, playfield data was stored 16-bit when only yamyam content
648 contained 16-bit elements and vice versa. */
650 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
651 chunk_size_expected *= 2;
653 if (chunk_size_expected != chunk_size)
655 ReadUnusedBytesFromFile(file, chunk_size);
656 return chunk_size_expected;
659 for (y = 0; y < level->fieldy; y++)
660 for (x = 0; x < level->fieldx; x++)
662 getMappedElement(level->encoding_16bit_field ? getFile16BitBE(file) :
667 static int LoadLevel_CONT(FILE *file, int chunk_size, struct LevelInfo *level)
671 int content_size = MAX_ELEMENT_CONTENTS * 3 * 3;
672 int chunk_size_expected = header_size + content_size;
674 /* Note: "chunk_size" was wrong before version 2.0 when elements are
675 stored with 16-bit encoding (and should be twice as big then).
676 Even worse, playfield data was stored 16-bit when only yamyam content
677 contained 16-bit elements and vice versa. */
679 if (level->encoding_16bit_field && level->file_version >= FILE_VERSION_2_0)
680 chunk_size_expected += content_size;
682 if (chunk_size_expected != chunk_size)
684 ReadUnusedBytesFromFile(file, chunk_size);
685 return chunk_size_expected;
689 level->num_yamyam_contents = getFile8Bit(file);
693 /* correct invalid number of content fields -- should never happen */
694 if (level->num_yamyam_contents < 1 ||
695 level->num_yamyam_contents > MAX_ELEMENT_CONTENTS)
696 level->num_yamyam_contents = STD_ELEMENT_CONTENTS;
698 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
699 for (y = 0; y < 3; y++)
700 for (x = 0; x < 3; x++)
701 level->yamyam_content[i][x][y] =
702 getMappedElement(level->encoding_16bit_field ?
703 getFile16BitBE(file) : getFile8Bit(file));
707 static int LoadLevel_CNT2(FILE *file, int chunk_size, struct LevelInfo *level)
711 int num_contents, content_xsize, content_ysize;
712 int content_array[MAX_ELEMENT_CONTENTS][3][3];
714 element = getMappedElement(getFile16BitBE(file));
715 num_contents = getFile8Bit(file);
716 content_xsize = getFile8Bit(file);
717 content_ysize = getFile8Bit(file);
719 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT2_UNUSED);
721 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
722 for (y = 0; y < 3; y++)
723 for (x = 0; x < 3; x++)
724 content_array[i][x][y] = getMappedElement(getFile16BitBE(file));
726 /* correct invalid number of content fields -- should never happen */
727 if (num_contents < 1 || num_contents > MAX_ELEMENT_CONTENTS)
728 num_contents = STD_ELEMENT_CONTENTS;
730 if (element == EL_YAMYAM)
732 level->num_yamyam_contents = num_contents;
734 for (i = 0; i < num_contents; i++)
735 for (y = 0; y < 3; y++)
736 for (x = 0; x < 3; x++)
737 level->yamyam_content[i][x][y] = content_array[i][x][y];
739 else if (element == EL_BD_AMOEBA)
741 level->amoeba_content = content_array[0][0][0];
745 Error(ERR_WARN, "cannot load content for element '%d'", element);
751 static int LoadLevel_CNT3(FILE *file, int chunk_size, struct LevelInfo *level)
757 int chunk_size_expected;
759 element = getMappedElement(getFile16BitBE(file));
760 if (!IS_ENVELOPE(element))
761 element = EL_ENVELOPE_1;
763 envelope_nr = element - EL_ENVELOPE_1;
765 envelope_len = getFile16BitBE(file);
767 level->envelope_xsize[envelope_nr] = getFile8Bit(file);
768 level->envelope_ysize[envelope_nr] = getFile8Bit(file);
770 ReadUnusedBytesFromFile(file, LEVEL_CHUNK_CNT3_UNUSED);
772 chunk_size_expected = LEVEL_CHUNK_CNT3_SIZE(envelope_len);
773 if (chunk_size_expected != chunk_size)
775 ReadUnusedBytesFromFile(file, chunk_size - LEVEL_CHUNK_CNT3_HEADER);
776 return chunk_size_expected;
779 for (i = 0; i < envelope_len; i++)
780 level->envelope_text[envelope_nr][i] = getFile8Bit(file);
785 static int LoadLevel_CUS1(FILE *file, int chunk_size, struct LevelInfo *level)
787 int num_changed_custom_elements = getFile16BitBE(file);
788 int chunk_size_expected = 2 + num_changed_custom_elements * 6;
791 if (chunk_size_expected != chunk_size)
793 ReadUnusedBytesFromFile(file, chunk_size - 2);
794 return chunk_size_expected;
797 for (i = 0; i < num_changed_custom_elements; i++)
799 int element = getFile16BitBE(file);
800 int properties = getFile32BitBE(file);
802 if (IS_CUSTOM_ELEMENT(element))
803 Properties[element][EP_BITFIELD_BASE] = properties;
805 Error(ERR_WARN, "invalid custom element number %d", element);
811 static int LoadLevel_CUS2(FILE *file, int chunk_size, struct LevelInfo *level)
813 int num_changed_custom_elements = getFile16BitBE(file);
814 int chunk_size_expected = 2 + num_changed_custom_elements * 4;
817 if (chunk_size_expected != chunk_size)
819 ReadUnusedBytesFromFile(file, chunk_size - 2);
820 return chunk_size_expected;
823 for (i = 0; i < num_changed_custom_elements; i++)
825 int element = getFile16BitBE(file);
826 int custom_target_element = getFile16BitBE(file);
828 if (IS_CUSTOM_ELEMENT(element))
829 element_info[element].change->target_element = custom_target_element;
831 Error(ERR_WARN, "invalid custom element number %d", element);
837 static int LoadLevel_CUS3(FILE *file, int chunk_size, struct LevelInfo *level)
839 int num_changed_custom_elements = getFile16BitBE(file);
840 int chunk_size_expected = LEVEL_CHUNK_CUS3_SIZE(num_changed_custom_elements);
843 if (chunk_size_expected != chunk_size)
845 ReadUnusedBytesFromFile(file, chunk_size - 2);
846 return chunk_size_expected;
849 for (i = 0; i < num_changed_custom_elements; i++)
851 int element = getFile16BitBE(file);
853 if (!IS_CUSTOM_ELEMENT(element))
855 Error(ERR_WARN, "invalid custom element number %d", element);
857 element = EL_INTERNAL_DUMMY;
860 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
861 element_info[element].description[j] = getFile8Bit(file);
862 element_info[element].description[MAX_ELEMENT_NAME_LEN] = 0;
864 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
866 /* some free bytes for future properties and padding */
867 ReadUnusedBytesFromFile(file, 7);
869 element_info[element].use_gfx_element = getFile8Bit(file);
870 element_info[element].gfx_element =
871 getMappedElement(getFile16BitBE(file));
873 element_info[element].collect_score = getFile8Bit(file);
874 element_info[element].collect_count = getFile8Bit(file);
876 element_info[element].push_delay_fixed = getFile16BitBE(file);
877 element_info[element].push_delay_random = getFile16BitBE(file);
878 element_info[element].move_delay_fixed = getFile16BitBE(file);
879 element_info[element].move_delay_random = getFile16BitBE(file);
881 element_info[element].move_pattern = getFile16BitBE(file);
882 element_info[element].move_direction_initial = getFile8Bit(file);
883 element_info[element].move_stepsize = getFile8Bit(file);
885 for (y = 0; y < 3; y++)
886 for (x = 0; x < 3; x++)
887 element_info[element].content[x][y] =
888 getMappedElement(getFile16BitBE(file));
890 element_info[element].change->events = getFile32BitBE(file);
892 element_info[element].change->target_element =
893 getMappedElement(getFile16BitBE(file));
895 element_info[element].change->delay_fixed = getFile16BitBE(file);
896 element_info[element].change->delay_random = getFile16BitBE(file);
897 element_info[element].change->delay_frames = getFile16BitBE(file);
899 element_info[element].change->trigger_element =
900 getMappedElement(getFile16BitBE(file));
902 element_info[element].change->explode = getFile8Bit(file);
903 element_info[element].change->use_content = getFile8Bit(file);
904 element_info[element].change->only_complete = getFile8Bit(file);
905 element_info[element].change->use_random_change = getFile8Bit(file);
907 element_info[element].change->random = getFile8Bit(file);
908 element_info[element].change->power = getFile8Bit(file);
910 for (y = 0; y < 3; y++)
911 for (x = 0; x < 3; x++)
912 element_info[element].change->content[x][y] =
913 getMappedElement(getFile16BitBE(file));
915 element_info[element].slippery_type = getFile8Bit(file);
917 /* some free bytes for future properties and padding */
918 ReadUnusedBytesFromFile(file, LEVEL_CPART_CUS3_UNUSED);
920 /* mark that this custom element has been modified */
921 element_info[element].modified_settings = TRUE;
927 static int LoadLevel_CUS4(FILE *file, int chunk_size, struct LevelInfo *level)
929 struct ElementInfo *ei;
930 int chunk_size_expected;
934 element = getFile16BitBE(file);
936 if (!IS_CUSTOM_ELEMENT(element))
938 Error(ERR_WARN, "invalid custom element number %d", element);
940 ReadUnusedBytesFromFile(file, chunk_size - 2);
944 ei = &element_info[element];
946 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
947 ei->description[i] = getFile8Bit(file);
948 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
950 Properties[element][EP_BITFIELD_BASE] = getFile32BitBE(file);
951 ReadUnusedBytesFromFile(file, 4); /* reserved for more base properties */
953 ei->num_change_pages = getFile8Bit(file);
955 /* some free bytes for future base property values and padding */
956 ReadUnusedBytesFromFile(file, 5);
958 chunk_size_expected = LEVEL_CHUNK_CUS4_SIZE(ei->num_change_pages);
959 if (chunk_size_expected != chunk_size)
961 ReadUnusedBytesFromFile(file, chunk_size - 48);
962 return chunk_size_expected;
965 /* read custom property values */
967 ei->use_gfx_element = getFile8Bit(file);
968 ei->gfx_element = getMappedElement(getFile16BitBE(file));
970 ei->collect_score = getFile8Bit(file);
971 ei->collect_count = getFile8Bit(file);
973 ei->push_delay_fixed = getFile16BitBE(file);
974 ei->push_delay_random = getFile16BitBE(file);
975 ei->move_delay_fixed = getFile16BitBE(file);
976 ei->move_delay_random = getFile16BitBE(file);
978 ei->move_pattern = getFile16BitBE(file);
979 ei->move_direction_initial = getFile8Bit(file);
980 ei->move_stepsize = getFile8Bit(file);
982 ei->slippery_type = getFile8Bit(file);
984 for (y = 0; y < 3; y++)
985 for (x = 0; x < 3; x++)
986 ei->content[x][y] = getMappedElement(getFile16BitBE(file));
988 ei->move_enter_element = getMappedElement(getFile16BitBE(file));
989 ei->move_leave_element = getMappedElement(getFile16BitBE(file));
990 ei->move_leave_type = getFile8Bit(file);
992 /* some free bytes for future custom property values and padding */
993 ReadUnusedBytesFromFile(file, 7);
995 /* read change property values */
997 setElementChangePages(ei, ei->num_change_pages);
999 for (i = 0; i < ei->num_change_pages; i++)
1001 struct ElementChangeInfo *change = &ei->change_page[i];
1003 /* always start with reliable default values */
1004 setElementChangeInfoToDefaults(change);
1006 change->events = getFile32BitBE(file);
1008 change->target_element = getMappedElement(getFile16BitBE(file));
1010 change->delay_fixed = getFile16BitBE(file);
1011 change->delay_random = getFile16BitBE(file);
1012 change->delay_frames = getFile16BitBE(file);
1014 change->trigger_element = getMappedElement(getFile16BitBE(file));
1016 change->explode = getFile8Bit(file);
1017 change->use_content = getFile8Bit(file);
1018 change->only_complete = getFile8Bit(file);
1019 change->use_random_change = getFile8Bit(file);
1021 change->random = getFile8Bit(file);
1022 change->power = getFile8Bit(file);
1024 for (y = 0; y < 3; y++)
1025 for (x = 0; x < 3; x++)
1026 change->content[x][y] = getMappedElement(getFile16BitBE(file));
1028 change->can_change = getFile8Bit(file);
1030 change->sides = getFile8Bit(file);
1032 if (change->sides == CH_SIDE_NONE) /* correct empty sides field */
1033 change->sides = CH_SIDE_ANY;
1035 /* some free bytes for future change property values and padding */
1036 ReadUnusedBytesFromFile(file, 8);
1039 /* mark this custom element as modified */
1040 ei->modified_settings = TRUE;
1045 static int LoadLevel_GRP1(FILE *file, int chunk_size, struct LevelInfo *level)
1047 struct ElementInfo *ei;
1048 struct ElementGroupInfo *group;
1052 element = getFile16BitBE(file);
1054 if (!IS_GROUP_ELEMENT(element))
1056 Error(ERR_WARN, "invalid group element number %d", element);
1058 ReadUnusedBytesFromFile(file, chunk_size - 2);
1062 ei = &element_info[element];
1064 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
1065 ei->description[i] = getFile8Bit(file);
1066 ei->description[MAX_ELEMENT_NAME_LEN] = 0;
1068 group = element_info[element].group;
1070 group->num_elements = getFile8Bit(file);
1072 ei->use_gfx_element = getFile8Bit(file);
1073 ei->gfx_element = getMappedElement(getFile16BitBE(file));
1075 /* some free bytes for future values and padding */
1076 ReadUnusedBytesFromFile(file, 4);
1078 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
1079 group->element[i] = getMappedElement(getFile16BitBE(file));
1081 /* mark this group element as modified */
1082 element_info[element].modified_settings = TRUE;
1087 static void LoadLevelFromFileInfo_RND(struct LevelInfo *level,
1088 struct LevelFileInfo *level_file_info)
1090 char *filename = level_file_info->filename;
1091 char cookie[MAX_LINE_LEN];
1092 char chunk_name[CHUNK_ID_LEN + 1];
1096 if (!(file = fopen(filename, MODE_READ)))
1098 level->no_level_file = TRUE;
1100 if (level != &level_template)
1101 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1106 getFileChunkBE(file, chunk_name, NULL);
1107 if (strcmp(chunk_name, "RND1") == 0)
1109 getFile32BitBE(file); /* not used */
1111 getFileChunkBE(file, chunk_name, NULL);
1112 if (strcmp(chunk_name, "CAVE") != 0)
1114 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1119 else /* check for pre-2.0 file format with cookie string */
1121 strcpy(cookie, chunk_name);
1122 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
1123 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
1124 cookie[strlen(cookie) - 1] = '\0';
1126 if (!checkCookieString(cookie, LEVEL_COOKIE_TMPL))
1128 Error(ERR_WARN, "unknown format of level file '%s'", filename);
1133 if ((level->file_version = getFileVersionFromCookieString(cookie)) == -1)
1135 Error(ERR_WARN, "unsupported version of level file '%s'", filename);
1140 /* pre-2.0 level files have no game version, so use file version here */
1141 level->game_version = level->file_version;
1144 if (level->file_version < FILE_VERSION_1_2)
1146 /* level files from versions before 1.2.0 without chunk structure */
1147 LoadLevel_HEAD(file, LEVEL_HEADER_SIZE, level);
1148 LoadLevel_BODY(file, level->fieldx * level->fieldy, level);
1156 int (*loader)(FILE *, int, struct LevelInfo *);
1160 { "VERS", FILE_VERS_CHUNK_SIZE, LoadLevel_VERS },
1161 { "HEAD", LEVEL_HEADER_SIZE, LoadLevel_HEAD },
1162 { "AUTH", MAX_LEVEL_AUTHOR_LEN, LoadLevel_AUTH },
1163 { "BODY", -1, LoadLevel_BODY },
1164 { "CONT", -1, LoadLevel_CONT },
1165 { "CNT2", LEVEL_CHUNK_CNT2_SIZE, LoadLevel_CNT2 },
1166 { "CNT3", -1, LoadLevel_CNT3 },
1167 { "CUS1", -1, LoadLevel_CUS1 },
1168 { "CUS2", -1, LoadLevel_CUS2 },
1169 { "CUS3", -1, LoadLevel_CUS3 },
1170 { "CUS4", -1, LoadLevel_CUS4 },
1171 { "GRP1", -1, LoadLevel_GRP1 },
1175 while (getFileChunkBE(file, chunk_name, &chunk_size))
1179 while (chunk_info[i].name != NULL &&
1180 strcmp(chunk_name, chunk_info[i].name) != 0)
1183 if (chunk_info[i].name == NULL)
1185 Error(ERR_WARN, "unknown chunk '%s' in level file '%s'",
1186 chunk_name, filename);
1187 ReadUnusedBytesFromFile(file, chunk_size);
1189 else if (chunk_info[i].size != -1 &&
1190 chunk_info[i].size != chunk_size)
1192 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1193 chunk_size, chunk_name, filename);
1194 ReadUnusedBytesFromFile(file, chunk_size);
1198 /* call function to load this level chunk */
1199 int chunk_size_expected =
1200 (chunk_info[i].loader)(file, chunk_size, level);
1202 /* the size of some chunks cannot be checked before reading other
1203 chunks first (like "HEAD" and "BODY") that contain some header
1204 information, so check them here */
1205 if (chunk_size_expected != chunk_size)
1207 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in level file '%s'",
1208 chunk_size, chunk_name, filename);
1217 /* ------------------------------------------------------------------------- */
1218 /* functions for loading EM level */
1219 /* ------------------------------------------------------------------------- */
1221 static int map_em_element_yam(int element)
1225 case 0x00: return EL_EMPTY;
1226 case 0x01: return EL_EMERALD;
1227 case 0x02: return EL_DIAMOND;
1228 case 0x03: return EL_ROCK;
1229 case 0x04: return EL_ROBOT;
1230 case 0x05: return EL_SPACESHIP_UP;
1231 case 0x06: return EL_BOMB;
1232 case 0x07: return EL_BUG_UP;
1233 case 0x08: return EL_AMOEBA_DROP;
1234 case 0x09: return EL_NUT;
1235 case 0x0a: return EL_YAMYAM;
1236 case 0x0b: return EL_QUICKSAND_FULL;
1237 case 0x0c: return EL_SAND;
1238 case 0x0d: return EL_WALL_SLIPPERY;
1239 case 0x0e: return EL_STEELWALL;
1240 case 0x0f: return EL_WALL;
1241 case 0x10: return EL_EM_KEY_1;
1242 case 0x11: return EL_EM_KEY_2;
1243 case 0x12: return EL_EM_KEY_4;
1244 case 0x13: return EL_EM_KEY_3;
1245 case 0x14: return EL_MAGIC_WALL;
1246 case 0x15: return EL_ROBOT_WHEEL;
1247 case 0x16: return EL_DYNAMITE;
1249 case 0x17: return EL_EM_KEY_1; /* EMC */
1250 case 0x18: return EL_BUG_UP; /* EMC */
1251 case 0x1a: return EL_DIAMOND; /* EMC */
1252 case 0x1b: return EL_EMERALD; /* EMC */
1253 case 0x25: return EL_NUT; /* EMC */
1254 case 0x80: return EL_EMPTY; /* EMC */
1255 case 0x85: return EL_EM_KEY_1; /* EMC */
1256 case 0x86: return EL_EM_KEY_2; /* EMC */
1257 case 0x87: return EL_EM_KEY_4; /* EMC */
1258 case 0x88: return EL_EM_KEY_3; /* EMC */
1259 case 0x94: return EL_QUICKSAND_EMPTY; /* EMC */
1260 case 0x9a: return EL_AMOEBA_WET; /* EMC */
1261 case 0xaf: return EL_DYNAMITE; /* EMC */
1262 case 0xbd: return EL_SAND; /* EMC */
1265 Error(ERR_WARN, "invalid level element %d", element);
1266 return EL_CHAR_QUESTION;
1270 static int map_em_element_field(int element)
1272 if (element >= 0xc8 && element <= 0xe1)
1273 return EL_CHAR_A + (element - 0xc8);
1274 else if (element >= 0xe2 && element <= 0xeb)
1275 return EL_CHAR_0 + (element - 0xe2);
1279 case 0x00: return EL_ROCK;
1280 case 0x02: return EL_DIAMOND;
1281 case 0x03: return EL_DIAMOND;
1282 case 0x04: return EL_ROBOT;
1283 case 0x05: return EL_ROBOT; /* EMC */
1284 case 0x08: return EL_SPACESHIP_UP;
1285 case 0x09: return EL_SPACESHIP_RIGHT;
1286 case 0x0a: return EL_SPACESHIP_DOWN;
1287 case 0x0b: return EL_SPACESHIP_LEFT;
1288 case 0x0c: return EL_SPACESHIP_UP;
1289 case 0x0d: return EL_SPACESHIP_RIGHT;
1290 case 0x0e: return EL_SPACESHIP_DOWN;
1291 case 0x0f: return EL_SPACESHIP_LEFT;
1292 case 0x10: return EL_BOMB;
1293 case 0x12: return EL_EMERALD;
1294 case 0x13: return EL_EMERALD;
1295 case 0x14: return EL_BUG_UP;
1296 case 0x15: return EL_BUG_RIGHT;
1297 case 0x16: return EL_BUG_DOWN;
1298 case 0x17: return EL_BUG_LEFT;
1299 case 0x18: return EL_BUG_UP;
1300 case 0x19: return EL_BUG_RIGHT;
1301 case 0x1a: return EL_BUG_DOWN;
1302 case 0x1b: return EL_BUG_LEFT;
1303 case 0x1c: return EL_AMOEBA_DROP;
1304 case 0x20: return EL_ROCK;
1305 case 0x24: return EL_MAGIC_WALL;
1306 case 0x25: return EL_NUT;
1308 /* looks like magic wheel, but is _always_ activated */
1309 case 0x28: return EL_ROBOT_WHEEL; /* EMC */
1311 case 0x29: return EL_YAMYAM;
1312 case 0x2a: return EL_YAMYAM;
1313 case 0x2b: return EL_YAMYAM; /* EMC */
1314 case 0x2c: return EL_YAMYAM; /* EMC */
1315 case 0x2d: return EL_QUICKSAND_FULL;
1316 case 0x39: return EL_EXPANDABLE_WALL_HORIZONTAL; /* EMC */
1317 case 0x3a: return EL_EXPANDABLE_WALL_VERTICAL; /* EMC */
1318 case 0x3b: return EL_DYNAMITE_ACTIVE;
1319 case 0x3c: return EL_DYNAMITE_ACTIVE;
1320 case 0x3d: return EL_DYNAMITE_ACTIVE;
1321 case 0x3e: return EL_DYNAMITE_ACTIVE;
1322 case 0x3f: return EL_ACID_POOL_BOTTOM;
1323 case 0x40: return EL_EXIT_OPEN;
1324 case 0x41: return EL_EXIT_OPEN;
1325 case 0x42: return EL_EXIT_OPEN;
1326 case 0x43: return EL_BALLOON;
1327 case 0x4e: return EL_INVISIBLE_WALL;
1328 case 0x65: return EL_ACID; /* EMC */
1329 case 0x73: return EL_SAND; /* EMC */
1330 case 0x74: return EL_STEELWALL;
1331 case 0x7b: return EL_ACID;
1332 case 0x80: return EL_EMPTY;
1333 case 0x81: return EL_WALL_SLIPPERY;
1334 case 0x82: return EL_SAND;
1335 case 0x83: return EL_STEELWALL;
1336 case 0x84: return EL_WALL;
1337 case 0x85: return EL_EM_KEY_1;
1338 case 0x86: return EL_EM_KEY_2;
1339 case 0x87: return EL_EM_KEY_4;
1340 case 0x88: return EL_EM_KEY_3;
1341 case 0x89: return EL_EM_GATE_1;
1342 case 0x8a: return EL_EM_GATE_2;
1343 case 0x8b: return EL_EM_GATE_4;
1344 case 0x8c: return EL_EM_GATE_3;
1345 case 0x8d: return EL_INVISIBLE_WALL; /* EMC */
1346 case 0x8e: return EL_EM_GATE_1_GRAY;
1347 case 0x8f: return EL_EM_GATE_2_GRAY;
1348 case 0x90: return EL_EM_GATE_4_GRAY;
1349 case 0x91: return EL_EM_GATE_3_GRAY;
1350 case 0x92: return EL_MAGIC_WALL;
1351 case 0x94: return EL_QUICKSAND_EMPTY;
1352 case 0x95: return EL_ACID_POOL_TOPLEFT;
1353 case 0x96: return EL_ACID_POOL_TOPRIGHT;
1354 case 0x97: return EL_ACID_POOL_BOTTOMLEFT;
1355 case 0x98: return EL_ACID_POOL_BOTTOMRIGHT;
1356 case 0x99: return EL_ACID;
1357 case 0x9a: return EL_AMOEBA_DEAD;
1358 case 0x9b: return EL_AMOEBA_DEAD;
1359 case 0x9c: return EL_AMOEBA_DEAD;
1360 case 0x9d: return EL_AMOEBA_DEAD;
1361 case 0x9e: return EL_EXIT_CLOSED;
1362 case 0x9f: return EL_CHAR_LESS; /* EMC */
1363 case 0x93: return EL_ROBOT_WHEEL;
1365 /* looks like normal dust, but behaves like wall */
1366 case 0xa0: return EL_WALL; /* EMC */
1368 case 0xa8: return EL_EMC_WALL_1; /* EMC */
1369 case 0xa9: return EL_EMC_WALL_2; /* EMC */
1370 case 0xaa: return EL_EMC_WALL_3; /* EMC */
1371 case 0xab: return EL_EMC_WALL_7; /* EMC */
1372 case 0xae: return EL_CHAR_MINUS; /* EMC */
1373 case 0xaf: return EL_DYNAMITE;
1374 case 0xb0: return EL_EMC_STEELWALL_1; /* EMC */
1375 case 0xb1: return EL_EMC_WALL_8; /* EMC */
1377 /* (exact steel wall) */
1378 case 0xb3: return EL_STEELWALL; /* EMC */
1380 case 0xb4: return EL_WALL_SLIPPERY; /* EMC */
1381 case 0xb5: return EL_EMC_WALL_6; /* EMC */
1382 case 0xb6: return EL_EMC_WALL_5; /* EMC */
1383 case 0xb7: return EL_EMC_WALL_4; /* EMC */
1384 case 0xb8: return EL_BALLOON_SWITCH_ANY; /* EMC */
1385 case 0xb9: return EL_BALLOON_SWITCH_RIGHT; /* EMC */
1386 case 0xba: return EL_BALLOON_SWITCH_DOWN; /* EMC */
1387 case 0xbb: return EL_BALLOON_SWITCH_LEFT; /* EMC */
1388 case 0xbc: return EL_BALLOON_SWITCH_UP; /* EMC */
1389 case 0xbd: return EL_SAND; /* EMC */
1390 case 0xec: return EL_CHAR_PERIOD;
1391 case 0xed: return EL_CHAR_EXCLAM;
1392 case 0xee: return EL_CHAR_COLON;
1393 case 0xef: return EL_CHAR_QUESTION;
1394 case 0xf0: return EL_CHAR_GREATER;
1395 case 0xf1: return EL_CHAR_COPYRIGHT;
1396 case 0xfe: return EL_PLAYER_1;
1397 case 0xff: return EL_PLAYER_2;
1400 Error(ERR_WARN, "invalid level element %d", element);
1401 return EL_CHAR_QUESTION;
1405 #define EM_LEVEL_SIZE 2106
1406 #define EM_LEVEL_XSIZE 64
1407 #define EM_LEVEL_YSIZE 32
1409 static void LoadLevelFromFileInfo_EM(struct LevelInfo *level,
1410 struct LevelFileInfo *level_file_info)
1412 char *filename = level_file_info->filename;
1414 unsigned char leveldata[EM_LEVEL_SIZE];
1415 unsigned char *header = &leveldata[EM_LEVEL_XSIZE * EM_LEVEL_YSIZE];
1416 unsigned char code0 = 0x65;
1417 unsigned char code1 = 0x11;
1418 boolean level_is_crypted = FALSE;
1419 int nr = level_file_info->nr;
1422 if (!(file = fopen(filename, MODE_READ)))
1424 level->no_level_file = TRUE;
1426 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1431 for(i = 0; i < EM_LEVEL_SIZE; i++)
1432 leveldata[i] = fgetc(file);
1436 /* check if level data is crypted by testing against known starting bytes
1437 of the few existing crypted level files (from Emerald Mine 1 + 2) */
1439 if ((leveldata[0] == 0xf1 ||
1440 leveldata[0] == 0xf5) && leveldata[2] == 0xe7 && leveldata[3] == 0xee)
1442 level_is_crypted = TRUE;
1444 if (leveldata[0] == 0xf5) /* error in crypted Emerald Mine 2 levels */
1445 leveldata[0] = 0xf1;
1448 if (level_is_crypted) /* decode crypted level data */
1450 for(i = 0; i < EM_LEVEL_SIZE; i++)
1452 leveldata[i] ^= code0;
1453 leveldata[i] -= code1;
1455 code0 = (code0 + 7) & 0xff;
1459 level->fieldx = EM_LEVEL_XSIZE;
1460 level->fieldy = EM_LEVEL_YSIZE;
1462 level->time = header[46] * 10;
1463 level->gems_needed = header[47];
1465 /* The original Emerald Mine levels have their level number stored
1466 at the second byte of the level file...
1467 Do not trust this information at other level files, e.g. EMC,
1468 but correct it anyway (normally the first row is completely
1469 steel wall, so the correction does not hurt anyway). */
1471 if (leveldata[1] == nr)
1472 leveldata[1] = leveldata[2]; /* correct level number field */
1474 sprintf(level->name, "Level %d", nr); /* set level name */
1476 level->score[SC_EMERALD] = header[36];
1477 level->score[SC_DIAMOND] = header[37];
1478 level->score[SC_ROBOT] = header[38];
1479 level->score[SC_SPACESHIP] = header[39];
1480 level->score[SC_BUG] = header[40];
1481 level->score[SC_YAMYAM] = header[41];
1482 level->score[SC_NUT] = header[42];
1483 level->score[SC_DYNAMITE] = header[43];
1484 level->score[SC_TIME_BONUS] = header[44];
1486 level->num_yamyam_contents = 4;
1488 for(i = 0; i < level->num_yamyam_contents; i++)
1489 for(y = 0; y < 3; y++)
1490 for(x = 0; x < 3; x++)
1491 level->yamyam_content[i][x][y] =
1492 map_em_element_yam(header[i * 9 + y * 3 + x]);
1494 level->amoeba_speed = (header[52] * 256 + header[53]) % 256;
1495 level->time_magic_wall = (header[54] * 256 + header[55]) * 16 / 100;
1496 level->time_wheel = (header[56] * 256 + header[57]) * 16 / 100;
1497 level->amoeba_content = EL_DIAMOND;
1499 for (y = 0; y < level->fieldy; y++) for (x = 0; x < level->fieldx; x++)
1501 int new_element = map_em_element_field(leveldata[y * EM_LEVEL_XSIZE + x]);
1503 if (new_element == EL_AMOEBA_DEAD && level->amoeba_speed)
1504 new_element = EL_AMOEBA_WET;
1506 level->field[x][y] = new_element;
1509 x = (header[48] * 256 + header[49]) % EM_LEVEL_XSIZE;
1510 y = (header[48] * 256 + header[49]) / EM_LEVEL_XSIZE;
1511 level->field[x][y] = EL_PLAYER_1;
1513 x = (header[50] * 256 + header[51]) % EM_LEVEL_XSIZE;
1514 y = (header[50] * 256 + header[51]) / EM_LEVEL_XSIZE;
1515 level->field[x][y] = EL_PLAYER_2;
1518 /* ------------------------------------------------------------------------- */
1519 /* functions for loading SP level */
1520 /* ------------------------------------------------------------------------- */
1522 #define NUM_SUPAPLEX_LEVELS_PER_PACKAGE 111
1523 #define SP_LEVEL_SIZE 1536
1524 #define SP_LEVEL_XSIZE 60
1525 #define SP_LEVEL_YSIZE 24
1526 #define SP_LEVEL_NAME_LEN 23
1528 static void LoadLevelFromFileStream_SP(FILE *file, struct LevelInfo *level,
1533 /* read level body (width * height == 60 * 24 tiles == 1440 bytes) */
1534 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1536 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1538 int element_old = fgetc(file);
1541 if (element_old <= 0x27)
1542 element_new = getMappedElement(EL_SP_START + element_old);
1543 else if (element_old == 0x28)
1544 element_new = EL_INVISIBLE_WALL;
1547 Error(ERR_WARN, "in level %d, at position %d, %d:", nr, x, y);
1548 Error(ERR_WARN, "invalid level element %d", element_old);
1550 element_new = EL_CHAR_QUESTION;
1553 level->field[x][y] = element_new;
1557 ReadUnusedBytesFromFile(file, 4);
1559 /* Initial gravitation: 1 == "on", anything else (0) == "off" */
1560 level->initial_gravity = (fgetc(file) == 1 ? TRUE : FALSE);
1562 ReadUnusedBytesFromFile(file, 1);
1564 /* level title in uppercase letters, padded with dashes ("-") (23 bytes) */
1565 for (i = 0; i < SP_LEVEL_NAME_LEN; i++)
1566 level->name[i] = fgetc(file);
1567 level->name[SP_LEVEL_NAME_LEN] = '\0';
1569 /* initial "freeze zonks": 2 == "on", anything else (0) == "off" */
1570 ReadUnusedBytesFromFile(file, 1); /* !!! NOT SUPPORTED YET !!! */
1572 /* number of infotrons needed; 0 means that Supaplex will count the total
1573 amount of infotrons in the level and use the low byte of that number.
1574 (a multiple of 256 infotrons will result in "0 infotrons needed"!) */
1575 level->gems_needed = fgetc(file);
1577 /* information about special gravity port entries */
1578 ReadUnusedBytesFromFile(file, 65); /* !!! NOT SUPPORTED YET !!! */
1580 level->fieldx = SP_LEVEL_XSIZE;
1581 level->fieldy = SP_LEVEL_YSIZE;
1583 level->time = 0; /* no time limit */
1584 level->amoeba_speed = 0;
1585 level->time_magic_wall = 0;
1586 level->time_wheel = 0;
1587 level->amoeba_content = EL_EMPTY;
1589 for(i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
1590 level->score[i] = 0; /* !!! CORRECT THIS !!! */
1592 /* there are no yamyams in supaplex levels */
1593 for(i = 0; i < level->num_yamyam_contents; i++)
1594 for(y = 0; y < 3; y++)
1595 for(x = 0; x < 3; x++)
1596 level->yamyam_content[i][x][y] = EL_EMPTY;
1599 static void LoadLevelFromFileInfo_SP(struct LevelInfo *level,
1600 struct LevelFileInfo *level_file_info)
1602 char *filename = level_file_info->filename;
1604 int nr = level_file_info->nr - leveldir_current->first_level;
1606 char name_first, name_last;
1607 struct LevelInfo multipart_level;
1608 int multipart_xpos, multipart_ypos;
1609 boolean is_multipart_level;
1610 boolean is_first_part;
1611 boolean reading_multipart_level = FALSE;
1612 boolean use_empty_level = FALSE;
1614 if (!(file = fopen(filename, MODE_READ)))
1616 level->no_level_file = TRUE;
1618 Error(ERR_WARN, "cannot read level '%s' -- using empty level", filename);
1623 /* position file stream to the requested level inside the level package */
1624 if (fseek(file, nr * SP_LEVEL_SIZE, SEEK_SET) != 0)
1626 level->no_level_file = TRUE;
1628 Error(ERR_WARN, "cannot fseek level '%s' -- using empty level", filename);
1633 /* there exist Supaplex level package files with multi-part levels which
1634 can be detected as follows: instead of leading and trailing dashes ('-')
1635 to pad the level name, they have leading and trailing numbers which are
1636 the x and y coordinations of the current part of the multi-part level;
1637 if there are '?' characters instead of numbers on the left or right side
1638 of the level name, the multi-part level consists of only horizontal or
1641 for (l = nr; l < NUM_SUPAPLEX_LEVELS_PER_PACKAGE; l++)
1643 LoadLevelFromFileStream_SP(file, level, l);
1645 /* check if this level is a part of a bigger multi-part level */
1647 name_first = level->name[0];
1648 name_last = level->name[SP_LEVEL_NAME_LEN - 1];
1650 is_multipart_level =
1651 ((name_first == '?' || (name_first >= '0' && name_first <= '9')) &&
1652 (name_last == '?' || (name_last >= '0' && name_last <= '9')));
1655 ((name_first == '?' || name_first == '1') &&
1656 (name_last == '?' || name_last == '1'));
1658 /* correct leading multipart level meta information in level name */
1659 for (i = 0; i < SP_LEVEL_NAME_LEN && level->name[i] == name_first; i++)
1660 level->name[i] = '-';
1662 /* correct trailing multipart level meta information in level name */
1663 for (i = SP_LEVEL_NAME_LEN - 1; i>=0 && level->name[i] == name_last; i--)
1664 level->name[i] = '-';
1666 /* ---------- check for normal single level ---------- */
1668 if (!reading_multipart_level && !is_multipart_level)
1670 /* the current level is simply a normal single-part level, and we are
1671 not reading a multi-part level yet, so return the level as it is */
1676 /* ---------- check for empty level (unused multi-part) ---------- */
1678 if (!reading_multipart_level && is_multipart_level && !is_first_part)
1680 /* this is a part of a multi-part level, but not the first part
1681 (and we are not already reading parts of a multi-part level);
1682 in this case, use an empty level instead of the single part */
1684 use_empty_level = TRUE;
1689 /* ---------- check for finished multi-part level ---------- */
1691 if (reading_multipart_level &&
1692 (!is_multipart_level ||
1693 strcmp(level->name, multipart_level.name) != 0))
1695 /* we are already reading parts of a multi-part level, but this level is
1696 either not a multi-part level, or a part of a different multi-part
1697 level; in both cases, the multi-part level seems to be complete */
1702 /* ---------- here we have one part of a multi-part level ---------- */
1704 reading_multipart_level = TRUE;
1706 if (is_first_part) /* start with first part of new multi-part level */
1708 /* copy level info structure from first part */
1709 multipart_level = *level;
1711 /* clear playfield of new multi-part level */
1712 for (y = 0; y < MAX_LEV_FIELDY; y++)
1713 for (x = 0; x < MAX_LEV_FIELDX; x++)
1714 multipart_level.field[x][y] = EL_EMPTY;
1717 if (name_first == '?')
1719 if (name_last == '?')
1722 multipart_xpos = (int)(name_first - '0');
1723 multipart_ypos = (int)(name_last - '0');
1726 printf("----------> part (%d/%d) of multi-part level '%s'\n",
1727 multipart_xpos, multipart_ypos, multipart_level.name);
1730 if (multipart_xpos * SP_LEVEL_XSIZE > MAX_LEV_FIELDX ||
1731 multipart_ypos * SP_LEVEL_YSIZE > MAX_LEV_FIELDY)
1733 Error(ERR_WARN, "multi-part level is too big -- ignoring part of it");
1738 multipart_level.fieldx = MAX(multipart_level.fieldx,
1739 multipart_xpos * SP_LEVEL_XSIZE);
1740 multipart_level.fieldy = MAX(multipart_level.fieldy,
1741 multipart_ypos * SP_LEVEL_YSIZE);
1743 /* copy level part at the right position of multi-part level */
1744 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1746 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1748 int start_x = (multipart_xpos - 1) * SP_LEVEL_XSIZE;
1749 int start_y = (multipart_ypos - 1) * SP_LEVEL_YSIZE;
1751 multipart_level.field[start_x + x][start_y + y] = level->field[x][y];
1758 if (use_empty_level)
1760 setLevelInfoToDefaults(level);
1762 level->fieldx = SP_LEVEL_XSIZE;
1763 level->fieldy = SP_LEVEL_YSIZE;
1765 for (y = 0; y < SP_LEVEL_YSIZE; y++)
1766 for (x = 0; x < SP_LEVEL_XSIZE; x++)
1767 level->field[x][y] = EL_EMPTY;
1769 strcpy(level->name, "-------- EMPTY --------");
1771 Error(ERR_WARN, "single part of multi-part level -- using empty level");
1774 if (reading_multipart_level)
1775 *level = multipart_level;
1778 /* ------------------------------------------------------------------------- */
1779 /* functions for loading generic level */
1780 /* ------------------------------------------------------------------------- */
1782 void LoadLevelFromFileInfo(struct LevelInfo *level,
1783 struct LevelFileInfo *level_file_info)
1785 /* always start with reliable default values */
1786 setLevelInfoToDefaults(level);
1788 switch (level_file_info->type)
1790 case LEVEL_FILE_TYPE_RND:
1791 LoadLevelFromFileInfo_RND(level, level_file_info);
1794 case LEVEL_FILE_TYPE_EM:
1795 LoadLevelFromFileInfo_EM(level, level_file_info);
1798 case LEVEL_FILE_TYPE_SP:
1799 LoadLevelFromFileInfo_SP(level, level_file_info);
1803 LoadLevelFromFileInfo_RND(level, level_file_info);
1808 void LoadLevelFromFilename(struct LevelInfo *level, char *filename)
1810 static struct LevelFileInfo level_file_info;
1812 /* always start with reliable default values */
1813 setFileInfoToDefaults(&level_file_info);
1815 level_file_info.nr = 0; /* unknown level number */
1816 level_file_info.type = LEVEL_FILE_TYPE_RND; /* no others supported yet */
1817 level_file_info.filename = filename;
1819 LoadLevelFromFileInfo(level, &level_file_info);
1822 static void LoadLevel_InitVersion(struct LevelInfo *level, char *filename)
1824 if (leveldir_current == NULL) /* only when dumping level */
1828 printf("::: sort_priority: %d\n", leveldir_current->sort_priority);
1831 /* determine correct game engine version of current level */
1833 if (!leveldir_current->latest_engine)
1835 if (IS_LEVELCLASS_CONTRIB(leveldir_current) ||
1836 IS_LEVELCLASS_PRIVATE(leveldir_current) ||
1837 IS_LEVELCLASS_UNDEFINED(leveldir_current))
1841 printf("\n::: This level is private or contributed: '%s'\n", filename);
1845 printf("\n::: Use the stored game engine version for this level\n");
1848 /* For all levels which are not forced to use the latest game engine
1849 version (normally user contributed, private and undefined levels),
1850 use the version of the game engine the levels were created for.
1852 Since 2.0.1, the game engine version is now directly stored
1853 in the level file (chunk "VERS"), so there is no need anymore
1854 to set the game version from the file version (except for old,
1855 pre-2.0 levels, where the game version is still taken from the
1856 file format version used to store the level -- see above). */
1858 /* do some special adjustments to support older level versions */
1859 if (level->file_version == FILE_VERSION_1_0)
1861 Error(ERR_WARN, "level file '%s' has version number 1.0", filename);
1862 Error(ERR_WARN, "using high speed movement for player");
1864 /* player was faster than monsters in (pre-)1.0 levels */
1865 level->double_speed = TRUE;
1868 /* Default behaviour for EM style gems was "slippery" only in 2.0.1 */
1869 if (level->game_version == VERSION_IDENT(2,0,1,0))
1870 level->em_slippery_gems = TRUE;
1875 printf("\n::: ALWAYS USE LATEST ENGINE FOR THIS LEVEL: [%d] '%s'\n",
1876 leveldir_current->sort_priority, filename);
1880 printf("\n::: Use latest game engine version for this level.\n");
1883 /* For all levels which are forced to use the latest game engine version
1884 (normally all but user contributed, private and undefined levels), set
1885 the game engine version to the actual version; this allows for actual
1886 corrections in the game engine to take effect for existing, converted
1887 levels (from "classic" or other existing games) to make the emulation
1888 of the corresponding game more accurate, while (hopefully) not breaking
1889 existing levels created from other players. */
1892 printf("::: changing engine from %d to %d\n",
1893 level->game_version, GAME_VERSION_ACTUAL);
1896 level->game_version = GAME_VERSION_ACTUAL;
1898 /* Set special EM style gems behaviour: EM style gems slip down from
1899 normal, steel and growing wall. As this is a more fundamental change,
1900 it seems better to set the default behaviour to "off" (as it is more
1901 natural) and make it configurable in the level editor (as a property
1902 of gem style elements). Already existing converted levels (neither
1903 private nor contributed levels) are changed to the new behaviour. */
1905 if (level->file_version < FILE_VERSION_2_0)
1906 level->em_slippery_gems = TRUE;
1910 printf("::: => %d\n", level->game_version);
1914 static void LoadLevel_InitElements(struct LevelInfo *level, char *filename)
1918 /* map custom element change events that have changed in newer versions
1919 (these following values were accidentally changed in version 3.0.1) */
1920 if (level->game_version <= VERSION_IDENT(3,0,0,0))
1922 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1924 int element = EL_CUSTOM_START + i;
1926 /* order of checking and copying events to be mapped is important */
1927 for (j = CE_BY_OTHER_ACTION; j >= CE_BY_PLAYER_OBSOLETE; j--)
1929 if (HAS_CHANGE_EVENT(element, j - 2))
1931 SET_CHANGE_EVENT(element, j - 2, FALSE);
1932 SET_CHANGE_EVENT(element, j, TRUE);
1936 /* order of checking and copying events to be mapped is important */
1937 for (j = CE_OTHER_GETS_COLLECTED; j >= CE_HITTING_SOMETHING; j--)
1939 if (HAS_CHANGE_EVENT(element, j - 1))
1941 SET_CHANGE_EVENT(element, j - 1, FALSE);
1942 SET_CHANGE_EVENT(element, j, TRUE);
1948 /* some custom element change events get mapped since version 3.0.3 */
1949 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1951 int element = EL_CUSTOM_START + i;
1953 if (HAS_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE) ||
1954 HAS_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE))
1956 SET_CHANGE_EVENT(element, CE_BY_PLAYER_OBSOLETE, FALSE);
1957 SET_CHANGE_EVENT(element, CE_BY_COLLISION_OBSOLETE, FALSE);
1959 SET_CHANGE_EVENT(element, CE_BY_DIRECT_ACTION, TRUE);
1963 /* initialize "can_change" field for old levels with only one change page */
1964 if (level->game_version <= VERSION_IDENT(3,0,2,0))
1966 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1968 int element = EL_CUSTOM_START + i;
1970 if (CAN_CHANGE(element))
1971 element_info[element].change->can_change = TRUE;
1976 /* set default push delay values (corrected since version 3.0.7-1) */
1977 if (level->game_version < VERSION_IDENT(3,0,7,1))
1979 game.default_push_delay_fixed = 2;
1980 game.default_push_delay_random = 8;
1984 game.default_push_delay_fixed = 8;
1985 game.default_push_delay_random = 8;
1988 /* set uninitialized push delay values of custom elements in older levels */
1989 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
1991 int element = EL_CUSTOM_START + i;
1993 if (element_info[element].push_delay_fixed == -1)
1994 element_info[element].push_delay_fixed = game.default_push_delay_fixed;
1995 if (element_info[element].push_delay_random == -1)
1996 element_info[element].push_delay_random = game.default_push_delay_random;
2000 /* initialize element properties for level editor etc. */
2001 InitElementPropertiesEngine(level->game_version);
2004 static void LoadLevel_InitPlayfield(struct LevelInfo *level, char *filename)
2008 /* map elements that have changed in newer versions */
2009 for (y = 0; y < level->fieldy; y++)
2011 for (x = 0; x < level->fieldx; x++)
2013 int element = level->field[x][y];
2015 if (level->game_version <= VERSION_IDENT(2,2,0,0))
2017 /* map game font elements */
2018 element = (element == EL_CHAR('[') ? EL_CHAR_AUMLAUT :
2019 element == EL_CHAR('\\') ? EL_CHAR_OUMLAUT :
2020 element == EL_CHAR(']') ? EL_CHAR_UUMLAUT :
2021 element == EL_CHAR('^') ? EL_CHAR_COPYRIGHT : element);
2024 if (level->game_version < VERSION_IDENT(3,0,0,0))
2026 /* map Supaplex gravity tube elements */
2027 element = (element == EL_SP_GRAVITY_PORT_LEFT ? EL_SP_PORT_LEFT :
2028 element == EL_SP_GRAVITY_PORT_RIGHT ? EL_SP_PORT_RIGHT :
2029 element == EL_SP_GRAVITY_PORT_UP ? EL_SP_PORT_UP :
2030 element == EL_SP_GRAVITY_PORT_DOWN ? EL_SP_PORT_DOWN :
2034 level->field[x][y] = element;
2038 /* copy elements to runtime playfield array */
2039 for (x = 0; x < MAX_LEV_FIELDX; x++)
2040 for (y = 0; y < MAX_LEV_FIELDY; y++)
2041 Feld[x][y] = level->field[x][y];
2043 /* initialize level size variables for faster access */
2044 lev_fieldx = level->fieldx;
2045 lev_fieldy = level->fieldy;
2047 /* determine border element for this level */
2051 void LoadLevelTemplate(int nr)
2054 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2055 char *filename = level_file_info->filename;
2057 LoadLevelFromFileInfo(&level_template, level_file_info);
2059 char *filename = getDefaultLevelFilename(nr);
2061 LoadLevelFromFilename_RND(&level_template, filename);
2064 LoadLevel_InitVersion(&level, filename);
2065 LoadLevel_InitElements(&level, filename);
2067 ActivateLevelTemplate();
2070 void LoadLevel(int nr)
2073 struct LevelFileInfo *level_file_info = getLevelFileInfo(nr);
2074 char *filename = level_file_info->filename;
2076 LoadLevelFromFileInfo(&level, level_file_info);
2078 char *filename = getLevelFilename(nr);
2080 LoadLevelFromFilename_RND(&level, filename);
2083 if (level.use_custom_template)
2084 LoadLevelTemplate(-1);
2087 LoadLevel_InitVersion(&level, filename);
2088 LoadLevel_InitElements(&level, filename);
2089 LoadLevel_InitPlayfield(&level, filename);
2091 LoadLevel_InitLevel(&level, filename);
2095 static void SaveLevel_VERS(FILE *file, struct LevelInfo *level)
2097 putFileVersion(file, level->file_version);
2098 putFileVersion(file, level->game_version);
2101 static void SaveLevel_HEAD(FILE *file, struct LevelInfo *level)
2105 putFile8Bit(file, level->fieldx);
2106 putFile8Bit(file, level->fieldy);
2108 putFile16BitBE(file, level->time);
2109 putFile16BitBE(file, level->gems_needed);
2111 for (i = 0; i < MAX_LEVEL_NAME_LEN; i++)
2112 putFile8Bit(file, level->name[i]);
2114 for (i = 0; i < LEVEL_SCORE_ELEMENTS; i++)
2115 putFile8Bit(file, level->score[i]);
2117 for (i = 0; i < STD_ELEMENT_CONTENTS; i++)
2118 for (y = 0; y < 3; y++)
2119 for (x = 0; x < 3; x++)
2120 putFile8Bit(file, (level->encoding_16bit_yamyam ? EL_EMPTY :
2121 level->yamyam_content[i][x][y]));
2122 putFile8Bit(file, level->amoeba_speed);
2123 putFile8Bit(file, level->time_magic_wall);
2124 putFile8Bit(file, level->time_wheel);
2125 putFile8Bit(file, (level->encoding_16bit_amoeba ? EL_EMPTY :
2126 level->amoeba_content));
2127 putFile8Bit(file, (level->double_speed ? 1 : 0));
2128 putFile8Bit(file, (level->initial_gravity ? 1 : 0));
2129 putFile8Bit(file, (level->encoding_16bit_field ? 1 : 0));
2130 putFile8Bit(file, (level->em_slippery_gems ? 1 : 0));
2132 putFile8Bit(file, (level->use_custom_template ? 1 : 0));
2134 WriteUnusedBytesToFile(file, LEVEL_HEADER_UNUSED);
2137 static void SaveLevel_AUTH(FILE *file, struct LevelInfo *level)
2141 for (i = 0; i < MAX_LEVEL_AUTHOR_LEN; i++)
2142 putFile8Bit(file, level->author[i]);
2145 static void SaveLevel_BODY(FILE *file, struct LevelInfo *level)
2149 for (y = 0; y < level->fieldy; y++)
2150 for (x = 0; x < level->fieldx; x++)
2151 if (level->encoding_16bit_field)
2152 putFile16BitBE(file, level->field[x][y]);
2154 putFile8Bit(file, level->field[x][y]);
2158 static void SaveLevel_CONT(FILE *file, struct LevelInfo *level)
2162 putFile8Bit(file, EL_YAMYAM);
2163 putFile8Bit(file, level->num_yamyam_contents);
2164 putFile8Bit(file, 0);
2165 putFile8Bit(file, 0);
2167 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2168 for (y = 0; y < 3; y++)
2169 for (x = 0; x < 3; x++)
2170 if (level->encoding_16bit_field)
2171 putFile16BitBE(file, level->yamyam_content[i][x][y]);
2173 putFile8Bit(file, level->yamyam_content[i][x][y]);
2177 static void SaveLevel_CNT2(FILE *file, struct LevelInfo *level, int element)
2180 int num_contents, content_xsize, content_ysize;
2181 int content_array[MAX_ELEMENT_CONTENTS][3][3];
2183 if (element == EL_YAMYAM)
2185 num_contents = level->num_yamyam_contents;
2189 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2190 for (y = 0; y < 3; y++)
2191 for (x = 0; x < 3; x++)
2192 content_array[i][x][y] = level->yamyam_content[i][x][y];
2194 else if (element == EL_BD_AMOEBA)
2200 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2201 for (y = 0; y < 3; y++)
2202 for (x = 0; x < 3; x++)
2203 content_array[i][x][y] = EL_EMPTY;
2204 content_array[0][0][0] = level->amoeba_content;
2208 /* chunk header already written -- write empty chunk data */
2209 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_SIZE);
2211 Error(ERR_WARN, "cannot save content for element '%d'", element);
2215 putFile16BitBE(file, element);
2216 putFile8Bit(file, num_contents);
2217 putFile8Bit(file, content_xsize);
2218 putFile8Bit(file, content_ysize);
2220 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT2_UNUSED);
2222 for (i = 0; i < MAX_ELEMENT_CONTENTS; i++)
2223 for (y = 0; y < 3; y++)
2224 for (x = 0; x < 3; x++)
2225 putFile16BitBE(file, content_array[i][x][y]);
2228 static void SaveLevel_CNT3(FILE *file, struct LevelInfo *level, int element)
2231 int envelope_nr = element - EL_ENVELOPE_1;
2232 int envelope_len = strlen(level->envelope_text[envelope_nr]) + 1;
2234 putFile16BitBE(file, element);
2235 putFile16BitBE(file, envelope_len);
2236 putFile8Bit(file, level->envelope_xsize[envelope_nr]);
2237 putFile8Bit(file, level->envelope_ysize[envelope_nr]);
2239 WriteUnusedBytesToFile(file, LEVEL_CHUNK_CNT3_UNUSED);
2241 for (i = 0; i < envelope_len; i++)
2242 putFile8Bit(file, level->envelope_text[envelope_nr][i]);
2246 static void SaveLevel_CUS1(FILE *file, struct LevelInfo *level,
2247 int num_changed_custom_elements)
2251 putFile16BitBE(file, num_changed_custom_elements);
2253 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2255 int element = EL_CUSTOM_START + i;
2257 if (Properties[element][EP_BITFIELD_BASE] != EP_BITMASK_DEFAULT)
2259 if (check < num_changed_custom_elements)
2261 putFile16BitBE(file, element);
2262 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2269 if (check != num_changed_custom_elements) /* should not happen */
2270 Error(ERR_WARN, "inconsistent number of custom element properties");
2275 static void SaveLevel_CUS2(FILE *file, struct LevelInfo *level,
2276 int num_changed_custom_elements)
2280 putFile16BitBE(file, num_changed_custom_elements);
2282 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2284 int element = EL_CUSTOM_START + i;
2286 if (element_info[element].change->target_element != EL_EMPTY_SPACE)
2288 if (check < num_changed_custom_elements)
2290 putFile16BitBE(file, element);
2291 putFile16BitBE(file, element_info[element].change->target_element);
2298 if (check != num_changed_custom_elements) /* should not happen */
2299 Error(ERR_WARN, "inconsistent number of custom target elements");
2304 static void SaveLevel_CUS3(FILE *file, struct LevelInfo *level,
2305 int num_changed_custom_elements)
2307 int i, j, x, y, check = 0;
2309 putFile16BitBE(file, num_changed_custom_elements);
2311 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2313 int element = EL_CUSTOM_START + i;
2315 if (element_info[element].modified_settings)
2317 if (check < num_changed_custom_elements)
2319 putFile16BitBE(file, element);
2321 for (j = 0; j < MAX_ELEMENT_NAME_LEN; j++)
2322 putFile8Bit(file, element_info[element].description[j]);
2324 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2326 /* some free bytes for future properties and padding */
2327 WriteUnusedBytesToFile(file, 7);
2329 putFile8Bit(file, element_info[element].use_gfx_element);
2330 putFile16BitBE(file, element_info[element].gfx_element);
2332 putFile8Bit(file, element_info[element].collect_score);
2333 putFile8Bit(file, element_info[element].collect_count);
2335 putFile16BitBE(file, element_info[element].push_delay_fixed);
2336 putFile16BitBE(file, element_info[element].push_delay_random);
2337 putFile16BitBE(file, element_info[element].move_delay_fixed);
2338 putFile16BitBE(file, element_info[element].move_delay_random);
2340 putFile16BitBE(file, element_info[element].move_pattern);
2341 putFile8Bit(file, element_info[element].move_direction_initial);
2342 putFile8Bit(file, element_info[element].move_stepsize);
2344 for (y = 0; y < 3; y++)
2345 for (x = 0; x < 3; x++)
2346 putFile16BitBE(file, element_info[element].content[x][y]);
2348 putFile32BitBE(file, element_info[element].change->events);
2350 putFile16BitBE(file, element_info[element].change->target_element);
2352 putFile16BitBE(file, element_info[element].change->delay_fixed);
2353 putFile16BitBE(file, element_info[element].change->delay_random);
2354 putFile16BitBE(file, element_info[element].change->delay_frames);
2356 putFile16BitBE(file, element_info[element].change->trigger_element);
2358 putFile8Bit(file, element_info[element].change->explode);
2359 putFile8Bit(file, element_info[element].change->use_content);
2360 putFile8Bit(file, element_info[element].change->only_complete);
2361 putFile8Bit(file, element_info[element].change->use_random_change);
2363 putFile8Bit(file, element_info[element].change->random);
2364 putFile8Bit(file, element_info[element].change->power);
2366 for (y = 0; y < 3; y++)
2367 for (x = 0; x < 3; x++)
2368 putFile16BitBE(file, element_info[element].change->content[x][y]);
2370 putFile8Bit(file, element_info[element].slippery_type);
2372 /* some free bytes for future properties and padding */
2373 WriteUnusedBytesToFile(file, LEVEL_CPART_CUS3_UNUSED);
2380 if (check != num_changed_custom_elements) /* should not happen */
2381 Error(ERR_WARN, "inconsistent number of custom element properties");
2385 static void SaveLevel_CUS4(FILE *file, struct LevelInfo *level, int element)
2387 struct ElementInfo *ei = &element_info[element];
2390 putFile16BitBE(file, element);
2392 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2393 putFile8Bit(file, ei->description[i]);
2395 putFile32BitBE(file, Properties[element][EP_BITFIELD_BASE]);
2396 WriteUnusedBytesToFile(file, 4); /* reserved for more base properties */
2398 putFile8Bit(file, ei->num_change_pages);
2400 /* some free bytes for future base property values and padding */
2401 WriteUnusedBytesToFile(file, 5);
2403 /* write custom property values */
2405 putFile8Bit(file, ei->use_gfx_element);
2406 putFile16BitBE(file, ei->gfx_element);
2408 putFile8Bit(file, ei->collect_score);
2409 putFile8Bit(file, ei->collect_count);
2411 putFile16BitBE(file, ei->push_delay_fixed);
2412 putFile16BitBE(file, ei->push_delay_random);
2413 putFile16BitBE(file, ei->move_delay_fixed);
2414 putFile16BitBE(file, ei->move_delay_random);
2416 putFile16BitBE(file, ei->move_pattern);
2417 putFile8Bit(file, ei->move_direction_initial);
2418 putFile8Bit(file, ei->move_stepsize);
2420 putFile8Bit(file, ei->slippery_type);
2422 for (y = 0; y < 3; y++)
2423 for (x = 0; x < 3; x++)
2424 putFile16BitBE(file, ei->content[x][y]);
2426 putFile16BitBE(file, ei->move_enter_element);
2427 putFile16BitBE(file, ei->move_leave_element);
2428 putFile8Bit(file, ei->move_leave_type);
2430 /* some free bytes for future custom property values and padding */
2431 WriteUnusedBytesToFile(file, 7);
2433 /* write change property values */
2435 for (i = 0; i < ei->num_change_pages; i++)
2437 struct ElementChangeInfo *change = &ei->change_page[i];
2439 putFile32BitBE(file, change->events);
2441 putFile16BitBE(file, change->target_element);
2443 putFile16BitBE(file, change->delay_fixed);
2444 putFile16BitBE(file, change->delay_random);
2445 putFile16BitBE(file, change->delay_frames);
2447 putFile16BitBE(file, change->trigger_element);
2449 putFile8Bit(file, change->explode);
2450 putFile8Bit(file, change->use_content);
2451 putFile8Bit(file, change->only_complete);
2452 putFile8Bit(file, change->use_random_change);
2454 putFile8Bit(file, change->random);
2455 putFile8Bit(file, change->power);
2457 for (y = 0; y < 3; y++)
2458 for (x = 0; x < 3; x++)
2459 putFile16BitBE(file, change->content[x][y]);
2461 putFile8Bit(file, change->can_change);
2463 putFile8Bit(file, change->sides);
2465 /* some free bytes for future change property values and padding */
2466 WriteUnusedBytesToFile(file, 8);
2470 static void SaveLevel_GRP1(FILE *file, struct LevelInfo *level, int element)
2472 struct ElementInfo *ei = &element_info[element];
2473 struct ElementGroupInfo *group = ei->group;
2476 putFile16BitBE(file, element);
2478 for (i = 0; i < MAX_ELEMENT_NAME_LEN; i++)
2479 putFile8Bit(file, ei->description[i]);
2481 putFile8Bit(file, group->num_elements);
2483 putFile8Bit(file, ei->use_gfx_element);
2484 putFile16BitBE(file, ei->gfx_element);
2486 /* some free bytes for future values and padding */
2487 WriteUnusedBytesToFile(file, 4);
2489 for (i = 0; i < MAX_ELEMENTS_IN_GROUP; i++)
2490 putFile16BitBE(file, group->element[i]);
2493 static void SaveLevelFromFilename(struct LevelInfo *level, char *filename)
2495 int body_chunk_size;
2499 if (!(file = fopen(filename, MODE_WRITE)))
2501 Error(ERR_WARN, "cannot save level file '%s'", filename);
2505 level->file_version = FILE_VERSION_ACTUAL;
2506 level->game_version = GAME_VERSION_ACTUAL;
2508 /* check level field for 16-bit elements */
2509 level->encoding_16bit_field = FALSE;
2510 for (y = 0; y < level->fieldy; y++)
2511 for (x = 0; x < level->fieldx; x++)
2512 if (level->field[x][y] > 255)
2513 level->encoding_16bit_field = TRUE;
2515 /* check yamyam content for 16-bit elements */
2516 level->encoding_16bit_yamyam = FALSE;
2517 for (i = 0; i < level->num_yamyam_contents; i++)
2518 for (y = 0; y < 3; y++)
2519 for (x = 0; x < 3; x++)
2520 if (level->yamyam_content[i][x][y] > 255)
2521 level->encoding_16bit_yamyam = TRUE;
2523 /* check amoeba content for 16-bit elements */
2524 level->encoding_16bit_amoeba = FALSE;
2525 if (level->amoeba_content > 255)
2526 level->encoding_16bit_amoeba = TRUE;
2528 /* calculate size of "BODY" chunk */
2530 level->fieldx * level->fieldy * (level->encoding_16bit_field ? 2 : 1);
2532 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
2533 putFileChunkBE(file, "CAVE", CHUNK_SIZE_NONE);
2535 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
2536 SaveLevel_VERS(file, level);
2538 putFileChunkBE(file, "HEAD", LEVEL_HEADER_SIZE);
2539 SaveLevel_HEAD(file, level);
2541 putFileChunkBE(file, "AUTH", MAX_LEVEL_AUTHOR_LEN);
2542 SaveLevel_AUTH(file, level);
2544 putFileChunkBE(file, "BODY", body_chunk_size);
2545 SaveLevel_BODY(file, level);
2547 if (level->encoding_16bit_yamyam ||
2548 level->num_yamyam_contents != STD_ELEMENT_CONTENTS)
2550 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2551 SaveLevel_CNT2(file, level, EL_YAMYAM);
2554 if (level->encoding_16bit_amoeba)
2556 putFileChunkBE(file, "CNT2", LEVEL_CHUNK_CNT2_SIZE);
2557 SaveLevel_CNT2(file, level, EL_BD_AMOEBA);
2560 /* check for envelope content */
2561 for (i = 0; i < 4; i++)
2563 if (strlen(level->envelope_text[i]) > 0)
2565 int envelope_len = strlen(level->envelope_text[i]) + 1;
2567 putFileChunkBE(file, "CNT3", LEVEL_CHUNK_CNT3_SIZE(envelope_len));
2568 SaveLevel_CNT3(file, level, EL_ENVELOPE_1 + i);
2572 /* check for non-default custom elements (unless using template level) */
2573 if (!level->use_custom_template)
2575 for (i = 0; i < NUM_CUSTOM_ELEMENTS; i++)
2577 int element = EL_CUSTOM_START + i;
2579 if (element_info[element].modified_settings)
2581 int num_change_pages = element_info[element].num_change_pages;
2583 putFileChunkBE(file, "CUS4", LEVEL_CHUNK_CUS4_SIZE(num_change_pages));
2584 SaveLevel_CUS4(file, level, element);
2589 /* check for non-default group elements (unless using template level) */
2590 if (!level->use_custom_template)
2592 for (i = 0; i < NUM_GROUP_ELEMENTS; i++)
2594 int element = EL_GROUP_START + i;
2596 if (element_info[element].modified_settings)
2598 putFileChunkBE(file, "GRP1", LEVEL_CHUNK_GRP1_SIZE);
2599 SaveLevel_GRP1(file, level, element);
2606 SetFilePermissions(filename, PERMS_PRIVATE);
2609 void SaveLevel(int nr)
2611 char *filename = getDefaultLevelFilename(nr);
2613 SaveLevelFromFilename(&level, filename);
2616 void SaveLevelTemplate()
2618 char *filename = getDefaultLevelFilename(-1);
2620 SaveLevelFromFilename(&level, filename);
2623 void DumpLevel(struct LevelInfo *level)
2625 printf_line("-", 79);
2626 printf("Level xxx (file version %08d, game version %08d)\n",
2627 level->file_version, level->game_version);
2628 printf_line("-", 79);
2630 printf("Level Author: '%s'\n", level->author);
2631 printf("Level Title: '%s'\n", level->name);
2633 printf("Playfield Size: %d x %d\n", level->fieldx, level->fieldy);
2635 printf("Level Time: %d seconds\n", level->time);
2636 printf("Gems needed: %d\n", level->gems_needed);
2638 printf("Time for Magic Wall: %d seconds\n", level->time_magic_wall);
2639 printf("Time for Wheel: %d seconds\n", level->time_wheel);
2640 printf("Time for Light: %d seconds\n", level->time_light);
2641 printf("Time for Timegate: %d seconds\n", level->time_timegate);
2643 printf("Amoeba Speed: %d\n", level->amoeba_speed);
2645 printf("Gravity: %s\n", (level->initial_gravity ? "yes" : "no"));
2646 printf("Double Speed Movement: %s\n", (level->double_speed ? "yes" : "no"));
2647 printf("EM style slippery gems: %s\n", (level->em_slippery_gems ? "yes" : "no"));
2649 printf_line("-", 79);
2653 /* ========================================================================= */
2654 /* tape file functions */
2655 /* ========================================================================= */
2657 static void setTapeInfoToDefaults()
2661 /* always start with reliable default values (empty tape) */
2664 /* default values (also for pre-1.2 tapes) with only the first player */
2665 tape.player_participates[0] = TRUE;
2666 for (i = 1; i < MAX_PLAYERS; i++)
2667 tape.player_participates[i] = FALSE;
2669 /* at least one (default: the first) player participates in every tape */
2670 tape.num_participating_players = 1;
2672 tape.level_nr = level_nr;
2674 tape.changed = FALSE;
2676 tape.recording = FALSE;
2677 tape.playing = FALSE;
2678 tape.pausing = FALSE;
2681 static int LoadTape_VERS(FILE *file, int chunk_size, struct TapeInfo *tape)
2683 tape->file_version = getFileVersion(file);
2684 tape->game_version = getFileVersion(file);
2689 static int LoadTape_HEAD(FILE *file, int chunk_size, struct TapeInfo *tape)
2693 tape->random_seed = getFile32BitBE(file);
2694 tape->date = getFile32BitBE(file);
2695 tape->length = getFile32BitBE(file);
2697 /* read header fields that are new since version 1.2 */
2698 if (tape->file_version >= FILE_VERSION_1_2)
2700 byte store_participating_players = getFile8Bit(file);
2703 /* since version 1.2, tapes store which players participate in the tape */
2704 tape->num_participating_players = 0;
2705 for (i = 0; i < MAX_PLAYERS; i++)
2707 tape->player_participates[i] = FALSE;
2709 if (store_participating_players & (1 << i))
2711 tape->player_participates[i] = TRUE;
2712 tape->num_participating_players++;
2716 ReadUnusedBytesFromFile(file, TAPE_HEADER_UNUSED);
2718 engine_version = getFileVersion(file);
2719 if (engine_version > 0)
2720 tape->engine_version = engine_version;
2722 tape->engine_version = tape->game_version;
2728 static int LoadTape_INFO(FILE *file, int chunk_size, struct TapeInfo *tape)
2730 int level_identifier_size;
2733 level_identifier_size = getFile16BitBE(file);
2735 tape->level_identifier =
2736 checked_realloc(tape->level_identifier, level_identifier_size);
2738 for (i = 0; i < level_identifier_size; i++)
2739 tape->level_identifier[i] = getFile8Bit(file);
2741 tape->level_nr = getFile16BitBE(file);
2743 chunk_size = 2 + level_identifier_size + 2;
2748 static int LoadTape_BODY(FILE *file, int chunk_size, struct TapeInfo *tape)
2751 int chunk_size_expected =
2752 (tape->num_participating_players + 1) * tape->length;
2754 if (chunk_size_expected != chunk_size)
2756 ReadUnusedBytesFromFile(file, chunk_size);
2757 return chunk_size_expected;
2760 for (i = 0; i < tape->length; i++)
2762 if (i >= MAX_TAPELEN)
2765 for (j = 0; j < MAX_PLAYERS; j++)
2767 tape->pos[i].action[j] = MV_NO_MOVING;
2769 if (tape->player_participates[j])
2770 tape->pos[i].action[j] = getFile8Bit(file);
2773 tape->pos[i].delay = getFile8Bit(file);
2775 if (tape->file_version == FILE_VERSION_1_0)
2777 /* eliminate possible diagonal moves in old tapes */
2778 /* this is only for backward compatibility */
2780 byte joy_dir[4] = { JOY_LEFT, JOY_RIGHT, JOY_UP, JOY_DOWN };
2781 byte action = tape->pos[i].action[0];
2782 int k, num_moves = 0;
2784 for (k = 0; k<4; k++)
2786 if (action & joy_dir[k])
2788 tape->pos[i + num_moves].action[0] = joy_dir[k];
2790 tape->pos[i + num_moves].delay = 0;
2799 tape->length += num_moves;
2802 else if (tape->file_version < FILE_VERSION_2_0)
2804 /* convert pre-2.0 tapes to new tape format */
2806 if (tape->pos[i].delay > 1)
2809 tape->pos[i + 1] = tape->pos[i];
2810 tape->pos[i + 1].delay = 1;
2813 for (j = 0; j < MAX_PLAYERS; j++)
2814 tape->pos[i].action[j] = MV_NO_MOVING;
2815 tape->pos[i].delay--;
2826 if (i != tape->length)
2827 chunk_size = (tape->num_participating_players + 1) * i;
2832 void LoadTapeFromFilename(char *filename)
2834 char cookie[MAX_LINE_LEN];
2835 char chunk_name[CHUNK_ID_LEN + 1];
2839 /* always start with reliable default values */
2840 setTapeInfoToDefaults();
2842 if (!(file = fopen(filename, MODE_READ)))
2845 getFileChunkBE(file, chunk_name, NULL);
2846 if (strcmp(chunk_name, "RND1") == 0)
2848 getFile32BitBE(file); /* not used */
2850 getFileChunkBE(file, chunk_name, NULL);
2851 if (strcmp(chunk_name, "TAPE") != 0)
2853 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
2858 else /* check for pre-2.0 file format with cookie string */
2860 strcpy(cookie, chunk_name);
2861 fgets(&cookie[4], MAX_LINE_LEN - 4, file);
2862 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
2863 cookie[strlen(cookie) - 1] = '\0';
2865 if (!checkCookieString(cookie, TAPE_COOKIE_TMPL))
2867 Error(ERR_WARN, "unknown format of tape file '%s'", filename);
2872 if ((tape.file_version = getFileVersionFromCookieString(cookie)) == -1)
2874 Error(ERR_WARN, "unsupported version of tape file '%s'", filename);
2879 /* pre-2.0 tape files have no game version, so use file version here */
2880 tape.game_version = tape.file_version;
2883 if (tape.file_version < FILE_VERSION_1_2)
2885 /* tape files from versions before 1.2.0 without chunk structure */
2886 LoadTape_HEAD(file, TAPE_HEADER_SIZE, &tape);
2887 LoadTape_BODY(file, 2 * tape.length, &tape);
2895 int (*loader)(FILE *, int, struct TapeInfo *);
2899 { "VERS", FILE_VERS_CHUNK_SIZE, LoadTape_VERS },
2900 { "HEAD", TAPE_HEADER_SIZE, LoadTape_HEAD },
2901 { "INFO", -1, LoadTape_INFO },
2902 { "BODY", -1, LoadTape_BODY },
2906 while (getFileChunkBE(file, chunk_name, &chunk_size))
2910 while (chunk_info[i].name != NULL &&
2911 strcmp(chunk_name, chunk_info[i].name) != 0)
2914 if (chunk_info[i].name == NULL)
2916 Error(ERR_WARN, "unknown chunk '%s' in tape file '%s'",
2917 chunk_name, filename);
2918 ReadUnusedBytesFromFile(file, chunk_size);
2920 else if (chunk_info[i].size != -1 &&
2921 chunk_info[i].size != chunk_size)
2923 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
2924 chunk_size, chunk_name, filename);
2925 ReadUnusedBytesFromFile(file, chunk_size);
2929 /* call function to load this tape chunk */
2930 int chunk_size_expected =
2931 (chunk_info[i].loader)(file, chunk_size, &tape);
2933 /* the size of some chunks cannot be checked before reading other
2934 chunks first (like "HEAD" and "BODY") that contain some header
2935 information, so check them here */
2936 if (chunk_size_expected != chunk_size)
2938 Error(ERR_WARN, "wrong size (%d) of chunk '%s' in tape file '%s'",
2939 chunk_size, chunk_name, filename);
2947 tape.length_seconds = GetTapeLength();
2950 printf("::: tape game version: %d\n", tape.game_version);
2951 printf("::: tape engine version: %d\n", tape.engine_version);
2955 void LoadTape(int nr)
2957 char *filename = getTapeFilename(nr);
2959 LoadTapeFromFilename(filename);
2962 void LoadSolutionTape(int nr)
2964 char *filename = getSolutionTapeFilename(nr);
2966 LoadTapeFromFilename(filename);
2969 static void SaveTape_VERS(FILE *file, struct TapeInfo *tape)
2971 putFileVersion(file, tape->file_version);
2972 putFileVersion(file, tape->game_version);
2975 static void SaveTape_HEAD(FILE *file, struct TapeInfo *tape)
2978 byte store_participating_players = 0;
2980 /* set bits for participating players for compact storage */
2981 for (i = 0; i < MAX_PLAYERS; i++)
2982 if (tape->player_participates[i])
2983 store_participating_players |= (1 << i);
2985 putFile32BitBE(file, tape->random_seed);
2986 putFile32BitBE(file, tape->date);
2987 putFile32BitBE(file, tape->length);
2989 putFile8Bit(file, store_participating_players);
2991 /* unused bytes not at the end here for 4-byte alignment of engine_version */
2992 WriteUnusedBytesToFile(file, TAPE_HEADER_UNUSED);
2994 putFileVersion(file, tape->engine_version);
2997 static void SaveTape_INFO(FILE *file, struct TapeInfo *tape)
2999 int level_identifier_size = strlen(tape->level_identifier) + 1;
3002 putFile16BitBE(file, level_identifier_size);
3004 for (i = 0; i < level_identifier_size; i++)
3005 putFile8Bit(file, tape->level_identifier[i]);
3007 putFile16BitBE(file, tape->level_nr);
3010 static void SaveTape_BODY(FILE *file, struct TapeInfo *tape)
3014 for (i = 0; i < tape->length; i++)
3016 for (j = 0; j < MAX_PLAYERS; j++)
3017 if (tape->player_participates[j])
3018 putFile8Bit(file, tape->pos[i].action[j]);
3020 putFile8Bit(file, tape->pos[i].delay);
3024 void SaveTape(int nr)
3026 char *filename = getTapeFilename(nr);
3028 boolean new_tape = TRUE;
3029 int num_participating_players = 0;
3030 int info_chunk_size;
3031 int body_chunk_size;
3034 InitTapeDirectory(leveldir_current->subdir);
3036 /* if a tape still exists, ask to overwrite it */
3037 if (access(filename, F_OK) == 0)
3040 if (!Request("Replace old tape ?", REQ_ASK))
3044 if (!(file = fopen(filename, MODE_WRITE)))
3046 Error(ERR_WARN, "cannot save level recording file '%s'", filename);
3050 tape.file_version = FILE_VERSION_ACTUAL;
3051 tape.game_version = GAME_VERSION_ACTUAL;
3053 /* count number of participating players */
3054 for (i = 0; i < MAX_PLAYERS; i++)
3055 if (tape.player_participates[i])
3056 num_participating_players++;
3058 info_chunk_size = 2 + (strlen(tape.level_identifier) + 1) + 2;
3059 body_chunk_size = (num_participating_players + 1) * tape.length;
3061 putFileChunkBE(file, "RND1", CHUNK_SIZE_UNDEFINED);
3062 putFileChunkBE(file, "TAPE", CHUNK_SIZE_NONE);
3064 putFileChunkBE(file, "VERS", FILE_VERS_CHUNK_SIZE);
3065 SaveTape_VERS(file, &tape);
3067 putFileChunkBE(file, "HEAD", TAPE_HEADER_SIZE);
3068 SaveTape_HEAD(file, &tape);
3070 putFileChunkBE(file, "INFO", info_chunk_size);
3071 SaveTape_INFO(file, &tape);
3073 putFileChunkBE(file, "BODY", body_chunk_size);
3074 SaveTape_BODY(file, &tape);
3078 SetFilePermissions(filename, PERMS_PRIVATE);
3080 tape.changed = FALSE;
3083 Request("tape saved !", REQ_CONFIRM);
3086 void DumpTape(struct TapeInfo *tape)
3090 if (TAPE_IS_EMPTY(*tape))
3092 Error(ERR_WARN, "no tape available for level %d", tape->level_nr);
3096 printf_line("-", 79);
3097 printf("Tape of Level %03d (file version %08d, game version %08d)\n",
3098 tape->level_nr, tape->file_version, tape->game_version);
3099 printf("Level series identifier: '%s'\n", tape->level_identifier);
3100 printf_line("-", 79);
3102 for (i = 0; i < tape->length; i++)
3104 if (i >= MAX_TAPELEN)
3107 printf("%03d: ", i);
3109 for (j = 0; j < MAX_PLAYERS; j++)
3111 if (tape->player_participates[j])
3113 int action = tape->pos[i].action[j];
3115 printf("%d:%02x ", j, action);
3116 printf("[%c%c%c%c|%c%c] - ",
3117 (action & JOY_LEFT ? '<' : ' '),
3118 (action & JOY_RIGHT ? '>' : ' '),
3119 (action & JOY_UP ? '^' : ' '),
3120 (action & JOY_DOWN ? 'v' : ' '),
3121 (action & JOY_BUTTON_1 ? '1' : ' '),
3122 (action & JOY_BUTTON_2 ? '2' : ' '));
3126 printf("(%03d)\n", tape->pos[i].delay);
3129 printf_line("-", 79);
3133 /* ========================================================================= */
3134 /* score file functions */
3135 /* ========================================================================= */
3137 void LoadScore(int nr)
3140 char *filename = getScoreFilename(nr);
3141 char cookie[MAX_LINE_LEN];
3142 char line[MAX_LINE_LEN];
3146 /* always start with reliable default values */
3147 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3149 strcpy(highscore[i].Name, EMPTY_PLAYER_NAME);
3150 highscore[i].Score = 0;
3153 if (!(file = fopen(filename, MODE_READ)))
3156 /* check file identifier */
3157 fgets(cookie, MAX_LINE_LEN, file);
3158 if (strlen(cookie) > 0 && cookie[strlen(cookie) - 1] == '\n')
3159 cookie[strlen(cookie) - 1] = '\0';
3161 if (!checkCookieString(cookie, SCORE_COOKIE))
3163 Error(ERR_WARN, "unknown format of score file '%s'", filename);
3168 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3170 fscanf(file, "%d", &highscore[i].Score);
3171 fgets(line, MAX_LINE_LEN, file);
3173 if (line[strlen(line) - 1] == '\n')
3174 line[strlen(line) - 1] = '\0';
3176 for (line_ptr = line; *line_ptr; line_ptr++)
3178 if (*line_ptr != ' ' && *line_ptr != '\t' && *line_ptr != '\0')
3180 strncpy(highscore[i].Name, line_ptr, MAX_PLAYER_NAME_LEN);
3181 highscore[i].Name[MAX_PLAYER_NAME_LEN] = '\0';
3190 void SaveScore(int nr)
3193 char *filename = getScoreFilename(nr);
3196 InitScoreDirectory(leveldir_current->subdir);
3198 if (!(file = fopen(filename, MODE_WRITE)))
3200 Error(ERR_WARN, "cannot save score for level %d", nr);
3204 fprintf(file, "%s\n\n", SCORE_COOKIE);
3206 for (i = 0; i < MAX_SCORE_ENTRIES; i++)
3207 fprintf(file, "%d %s\n", highscore[i].Score, highscore[i].Name);
3211 SetFilePermissions(filename, PERMS_PUBLIC);
3215 /* ========================================================================= */
3216 /* setup file functions */
3217 /* ========================================================================= */
3219 #define TOKEN_STR_PLAYER_PREFIX "player_"
3222 #define SETUP_TOKEN_PLAYER_NAME 0
3223 #define SETUP_TOKEN_SOUND 1
3224 #define SETUP_TOKEN_SOUND_LOOPS 2
3225 #define SETUP_TOKEN_SOUND_MUSIC 3
3226 #define SETUP_TOKEN_SOUND_SIMPLE 4
3227 #define SETUP_TOKEN_TOONS 5
3228 #define SETUP_TOKEN_SCROLL_DELAY 6
3229 #define SETUP_TOKEN_SOFT_SCROLLING 7
3230 #define SETUP_TOKEN_FADING 8
3231 #define SETUP_TOKEN_AUTORECORD 9
3232 #define SETUP_TOKEN_QUICK_DOORS 10
3233 #define SETUP_TOKEN_TEAM_MODE 11
3234 #define SETUP_TOKEN_HANDICAP 12
3235 #define SETUP_TOKEN_TIME_LIMIT 13
3236 #define SETUP_TOKEN_FULLSCREEN 14
3237 #define SETUP_TOKEN_ASK_ON_ESCAPE 15
3238 #define SETUP_TOKEN_GRAPHICS_SET 16
3239 #define SETUP_TOKEN_SOUNDS_SET 17
3240 #define SETUP_TOKEN_MUSIC_SET 18
3241 #define SETUP_TOKEN_OVERRIDE_LEVEL_GRAPHICS 19
3242 #define SETUP_TOKEN_OVERRIDE_LEVEL_SOUNDS 20
3243 #define SETUP_TOKEN_OVERRIDE_LEVEL_MUSIC 21
3245 #define NUM_GLOBAL_SETUP_TOKENS 22
3248 #define SETUP_TOKEN_EDITOR_EL_BOULDERDASH 0
3249 #define SETUP_TOKEN_EDITOR_EL_EMERALD_MINE 1
3250 #define SETUP_TOKEN_EDITOR_EL_MORE 2
3251 #define SETUP_TOKEN_EDITOR_EL_SOKOBAN 3
3252 #define SETUP_TOKEN_EDITOR_EL_SUPAPLEX 4
3253 #define SETUP_TOKEN_EDITOR_EL_DIAMOND_CAVES 5
3254 #define SETUP_TOKEN_EDITOR_EL_DX_BOULDERDASH 6
3255 #define SETUP_TOKEN_EDITOR_EL_CHARS 7
3256 #define SETUP_TOKEN_EDITOR_EL_CUSTOM 8
3257 #define SETUP_TOKEN_EDITOR_EL_CUSTOM_MORE 9
3258 #define SETUP_TOKEN_EDITOR_EL_HEADLINES 10
3259 #define SETUP_TOKEN_EDITOR_EL_USER_DEFINED 11
3261 #define NUM_EDITOR_SETUP_TOKENS 12
3263 /* shortcut setup */
3264 #define SETUP_TOKEN_SHORTCUT_SAVE_GAME 0
3265 #define SETUP_TOKEN_SHORTCUT_LOAD_GAME 1
3266 #define SETUP_TOKEN_SHORTCUT_TOGGLE_PAUSE 2
3268 #define NUM_SHORTCUT_SETUP_TOKENS 3
3271 #define SETUP_TOKEN_PLAYER_USE_JOYSTICK 0
3272 #define SETUP_TOKEN_PLAYER_JOY_DEVICE_NAME 1
3273 #define SETUP_TOKEN_PLAYER_JOY_XLEFT 2
3274 #define SETUP_TOKEN_PLAYER_JOY_XMIDDLE 3
3275 #define SETUP_TOKEN_PLAYER_JOY_XRIGHT 4
3276 #define SETUP_TOKEN_PLAYER_JOY_YUPPER 5
3277 #define SETUP_TOKEN_PLAYER_JOY_YMIDDLE 6
3278 #define SETUP_TOKEN_PLAYER_JOY_YLOWER 7
3279 #define SETUP_TOKEN_PLAYER_JOY_SNAP 8
3280 #define SETUP_TOKEN_PLAYER_JOY_DROP 9
3281 #define SETUP_TOKEN_PLAYER_KEY_LEFT 10
3282 #define SETUP_TOKEN_PLAYER_KEY_RIGHT 11
3283 #define SETUP_TOKEN_PLAYER_KEY_UP 12
3284 #define SETUP_TOKEN_PLAYER_KEY_DOWN 13
3285 #define SETUP_TOKEN_PLAYER_KEY_SNAP 14
3286 #define SETUP_TOKEN_PLAYER_KEY_DROP 15
3288 #define NUM_PLAYER_SETUP_TOKENS 16
3291 #define SETUP_TOKEN_SYSTEM_SDL_AUDIODRIVER 0
3292 #define SETUP_TOKEN_SYSTEM_AUDIO_FRAGMENT_SIZE 1
3294 #define NUM_SYSTEM_SETUP_TOKENS 2
3297 #define SETUP_TOKEN_OPTIONS_VERBOSE 0
3299 #define NUM_OPTIONS_SETUP_TOKENS 1
3302 static struct SetupInfo si;
3303 static struct SetupEditorInfo sei;
3304 static struct SetupShortcutInfo ssi;
3305 static struct SetupInputInfo sii;
3306 static struct SetupSystemInfo syi;
3307 static struct OptionInfo soi;
3309 static struct TokenInfo global_setup_tokens[] =
3311 { TYPE_STRING, &si.player_name, "player_name" },
3312 { TYPE_SWITCH, &si.sound, "sound" },
3313 { TYPE_SWITCH, &si.sound_loops, "repeating_sound_loops" },
3314 { TYPE_SWITCH, &si.sound_music, "background_music" },
3315 { TYPE_SWITCH, &si.sound_simple, "simple_sound_effects" },
3316 { TYPE_SWITCH, &si.toons, "toons" },
3317 { TYPE_SWITCH, &si.scroll_delay, "scroll_delay" },
3318 { TYPE_SWITCH, &si.soft_scrolling, "soft_scrolling" },
3319 { TYPE_SWITCH, &si.fading, "screen_fading" },
3320 { TYPE_SWITCH, &si.autorecord, "automatic_tape_recording" },
3321 { TYPE_SWITCH, &si.quick_doors, "quick_doors" },
3322 { TYPE_SWITCH, &si.team_mode, "team_mode" },
3323 { TYPE_SWITCH, &si.handicap, "handicap" },
3324 { TYPE_SWITCH, &si.time_limit, "time_limit" },
3325 { TYPE_SWITCH, &si.fullscreen, "fullscreen" },
3326 { TYPE_SWITCH, &si.ask_on_escape, "ask_on_escape" },
3327 { TYPE_STRING, &si.graphics_set, "graphics_set" },
3328 { TYPE_STRING, &si.sounds_set, "sounds_set" },
3329 { TYPE_STRING, &si.music_set, "music_set" },
3330 { TYPE_SWITCH, &si.override_level_graphics, "override_level_graphics" },
3331 { TYPE_SWITCH, &si.override_level_sounds, "override_level_sounds" },
3332 { TYPE_SWITCH, &si.override_level_music, "override_level_music" },
3335 static struct TokenInfo editor_setup_tokens[] =
3337 { TYPE_SWITCH, &sei.el_boulderdash, "editor.el_boulderdash" },
3338 { TYPE_SWITCH, &sei.el_emerald_mine, "editor.el_emerald_mine" },
3339 { TYPE_SWITCH, &sei.el_more, "editor.el_more" },
3340 { TYPE_SWITCH, &sei.el_sokoban, "editor.el_sokoban" },
3341 { TYPE_SWITCH, &sei.el_supaplex, "editor.el_supaplex" },
3342 { TYPE_SWITCH, &sei.el_diamond_caves, "editor.el_diamond_caves" },
3343 { TYPE_SWITCH, &sei.el_dx_boulderdash,"editor.el_dx_boulderdash" },
3344 { TYPE_SWITCH, &sei.el_chars, "editor.el_chars" },
3345 { TYPE_SWITCH, &sei.el_custom, "editor.el_custom" },
3346 { TYPE_SWITCH, &sei.el_custom_more, "editor.el_custom_more" },
3347 { TYPE_SWITCH, &sei.el_headlines, "editor.el_headlines" },
3348 { TYPE_SWITCH, &sei.el_user_defined, "editor.el_user_defined" },
3351 static struct TokenInfo shortcut_setup_tokens[] =
3353 { TYPE_KEY_X11, &ssi.save_game, "shortcut.save_game" },
3354 { TYPE_KEY_X11, &ssi.load_game, "shortcut.load_game" },
3355 { TYPE_KEY_X11, &ssi.toggle_pause, "shortcut.toggle_pause" }
3358 static struct TokenInfo player_setup_tokens[] =
3360 { TYPE_BOOLEAN, &sii.use_joystick, ".use_joystick" },
3361 { TYPE_STRING, &sii.joy.device_name, ".joy.device_name" },
3362 { TYPE_INTEGER, &sii.joy.xleft, ".joy.xleft" },
3363 { TYPE_INTEGER, &sii.joy.xmiddle, ".joy.xmiddle" },
3364 { TYPE_INTEGER, &sii.joy.xright, ".joy.xright" },
3365 { TYPE_INTEGER, &sii.joy.yupper, ".joy.yupper" },
3366 { TYPE_INTEGER, &sii.joy.ymiddle, ".joy.ymiddle" },
3367 { TYPE_INTEGER, &sii.joy.ylower, ".joy.ylower" },
3368 { TYPE_INTEGER, &sii.joy.snap, ".joy.snap_field" },
3369 { TYPE_INTEGER, &sii.joy.drop, ".joy.place_bomb" },
3370 { TYPE_KEY_X11, &sii.key.left, ".key.move_left" },
3371 { TYPE_KEY_X11, &sii.key.right, ".key.move_right" },
3372 { TYPE_KEY_X11, &sii.key.up, ".key.move_up" },
3373 { TYPE_KEY_X11, &sii.key.down, ".key.move_down" },
3374 { TYPE_KEY_X11, &sii.key.snap, ".key.snap_field" },
3375 { TYPE_KEY_X11, &sii.key.drop, ".key.place_bomb" }
3378 static struct TokenInfo system_setup_tokens[] =
3380 { TYPE_STRING, &syi.sdl_audiodriver, "system.sdl_audiodriver" },
3381 { TYPE_INTEGER, &syi.audio_fragment_size,"system.audio_fragment_size" }
3384 static struct TokenInfo options_setup_tokens[] =
3386 { TYPE_BOOLEAN, &soi.verbose, "options.verbose" }
3389 static char *get_corrected_login_name(char *login_name)
3391 /* needed because player name must be a fixed length string */
3392 char *login_name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
3394 strncpy(login_name_new, login_name, MAX_PLAYER_NAME_LEN);
3395 login_name_new[MAX_PLAYER_NAME_LEN] = '\0';
3397 if (strlen(login_name) > MAX_PLAYER_NAME_LEN) /* name has been cut */
3398 if (strchr(login_name_new, ' '))
3399 *strchr(login_name_new, ' ') = '\0';
3401 return login_name_new;
3404 static void setSetupInfoToDefaults(struct SetupInfo *si)
3408 si->player_name = get_corrected_login_name(getLoginName());
3411 si->sound_loops = TRUE;
3412 si->sound_music = TRUE;
3413 si->sound_simple = TRUE;
3415 si->double_buffering = TRUE;
3416 si->direct_draw = !si->double_buffering;
3417 si->scroll_delay = TRUE;
3418 si->soft_scrolling = TRUE;
3420 si->autorecord = TRUE;
3421 si->quick_doors = FALSE;
3422 si->team_mode = FALSE;
3423 si->handicap = TRUE;
3424 si->time_limit = TRUE;
3425 si->fullscreen = FALSE;
3426 si->ask_on_escape = TRUE;
3428 si->graphics_set = getStringCopy(GFX_CLASSIC_SUBDIR);
3429 si->sounds_set = getStringCopy(SND_CLASSIC_SUBDIR);
3430 si->music_set = getStringCopy(MUS_CLASSIC_SUBDIR);
3431 si->override_level_graphics = FALSE;
3432 si->override_level_sounds = FALSE;
3433 si->override_level_music = FALSE;
3435 si->editor.el_boulderdash = TRUE;
3436 si->editor.el_emerald_mine = TRUE;
3437 si->editor.el_more = TRUE;
3438 si->editor.el_sokoban = TRUE;
3439 si->editor.el_supaplex = TRUE;
3440 si->editor.el_diamond_caves = TRUE;
3441 si->editor.el_dx_boulderdash = TRUE;
3442 si->editor.el_chars = TRUE;
3443 si->editor.el_custom = TRUE;
3444 si->editor.el_custom_more = FALSE;
3446 si->editor.el_headlines = TRUE;
3447 si->editor.el_user_defined = FALSE;
3449 si->shortcut.save_game = DEFAULT_KEY_SAVE_GAME;
3450 si->shortcut.load_game = DEFAULT_KEY_LOAD_GAME;
3451 si->shortcut.toggle_pause = DEFAULT_KEY_TOGGLE_PAUSE;
3453 for (i = 0; i < MAX_PLAYERS; i++)
3455 si->input[i].use_joystick = FALSE;
3456 si->input[i].joy.device_name=getStringCopy(getDeviceNameFromJoystickNr(i));
3457 si->input[i].joy.xleft = JOYSTICK_XLEFT;
3458 si->input[i].joy.xmiddle = JOYSTICK_XMIDDLE;
3459 si->input[i].joy.xright = JOYSTICK_XRIGHT;
3460 si->input[i].joy.yupper = JOYSTICK_YUPPER;
3461 si->input[i].joy.ymiddle = JOYSTICK_YMIDDLE;
3462 si->input[i].joy.ylower = JOYSTICK_YLOWER;
3463 si->input[i].joy.snap = (i == 0 ? JOY_BUTTON_1 : 0);
3464 si->input[i].joy.drop = (i == 0 ? JOY_BUTTON_2 : 0);
3465 si->input[i].key.left = (i == 0 ? DEFAULT_KEY_LEFT : KSYM_UNDEFINED);
3466 si->input[i].key.right = (i == 0 ? DEFAULT_KEY_RIGHT : KSYM_UNDEFINED);
3467 si->input[i].key.up = (i == 0 ? DEFAULT_KEY_UP : KSYM_UNDEFINED);
3468 si->input[i].key.down = (i == 0 ? DEFAULT_KEY_DOWN : KSYM_UNDEFINED);
3469 si->input[i].key.snap = (i == 0 ? DEFAULT_KEY_SNAP : KSYM_UNDEFINED);
3470 si->input[i].key.drop = (i == 0 ? DEFAULT_KEY_DROP : KSYM_UNDEFINED);
3473 si->system.sdl_audiodriver = getStringCopy(ARG_DEFAULT);
3474 si->system.audio_fragment_size = DEFAULT_AUDIO_FRAGMENT_SIZE;
3476 si->options.verbose = FALSE;
3479 static void decodeSetupFileHash(SetupFileHash *setup_file_hash)
3483 if (!setup_file_hash)
3488 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3489 setSetupInfo(global_setup_tokens, i,
3490 getHashEntry(setup_file_hash, global_setup_tokens[i].text));
3495 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3496 setSetupInfo(editor_setup_tokens, i,
3497 getHashEntry(setup_file_hash,editor_setup_tokens[i].text));
3500 /* shortcut setup */
3501 ssi = setup.shortcut;
3502 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3503 setSetupInfo(shortcut_setup_tokens, i,
3504 getHashEntry(setup_file_hash,shortcut_setup_tokens[i].text));
3505 setup.shortcut = ssi;
3508 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3512 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3514 sii = setup.input[pnr];
3515 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3517 char full_token[100];
3519 sprintf(full_token, "%s%s", prefix, player_setup_tokens[i].text);
3520 setSetupInfo(player_setup_tokens, i,
3521 getHashEntry(setup_file_hash, full_token));
3523 setup.input[pnr] = sii;
3528 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3529 setSetupInfo(system_setup_tokens, i,
3530 getHashEntry(setup_file_hash, system_setup_tokens[i].text));
3534 soi = setup.options;
3535 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3536 setSetupInfo(options_setup_tokens, i,
3537 getHashEntry(setup_file_hash, options_setup_tokens[i].text));
3538 setup.options = soi;
3543 char *filename = getSetupFilename();
3544 SetupFileHash *setup_file_hash = NULL;
3546 /* always start with reliable default values */
3547 setSetupInfoToDefaults(&setup);
3549 setup_file_hash = loadSetupFileHash(filename);
3551 if (setup_file_hash)
3553 char *player_name_new;
3555 checkSetupFileHashIdentifier(setup_file_hash, getCookie("SETUP"));
3556 decodeSetupFileHash(setup_file_hash);
3558 setup.direct_draw = !setup.double_buffering;
3560 freeSetupFileHash(setup_file_hash);
3562 /* needed to work around problems with fixed length strings */
3563 player_name_new = get_corrected_login_name(setup.player_name);
3564 free(setup.player_name);
3565 setup.player_name = player_name_new;
3568 Error(ERR_WARN, "using default setup values");
3573 char *filename = getSetupFilename();
3577 InitUserDataDirectory();
3579 if (!(file = fopen(filename, MODE_WRITE)))
3581 Error(ERR_WARN, "cannot write setup file '%s'", filename);
3585 fprintf(file, "%s\n", getFormattedSetupEntry(TOKEN_STR_FILE_IDENTIFIER,
3586 getCookie("SETUP")));
3587 fprintf(file, "\n");
3591 for (i = 0; i < NUM_GLOBAL_SETUP_TOKENS; i++)
3593 /* just to make things nicer :) */
3594 if (i == SETUP_TOKEN_PLAYER_NAME + 1 ||
3595 i == SETUP_TOKEN_GRAPHICS_SET)
3596 fprintf(file, "\n");
3598 fprintf(file, "%s\n", getSetupLine(global_setup_tokens, "", i));
3603 fprintf(file, "\n");
3604 for (i = 0; i < NUM_EDITOR_SETUP_TOKENS; i++)
3605 fprintf(file, "%s\n", getSetupLine(editor_setup_tokens, "", i));
3607 /* shortcut setup */
3608 ssi = setup.shortcut;
3609 fprintf(file, "\n");
3610 for (i = 0; i < NUM_SHORTCUT_SETUP_TOKENS; i++)
3611 fprintf(file, "%s\n", getSetupLine(shortcut_setup_tokens, "", i));
3614 for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
3618 sprintf(prefix, "%s%d", TOKEN_STR_PLAYER_PREFIX, pnr + 1);
3619 fprintf(file, "\n");
3621 sii = setup.input[pnr];
3622 for (i = 0; i < NUM_PLAYER_SETUP_TOKENS; i++)
3623 fprintf(file, "%s\n", getSetupLine(player_setup_tokens, prefix, i));
3628 fprintf(file, "\n");
3629 for (i = 0; i < NUM_SYSTEM_SETUP_TOKENS; i++)
3630 fprintf(file, "%s\n", getSetupLine(system_setup_tokens, "", i));
3633 soi = setup.options;
3634 fprintf(file, "\n");
3635 for (i = 0; i < NUM_OPTIONS_SETUP_TOKENS; i++)
3636 fprintf(file, "%s\n", getSetupLine(options_setup_tokens, "", i));
3640 SetFilePermissions(filename, PERMS_PRIVATE);
3643 void LoadCustomElementDescriptions()
3645 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3646 SetupFileHash *setup_file_hash;
3649 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3651 if (element_info[i].custom_description != NULL)
3653 free(element_info[i].custom_description);
3654 element_info[i].custom_description = NULL;
3658 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3661 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3663 char *token = getStringCat2(element_info[i].token_name, ".name");
3664 char *value = getHashEntry(setup_file_hash, token);
3667 element_info[i].custom_description = getStringCopy(value);
3672 freeSetupFileHash(setup_file_hash);
3675 void LoadSpecialMenuDesignSettings()
3677 char *filename = getCustomArtworkConfigFilename(ARTWORK_TYPE_GRAPHICS);
3678 SetupFileHash *setup_file_hash;
3681 /* always start with reliable default values from default config */
3682 for (i = 0; image_config_vars[i].token != NULL; i++)
3683 for (j = 0; image_config[j].token != NULL; j++)
3684 if (strcmp(image_config_vars[i].token, image_config[j].token) == 0)
3685 *image_config_vars[i].value =
3686 get_auto_parameter_value(image_config_vars[i].token,
3687 image_config[j].value);
3689 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3692 /* special case: initialize with default values that may be overwritten */
3693 for (i = 0; i < NUM_SPECIAL_GFX_ARGS; i++)
3695 char *value_x = getHashEntry(setup_file_hash, "menu.draw_xoffset");
3696 char *value_y = getHashEntry(setup_file_hash, "menu.draw_yoffset");
3697 char *list_size = getHashEntry(setup_file_hash, "menu.list_size");
3699 if (value_x != NULL)
3700 menu.draw_xoffset[i] = get_integer_from_string(value_x);
3701 if (value_y != NULL)
3702 menu.draw_yoffset[i] = get_integer_from_string(value_y);
3703 if (list_size != NULL)
3704 menu.list_size[i] = get_integer_from_string(list_size);
3707 /* read (and overwrite with) values that may be specified in config file */
3708 for (i = 0; image_config_vars[i].token != NULL; i++)
3710 char *value = getHashEntry(setup_file_hash, image_config_vars[i].token);
3713 *image_config_vars[i].value =
3714 get_auto_parameter_value(image_config_vars[i].token, value);
3717 freeSetupFileHash(setup_file_hash);
3720 void LoadUserDefinedEditorElementList(int **elements, int *num_elements)
3722 char *filename = getEditorSetupFilename();
3723 SetupFileList *setup_file_list, *list;
3724 SetupFileHash *element_hash;
3725 int num_unknown_tokens = 0;
3728 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3731 element_hash = newSetupFileHash();
3733 for (i = 0; i < NUM_FILE_ELEMENTS; i++)
3734 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
3736 /* determined size may be larger than needed (due to unknown elements) */
3738 for (list = setup_file_list; list != NULL; list = list->next)
3741 /* add space for up to 3 more elements for padding that may be needed */
3744 *elements = checked_malloc(*num_elements * sizeof(int));
3747 for (list = setup_file_list; list != NULL; list = list->next)
3749 char *value = getHashEntry(element_hash, list->token);
3753 (*elements)[(*num_elements)++] = atoi(value);
3757 if (num_unknown_tokens == 0)
3759 Error(ERR_RETURN_LINE, "-");
3760 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
3761 Error(ERR_RETURN, "- config file: '%s'", filename);
3763 num_unknown_tokens++;
3766 Error(ERR_RETURN, "- token: '%s'", list->token);
3770 if (num_unknown_tokens > 0)
3771 Error(ERR_RETURN_LINE, "-");
3773 while (*num_elements % 4) /* pad with empty elements, if needed */
3774 (*elements)[(*num_elements)++] = EL_EMPTY;
3776 freeSetupFileList(setup_file_list);
3777 freeSetupFileHash(element_hash);
3781 for (i = 0; i < *num_elements; i++)
3782 printf("editor: element '%s' [%d]\n",
3783 element_info[(*elements)[i]].token_name, (*elements)[i]);
3787 static struct MusicFileInfo *get_music_file_info_ext(char *basename, int music,
3790 SetupFileHash *setup_file_hash = NULL;
3791 struct MusicFileInfo tmp_music_file_info, *new_music_file_info;
3792 char *filename_music, *filename_prefix, *filename_info;
3798 token_to_value_ptr[] =
3800 { "title_header", &tmp_music_file_info.title_header },
3801 { "artist_header", &tmp_music_file_info.artist_header },
3802 { "album_header", &tmp_music_file_info.album_header },
3803 { "year_header", &tmp_music_file_info.year_header },
3805 { "title", &tmp_music_file_info.title },
3806 { "artist", &tmp_music_file_info.artist },
3807 { "album", &tmp_music_file_info.album },
3808 { "year", &tmp_music_file_info.year },
3814 filename_music = (is_sound ? getCustomSoundFilename(basename) :
3815 getCustomMusicFilename(basename));
3817 if (filename_music == NULL)
3820 /* ---------- try to replace file extension ---------- */
3822 filename_prefix = getStringCopy(filename_music);
3823 if (strrchr(filename_prefix, '.') != NULL)
3824 *strrchr(filename_prefix, '.') = '\0';
3825 filename_info = getStringCat2(filename_prefix, ".txt");
3828 printf("trying to load file '%s'...\n", filename_info);
3831 if (fileExists(filename_info))
3832 setup_file_hash = loadSetupFileHash(filename_info);
3834 free(filename_prefix);
3835 free(filename_info);
3837 if (setup_file_hash == NULL)
3839 /* ---------- try to add file extension ---------- */
3841 filename_prefix = getStringCopy(filename_music);
3842 filename_info = getStringCat2(filename_prefix, ".txt");
3845 printf("trying to load file '%s'...\n", filename_info);
3848 if (fileExists(filename_info))
3849 setup_file_hash = loadSetupFileHash(filename_info);
3851 free(filename_prefix);
3852 free(filename_info);
3855 if (setup_file_hash == NULL)
3858 /* ---------- music file info found ---------- */
3860 memset(&tmp_music_file_info, 0, sizeof(struct MusicFileInfo));
3862 for (i = 0; token_to_value_ptr[i].token != NULL; i++)
3864 char *value = getHashEntry(setup_file_hash, token_to_value_ptr[i].token);
3866 *token_to_value_ptr[i].value_ptr =
3867 getStringCopy(value != NULL && *value != '\0' ? value : UNKNOWN_NAME);
3870 tmp_music_file_info.basename = getStringCopy(basename);
3871 tmp_music_file_info.music = music;
3872 tmp_music_file_info.is_sound = is_sound;
3874 new_music_file_info = checked_malloc(sizeof(struct MusicFileInfo));
3875 *new_music_file_info = tmp_music_file_info;
3877 return new_music_file_info;
3880 static struct MusicFileInfo *get_music_file_info(char *basename, int music)
3882 return get_music_file_info_ext(basename, music, FALSE);
3885 static struct MusicFileInfo *get_sound_file_info(char *basename, int sound)
3887 return get_music_file_info_ext(basename, sound, TRUE);
3890 static boolean music_info_listed_ext(struct MusicFileInfo *list,
3891 char *basename, boolean is_sound)
3893 for (; list != NULL; list = list->next)
3894 if (list->is_sound == is_sound && strcmp(list->basename, basename) == 0)
3900 static boolean music_info_listed(struct MusicFileInfo *list, char *basename)
3902 return music_info_listed_ext(list, basename, FALSE);
3905 static boolean sound_info_listed(struct MusicFileInfo *list, char *basename)
3907 return music_info_listed_ext(list, basename, TRUE);
3910 void LoadMusicInfo()
3912 char *music_directory = getCustomMusicDirectory();
3913 int num_music = getMusicListSize();
3914 int num_music_noconf = 0;
3915 int num_sounds = getSoundListSize();
3917 struct dirent *dir_entry;
3918 struct FileInfo *music, *sound;
3919 struct MusicFileInfo *next, **new;
3922 while (music_file_info != NULL)
3924 next = music_file_info->next;
3926 checked_free(music_file_info->basename);
3928 checked_free(music_file_info->title_header);
3929 checked_free(music_file_info->artist_header);
3930 checked_free(music_file_info->album_header);
3931 checked_free(music_file_info->year_header);
3933 checked_free(music_file_info->title);
3934 checked_free(music_file_info->artist);
3935 checked_free(music_file_info->album);
3936 checked_free(music_file_info->year);
3938 free(music_file_info);
3940 music_file_info = next;
3943 new = &music_file_info;
3946 printf("::: num_music == %d\n", num_music);
3949 for (i = 0; i < num_music; i++)
3951 music = getMusicListEntry(i);
3954 printf("::: %d [%08x]\n", i, music->filename);
3957 if (music->filename == NULL)
3960 if (strcmp(music->filename, UNDEFINED_FILENAME) == 0)
3963 /* a configured file may be not recognized as music */
3964 if (!FileIsMusic(music->filename))
3968 printf("::: -> '%s' (configured)\n", music->filename);
3971 if (!music_info_listed(music_file_info, music->filename))
3973 *new = get_music_file_info(music->filename, i);
3975 new = &(*new)->next;
3979 if ((dir = opendir(music_directory)) == NULL)
3981 Error(ERR_WARN, "cannot read music directory '%s'", music_directory);
3985 while ((dir_entry = readdir(dir)) != NULL) /* loop until last dir entry */
3987 char *basename = dir_entry->d_name;
3988 boolean music_already_used = FALSE;
3991 /* skip all music files that are configured in music config file */
3992 for (i = 0; i < num_music; i++)
3994 music = getMusicListEntry(i);
3996 if (music->filename == NULL)
3999 if (strcmp(basename, music->filename) == 0)
4001 music_already_used = TRUE;
4006 if (music_already_used)
4009 if (!FileIsMusic(basename))
4013 printf("::: -> '%s' (found in directory)\n", basename);
4016 if (!music_info_listed(music_file_info, basename))
4018 *new = get_music_file_info(basename, MAP_NOCONF_MUSIC(num_music_noconf));
4020 new = &(*new)->next;
4028 for (i = 0; i < num_sounds; i++)
4030 sound = getSoundListEntry(i);
4032 if (sound->filename == NULL)
4035 if (strcmp(sound->filename, UNDEFINED_FILENAME) == 0)
4038 /* a configured file may be not recognized as sound */
4039 if (!FileIsSound(sound->filename))
4043 printf("::: -> '%s' (configured)\n", sound->filename);
4046 if (!sound_info_listed(music_file_info, sound->filename))
4048 *new = get_sound_file_info(sound->filename, i);
4050 new = &(*new)->next;
4056 for (next = music_file_info; next != NULL; next = next->next)
4057 printf("::: title == '%s'\n", next->title);
4061 void add_helpanim_entry(int element, int action, int direction, int delay,
4062 int *num_list_entries)
4064 struct HelpAnimInfo *new_list_entry;
4065 (*num_list_entries)++;
4068 checked_realloc(helpanim_info,
4069 *num_list_entries * sizeof(struct HelpAnimInfo));
4070 new_list_entry = &helpanim_info[*num_list_entries - 1];
4072 new_list_entry->element = element;
4073 new_list_entry->action = action;
4074 new_list_entry->direction = direction;
4075 new_list_entry->delay = delay;
4078 void print_unknown_token(char *filename, char *token, int token_nr)
4082 Error(ERR_RETURN_LINE, "-");
4083 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
4084 Error(ERR_RETURN, "- config file: '%s'", filename);
4087 Error(ERR_RETURN, "- token: '%s'", token);
4090 void print_unknown_token_end(int token_nr)
4093 Error(ERR_RETURN_LINE, "-");
4096 void LoadHelpAnimInfo()
4098 char *filename = getHelpAnimFilename();
4099 SetupFileList *setup_file_list = NULL, *list;
4100 SetupFileHash *element_hash, *action_hash, *direction_hash;
4101 int num_list_entries = 0;
4102 int num_unknown_tokens = 0;
4105 if (fileExists(filename))
4106 setup_file_list = loadSetupFileList(filename);
4108 if (setup_file_list == NULL)
4110 /* use reliable default values from static configuration */
4111 SetupFileList *insert_ptr;
4113 insert_ptr = setup_file_list =
4114 newSetupFileList(helpanim_config[0].token,
4115 helpanim_config[0].value);
4117 for (i = 1; helpanim_config[i].token; i++)
4118 insert_ptr = addListEntry(insert_ptr,
4119 helpanim_config[i].token,
4120 helpanim_config[i].value);
4123 element_hash = newSetupFileHash();
4124 action_hash = newSetupFileHash();
4125 direction_hash = newSetupFileHash();
4127 for (i = 0; i < MAX_NUM_ELEMENTS; i++)
4128 setHashEntry(element_hash, element_info[i].token_name, i_to_a(i));
4130 for (i = 0; i < NUM_ACTIONS; i++)
4131 setHashEntry(action_hash, element_action_info[i].suffix,
4132 i_to_a(element_action_info[i].value));
4134 /* do not store direction index (bit) here, but direction value! */
4135 for (i = 0; i < NUM_DIRECTIONS; i++)
4136 setHashEntry(direction_hash, element_direction_info[i].suffix,
4137 i_to_a(1 << element_direction_info[i].value));
4139 for (list = setup_file_list; list != NULL; list = list->next)
4141 char *element_token, *action_token, *direction_token;
4142 char *element_value, *action_value, *direction_value;
4143 int delay = atoi(list->value);
4145 if (strcmp(list->token, "end") == 0)
4147 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4152 /* first try to break element into element/action/direction parts;
4153 if this does not work, also accept combined "element[.act][.dir]"
4154 elements (like "dynamite.active"), which are unique elements */
4156 if (strchr(list->token, '.') == NULL) /* token contains no '.' */
4158 element_value = getHashEntry(element_hash, list->token);
4159 if (element_value != NULL) /* element found */
4160 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4164 /* no further suffixes found -- this is not an element */
4165 print_unknown_token(filename, list->token, num_unknown_tokens++);
4171 /* token has format "<prefix>.<something>" */
4173 action_token = strchr(list->token, '.'); /* suffix may be action ... */
4174 direction_token = action_token; /* ... or direction */
4176 element_token = getStringCopy(list->token);
4177 *strchr(element_token, '.') = '\0';
4179 element_value = getHashEntry(element_hash, element_token);
4181 if (element_value == NULL) /* this is no element */
4183 element_value = getHashEntry(element_hash, list->token);
4184 if (element_value != NULL) /* combined element found */
4185 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4188 print_unknown_token(filename, list->token, num_unknown_tokens++);
4190 free(element_token);
4195 action_value = getHashEntry(action_hash, action_token);
4197 if (action_value != NULL) /* action found */
4199 add_helpanim_entry(atoi(element_value), atoi(action_value), -1, delay,
4202 free(element_token);
4207 direction_value = getHashEntry(direction_hash, direction_token);
4209 if (direction_value != NULL) /* direction found */
4211 add_helpanim_entry(atoi(element_value), -1, atoi(direction_value), delay,
4214 free(element_token);
4219 if (strchr(action_token + 1, '.') == NULL)
4221 /* no further suffixes found -- this is not an action nor direction */
4223 element_value = getHashEntry(element_hash, list->token);
4224 if (element_value != NULL) /* combined element found */
4225 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4228 print_unknown_token(filename, list->token, num_unknown_tokens++);
4230 free(element_token);
4235 /* token has format "<prefix>.<suffix>.<something>" */
4237 direction_token = strchr(action_token + 1, '.');
4239 action_token = getStringCopy(action_token);
4240 *strchr(action_token + 1, '.') = '\0';
4242 action_value = getHashEntry(action_hash, action_token);
4244 if (action_value == NULL) /* this is no action */
4246 element_value = getHashEntry(element_hash, list->token);
4247 if (element_value != NULL) /* combined element found */
4248 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4251 print_unknown_token(filename, list->token, num_unknown_tokens++);
4253 free(element_token);
4259 direction_value = getHashEntry(direction_hash, direction_token);
4261 if (direction_value != NULL) /* direction found */
4263 add_helpanim_entry(atoi(element_value), atoi(action_value),
4264 atoi(direction_value), delay, &num_list_entries);
4266 free(element_token);
4272 /* this is no direction */
4274 element_value = getHashEntry(element_hash, list->token);
4275 if (element_value != NULL) /* combined element found */
4276 add_helpanim_entry(atoi(element_value), -1, -1, delay,
4279 print_unknown_token(filename, list->token, num_unknown_tokens++);
4281 free(element_token);
4285 print_unknown_token_end(num_unknown_tokens);
4287 add_helpanim_entry(HELPANIM_LIST_NEXT, -1, -1, -1, &num_list_entries);
4288 add_helpanim_entry(HELPANIM_LIST_END, -1, -1, -1, &num_list_entries);
4290 freeSetupFileList(setup_file_list);
4291 freeSetupFileHash(element_hash);
4292 freeSetupFileHash(action_hash);
4293 freeSetupFileHash(direction_hash);
4297 for (i = 0; i < num_list_entries; i++)
4298 printf("::: %d, %d, %d => %d\n",
4299 helpanim_info[i].element,
4300 helpanim_info[i].action,
4301 helpanim_info[i].direction,
4302 helpanim_info[i].delay);
4306 void LoadHelpTextInfo()
4308 char *filename = getHelpTextFilename();
4311 if (helptext_info != NULL)
4313 freeSetupFileHash(helptext_info);
4314 helptext_info = NULL;
4317 if (fileExists(filename))
4318 helptext_info = loadSetupFileHash(filename);
4320 if (helptext_info == NULL)
4322 /* use reliable default values from static configuration */
4323 helptext_info = newSetupFileHash();
4325 for (i = 0; helptext_config[i].token; i++)
4326 setHashEntry(helptext_info,
4327 helptext_config[i].token,
4328 helptext_config[i].value);
4333 BEGIN_HASH_ITERATION(helptext_info, itr)
4335 printf("::: '%s' => '%s'\n",
4336 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
4338 END_HASH_ITERATION(hash, itr)