7 bill@newbreedsoftware.com
8 http://www.newbreedsoftware.com/supertux/
10 April 11, 2000 - March 15, 2004
21 #include <SDL_image.h>
23 #include <SDL_opengl.h>
27 #include <sys/types.h>
41 #include "configfile.h"
45 #define mkdir(dir, mode) mkdir(dir)
46 // on win32 we typically don't want LFS paths
48 #define DATA_PREFIX "./data/"
51 /* Local function prototypes: */
54 void usage(char * prog, int ret);
56 /* Does the given file exist and is it accessible? */
57 int faccessible(const char *filename)
60 if (stat(filename, &filestat) == -1)
66 if(S_ISREG(filestat.st_mode))
73 /* Can we write to this location? */
74 int fwriteable(const char *filename)
77 fi = fopen(filename, "wa");
85 /* Makes sure a directory is created in either the SuperTux home directory or the SuperTux base directory.*/
86 int fcreatedir(const char* relative_dir)
89 snprintf(path, 1024, "%s/%s/", st_dir, relative_dir);
90 if(mkdir(path,0755) != 0)
92 snprintf(path, 1024, "%s/%s/", datadir.c_str(), relative_dir);
93 if(mkdir(path,0755) != 0)
108 FILE * opendata(const char * rel_filename, const char * mode)
110 char * filename = NULL;
113 filename = (char *) malloc(sizeof(char) * (strlen(st_dir) +
114 strlen(rel_filename) + 1));
116 strcpy(filename, st_dir);
117 /* Open the high score file: */
119 strcat(filename, rel_filename);
121 /* Try opening the file: */
122 fi = fopen(filename, mode);
126 fprintf(stderr, "Warning: Unable to open the file \"%s\" ", filename);
128 if (strcmp(mode, "r") == 0)
129 fprintf(stderr, "for read!!!\n");
130 else if (strcmp(mode, "w") == 0)
131 fprintf(stderr, "for write!!!\n");
138 /* Get all names of sub-directories in a certain directory. */
139 /* Returns the number of sub-directories found. */
140 /* Note: The user has to free the allocated space. */
141 string_list_type dsubdirs(const char *rel_path,const char* expected_file)
144 struct dirent *direntp;
145 string_list_type sdirs;
149 string_list_init(&sdirs);
150 sprintf(path,"%s/%s",st_dir,rel_path);
151 if((dirStructP = opendir(path)) != NULL)
153 while((direntp = readdir(dirStructP)) != NULL)
155 char absolute_filename[1024];
158 sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
160 if (stat(absolute_filename, &buf) == 0 && S_ISDIR(buf.st_mode))
162 if(expected_file != NULL)
164 sprintf(filename,"%s/%s/%s",path,direntp->d_name,expected_file);
165 if(!faccessible(filename))
169 string_list_add_item(&sdirs,direntp->d_name);
172 closedir(dirStructP);
175 sprintf(path,"%s/%s",datadir.c_str(),rel_path);
176 if((dirStructP = opendir(path)) != NULL)
178 while((direntp = readdir(dirStructP)) != NULL)
180 char absolute_filename[1024];
183 sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
185 if (stat(absolute_filename, &buf) == 0 && S_ISDIR(buf.st_mode))
187 if(expected_file != NULL)
189 sprintf(filename,"%s/%s/%s",path,direntp->d_name,expected_file);
190 if(!faccessible(filename))
196 sprintf(filename,"%s/%s/%s/%s",st_dir,rel_path,direntp->d_name,expected_file);
197 if(faccessible(filename))
202 string_list_add_item(&sdirs,direntp->d_name);
205 closedir(dirStructP);
211 string_list_type dfiles(const char *rel_path, const char* glob, const char* exception_str)
214 struct dirent *direntp;
215 string_list_type sdirs;
218 string_list_init(&sdirs);
219 sprintf(path,"%s/%s",st_dir,rel_path);
220 if((dirStructP = opendir(path)) != NULL)
222 while((direntp = readdir(dirStructP)) != NULL)
224 char absolute_filename[1024];
227 sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
229 if (stat(absolute_filename, &buf) == 0 && S_ISREG(buf.st_mode))
231 if(exception_str != NULL)
233 if(strstr(direntp->d_name,exception_str) != NULL)
237 if(strstr(direntp->d_name,glob) == NULL)
240 string_list_add_item(&sdirs,direntp->d_name);
243 closedir(dirStructP);
246 sprintf(path,"%s/%s",datadir.c_str(),rel_path);
247 if((dirStructP = opendir(path)) != NULL)
249 while((direntp = readdir(dirStructP)) != NULL)
251 char absolute_filename[1024];
254 sprintf(absolute_filename, "%s/%s", path, direntp->d_name);
256 if (stat(absolute_filename, &buf) == 0 && S_ISREG(buf.st_mode))
258 if(exception_str != NULL)
260 if(strstr(direntp->d_name,exception_str) != NULL)
264 if(strstr(direntp->d_name,glob) == NULL)
267 string_list_add_item(&sdirs,direntp->d_name);
270 closedir(dirStructP);
276 void free_strings(char **strings, int num)
279 for(i=0; i < num; ++i)
284 /* Set SuperTux configuration and save directories */
285 void st_directory_setup(void)
289 /* Get home directory (from $HOME variable)... if we can't determine it,
290 use the current directory ("."): */
291 if (getenv("HOME") != NULL)
292 home = getenv("HOME");
296 st_dir = (char *) malloc(sizeof(char) * (strlen(home) +
297 strlen("/.supertux") + 1));
298 strcpy(st_dir, home);
299 strcat(st_dir, "/.supertux");
301 /* Remove .supertux config-file from old SuperTux versions */
302 if(faccessible(st_dir))
308 st_save_dir = (char *) malloc(sizeof(char) * (strlen(st_dir) + strlen("/save") + 1));
310 strcpy(st_save_dir,st_dir);
311 strcat(st_save_dir,"/save");
313 /* Create them. In the case they exist they won't destroy anything. */
315 mkdir(st_save_dir, 0755);
317 sprintf(str, "%s/levels", st_dir);
320 // User has not that a datadir, so we try some magic
325 char exe_file[PATH_MAX];
326 if (readlink("/proc/self/exe", exe_file, PATH_MAX) < 0)
328 puts("Couldn't read /proc/self/exe, using default path: " DATA_PREFIX);
329 datadir = DATA_PREFIX;
333 std::string exedir = std::string(dirname(exe_file)) + "/";
335 datadir = exedir + "../data/"; // SuperTux run from source dir
336 if (access(datadir.c_str(), F_OK) != 0)
338 datadir = exedir + "../share/supertux/"; // SuperTux run from PATH
339 if (access(datadir.c_str(), F_OK) != 0)
340 { // If all fails, fall back to compiled path
341 datadir = DATA_PREFIX;
346 datadir = DATA_PREFIX;
349 printf("Datadir: %s\n", datadir.c_str());
352 /* Create and setup menus. */
355 main_menu = new Menu();
356 options_menu = new Menu();
357 options_controls_menu = new Menu();
358 load_game_menu = new Menu();
359 save_game_menu = new Menu();
360 game_menu = new Menu();
361 highscore_menu = new Menu();
362 contrib_menu = new Menu();
364 main_menu->set_pos(screen->w/2, 335);
365 main_menu->additem(MN_GOTO, "Start Game",0,load_game_menu);
366 main_menu->additem(MN_GOTO, "Contrib Levels",0,contrib_menu);
367 main_menu->additem(MN_GOTO, "Options",0,options_menu);
368 main_menu->additem(MN_ACTION,"Level editor",0,0);
369 main_menu->additem(MN_ACTION,"Credits",0,0);
370 main_menu->additem(MN_ACTION,"Quit",0,0);
372 contrib_menu->additem(MN_LABEL,"Contrib Levels",0,0);
373 contrib_menu->additem(MN_HL,"",0,0);
374 contrib_menu->additem(MN_ACTION, "Some Levelset", 0, 0);
375 contrib_menu->additem(MN_ACTION, "Someother Levelset", 0, 0);
376 contrib_menu->additem(MN_ACTION, "Yet another Levelset", 0, 0);
377 contrib_menu->additem(MN_HL,"",0,0);
378 contrib_menu->additem(MN_BACK,"Back",0,0);
380 options_menu->additem(MN_LABEL,"Options",0,0);
381 options_menu->additem(MN_HL,"",0,0);
382 options_menu->additem(MN_TOGGLE,"Fullscreen",use_fullscreen,0);
385 options_menu->additem(MN_TOGGLE,"Sound ",use_sound,0);
386 options_menu->additem(MN_TOGGLE,"Music ",use_music,0);
390 options_menu->additem(MN_DEACTIVE,"Sound ",use_sound,0);
391 options_menu->additem(MN_DEACTIVE,"Music ",use_music,0);
393 options_menu->additem(MN_TOGGLE,"Show FPS ",show_fps,0);
394 options_menu->additem(MN_GOTO,"Controls ",0,options_controls_menu);
395 options_menu->additem(MN_HL,"",0,0);
396 options_menu->additem(MN_BACK,"Back",0,0);
398 options_controls_menu->additem(MN_LABEL,"Controls",0,0);
399 options_controls_menu->additem(MN_HL,"",0,0);
400 options_controls_menu->additem(MN_CONTROLFIELD,"Move Right",tux.keymap.right,0);
401 options_controls_menu->additem(MN_HL,"",0,0);
402 options_controls_menu->additem(MN_BACK,"Back",0,0);
404 load_game_menu->additem(MN_LABEL,"Start Game",0,0);
405 load_game_menu->additem(MN_HL,"",0,0);
406 load_game_menu->additem(MN_DEACTIVE,"Slot 1",0,0);
407 load_game_menu->additem(MN_DEACTIVE,"Slot 2",0,0);
408 load_game_menu->additem(MN_DEACTIVE,"Slot 3",0,0);
409 load_game_menu->additem(MN_DEACTIVE,"Slot 4",0,0);
410 load_game_menu->additem(MN_DEACTIVE,"Slot 5",0,0);
411 load_game_menu->additem(MN_HL,"",0,0);
412 load_game_menu->additem(MN_BACK,"Back",0,0);
414 save_game_menu->additem(MN_LABEL,"Save Game",0,0);
415 save_game_menu->additem(MN_HL,"",0,0);
416 save_game_menu->additem(MN_DEACTIVE,"Slot 1",0,0);
417 save_game_menu->additem(MN_DEACTIVE,"Slot 2",0,0);
418 save_game_menu->additem(MN_DEACTIVE,"Slot 3",0,0);
419 save_game_menu->additem(MN_DEACTIVE,"Slot 4",0,0);
420 save_game_menu->additem(MN_DEACTIVE,"Slot 5",0,0);
421 save_game_menu->additem(MN_HL,"",0,0);
422 save_game_menu->additem(MN_BACK,"Back",0,0);
424 game_menu->additem(MN_LABEL,"InGame Menu",0,0);
425 game_menu->additem(MN_HL,"",0,0);
426 game_menu->additem(MN_ACTION,"Return To Game",0,0);
427 game_menu->additem(MN_GOTO,"Save Game",0,save_game_menu);
428 game_menu->additem(MN_GOTO,"Load Game",0,load_game_menu);
429 game_menu->additem(MN_GOTO,"Options",0,options_menu);
430 game_menu->additem(MN_HL,"",0,0);
431 game_menu->additem(MN_ACTION,"Quit Game",0,0);
433 highscore_menu->additem(MN_TEXTFIELD,"Enter your name:",0,0);
436 void update_load_save_game_menu(Menu* pmenu, int load)
438 for(int i = 2; i < 7; ++i)
440 // FIXME: Insert a real savegame struct/class here instead of
441 // doing string vodoo
442 std::string tmp = slotinfo(i-1);
444 if(load && tmp.length() == strlen("Slot X - Free"))
445 pmenu->item[i].kind = MN_ACTION;
447 pmenu->item[i].kind = MN_ACTION;
448 menu_item_change_text(&pmenu->item[i], tmp.c_str());
452 void process_save_game_menu()
454 int slot = save_game_menu->check();
459 bool process_load_game_menu()
461 int slot = load_game_menu->check();
465 // FIXME: Insert a real savegame struct/class here instead of
466 // doing string vodoo
467 std::string tmp = slotinfo(slot-1);
468 if (tmp.length() == strlen("Slot X - Free"))
470 gameloop("default", 1, ST_GL_PLAY);
472 Menu::set_current(main_menu);
478 gameloop("default",slot - 1,ST_GL_LOAD_GAME);
480 Menu::set_current(main_menu);
487 st_pause_ticks_stop();
496 /* Handle changes made to global settings in the options menu. */
497 void process_options_menu(void)
499 switch (options_menu->check())
502 if(use_fullscreen != options_menu->item[2].toggled)
504 use_fullscreen = !use_fullscreen;
509 if(use_sound != options_menu->item[3].toggled)
510 use_sound = !use_sound;
513 if(use_music != options_menu->item[4].toggled)
526 if (!playing_music())
528 play_current_music();
534 if(show_fps != options_menu->item[5].toggled)
535 show_fps = !show_fps;
540 void st_general_setup(void)
542 /* Seed random number generator: */
544 srand(SDL_GetTicks());
546 /* Set icon image: */
550 /* Unicode needed for input handling: */
552 SDL_EnableUNICODE(1);
554 /* Load global images: */
556 text_load(&black_text, datadir + "/images/status/letters-black.png", TEXT_TEXT, 16,18);
557 text_load(&gold_text,datadir + "/images/status/letters-gold.png", TEXT_TEXT, 16,18);
558 text_load(&blue_text,datadir + "/images/status/letters-blue.png", TEXT_TEXT, 16,18);
559 text_load(&red_text,datadir + "/images/status/letters-red.png", TEXT_TEXT, 16,18);
560 text_load(&white_text,datadir + "/images/status/letters-white.png", TEXT_TEXT, 16,18);
561 text_load(&white_small_text,datadir + "/images/status/letters-white-small.png", TEXT_TEXT, 8,9);
562 text_load(&white_big_text,datadir + "/images/status/letters-white-big.png", TEXT_TEXT, 20,23);
563 text_load(&yellow_nums,datadir + "/images/status/numbers.png", TEXT_NUM, 32,32);
565 /* Load GUI/menu images: */
566 texture_load(&checkbox, datadir + "/images/status/checkbox.png", USE_ALPHA);
567 texture_load(&checkbox_checked, datadir + "/images/status/checkbox-checked.png", USE_ALPHA);
568 texture_load(&back, datadir + "/images/status/back.png", USE_ALPHA);
569 texture_load(&arrow_left, datadir + "/images/icons/left.png", USE_ALPHA);
570 texture_load(&arrow_right, datadir + "/images/icons/right.png", USE_ALPHA);
572 /* Load the mouse-cursor */
573 mouse_cursor = new MouseCursor( datadir + "/images/status/mousecursor.png",1);
577 void st_general_free(void)
580 /* Free global images: */
582 text_free(&black_text);
583 text_free(&gold_text);
584 text_free(&white_text);
585 text_free(&blue_text);
586 text_free(&red_text);
587 text_free(&white_small_text);
588 text_free(&white_big_text);
590 /* Free GUI/menu images: */
591 texture_free(&checkbox);
592 texture_free(&checkbox_checked);
594 texture_free(&arrow_left);
595 texture_free(&arrow_right);
597 /* Free mouse-cursor */
604 delete highscore_menu;
605 delete save_game_menu;
606 delete load_game_menu;
609 void st_video_setup(void)
613 SDL_FreeSurface(screen);
615 /* Init SDL Video: */
617 if (SDL_Init(SDL_INIT_VIDEO) < 0)
620 "\nError: I could not initialize video!\n"
621 "The Simple DirectMedia error that occured was:\n"
622 "%s\n\n", SDL_GetError());
631 st_video_setup_sdl();
635 /* Set window manager stuff: */
637 SDL_WM_SetCaption("SuperTux " VERSION, "SuperTux");
641 void st_video_setup_sdl(void)
643 SDL_FreeSurface(screen);
647 screen = SDL_SetVideoMode(640, 480, 0, SDL_FULLSCREEN ) ; /* | SDL_HWSURFACE); */
651 "\nWarning: I could not set up fullscreen video for "
653 "The Simple DirectMedia error that occured was:\n"
654 "%s\n\n", SDL_GetError());
655 use_fullscreen = false;
660 screen = SDL_SetVideoMode(640, 480, 0, SDL_HWSURFACE | SDL_DOUBLEBUF );
665 "\nError: I could not set up video for 640x480 mode.\n"
666 "The Simple DirectMedia error that occured was:\n"
667 "%s\n\n", SDL_GetError());
673 void st_video_setup_gl(void)
677 SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 5);
678 SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 5);
679 SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 5);
680 SDL_GL_SetAttribute(SDL_GL_DEPTH_SIZE, 16);
681 SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1);
685 screen = SDL_SetVideoMode(640, 480, 0, SDL_FULLSCREEN | SDL_OPENGL) ; /* | SDL_HWSURFACE); */
689 "\nWarning: I could not set up fullscreen video for "
691 "The Simple DirectMedia error that occured was:\n"
692 "%s\n\n", SDL_GetError());
693 use_fullscreen = false;
698 screen = SDL_SetVideoMode(640, 480, 0, SDL_OPENGL);
703 "\nError: I could not set up video for 640x480 mode.\n"
704 "The Simple DirectMedia error that occured was:\n"
705 "%s\n\n", SDL_GetError());
711 * Set up OpenGL for 2D rendering.
713 glDisable(GL_DEPTH_TEST);
714 glDisable(GL_CULL_FACE);
716 glViewport(0, 0, screen->w, screen->h);
717 glMatrixMode(GL_PROJECTION);
719 glOrtho(0, screen->w, screen->h, 0, -1.0, 1.0);
721 glMatrixMode(GL_MODELVIEW);
723 glTranslatef(0.0f, 0.0f, 0.0f);
729 void st_joystick_setup(void)
736 if (SDL_Init(SDL_INIT_JOYSTICK) < 0)
738 fprintf(stderr, "Warning: I could not initialize joystick!\n"
739 "The Simple DirectMedia error that occured was:\n"
740 "%s\n\n", SDL_GetError());
742 use_joystick = false;
747 if (SDL_NumJoysticks() <= 0)
749 fprintf(stderr, "Warning: No joysticks are available.\n");
751 use_joystick = false;
755 js = SDL_JoystickOpen(joystick_num);
759 fprintf(stderr, "Warning: Could not open joystick %d.\n"
760 "The Simple DirectMedia error that occured was:\n"
761 "%s\n\n", joystick_num, SDL_GetError());
763 use_joystick = false;
767 /* Check for proper joystick configuration: */
769 if (SDL_JoystickNumAxes(js) < 2)
772 "Warning: Joystick does not have enough axes!\n");
774 use_joystick = false;
778 if (SDL_JoystickNumButtons(js) < 2)
782 "Joystick does not have enough buttons!\n");
784 use_joystick = false;
792 void st_audio_setup(void)
795 /* Init SDL Audio silently even if --disable-sound : */
799 if (SDL_Init(SDL_INIT_AUDIO) < 0)
801 /* only print out message if sound or music
802 was not disabled at command-line
804 if (use_sound || use_music)
807 "\nWarning: I could not initialize audio!\n"
808 "The Simple DirectMedia error that occured was:\n"
809 "%s\n\n", SDL_GetError());
811 /* keep the programming logic the same :-)
812 because in this case, use_sound & use_music' values are ignored
813 when there's no available audio device
817 audio_device = false;
822 /* Open sound silently regarless the value of "use_sound": */
826 if (open_audio(44100, AUDIO_S16, 2, 2048) < 0)
828 /* only print out message if sound or music
829 was not disabled at command-line
831 if (use_sound || use_music)
834 "\nWarning: I could not set up audio for 44100 Hz "
836 "The Simple DirectMedia error that occured was:\n"
837 "%s\n\n", SDL_GetError());
841 audio_device = false;
848 /* --- SHUTDOWN --- */
850 void st_shutdown(void)
859 void st_abort(const std::string& reason, const std::string& details)
861 fprintf(stderr, "\nError: %s\n%s\n\n", reason.c_str(), details.c_str());
867 /* Set Icon (private) */
876 /* Load icon into a surface: */
878 icon = IMG_Load((datadir + "/images/icon.png").c_str());
882 "\nError: I could not load the icon image: %s%s\n"
883 "The Simple DirectMedia error that occured was:\n"
884 "%s\n\n", datadir.c_str(), "/images/icon.png", SDL_GetError());
891 masklen = (((icon -> w) + 7) / 8) * (icon -> h);
892 mask = (Uint8*) malloc(masklen * sizeof(Uint8));
893 memset(mask, 0xFF, masklen);
898 SDL_WM_SetIcon(icon, mask);
901 /* Free icon surface & mask: */
904 SDL_FreeSurface(icon);
908 /* Parse command-line arguments: */
910 void parseargs(int argc, char * argv[])
916 /* Parse arguments: */
918 for (i = 1; i < argc; i++)
920 if (strcmp(argv[i], "--fullscreen") == 0 ||
921 strcmp(argv[i], "-f") == 0)
923 /* Use full screen: */
925 use_fullscreen = true;
927 else if (strcmp(argv[i], "--joystick") == 0 || strcmp(argv[i], "-j") == 0)
930 joystick_num = atoi(argv[++i]);
932 else if (strcmp(argv[i], "--worldmap") == 0)
934 launch_worldmap_mode = true;
936 else if (strcmp(argv[i], "--datadir") == 0
937 || strcmp(argv[i], "-d") == 0 )
942 else if (strcmp(argv[i], "--show-fps") == 0)
944 /* Use full screen: */
948 else if (strcmp(argv[i], "--opengl") == 0 ||
949 strcmp(argv[i], "-gl") == 0)
957 else if (strcmp(argv[i], "--sdl") == 0)
961 else if (strcmp(argv[i], "--usage") == 0)
967 else if (strcmp(argv[i], "--version") == 0)
970 printf("SuperTux " VERSION "\n");
973 else if (strcmp(argv[i], "--disable-sound") == 0)
975 /* Disable the compiled in sound feature */
976 printf("Sounds disabled \n");
979 else if (strcmp(argv[i], "--disable-music") == 0)
981 /* Disable the compiled in sound feature */
982 printf("Music disabled \n");
985 else if (strcmp(argv[i], "--debug-mode") == 0)
987 /* Enable the debug-mode */
991 else if (strcmp(argv[i], "--help") == 0)
993 puts("Super Tux " VERSION "\n"
994 " Please see the file \"README.txt\" for more details.\n");
995 printf("Usage: %s [OPTIONS] FILENAME\n\n", argv[0]);
996 puts("Display Options:\n"
997 " --fullscreen Run in fullscreen mode.\n"
998 " --opengl If opengl support was compiled in, this will enable\n"
999 " the EXPERIMENTAL OpenGL mode.\n"
1000 " --sdl Use non-opengl renderer\n"
1003 " --disable-sound If sound support was compiled in, this will\n"
1004 " disable sound for this session of the game.\n"
1005 " --disable-music Like above, but this will disable music.\n"
1008 " -j, --joystick NUM Use joystick NUM (default: 0)\n"
1009 " --worldmap Start in worldmap-mode (EXPERIMENTAL)\n"
1010 " -d, --datadir DIR Load Game data from DIR (default: automatic)\n"
1011 " --debug-mode Enables the debug-mode, which is useful for developers.\n"
1012 " --help Display a help message summarizing command-line\n"
1013 " options, license and game controls.\n"
1014 " --usage Display a brief message summarizing command-line options.\n"
1015 " --version Display the version of SuperTux you're running.\n\n"
1019 else if (argv[i][0] != '-')
1021 level_startup_file = argv[i];
1025 /* Unknown - complain! */
1033 /* Display usage: */
1035 void usage(char * prog, int ret)
1040 /* Determine which stream to write to: */
1048 /* Display the usage message: */
1050 fprintf(fi, "Usage: %s [--fullscreen] [--opengl] [--disable-sound] [--disable-music] [--debug-mode] | [--usage | --help | --version] [--worldmap] FILENAME\n",