3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "mainmenumanager.h"
25 #include "guiMainMenu.h"
31 #include "serverlist.h"
32 #include "guiEngine.h"
34 #include "fontengine.h"
35 #include "joystick_controller.h"
36 #include "clientlauncher.h"
41 gui::IGUIEnvironment *guienv = NULL;
42 gui::IGUIStaticText *guiroot = NULL;
43 MainMenuManager g_menumgr;
47 return g_menumgr.menuCount() == 0;
50 // Passed to menus to allow disconnecting and exiting
51 MainGameCallback *g_gamecallback = NULL;
54 // Instance of the time getter
55 static TimeGetter *g_timegetter = NULL;
59 if (g_timegetter == NULL)
61 return g_timegetter->getTime(PRECISION_MILLI);
64 u32 getTime(TimePrecision prec) {
65 if (g_timegetter == NULL)
67 return g_timegetter->getTime(prec);
70 ClientLauncher::~ClientLauncher()
86 bool ClientLauncher::run(GameParams &game_params, const Settings &cmd_args)
88 init_args(game_params, cmd_args);
90 // List video modes if requested
92 return print_video_modes();
95 errorstream << "Could not initialize game engine." << std::endl;
100 g_timegetter = new IrrlichtTimeGetter(device);
102 // Speed tests (done after irrlicht is loaded to get timer)
103 if (cmd_args.getFlag("speedtests")) {
104 dstream << "Running speed tests" << std::endl;
109 video::IVideoDriver *video_driver = device->getVideoDriver();
110 if (video_driver == NULL) {
111 errorstream << "Could not initialize video driver." << std::endl;
115 porting::setXorgClassHint(video_driver->getExposedVideoData(), PROJECT_NAME_C);
117 porting::setXorgWindowIcon(device);
120 This changes the minimum allowed number of vertices in a VBO.
123 //driver->setMinHardwareBufferVertexCount(50);
125 // Create game callback for menus
126 g_gamecallback = new MainGameCallback(device);
128 device->setResizable(true);
131 input = new RandomInputHandler();
133 input = new RealInputHandler(device, receiver);
135 smgr = device->getSceneManager();
136 smgr->getParameters()->setAttribute(scene::ALLOW_ZWRITE_ON_TRANSPARENT, true);
138 guienv = device->getGUIEnvironment();
139 skin = guienv->getSkin();
140 skin->setColor(gui::EGDC_BUTTON_TEXT, video::SColor(255, 255, 255, 255));
141 skin->setColor(gui::EGDC_3D_LIGHT, video::SColor(0, 0, 0, 0));
142 skin->setColor(gui::EGDC_3D_HIGH_LIGHT, video::SColor(255, 30, 30, 30));
143 skin->setColor(gui::EGDC_3D_SHADOW, video::SColor(255, 0, 0, 0));
144 skin->setColor(gui::EGDC_HIGH_LIGHT, video::SColor(255, 70, 120, 50));
145 skin->setColor(gui::EGDC_HIGH_LIGHT_TEXT, video::SColor(255, 255, 255, 255));
147 g_fontengine = new FontEngine(g_settings, guienv);
148 FATAL_ERROR_IF(g_fontengine == NULL, "Font engine creation failed.");
150 #if (IRRLICHT_VERSION_MAJOR >= 1 && IRRLICHT_VERSION_MINOR >= 8) || IRRLICHT_VERSION_MAJOR >= 2
151 // Irrlicht 1.8 input colours
152 skin->setColor(gui::EGDC_EDITABLE, video::SColor(255, 128, 128, 128));
153 skin->setColor(gui::EGDC_FOCUSED_EDITABLE, video::SColor(255, 96, 134, 49));
156 // Create the menu clouds
157 if (!g_menucloudsmgr)
158 g_menucloudsmgr = smgr->createNewSceneManager();
160 g_menuclouds = new Clouds(g_menucloudsmgr->getRootSceneNode(),
161 g_menucloudsmgr, -1, rand(), 100);
162 g_menuclouds->update(v2f(0, 0), video::SColor(255, 200, 200, 255));
163 scene::ICameraSceneNode* camera;
164 camera = g_menucloudsmgr->addCameraSceneNode(0,
165 v3f(0, 0, 0), v3f(0, 60, 100));
166 camera->setFarValue(10000);
172 ChatBackend chat_backend;
174 // If an error occurs, this is set to something by menu().
175 // It is then displayed before the menu shows on the next call to menu()
176 std::string error_message;
177 bool reconnect_requested = false;
179 bool first_loop = true;
185 bool *kill = porting::signal_handler_killstatus();
187 while (device->run() && !*kill && !g_gamecallback->shutdown_requested)
189 // Set the window caption
190 const wchar_t *text = wgettext("Main Menu");
191 device->setWindowCaption((utf8_to_wide(PROJECT_NAME_C) +
192 L" " + utf8_to_wide(g_version_hash) +
193 L" [" + text + L"]").c_str());
196 try { // This is used for catching disconnects
201 We need some kind of a root node to be able to add
202 custom gui elements directly on the screen.
203 Otherwise they won't be automatically drawn.
205 guiroot = guienv->addStaticText(L"", core::rect<s32>(0, 0, 10000, 10000));
207 bool game_has_run = launch_game(error_message, reconnect_requested,
208 game_params, cmd_args);
210 // Reset the reconnect_requested flag
211 reconnect_requested = false;
213 // If skip_main_menu, we only want to startup once
214 if (skip_main_menu && !first_loop)
226 // Break out of menu-game loop to shut down cleanly
227 if (!device->run() || *kill) {
228 if (g_settings_path != "")
229 g_settings->updateConfigFile(g_settings_path.c_str());
233 if (current_playername.length() > PLAYERNAME_SIZE-1) {
234 error_message = gettext("Player name too long.");
235 playername = current_playername.substr(0, PLAYERNAME_SIZE-1);
236 g_settings->set("name", playername);
240 device->getVideoDriver()->setTextureCreationFlag(
241 video::ETCF_CREATE_MIP_MAPS, g_settings->getBool("mip_map"));
243 #ifdef HAVE_TOUCHSCREENGUI
244 receiver->m_touchscreengui = new TouchScreenGUI(device, receiver);
245 g_touchscreengui = receiver->m_touchscreengui;
260 &reconnect_requested,
262 simple_singleplayer_mode
266 #ifdef HAVE_TOUCHSCREENGUI
267 delete g_touchscreengui;
268 g_touchscreengui = NULL;
269 receiver->m_touchscreengui = NULL;
273 catch (con::PeerNotFoundException &e) {
274 error_message = gettext("Connection error (timed out?)");
275 errorstream << error_message << std::endl;
279 catch (std::exception &e) {
280 std::string error_message = "Some exception: \"";
281 error_message += e.what();
282 error_message += "\"";
283 errorstream << error_message << std::endl;
287 // If no main menu, show error and exit
288 if (skip_main_menu) {
289 if (!error_message.empty()) {
290 verbosestream << "error_message = "
291 << error_message << std::endl;
298 g_menuclouds->drop();
299 g_menucloudsmgr->drop();
304 void ClientLauncher::init_args(GameParams &game_params, const Settings &cmd_args)
307 skip_main_menu = cmd_args.getFlag("go");
309 // FIXME: This is confusing (but correct)
311 /* If world_path is set then override it unless skipping the main menu using
312 * the --go command line param. Else, give preference to the address
313 * supplied on the command line
315 address = g_settings->get("address");
316 if (game_params.world_path != "" && !skip_main_menu)
318 else if (cmd_args.exists("address"))
319 address = cmd_args.get("address");
321 playername = g_settings->get("name");
322 if (cmd_args.exists("name"))
323 playername = cmd_args.get("name");
325 list_video_modes = cmd_args.getFlag("videomodes");
327 use_freetype = g_settings->getBool("freetype");
329 random_input = g_settings->getBool("random_input")
330 || cmd_args.getFlag("random-input");
333 bool ClientLauncher::init_engine()
335 receiver = new MyEventReceiver();
336 create_engine_device();
337 return device != NULL;
340 bool ClientLauncher::launch_game(std::string &error_message,
341 bool reconnect_requested, GameParams &game_params,
342 const Settings &cmd_args)
344 // Initialize menu data
345 MainMenuData menudata;
346 menudata.address = address;
347 menudata.name = playername;
348 menudata.password = password;
349 menudata.port = itos(game_params.socket_port);
350 menudata.script_data.errormessage = error_message;
351 menudata.script_data.reconnect_requested = reconnect_requested;
353 error_message.clear();
355 if (cmd_args.exists("password"))
356 menudata.password = cmd_args.get("password");
358 menudata.enable_public = g_settings->getBool("server_announce");
360 // If a world was commanded, append and select it
361 if (game_params.world_path != "") {
362 worldspec.gameid = getWorldGameId(game_params.world_path, true);
363 worldspec.name = _("[--world parameter]");
365 if (worldspec.gameid == "") { // Create new
366 worldspec.gameid = g_settings->get("default_game");
367 worldspec.name += " [new]";
369 worldspec.path = game_params.world_path;
374 if (!skip_main_menu) {
375 main_menu(&menudata);
377 // Skip further loading if there was an exit signal.
378 if (*porting::signal_handler_killstatus())
381 address = menudata.address;
382 int newport = stoi(menudata.port);
384 game_params.socket_port = newport;
386 simple_singleplayer_mode = menudata.simple_singleplayer_mode;
388 std::vector<WorldSpec> worldspecs = getAvailableWorlds();
390 if (menudata.selected_world >= 0
391 && menudata.selected_world < (int)worldspecs.size()) {
392 g_settings->set("selected_world_path",
393 worldspecs[menudata.selected_world].path);
394 worldspec = worldspecs[menudata.selected_world];
398 if (!menudata.script_data.errormessage.empty()) {
399 /* The calling function will pass this back into this function upon the
400 * next iteration (if any) causing it to be displayed by the GUI
402 error_message = menudata.script_data.errormessage;
406 if (menudata.name == "" && !simple_singleplayer_mode) {
407 error_message = gettext("Please choose a name!");
411 playername = menudata.name;
412 password = menudata.password;
414 current_playername = playername;
415 current_password = password;
416 current_address = address;
417 current_port = game_params.socket_port;
419 // If using simple singleplayer mode, override
420 if (simple_singleplayer_mode) {
421 assert(skip_main_menu == false);
422 current_playername = "singleplayer";
423 current_password = "";
424 current_address = "";
425 current_port = myrand_range(49152, 65535);
427 g_settings->set("name", playername);
429 ServerListSpec server;
430 server["name"] = menudata.servername;
431 server["address"] = menudata.address;
432 server["port"] = menudata.port;
433 server["description"] = menudata.serverdescription;
434 ServerList::insert(server);
438 infostream << "Selected world: " << worldspec.name
439 << " [" << worldspec.path << "]" << std::endl;
441 if (current_address == "") { // If local game
442 if (worldspec.path == "") {
443 error_message = gettext("No world selected and no address "
444 "provided. Nothing to do.");
445 errorstream << error_message << std::endl;
449 if (!fs::PathExists(worldspec.path)) {
450 error_message = gettext("Provided world path doesn't exist: ")
452 errorstream << error_message << std::endl;
456 // Load gamespec for required game
457 gamespec = findWorldSubgame(worldspec.path);
458 if (!gamespec.isValid() && !game_params.game_spec.isValid()) {
459 error_message = gettext("Could not find or load game \"")
460 + worldspec.gameid + "\"";
461 errorstream << error_message << std::endl;
465 if (porting::signal_handler_killstatus())
468 if (game_params.game_spec.isValid() &&
469 game_params.game_spec.id != worldspec.gameid) {
470 warningstream << "Overriding gamespec from \""
471 << worldspec.gameid << "\" to \""
472 << game_params.game_spec.id << "\"" << std::endl;
473 gamespec = game_params.game_spec;
476 if (!gamespec.isValid()) {
477 error_message = gettext("Invalid gamespec.");
478 error_message += " (world.gameid=" + worldspec.gameid + ")";
479 errorstream << error_message << std::endl;
487 void ClientLauncher::main_menu(MainMenuData *menudata)
489 bool *kill = porting::signal_handler_killstatus();
490 video::IVideoDriver *driver = device->getVideoDriver();
492 infostream << "Waiting for other menus" << std::endl;
493 while (device->run() && *kill == false) {
496 driver->beginScene(true, true, video::SColor(255, 128, 128, 128));
499 // On some computers framerate doesn't seem to be automatically limited
502 infostream << "Waited for other menus" << std::endl;
504 // Cursor can be non-visible when coming from the game
506 device->getCursorControl()->setVisible(true);
510 GUIEngine mymenu(device, &input->joystick, guiroot,
511 &g_menumgr, smgr, menudata, *kill);
513 smgr->clear(); /* leave scene manager in a clean state */
516 bool ClientLauncher::create_engine_device()
518 // Resolution selection
519 bool fullscreen = g_settings->getBool("fullscreen");
520 u16 screenW = g_settings->getU16("screenW");
521 u16 screenH = g_settings->getU16("screenH");
524 bool vsync = g_settings->getBool("vsync");
525 u16 bits = g_settings->getU16("fullscreen_bpp");
526 u16 fsaa = g_settings->getU16("fsaa");
528 // stereo buffer required for pageflip stereo
529 bool stereo_buffer = g_settings->get("3d_mode") == "pageflip";
532 video::E_DRIVER_TYPE driverType = video::EDT_OPENGL;
533 std::string driverstring = g_settings->get("video_driver");
534 std::vector<video::E_DRIVER_TYPE> drivers
535 = porting::getSupportedVideoDrivers();
537 for (i = 0; i != drivers.size(); i++) {
538 if (!strcasecmp(driverstring.c_str(),
539 porting::getVideoDriverName(drivers[i]))) {
540 driverType = drivers[i];
544 if (i == drivers.size()) {
545 errorstream << "Invalid video_driver specified; "
546 "defaulting to opengl" << std::endl;
549 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
550 params.DriverType = driverType;
551 params.WindowSize = core::dimension2d<u32>(screenW, screenH);
553 params.AntiAlias = fsaa;
554 params.Fullscreen = fullscreen;
555 params.Stencilbuffer = false;
556 params.Stereobuffer = stereo_buffer;
557 params.Vsync = vsync;
558 params.EventReceiver = receiver;
559 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
560 params.ZBufferBits = 24;
562 params.PrivateData = porting::app_global;
563 params.OGLES2ShaderPath = std::string(porting::path_user + DIR_DELIM +
564 "media" + DIR_DELIM + "Shaders" + DIR_DELIM).c_str();
567 device = createDeviceEx(params);
570 if (g_settings->getBool("enable_joysticks")) {
571 irr::core::array<irr::SJoystickInfo> infos;
572 std::vector<irr::SJoystickInfo> joystick_infos;
573 // Make sure this is called maximum once per
574 // irrlicht device, otherwise it will give you
575 // multiple events for the same joystick.
576 if (device->activateJoysticks(infos)) {
577 infostream << "Joystick support enabled" << std::endl;
578 joystick_infos.reserve(infos.size());
579 for (u32 i = 0; i < infos.size(); i++) {
580 joystick_infos.push_back(infos[i]);
583 errorstream << "Could not activate joystick support." << std::endl;
586 porting::initIrrlicht(device);
589 return device != NULL;
592 void ClientLauncher::speed_tests()
594 // volatile to avoid some potential compiler optimisations
595 volatile static s16 temp16;
596 volatile static f32 tempf;
599 static std::string tempstring;
600 static std::string tempstring2;
604 tempstring = std::string();
605 tempstring2 = std::string();
608 infostream << "The following test should take around 20ms." << std::endl;
609 TimeTaker timer("Testing std::string speed");
610 const u32 jj = 10000;
611 for (u32 j = 0; j < jj; j++) {
615 for (u32 i = 0; i < ii; i++) {
616 tempstring2 += "asd";
618 for (u32 i = 0; i < ii+1; i++) {
620 if (tempstring == tempstring2)
626 infostream << "All of the following tests should take around 100ms each."
630 TimeTaker timer("Testing floating-point conversion speed");
632 for (u32 i = 0; i < 4000000; i++) {
639 TimeTaker timer("Testing floating-point vector speed");
641 tempv3f1 = v3f(1, 2, 3);
642 tempv3f2 = v3f(4, 5, 6);
643 for (u32 i = 0; i < 10000000; i++) {
644 tempf += tempv3f1.dotProduct(tempv3f2);
645 tempv3f2 += v3f(7, 8, 9);
650 TimeTaker timer("Testing std::map speed");
652 std::map<v2s16, f32> map1;
655 for (s16 y = 0; y < ii; y++) {
656 for (s16 x = 0; x < ii; x++) {
657 map1[v2s16(x, y)] = tempf;
661 for (s16 y = ii - 1; y >= 0; y--) {
662 for (s16 x = 0; x < ii; x++) {
663 tempf = map1[v2s16(x, y)];
669 infostream << "Around 5000/ms should do well here." << std::endl;
670 TimeTaker timer("Testing mutex speed");
683 while(timer.getTimerTime() < 10);
685 u32 dtime = timer.stop();
686 u32 per_ms = n / dtime;
687 infostream << "Done. " << dtime << "ms, " << per_ms << "/ms" << std::endl;
691 bool ClientLauncher::print_video_modes()
693 IrrlichtDevice *nulldevice;
695 bool vsync = g_settings->getBool("vsync");
696 u16 fsaa = g_settings->getU16("fsaa");
697 MyEventReceiver* receiver = new MyEventReceiver();
699 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
700 params.DriverType = video::EDT_NULL;
701 params.WindowSize = core::dimension2d<u32>(640, 480);
703 params.AntiAlias = fsaa;
704 params.Fullscreen = false;
705 params.Stencilbuffer = false;
706 params.Vsync = vsync;
707 params.EventReceiver = receiver;
708 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
710 nulldevice = createDeviceEx(params);
712 if (nulldevice == NULL) {
717 std::cout << _("Available video modes (WxHxD):") << std::endl;
719 video::IVideoModeList *videomode_list = nulldevice->getVideoModeList();
721 if (videomode_list != NULL) {
722 s32 videomode_count = videomode_list->getVideoModeCount();
723 core::dimension2d<u32> videomode_res;
725 for (s32 i = 0; i < videomode_count; ++i) {
726 videomode_res = videomode_list->getVideoModeResolution(i);
727 videomode_depth = videomode_list->getVideoModeDepth(i);
728 std::cout << videomode_res.Width << "x" << videomode_res.Height
729 << "x" << videomode_depth << std::endl;
732 std::cout << _("Active video mode (WxHxD):") << std::endl;
733 videomode_res = videomode_list->getDesktopResolution();
734 videomode_depth = videomode_list->getDesktopDepth();
735 std::cout << videomode_res.Width << "x" << videomode_res.Height
736 << "x" << videomode_depth << std::endl;
743 return videomode_list != NULL;