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 ClientLauncher::~ClientLauncher()
70 bool ClientLauncher::run(GameParams &game_params, const Settings &cmd_args)
72 init_args(game_params, cmd_args);
74 // List video modes if requested
76 return print_video_modes();
79 errorstream << "Could not initialize game engine." << std::endl;
83 // Speed tests (done after irrlicht is loaded to get timer)
84 if (cmd_args.getFlag("speedtests")) {
85 dstream << "Running speed tests" << std::endl;
90 video::IVideoDriver *video_driver = device->getVideoDriver();
91 if (video_driver == NULL) {
92 errorstream << "Could not initialize video driver." << std::endl;
96 porting::setXorgClassHint(video_driver->getExposedVideoData(), PROJECT_NAME_C);
98 porting::setWindowIcon(device);
101 This changes the minimum allowed number of vertices in a VBO.
104 //driver->setMinHardwareBufferVertexCount(50);
106 // Create game callback for menus
107 g_gamecallback = new MainGameCallback(device);
109 device->setResizable(true);
113 smgr = device->getSceneManager();
114 smgr->getParameters()->setAttribute(scene::ALLOW_ZWRITE_ON_TRANSPARENT, true);
116 guienv = device->getGUIEnvironment();
117 skin = guienv->getSkin();
118 skin->setColor(gui::EGDC_BUTTON_TEXT, video::SColor(255, 255, 255, 255));
119 skin->setColor(gui::EGDC_3D_LIGHT, video::SColor(0, 0, 0, 0));
120 skin->setColor(gui::EGDC_3D_HIGH_LIGHT, video::SColor(255, 30, 30, 30));
121 skin->setColor(gui::EGDC_3D_SHADOW, video::SColor(255, 0, 0, 0));
122 skin->setColor(gui::EGDC_HIGH_LIGHT, video::SColor(255, 70, 120, 50));
123 skin->setColor(gui::EGDC_HIGH_LIGHT_TEXT, video::SColor(255, 255, 255, 255));
125 g_fontengine = new FontEngine(g_settings, guienv);
126 FATAL_ERROR_IF(g_fontengine == NULL, "Font engine creation failed.");
128 #if (IRRLICHT_VERSION_MAJOR >= 1 && IRRLICHT_VERSION_MINOR >= 8) || IRRLICHT_VERSION_MAJOR >= 2
129 // Irrlicht 1.8 input colours
130 skin->setColor(gui::EGDC_EDITABLE, video::SColor(255, 128, 128, 128));
131 skin->setColor(gui::EGDC_FOCUSED_EDITABLE, video::SColor(255, 96, 134, 49));
134 // Create the menu clouds
135 if (!g_menucloudsmgr)
136 g_menucloudsmgr = smgr->createNewSceneManager();
138 g_menuclouds = new Clouds(g_menucloudsmgr->getRootSceneNode(),
139 g_menucloudsmgr, -1, rand(), 100);
140 g_menuclouds->update(v2f(0, 0), video::SColor(255, 200, 200, 255));
141 scene::ICameraSceneNode* camera;
142 camera = g_menucloudsmgr->addCameraSceneNode(0,
143 v3f(0, 0, 0), v3f(0, 60, 100));
144 camera->setFarValue(10000);
150 ChatBackend chat_backend;
152 // If an error occurs, this is set to something by menu().
153 // It is then displayed before the menu shows on the next call to menu()
154 std::string error_message;
155 bool reconnect_requested = false;
157 bool first_loop = true;
163 bool *kill = porting::signal_handler_killstatus();
165 while (device->run() && !*kill && !g_gamecallback->shutdown_requested)
167 // Set the window caption
168 const wchar_t *text = wgettext("Main Menu");
169 device->setWindowCaption((utf8_to_wide(PROJECT_NAME_C) +
170 L" " + utf8_to_wide(g_version_hash) +
171 L" [" + text + L"]").c_str());
174 try { // This is used for catching disconnects
179 We need some kind of a root node to be able to add
180 custom gui elements directly on the screen.
181 Otherwise they won't be automatically drawn.
183 guiroot = guienv->addStaticText(L"", core::rect<s32>(0, 0, 10000, 10000));
185 bool game_has_run = launch_game(error_message, reconnect_requested,
186 game_params, cmd_args);
188 // Reset the reconnect_requested flag
189 reconnect_requested = false;
191 // If skip_main_menu, we only want to startup once
192 if (skip_main_menu && !first_loop)
204 // Break out of menu-game loop to shut down cleanly
205 if (!device->run() || *kill) {
206 if (g_settings_path != "")
207 g_settings->updateConfigFile(g_settings_path.c_str());
211 if (current_playername.length() > PLAYERNAME_SIZE-1) {
212 error_message = gettext("Player name too long.");
213 playername = current_playername.substr(0, PLAYERNAME_SIZE-1);
214 g_settings->set("name", playername);
218 device->getVideoDriver()->setTextureCreationFlag(
219 video::ETCF_CREATE_MIP_MAPS, g_settings->getBool("mip_map"));
221 #ifdef HAVE_TOUCHSCREENGUI
222 receiver->m_touchscreengui = new TouchScreenGUI(device, receiver);
223 g_touchscreengui = receiver->m_touchscreengui;
238 &reconnect_requested,
240 simple_singleplayer_mode
244 #ifdef HAVE_TOUCHSCREENGUI
245 delete g_touchscreengui;
246 g_touchscreengui = NULL;
247 receiver->m_touchscreengui = NULL;
251 catch (con::PeerNotFoundException &e) {
252 error_message = gettext("Connection error (timed out?)");
253 errorstream << error_message << std::endl;
257 catch (std::exception &e) {
258 std::string error_message = "Some exception: \"";
259 error_message += e.what();
260 error_message += "\"";
261 errorstream << error_message << std::endl;
265 // If no main menu, show error and exit
266 if (skip_main_menu) {
267 if (!error_message.empty()) {
268 verbosestream << "error_message = "
269 << error_message << std::endl;
276 g_menuclouds->drop();
277 g_menucloudsmgr->drop();
282 void ClientLauncher::init_args(GameParams &game_params, const Settings &cmd_args)
285 skip_main_menu = cmd_args.getFlag("go");
287 // FIXME: This is confusing (but correct)
289 /* If world_path is set then override it unless skipping the main menu using
290 * the --go command line param. Else, give preference to the address
291 * supplied on the command line
293 address = g_settings->get("address");
294 if (game_params.world_path != "" && !skip_main_menu)
296 else if (cmd_args.exists("address"))
297 address = cmd_args.get("address");
299 playername = g_settings->get("name");
300 if (cmd_args.exists("name"))
301 playername = cmd_args.get("name");
303 list_video_modes = cmd_args.getFlag("videomodes");
305 use_freetype = g_settings->getBool("freetype");
307 random_input = g_settings->getBool("random_input")
308 || cmd_args.getFlag("random-input");
311 bool ClientLauncher::init_engine()
313 receiver = new MyEventReceiver();
314 create_engine_device();
315 return device != NULL;
318 void ClientLauncher::init_input()
321 input = new RandomInputHandler();
323 input = new RealInputHandler(device, receiver);
325 if (g_settings->getBool("enable_joysticks")) {
326 irr::core::array<irr::SJoystickInfo> infos;
327 std::vector<irr::SJoystickInfo> joystick_infos;
329 // Make sure this is called maximum once per
330 // irrlicht device, otherwise it will give you
331 // multiple events for the same joystick.
332 if (device->activateJoysticks(infos)) {
333 infostream << "Joystick support enabled" << std::endl;
334 joystick_infos.reserve(infos.size());
335 for (u32 i = 0; i < infos.size(); i++) {
336 joystick_infos.push_back(infos[i]);
338 input->joystick.onJoystickConnect(joystick_infos);
340 errorstream << "Could not activate joystick support." << std::endl;
345 bool ClientLauncher::launch_game(std::string &error_message,
346 bool reconnect_requested, GameParams &game_params,
347 const Settings &cmd_args)
349 // Initialize menu data
350 MainMenuData menudata;
351 menudata.address = address;
352 menudata.name = playername;
353 menudata.password = password;
354 menudata.port = itos(game_params.socket_port);
355 menudata.script_data.errormessage = error_message;
356 menudata.script_data.reconnect_requested = reconnect_requested;
358 error_message.clear();
360 if (cmd_args.exists("password"))
361 menudata.password = cmd_args.get("password");
363 menudata.enable_public = g_settings->getBool("server_announce");
365 // If a world was commanded, append and select it
366 if (game_params.world_path != "") {
367 worldspec.gameid = getWorldGameId(game_params.world_path, true);
368 worldspec.name = _("[--world parameter]");
370 if (worldspec.gameid == "") { // Create new
371 worldspec.gameid = g_settings->get("default_game");
372 worldspec.name += " [new]";
374 worldspec.path = game_params.world_path;
379 if (!skip_main_menu) {
380 main_menu(&menudata);
382 // Skip further loading if there was an exit signal.
383 if (*porting::signal_handler_killstatus())
386 address = menudata.address;
387 int newport = stoi(menudata.port);
389 game_params.socket_port = newport;
391 simple_singleplayer_mode = menudata.simple_singleplayer_mode;
393 std::vector<WorldSpec> worldspecs = getAvailableWorlds();
395 if (menudata.selected_world >= 0
396 && menudata.selected_world < (int)worldspecs.size()) {
397 g_settings->set("selected_world_path",
398 worldspecs[menudata.selected_world].path);
399 worldspec = worldspecs[menudata.selected_world];
403 if (!menudata.script_data.errormessage.empty()) {
404 /* The calling function will pass this back into this function upon the
405 * next iteration (if any) causing it to be displayed by the GUI
407 error_message = menudata.script_data.errormessage;
411 if (menudata.name == "" && !simple_singleplayer_mode) {
412 error_message = gettext("Please choose a name!");
416 playername = menudata.name;
417 password = menudata.password;
419 current_playername = playername;
420 current_password = password;
421 current_address = address;
422 current_port = game_params.socket_port;
424 // If using simple singleplayer mode, override
425 if (simple_singleplayer_mode) {
426 assert(skip_main_menu == false);
427 current_playername = "singleplayer";
428 current_password = "";
429 current_address = "";
430 current_port = myrand_range(49152, 65535);
432 g_settings->set("name", playername);
434 ServerListSpec server;
435 server["name"] = menudata.servername;
436 server["address"] = menudata.address;
437 server["port"] = menudata.port;
438 server["description"] = menudata.serverdescription;
439 ServerList::insert(server);
443 infostream << "Selected world: " << worldspec.name
444 << " [" << worldspec.path << "]" << std::endl;
446 if (current_address == "") { // If local game
447 if (worldspec.path == "") {
448 error_message = gettext("No world selected and no address "
449 "provided. Nothing to do.");
450 errorstream << error_message << std::endl;
454 if (!fs::PathExists(worldspec.path)) {
455 error_message = gettext("Provided world path doesn't exist: ")
457 errorstream << error_message << std::endl;
461 // Load gamespec for required game
462 gamespec = findWorldSubgame(worldspec.path);
463 if (!gamespec.isValid() && !game_params.game_spec.isValid()) {
464 error_message = gettext("Could not find or load game \"")
465 + worldspec.gameid + "\"";
466 errorstream << error_message << std::endl;
470 if (porting::signal_handler_killstatus())
473 if (game_params.game_spec.isValid() &&
474 game_params.game_spec.id != worldspec.gameid) {
475 warningstream << "Overriding gamespec from \""
476 << worldspec.gameid << "\" to \""
477 << game_params.game_spec.id << "\"" << std::endl;
478 gamespec = game_params.game_spec;
481 if (!gamespec.isValid()) {
482 error_message = gettext("Invalid gamespec.");
483 error_message += " (world.gameid=" + worldspec.gameid + ")";
484 errorstream << error_message << std::endl;
492 void ClientLauncher::main_menu(MainMenuData *menudata)
494 bool *kill = porting::signal_handler_killstatus();
495 video::IVideoDriver *driver = device->getVideoDriver();
497 infostream << "Waiting for other menus" << std::endl;
498 while (device->run() && *kill == false) {
501 driver->beginScene(true, true, video::SColor(255, 128, 128, 128));
504 // On some computers framerate doesn't seem to be automatically limited
507 infostream << "Waited for other menus" << std::endl;
509 // Cursor can be non-visible when coming from the game
511 device->getCursorControl()->setVisible(true);
515 GUIEngine mymenu(device, &input->joystick, guiroot,
516 &g_menumgr, smgr, menudata, *kill);
518 smgr->clear(); /* leave scene manager in a clean state */
521 bool ClientLauncher::create_engine_device()
523 // Resolution selection
524 bool fullscreen = g_settings->getBool("fullscreen");
525 u16 screenW = g_settings->getU16("screenW");
526 u16 screenH = g_settings->getU16("screenH");
529 bool vsync = g_settings->getBool("vsync");
530 u16 bits = g_settings->getU16("fullscreen_bpp");
531 u16 fsaa = g_settings->getU16("fsaa");
533 // stereo buffer required for pageflip stereo
534 bool stereo_buffer = g_settings->get("3d_mode") == "pageflip";
537 video::E_DRIVER_TYPE driverType = video::EDT_OPENGL;
538 const std::string &driverstring = g_settings->get("video_driver");
539 std::vector<video::E_DRIVER_TYPE> drivers
540 = porting::getSupportedVideoDrivers();
542 for (i = 0; i != drivers.size(); i++) {
543 if (!strcasecmp(driverstring.c_str(),
544 porting::getVideoDriverName(drivers[i]))) {
545 driverType = drivers[i];
549 if (i == drivers.size()) {
550 errorstream << "Invalid video_driver specified; "
551 "defaulting to opengl" << std::endl;
554 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
555 params.DriverType = driverType;
556 params.WindowSize = core::dimension2d<u32>(screenW, screenH);
558 params.AntiAlias = fsaa;
559 params.Fullscreen = fullscreen;
560 params.Stencilbuffer = false;
561 params.Stereobuffer = stereo_buffer;
562 params.Vsync = vsync;
563 params.EventReceiver = receiver;
564 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
565 params.ZBufferBits = 24;
567 params.PrivateData = porting::app_global;
568 params.OGLES2ShaderPath = std::string(porting::path_user + DIR_DELIM +
569 "media" + DIR_DELIM + "Shaders" + DIR_DELIM).c_str();
572 device = createDeviceEx(params);
575 porting::initIrrlicht(device);
577 return device != NULL;
580 void ClientLauncher::speed_tests()
582 // volatile to avoid some potential compiler optimisations
583 volatile static s16 temp16;
584 volatile static f32 tempf;
587 static std::string tempstring;
588 static std::string tempstring2;
592 tempstring = std::string();
593 tempstring2 = std::string();
596 infostream << "The following test should take around 20ms." << std::endl;
597 TimeTaker timer("Testing std::string speed");
598 const u32 jj = 10000;
599 for (u32 j = 0; j < jj; j++) {
603 for (u32 i = 0; i < ii; i++) {
604 tempstring2 += "asd";
606 for (u32 i = 0; i < ii+1; i++) {
608 if (tempstring == tempstring2)
614 infostream << "All of the following tests should take around 100ms each."
618 TimeTaker timer("Testing floating-point conversion speed");
620 for (u32 i = 0; i < 4000000; i++) {
627 TimeTaker timer("Testing floating-point vector speed");
629 tempv3f1 = v3f(1, 2, 3);
630 tempv3f2 = v3f(4, 5, 6);
631 for (u32 i = 0; i < 10000000; i++) {
632 tempf += tempv3f1.dotProduct(tempv3f2);
633 tempv3f2 += v3f(7, 8, 9);
638 TimeTaker timer("Testing std::map speed");
640 std::map<v2s16, f32> map1;
643 for (s16 y = 0; y < ii; y++) {
644 for (s16 x = 0; x < ii; x++) {
645 map1[v2s16(x, y)] = tempf;
649 for (s16 y = ii - 1; y >= 0; y--) {
650 for (s16 x = 0; x < ii; x++) {
651 tempf = map1[v2s16(x, y)];
657 infostream << "Around 5000/ms should do well here." << std::endl;
658 TimeTaker timer("Testing mutex speed");
671 while(timer.getTimerTime() < 10);
673 u32 dtime = timer.stop();
674 u32 per_ms = n / dtime;
675 infostream << "Done. " << dtime << "ms, " << per_ms << "/ms" << std::endl;
679 bool ClientLauncher::print_video_modes()
681 IrrlichtDevice *nulldevice;
683 bool vsync = g_settings->getBool("vsync");
684 u16 fsaa = g_settings->getU16("fsaa");
685 MyEventReceiver* receiver = new MyEventReceiver();
687 SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
688 params.DriverType = video::EDT_NULL;
689 params.WindowSize = core::dimension2d<u32>(640, 480);
691 params.AntiAlias = fsaa;
692 params.Fullscreen = false;
693 params.Stencilbuffer = false;
694 params.Vsync = vsync;
695 params.EventReceiver = receiver;
696 params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
698 nulldevice = createDeviceEx(params);
700 if (nulldevice == NULL) {
705 std::cout << _("Available video modes (WxHxD):") << std::endl;
707 video::IVideoModeList *videomode_list = nulldevice->getVideoModeList();
709 if (videomode_list != NULL) {
710 s32 videomode_count = videomode_list->getVideoModeCount();
711 core::dimension2d<u32> videomode_res;
713 for (s32 i = 0; i < videomode_count; ++i) {
714 videomode_res = videomode_list->getVideoModeResolution(i);
715 videomode_depth = videomode_list->getVideoModeDepth(i);
716 std::cout << videomode_res.Width << "x" << videomode_res.Height
717 << "x" << videomode_depth << std::endl;
720 std::cout << _("Active video mode (WxHxD):") << std::endl;
721 videomode_res = videomode_list->getDesktopResolution();
722 videomode_depth = videomode_list->getDesktopDepth();
723 std::cout << videomode_res.Width << "x" << videomode_res.Height
724 << "x" << videomode_depth << std::endl;
731 return videomode_list != NULL;