feat: Merge new help_gui with tutorial_gui

This commit is contained in:
2024-04-10 20:46:11 +01:00
parent b247be24a8
commit 71f533e662
5 changed files with 62 additions and 224 deletions

View File

@@ -505,8 +505,6 @@ add_files(
tunnelbridge_cmd.cpp
tunnelbridge_cmd.h
tunnelbridge_map.h
tutorial_gui.cpp
tutorial_gui.h
vehicle.cpp
vehicle_base.h
vehicle_cmd.cpp

View File

@@ -15,6 +15,7 @@
#include "table/control_codes.h"
#include "string_func.h"
#include "openttd.h"
#include "language.h"
#include "help_gui.h"
#include "widgets/help_widget.h"
@@ -32,6 +33,35 @@ static const std::string WIKI_LINK = "https://wiki.openttd.org/";
static const std::string BUGTRACKER_LINK = "https://bugs.openttd.org/";
static const std::string COMMUNITY_LINK = "https://community.openttd.org/";
using VideoOption = std::unordered_map<std::string, std::string> ;
static const std::unordered_map<WidgetID, VideoOption> tutorial_list = {
{
WID_HW_BUS, {
{"en", "https://www.youtube.com/watch?v=EULXRMR4PyE"}
},
},
{
WID_HW_TRAIN, {
{"en", "https://www.youtube.com/watch?v=VdMdL2qyZ6s"}
},
},
{
WID_HW_TRUCK, {
{"en", "https://www.youtube.com/watch?v=B-CL-XFGNtw"}
},
},
{
WID_HW_SHIP, {
{"en", "https://www.youtube.com/watch?v=a5JHlWtIg3A"}
},
},
{
WID_HW_FACILALL, {
{"en", "https://www.youtube.com/watch?v=GwjiQYsu3xg"}
},
}
};
/** Only show the first 20 changelog versions in the textfile viewer. */
static constexpr size_t CHANGELOG_VERSIONS_LIMIT = 20;
@@ -131,6 +161,18 @@ struct HelpWindow : public Window {
this->EnableTextfileButton(LICENSE_FILENAME, WID_HW_LICENSE);
}
static void OpenTutorial(WidgetID wid) {
std::string link;
try {
link = tutorial_list.at(wid).at(_current_language->isocode);
} catch (const std::out_of_range& e) {
link = tutorial_list.at(wid).at("en");
}
OpenBrowser(link);
}
void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
{
switch (widget) {
@@ -158,6 +200,13 @@ struct HelpWindow : public Window {
case WID_HW_COMMUNITY:
OpenBrowser(COMMUNITY_LINK);
break;
case WID_HW_BUS:
case WID_HW_TRAIN:
case WID_HW_TRUCK:
case WID_HW_SHIP:
case WID_HW_FACILALL:
OpenTutorial(widget);
break;
}
}
@@ -189,6 +238,14 @@ static constexpr NWidgetPart _nested_helpwin_widgets[] = {
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_KNOWN_BUGS),SetDataTip(STR_HELP_WINDOW_KNOWN_BUGS, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_LICENSE), SetDataTip(STR_HELP_WINDOW_LICENSE, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
EndContainer(),
NWidget(WWT_FRAME, COLOUR_DARK_GREEN), SetDataTip(STR_TUTORIAL_WINDOW_TITLE, STR_TUTORIAL_WINDOW_TOOLTIP),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_BUS), SetDataTip(STR_TUTORIAL_ROADS_AND_STATIONS, STR_TUTORIAL_ROADS_AND_STATIONS), SetMinimalSize(128, 12), SetFill(1, 0),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_TRAIN), SetDataTip(STR_TUTORIAL_RAILWAYS, STR_TUTORIAL_RAILWAYS), SetMinimalSize(128, 12), SetFill(1, 0),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_TRUCK),SetDataTip(STR_TUTORIAL_ROAD_VEHICLES, STR_TUTORIAL_ROAD_VEHICLES), SetMinimalSize(128, 12), SetFill(1, 0),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_SHIP), SetDataTip(STR_TUTORIAL_SHIPS, STR_TUTORIAL_SHIPS), SetMinimalSize(128, 12), SetFill(1, 0),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_FACILALL), SetDataTip(STR_TUTORIAL_CARGO, STR_TUTORIAL_CARGO), SetMinimalSize(128, 12), SetFill(1, 0),
EndContainer(),
EndContainer(),
EndContainer(),
};

View File

@@ -1,204 +0,0 @@
/* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file tutorial_gui.cpp
* Links to video tutorials on Youtube.
*/
#include "stdafx.h"
#ifdef __ANDROID__
#include <SDL_android.h>
#endif
#include "tutorial_gui.h"
#include "debug.h"
#include "strings_func.h"
#include "window_func.h"
#include "fios.h"
#include "string_func.h"
#include "language.h"
#include "widget_type.h"
#include "window_type.h"
#include "window_func.h"
#include "window_gui.h"
#include "widgets/station_widget.h"
#include "table/strings.h"
#include "table/sprites.h"
static bool showTutorialMainMenu = false;
static const char * ANY_LANG = "ANY_LANG";
struct VideoLink_t {
const char *lang;
const char *video;
};
static VideoLink_t busTutorial[] = {
{ "en", "https://www.youtube.com/watch?v=EULXRMR4PyE" },
{ ANY_LANG, "https://www.youtube.com/watch?v=EULXRMR4PyE" },
{ NULL, NULL }
};
static VideoLink_t trainTutorial[] = {
{ "en", "https://www.youtube.com/watch?v=VdMdL2qyZ6s" },
{ ANY_LANG, "https://www.youtube.com/watch?v=VdMdL2qyZ6s" },
{ NULL, NULL }
};
static VideoLink_t truckTutorial[] = {
{ "en", "https://www.youtube.com/watch?v=B-CL-XFGNtw" },
{ ANY_LANG, "https://www.youtube.com/watch?v=B-CL-XFGNtw" },
{ NULL, NULL }
};
static VideoLink_t shipTutorial[] = {
{ "en", "https://www.youtube.com/watch?v=a5JHlWtIg3A" },
{ ANY_LANG, "https://www.youtube.com/watch?v=a5JHlWtIg3A" },
{ NULL, NULL }
};
static VideoLink_t cargoTutorial[] = {
{ "en", "https://www.youtube.com/watch?v=GwjiQYsu3xg" },
{ ANY_LANG, "https://www.youtube.com/watch?v=GwjiQYsu3xg" },
{ NULL, NULL }
};
void OpenExternTutorialVideo(VideoLink_t *tutorial)
{
const char *link = NULL;
for (; tutorial->lang != NULL; tutorial++) {
if (strcmp(tutorial->lang, _current_language->isocode) == 0) {
link = tutorial->video;
break;
}
if (strcmp(tutorial->lang, ANY_LANG) == 0) {
link = tutorial->video;
break;
}
}
if (!link) {
return;
}
#ifdef __ANDROID__
SDL_ANDROID_OpenExternalWebBrowser(link);
#else
//char cmd[PATH_MAX] =
#ifdef WIN32
"start ";
#else
"xdg-open ";
#endif
//strcat(cmd, link);
//system(cmd);
#endif
}
static const NWidgetPart _nested_tutorial_widgets[] = {
NWidget(NWID_HORIZONTAL),
NWidget(WWT_CLOSEBOX, COLOUR_GREY),
NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_TUTORIAL_WINDOW_TITLE, STR_TUTORIAL_WINDOW_TOOLTIP),
EndContainer(),
NWidget(WWT_PANEL, COLOUR_GREY),
NWidget(NWID_HORIZONTAL),
NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
NWidget(NWID_VERTICAL), SetPIP(16, 2, 6),
// TODO: make different button IDs
NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_BUS), SetMinimalSize(120, 20), SetDataTip(STR_TUTORIAL_ROADS_AND_STATIONS, STR_TUTORIAL_ROADS_AND_STATIONS), SetFill(1, 1),
NWidget(NWID_SPACER), SetMinimalSize(0, 10), SetFill(1, 0),
NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_TRAIN), SetMinimalSize(120, 20), SetDataTip(STR_TUTORIAL_RAILWAYS, STR_TUTORIAL_RAILWAYS), SetFill(1, 1),
NWidget(NWID_SPACER), SetMinimalSize(0, 10), SetFill(1, 0),
NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_TRUCK), SetMinimalSize(120, 20), SetDataTip(STR_TUTORIAL_ROAD_VEHICLES, STR_TUTORIAL_ROAD_VEHICLES), SetFill(1, 1),
NWidget(NWID_SPACER), SetMinimalSize(0, 10), SetFill(1, 0),
NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_SHIP), SetMinimalSize(120, 20), SetDataTip(STR_TUTORIAL_SHIPS, STR_TUTORIAL_SHIPS), SetFill(1, 1),
NWidget(NWID_SPACER), SetMinimalSize(0, 10), SetFill(1, 0),
NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_STL_FACILALL), SetMinimalSize(120, 20), SetDataTip(STR_TUTORIAL_CARGO, STR_TUTORIAL_CARGO), SetFill(1, 1),
EndContainer(),
NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
EndContainer(),
EndContainer(),
};
static WindowDesc _tutorial_desc(__FILE__, __LINE__,
WDP_CENTER, NULL, 0, 0,
WC_GAME_OPTIONS, WC_NONE,
0,
std::begin(_nested_tutorial_widgets), std::end(_nested_tutorial_widgets)
);
struct TutorialWindow : public Window {
VideoLink_t *video;
TutorialWindow() : Window(&_tutorial_desc)
{
this->InitNested(WN_GAME_OPTIONS_ABOUT);
this->video = NULL;
}
virtual void OnClick(Point pt, int widget, int click_count)
{
showTutorialMainMenu = false;
this->video = NULL;
this->SetDirty();
switch (widget) {
case WID_STL_BUS:
this->video = busTutorial;
break;
case WID_STL_TRUCK:
this->video = truckTutorial;
break;
case WID_STL_TRAIN:
this->video = trainTutorial;
break;
case WID_STL_SHIP:
this->video = shipTutorial;
break;
//case WID_STL_AIRPLANE:
// this->video = planeTutorial;
// break;
case WID_STL_FACILALL:
this->video = cargoTutorial;
break;
}
if (this->video) {
OpenExternTutorialVideo(this->video);
this->video = NULL;
}
}
};
void ShowTutorialWindow()
{
CloseWindowByClass(WC_GAME_OPTIONS);
new TutorialWindow();
}
void ShowTutorialWindowOnceAfterInstall()
{
// Close button on tutorial window is gone, so don't show that windows on first run, it's confusing
#if 0
static const char * TUTORIAL_SHOWN_FLAG = ".tutorial-shown-3.flag";
FILE *ff = fopen(TUTORIAL_SHOWN_FLAG, "r");
if (ff) {
fclose(ff);
if (!showTutorialMainMenu)
return;
}
showTutorialMainMenu = true;
ff = fopen(TUTORIAL_SHOWN_FLAG, "w");
fprintf(ff, "Tutorial shown");
fclose(ff);
ShowTutorialWindow();
#endif
}

View File

@@ -1,18 +0,0 @@
/* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file tutorial_gui.h Links to video tutorials. */
#ifndef TUTORIAL_GUI_H
#define TUTORIAL_GUI_H
void ShowTutorialWindow();
void ShowTutorialWindowOnceAfterInstall();
#endif /* TUTORIAL_GUI_H */

View File

@@ -20,6 +20,11 @@ enum HelpWindowWidgets : WidgetID {
WID_HW_WIKI,
WID_HW_BUGTRACKER,
WID_HW_COMMUNITY,
WID_HW_BUS,
WID_HW_TRAIN,
WID_HW_TRUCK,
WID_HW_SHIP,
WID_HW_FACILALL
};
#endif /* WIDGETS_HELP_WIDGET_H */