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 = nullptr;
42 gui::IGUIStaticText *guiroot = nullptr;
43 MainMenuManager g_menumgr;
47 return g_menumgr.menuCount() != 0;
50 // Passed to menus to allow disconnecting and exiting
51 MainGameCallback *g_gamecallback = nullptr;
54 ClientLauncher::~ClientLauncher()
67 bool ClientLauncher::run(GameParams &game_params, const Settings &cmd_args)
69 init_args(game_params, cmd_args);
71 // List video modes if requested
73 return print_video_modes();
76 errorstream << "Could not initialize game engine." << std::endl;
80 // Speed tests (done after irrlicht is loaded to get timer)
81 if (cmd_args.getFlag("speedtests")) {
82 dstream << "Running speed tests" << std::endl;
87 video::IVideoDriver *video_driver = device->getVideoDriver();
88 if (video_driver == NULL) {
89 errorstream << "Could not initialize video driver." << std::endl;
93 porting::setXorgClassHint(video_driver->getExposedVideoData(), PROJECT_NAME_C);
95 porting::setWindowIcon(device);
98 This changes the minimum allowed number of vertices in a VBO.
101 //driver->setMinHardwareBufferVertexCount(50);
103 // Create game callback for menus
104 g_gamecallback = new MainGameCallback(device);
106 device->setResizable(true);
110 smgr = device->getSceneManager();
111 smgr->getParameters()->setAttribute(scene::ALLOW_ZWRITE_ON_TRANSPARENT, true);
113 guienv = device->getGUIEnvironment();
114 skin = guienv->getSkin();
115 skin->setColor(gui::EGDC_BUTTON_TEXT, video::SColor(255, 255, 255, 255));
116 skin->setColor(gui::EGDC_3D_LIGHT, video::SColor(0, 0, 0, 0));
117 skin->setColor(gui::EGDC_3D_HIGH_LIGHT, video::SColor(255, 30, 30, 30));
118 skin->setColor(gui::EGDC_3D_SHADOW, video::SColor(255, 0, 0, 0));
119 skin->setColor(gui::EGDC_HIGH_LIGHT, video::SColor(255, 70, 120, 50));
120 skin->setColor(gui::EGDC_HIGH_LIGHT_TEXT, video::SColor(255, 255, 255, 255));
122 g_fontengine = new FontEngine(g_settings, guienv);
123 FATAL_ERROR_IF(g_fontengine == NULL, "Font engine creation failed.");
125 #if (IRRLICHT_VERSION_MAJOR >= 1 && IRRLICHT_VERSION_MINOR >= 8) || IRRLICHT_VERSION_MAJOR >= 2
126 // Irrlicht 1.8 input colours
127 skin->setColor(gui::EGDC_EDITABLE, video::SColor(255, 128, 128, 128));
128 skin->setColor(gui::EGDC_FOCUSED_EDITABLE, video::SColor(255, 96, 134, 49));
131 // Create the menu clouds
132 if (!g_menucloudsmgr)
133 g_menucloudsmgr = smgr->createNewSceneManager();
135 g_menuclouds = new Clouds(g_menucloudsmgr->getRootSceneNode(),
136 g_menucloudsmgr, -1, rand(), 100);
137 g_menuclouds->update(v2f(0, 0), video::SColor(255, 200, 200, 255));
138 scene::ICameraSceneNode* camera;
139 camera = g_menucloudsmgr->addCameraSceneNode(0,
140 v3f(0, 0, 0), v3f(0, 60, 100));
141 camera->setFarValue(10000);
147 ChatBackend chat_backend;
149 // If an error occurs, this is set to something by menu().
150 // It is then displayed before the menu shows on the next call to menu()
151 std::string error_message;
152 bool reconnect_requested = false;
154 bool first_loop = true;
160 bool *kill = porting::signal_handler_killstatus();
162 while (device->run() && !*kill && !g_gamecallback->shutdown_requested)
164 // Set the window caption
165 const wchar_t *text = wgettext("Main Menu");
166 device->setWindowCaption((utf8_to_wide(PROJECT_NAME_C) +
167 L" " + utf8_to_wide(g_version_hash) +
168 L" [" + text + L"]").c_str());
171 try { // This is used for catching disconnects
176 We need some kind of a root node to be able to add
177 custom gui elements directly on the screen.
178 Otherwise they won't be automatically drawn.
180 guiroot = guienv->addStaticText(L"", core::rect<s32>(0, 0, 10000, 10000));
182 bool game_has_run = launch_game(error_message, reconnect_requested,
183 game_params, cmd_args);
185 // Reset the reconnect_requested flag
186 reconnect_requested = false;
188 // If skip_main_menu, we only want to startup once
189 if (skip_main_menu && !first_loop)
201 // Break out of menu-game loop to shut down cleanly
202 if (!device->run() || *kill) {
203 if (g_settings_path != "")
204 g_settings->updateConfigFile(g_settings_path.c_str());
208 if (current_playername.length() > PLAYERNAME_SIZE-1) {
209 error_message = gettext("Player name too long.");
210 playername = current_playername.substr(0, PLAYERNAME_SIZE-1);
211 g_settings->set("name", playername);
215 device->getVideoDriver()->setTextureCreationFlag(
216 video::ETCF_CREATE_MIP_MAPS, g_settings->getBool("mip_map"));
218 #ifdef HAVE_TOUCHSCREENGUI
219 receiver->m_touchscreengui = new TouchScreenGUI(device, receiver);
220 g_touchscreengui = receiver->m_touchscreengui;
235 &reconnect_requested,
237 simple_singleplayer_mode
241 #ifdef HAVE_TOUCHSCREENGUI
242 delete g_touchscreengui;
243 g_touchscreengui = NULL;
244 receiver->m_touchscreengui = NULL;
248 catch (con::PeerNotFoundException &e) {
249 error_message = gettext("Connection error (timed out?)");
250 errorstream << error_message << std::endl;
254 catch (std::exception &e) {
255 std::string error_message = "Some exception: \"";
256 error_message += e.what();
257 error_message += "\"";
258 errorstream << error_message << std::endl;
262 // If no main menu, show error and exit
263 if (skip_main_menu) {
264 if (!error_message.empty()) {
265 verbosestream << "error_message = "
266 << error_message << std::endl;
273 g_menuclouds->drop();
274 g_menucloudsmgr->drop();
279 void ClientLauncher::init_args(GameParams &game_params, const Settings &cmd_args)
282 skip_main_menu = cmd_args.getFlag("go");
284 // FIXME: This is confusing (but correct)
286 /* If world_path is set then override it unless skipping the main menu using
287 * the --go command line param. Else, give preference to the address
288 * supplied on the command line
290 address = g_settings->get("address");
291 if (game_params.world_path != "" && !skip_main_menu)
293 else if (cmd_args.exists("address"))
294 address = cmd_args.get("address");
296 playername = g_settings->get("name");
297 if (cmd_args.exists("name"))
298 playername = cmd_args.get("name");
300 list_video_modes = cmd_args.getFlag("videomodes");
302 use_freetype = g_settings->getBool("freetype");
304 random_input = g_settings->getBool("random_input")
305 || cmd_args.getFlag("random-input");
308 bool ClientLauncher::init_engine()
310 receiver = new MyEventReceiver();
311 create_engine_device();
312 return device != NULL;
315 void ClientLauncher::init_input()
318 input = new RandomInputHandler();
320 input = new RealInputHandler(device, receiver);
322 if (g_settings->getBool("enable_joysticks")) {
323 irr::core::array<irr::SJoystickInfo> infos;
324 std::vector<irr::SJoystickInfo> joystick_infos;
326 // Make sure this is called maximum once per
327 // irrlicht device, otherwise it will give you
328 // multiple events for the same joystick.
329 if (device->activateJoysticks(infos)) {
330 infostream << "Joystick support enabled" << std::endl;
331 joystick_infos.reserve(infos.size());
332 for (u32 i = 0; i < infos.size(); i++) {
333 joystick_infos.push_back(infos[i]);
335 input->joystick.onJoystickConnect(joystick_infos);
337 errorstream << "Could not activate joystick support." << std::endl;
342 bool ClientLauncher::launch_game(std::string &error_message,
343 bool reconnect_requested, GameParams &game_params,
344 const Settings &cmd_args)
346 // Initialize menu data
347 MainMenuData menudata;
348 menudata.address = address;
349 menudata.name = playername;
350 menudata.password = password;
351 menudata.port = itos(game_params.socket_port);
352 menudata.script_data.errormessage = error_message;
353 menudata.script_data.reconnect_requested = reconnect_requested;
355 error_message.clear();
357 if (cmd_args.exists("password"))
358 menudata.password = cmd_args.get("password");
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 screen_w = g_settings->getU16("screen_w");
521 u16 screen_h = g_settings->getU16("screen_h");
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 const 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>(screen_w, screen_h);
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 porting::initIrrlicht(device);
572 return device != NULL;
575 void ClientLauncher::speed_tests()
577 // volatile to avoid some potential compiler optimisations
578 volatile static s16 temp16;
579 volatile static f32 tempf;
582 static std::string tempstring;
583 static std::string tempstring2;
587 tempstring = std::string();
588 tempstring2 = std::string();
591 infostream << "The following test should take around 20ms." << std::endl;
592 TimeTaker timer("Testing std::string speed");
593 const u32 jj = 10000;
594 for (u32 j = 0; j < jj; j++) {
598 for (u32 i = 0; i < ii; i++) {
599 tempstring2 += "asd";
601 for (u32 i = 0; i < ii+1; i++) {
603 if (tempstring == tempstring2)
609 infostream << "All of the following tests should take around 100ms each."
613 TimeTaker timer("Testing floating-point conversion speed");
615 for (u32 i = 0; i < 4000000; i++) {
622 TimeTaker timer("Testing floating-point vector speed");
624 tempv3f1 = v3f(1, 2, 3);
625 tempv3f2 = v3f(4, 5, 6);
626 for (u32 i = 0; i < 10000000; i++) {
627 tempf += tempv3f1.dotProduct(tempv3f2);
628 tempv3f2 += v3f(7, 8, 9);
633 TimeTaker timer("Testing std::map speed");
635 std::map<v2s16, f32> map1;
638 for (s16 y = 0; y < ii; y++) {
639 for (s16 x = 0; x < ii; x++) {
640 map1[v2s16(x, y)] = tempf;
644 for (s16 y = ii - 1; y >= 0; y--) {
645 for (s16 x = 0; x < ii; x++) {
646 tempf = map1[v2s16(x, y)];
652 infostream << "Around 5000/ms should do well here." << std::endl;
653 TimeTaker timer("Testing mutex speed");
666 while(timer.getTimerTime() < 10);
668 u32 dtime = timer.stop();
669 u32 per_ms = n / dtime;
670 infostream << "Done. " << dtime << "ms, " << per_ms << "/ms" << std::endl;
674 bool ClientLauncher::print_video_modes()
676 IrrlichtDevice *nulldevice;
678 bool vsync = g_settings->getBool("vsync");
679 u16 fsaa = g_settings->getU16("fsaa");
680 MyEventReceiver* receiver = new MyEventReceiver();
682 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
683 params.DriverType = video::EDT_NULL;
684 params.WindowSize = core::dimension2d<u32>(640, 480);
686 params.AntiAlias = fsaa;
687 params.Fullscreen = false;
688 params.Stencilbuffer = false;
689 params.Vsync = vsync;
690 params.EventReceiver = receiver;
691 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
693 nulldevice = createDeviceEx(params);
695 if (nulldevice == NULL) {
700 std::cout << _("Available video modes (WxHxD):") << std::endl;
702 video::IVideoModeList *videomode_list = nulldevice->getVideoModeList();
704 if (videomode_list != NULL) {
705 s32 videomode_count = videomode_list->getVideoModeCount();
706 core::dimension2d<u32> videomode_res;
708 for (s32 i = 0; i < videomode_count; ++i) {
709 videomode_res = videomode_list->getVideoModeResolution(i);
710 videomode_depth = videomode_list->getVideoModeDepth(i);
711 std::cout << videomode_res.Width << "x" << videomode_res.Height
712 << "x" << videomode_depth << std::endl;
715 std::cout << _("Active video mode (WxHxD):") << std::endl;
716 videomode_res = videomode_list->getDesktopResolution();
717 videomode_depth = videomode_list->getDesktopDepth();
718 std::cout << videomode_res.Width << "x" << videomode_res.Height
719 << "x" << videomode_depth << std::endl;
726 return videomode_list != NULL;