From 04d85a9ff61542662d4813c9c158b525ba64e684 Mon Sep 17 00:00:00 2001 From: Gustavo Barreira <155913980+CreamBR-STK@users.noreply.github.com> Date: Fri, 15 Aug 2025 11:27:10 -0300 Subject: [PATCH 1/5] Add a speedmeter on multitouch Speedmeter in left of the power and see behind buttons --- src/states_screens/race_gui.cpp | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/src/states_screens/race_gui.cpp b/src/states_screens/race_gui.cpp index bf437a12ff..53ca4f5b55 100644 --- a/src/states_screens/race_gui.cpp +++ b/src/states_screens/race_gui.cpp @@ -401,6 +401,10 @@ void RaceGUI::renderPlayerView(const Camera *camera, float dt) drawPowerupIcons(kart, viewport, scaling); drawSpeedEnergyRank(kart, viewport, scaling, dt); } + else + { + drawSpeedEnergyRank(kart, viewport, scaling, dt); + } } if (!m_is_tutorial) @@ -1018,17 +1022,26 @@ void RaceGUI::drawSpeedEnergyRank(const AbstractKart* kart, const int SPEEDWIDTH = 128; int meter_width = (int)(SPEEDWIDTH*min_ratio); int meter_height = (int)(SPEEDWIDTH*min_ratio); - - drawEnergyMeter(viewport.LowerRightCorner.X , - (int)(viewport.LowerRightCorner.Y), - kart, viewport, scaling); + if (m_multitouch_gui == NULL || m_multitouch_gui->isSpectatorMode()) + { + drawEnergyMeter(viewport.LowerRightCorner.X , + (int)(viewport.LowerRightCorner.Y), + kart, viewport, scaling); + } // First draw the meter (i.e. the background ) // ------------------------------------------------------------------------- core::vector2df offset; - offset.X = (float)(viewport.LowerRightCorner.X-meter_width) - 24.0f*scaling.X; - offset.Y = viewport.LowerRightCorner.Y-10.0f*scaling.Y; - + if (m_multitouch_gui == NULL || m_multitouch_gui->isSpectatorMode()) + { + offset.X = (float)(viewport.LowerRightCorner.X-meter_width) - 24.0f*scaling.X; + offset.Y = viewport.LowerRightCorner.Y-10.0f*scaling.Y; + } + else + { + offset.X = (float)(viewport.LowerRightCorner.X-meter_width) - 250.0f*scaling.X; + offset.Y = viewport.LowerRightCorner.Y-60.0f*scaling.Y; + } const core::rect meter_pos((int)offset.X, (int)(offset.Y-meter_height), (int)(offset.X+meter_width), @@ -1125,7 +1138,6 @@ void RaceGUI::drawSpeedEnergyRank(const AbstractKart* kart, unsigned int count = computeVerticesForMeter(position, threshold, vertices, vertices_count, speed_ratio, meter_width, meter_height, offset); - drawMeterTexture(m_speed_bar_icon, vertices, count); #endif } // drawSpeedEnergyRank From 136bf88df80268c6a382edf6da363d7ba2e68b2c Mon Sep 17 00:00:00 2001 From: Gustavo Barreira <155913980+CreamBR-STK@users.noreply.github.com> Date: Tue, 19 Aug 2025 17:59:14 -0300 Subject: [PATCH 2/5] Add setting to enable or disable speedmeter Main use: to activate this on multitouch (mobile) controls --- src/config/user_config.hpp | 2987 ++++++++++++++++++------------------ 1 file changed, 1499 insertions(+), 1488 deletions(-) diff --git a/src/config/user_config.hpp b/src/config/user_config.hpp index 8d12b3b801..ac8e0c489d 100644 --- a/src/config/user_config.hpp +++ b/src/config/user_config.hpp @@ -1,1489 +1,1500 @@ -// -// SuperTuxKart - a fun racing game with go-kart -// Copyright (C) 2006-2015 SuperTuxKart-Team -// Modelled after Supertux's configfile.h -// -// This program 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; either version 3 -// of the License, or (at your option) any later version. -// -// This program 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 this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -#ifndef HEADER_USER_CONFIG_HPP -#define HEADER_USER_CONFIG_HPP - -/* The following config versions are currently used: - 0: the 0.2 release config file, without config-version number - (so that defaults to 0) - 1: Removed singleWindowMenu, newKeyboardStyle, oldStatusDisplay, - added config-version number - Version 1 can read version 0 without any problems, so - SUPPORTED_CONFIG_VERSION is 0. - 2: Changed to SDL keyboard bindings - 3: Added username (userid was used for ALL players) - 4: Added username per player - 5: Enabled jumping, which might cause a problem with old - config files (which have an unused entry for jump defined - --> if a kart control for (say) player 2 uses the same key as - jump for player 1, this problem is not noticed in 0.3, but will - cause an undefined game action now - 6: Added stick configurations. -*/ -#include -#include -#include -#include -#include -#include - -#include -#include - -using irr::core::stringc; -using irr::core::stringw; - -#include "utils/constants.hpp" -#include "utils/no_copy.hpp" -#include "utils/ptr_vector.hpp" -#include "utils/time.hpp" - -class PlayerProfile; -class SavedGrandPrix; -class XMLNode; -class UTFWriter; - -/** - * The base of a set of small utilities to enable quickly adding/removing - * stuff to/from config painlessly. - */ -class UserConfigParam -{ - friend class GroupUserConfigParam; -protected: - bool m_can_be_deleted = true; - std::string m_param_name; - std::string m_comment; -public: - virtual ~UserConfigParam(); - virtual void write(std::stringstream & stream) const = 0; - virtual void writeInner(std::stringstream & stream, int level = 0) const; - virtual void findYourDataInAChildOf(const XMLNode* node) = 0; - virtual void findYourDataInAnAttributeOf(const XMLNode* node) = 0; - virtual irr::core::stringc toString() const = 0; -}; // UserConfigParam - -// ============================================================================ -class GroupUserConfigParam : public UserConfigParam -{ - std::vector m_attributes; - std::vector m_children; -public: - GroupUserConfigParam(const char* name, const char* comment=NULL); - GroupUserConfigParam(const char* param_name, - GroupUserConfigParam* group, - const char* comment = NULL); - void write(std::stringstream& stream) const; - void writeInner(std::stringstream& stream, int level = 0) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - void addChild(UserConfigParam* child); - void addChild(GroupUserConfigParam* child); - void clearChildren(); - - irr::core::stringc toString() const; -}; // GroupUserConfigParam - -// ============================================================================ -/** ATM only map with 1 key and 1 value is supported - */ -template -class MapUserConfigParam : public UserConfigParam -{ -protected: - std::array m_key_names; - std::map m_elements; - MapUserConfigParam(const char* param_name, - const char* comment) - { - m_param_name = param_name; - if (comment != NULL) - m_comment = comment; - } - -public: - MapUserConfigParam(const char* param_name, - const char* comment, - std::array key_names, - std::map default_value); - MapUserConfigParam(const char* param_name, - GroupUserConfigParam* group, - const char* comment = NULL); - MapUserConfigParam(const char* param_name, - GroupUserConfigParam* group, - const char* comment, std::array key_names, - std::map default_value); - - void write(std::stringstream& stream) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - void addElement(T element, U value); - - irr::core::stringc toString() const; - - operator std::map&() - { - return m_elements; - } - typename std::map::iterator begin() - { - return m_elements.begin(); - } - typename std::map::iterator end() - { - return m_elements.end(); - } - typename std::map::iterator find(const T& key) - { - return m_elements.find(key); - } - size_t erase(const T& key) - { - return m_elements.erase(key); - } - bool empty() const - { - return m_elements.empty(); - } - std::map& operator=(const std::map& v) - { - m_elements = std::map(v); - return m_elements; - } - std::map& operator=(const MapUserConfigParam& v) - { - m_elements = std::map(v); - return m_elements; - } - size_t size() const - { - return m_elements.size(); - } - U& operator[] (const T key) - { - return m_elements[key]; - } - U& at(const T key) - { - return m_elements.at(key); - } -}; // MapUserConfigParam -typedef MapUserConfigParam UIntToUIntUserConfigParam; -typedef MapUserConfigParam StringToUIntUserConfigParam; -// ============================================================================ -class IntUserConfigParam : public UserConfigParam -{ -protected: - int m_value; - int m_default_value; - IntUserConfigParam(const char* param_name, const char* comment) - { - m_param_name = param_name; - if (comment != NULL) - m_comment = comment; - } - -public: - - IntUserConfigParam(int default_value, const char* param_name, - const char* comment = NULL); - IntUserConfigParam(int default_value, const char* param_name, - GroupUserConfigParam* group, - const char* comment = NULL); - - void write(std::stringstream& stream) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - irr::core::stringc toString() const; - void setDefaultValue(int v) { m_value = m_default_value = v; } - void revertToDefaults() { m_value = m_default_value; } - int getDefaultValue() { return m_default_value; } - operator int() const { return m_value; } - int& operator++(int dummy) { m_value++; return m_value; } - int& operator=(const int& v) { m_value = v; return m_value; } - int& operator=(const IntUserConfigParam& v) - { m_value = (int)v; return m_value; } -}; // IntUserConfigParam - -// ============================================================================ -class TimeUserConfigParam : public UserConfigParam -{ - StkTime::TimeType m_value; - StkTime::TimeType m_default_value; - -public: - - TimeUserConfigParam(StkTime::TimeType default_value, const char* param_name, - const char* comment = NULL); - TimeUserConfigParam(StkTime::TimeType default_value, const char* param_name, - GroupUserConfigParam* group, const char* comment=NULL); - - void write(std::stringstream& stream) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - irr::core::stringc toString() const; - void revertToDefaults() { m_value = m_default_value; } - operator StkTime::TimeType() const { return m_value; } - StkTime::TimeType& operator=(const StkTime::TimeType& v) - { m_value = v; return m_value; } - StkTime::TimeType& operator=(const TimeUserConfigParam& v) - { m_value = (int)v; return m_value; } -}; // TimeUserConfigParam - -// ============================================================================ -class StringUserConfigParam : public UserConfigParam -{ -protected: - std::string m_value; - std::string m_default_value; - StringUserConfigParam(const char* param_name, const char* comment) - { - m_param_name = param_name; - if (comment != NULL) - m_comment = comment; - } - -public: - - StringUserConfigParam(const char* default_value, const char* param_name, - const char* comment); - StringUserConfigParam(const char* default_value, const char* param_name, - GroupUserConfigParam* group, - const char* comment = NULL); - - void write(std::stringstream& stream) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - void revertToDefaults() { m_value = m_default_value; } - - std::string getDefaultValue() const { return m_default_value; } - - irr::core::stringc toString() const { return m_value.c_str(); } - - operator std::string() const { return m_value; } - std::string& operator=(const std::string& v) - { m_value = v; return m_value; } - std::string& operator=(const StringUserConfigParam& v) - { m_value = (std::string)v; return m_value; } - - const char* c_str() const { return m_value.c_str(); } -}; // StringUserConfigParam - -// ============================================================================ -class BoolUserConfigParam : public UserConfigParam -{ -protected: - bool m_value; - bool m_default_value; - BoolUserConfigParam(const char* param_name, const char* comment) - { - m_param_name = param_name; - if (comment != NULL) - m_comment = comment; - } - -public: - BoolUserConfigParam(bool default_value, const char* param_name, - const char* comment = NULL); - BoolUserConfigParam(bool default_value, const char* param_name, - GroupUserConfigParam* group, - const char* comment = NULL); - void write(std::stringstream& stream) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - irr::core::stringc toString() const; - void revertToDefaults() { m_value = m_default_value; } - void setDefaultValue(bool v) { m_value = m_default_value = v; } - - operator bool() const { return m_value; } - bool& operator=(const bool& v) { m_value = v; return m_value; } - bool& operator=(const BoolUserConfigParam& v) - { m_value = (bool)v; return m_value; } -}; // BoolUserConfigParam - -// ============================================================================ -class FloatUserConfigParam : public UserConfigParam -{ -protected: - float m_value; - float m_default_value; - FloatUserConfigParam(const char* param_name, const char* comment) - { - m_param_name = param_name; - if (comment != NULL) - m_comment = comment; - } - -public: - FloatUserConfigParam(float default_value, const char* param_name, - const char* comment = NULL); - FloatUserConfigParam(float default_value, const char* param_name, - GroupUserConfigParam* group, - const char* comment = NULL); - - void write(std::stringstream& stream) const; - void findYourDataInAChildOf(const XMLNode* node); - void findYourDataInAnAttributeOf(const XMLNode* node); - - irr::core::stringc toString() const; - void revertToDefaults() { m_value = m_default_value; } - void setDefaultValue(float v) { m_value = m_default_value = v; } - - operator float() const { return m_value; } - float& operator=(const float& v) { m_value = v; return m_value; } - float& operator=(const FloatUserConfigParam& v) - { m_value = (float)v; return m_value; } -}; // FloatUserConfigParam - -// ============================================================================ -enum AnimType {ANIMS_NONE = 0, - ANIMS_PLAYERS_ONLY = 1, - ANIMS_ALL = 2 }; - -enum MultitouchControls -{ - MULTITOUCH_CONTROLS_UNDEFINED = 0, - MULTITOUCH_CONTROLS_STEERING_WHEEL = 1, - MULTITOUCH_CONTROLS_ACCELEROMETER = 2, - MULTITOUCH_CONTROLS_GYROSCOPE = 3, -}; - -/** Using X-macros for setting-possible values is not very pretty, but it's a - * no-maintenance case : - * when you want to add a new parameter, just add one signle line below and - * everything else automagically works (including default value, saving to - * file, loading from file) - */ - -#ifndef PARAM_PREFIX -#define PARAM_PREFIX extern -#endif - -#ifndef PARAM_DEFAULT -#define PARAM_DEFAULT(X) -#endif - -// ============================================================================ -/** \brief Contains all parameters that are stored in the user's config file - * \ingroup config - */ -namespace UserConfigParams -{ - - // ---- Audio - PARAM_PREFIX GroupUserConfigParam m_audio_group - PARAM_DEFAULT( GroupUserConfigParam("Audio", "Audio Settings") ); - - PARAM_PREFIX BoolUserConfigParam m_sfx - PARAM_DEFAULT( BoolUserConfigParam(true, "sfx_on", &m_audio_group, - "Whether sound effects are enabled or not (true or false)") ); - PARAM_PREFIX BoolUserConfigParam m_music - PARAM_DEFAULT( BoolUserConfigParam(true, "music_on", - &m_audio_group, - "Whether musics are enabled or not (true or false)") ); - PARAM_PREFIX IntUserConfigParam m_sfx_numerator - PARAM_DEFAULT( IntUserConfigParam(10, "sfx_numerator", - &m_audio_group, "The value in the audio options SFX spinner") ); - PARAM_PREFIX FloatUserConfigParam m_sfx_volume - PARAM_DEFAULT( FloatUserConfigParam(0.2678f, "sfx_volume", - &m_audio_group, "Volume for sound effects, see openal AL_GAIN " - "for interpretation") ); - PARAM_PREFIX IntUserConfigParam m_music_numerator - PARAM_DEFAULT( IntUserConfigParam(10, "music_numerator", - &m_audio_group, "The value in the audio options music spinner") ); - PARAM_PREFIX FloatUserConfigParam m_music_volume - PARAM_DEFAULT( FloatUserConfigParam(0.2678f, "music_volume", - &m_audio_group, "Music volume from 0.0 to 1.0") ); - - PARAM_PREFIX IntUserConfigParam m_volume_denominator - PARAM_DEFAULT( IntUserConfigParam(15, "volume_denominator", - &m_audio_group, - "Number of steps for volume adjustment") ); - - // ---- Race setup - PARAM_PREFIX GroupUserConfigParam m_race_setup_group - PARAM_DEFAULT( GroupUserConfigParam("RaceSetup", - "Race Setup Settings") ); - - PARAM_PREFIX IntUserConfigParam m_default_num_karts - PARAM_DEFAULT( IntUserConfigParam(4, "numkarts", - &m_race_setup_group, - "Default number of karts. -1 means use all") ); - PARAM_PREFIX IntUserConfigParam m_num_laps - PARAM_DEFAULT( IntUserConfigParam(4, "numlaps", - &m_race_setup_group, "Default number of laps.") ); - PARAM_PREFIX IntUserConfigParam m_gp_reverse - PARAM_DEFAULT( IntUserConfigParam(0, "gp-reverse", - &m_race_setup_group, "Default direction of GP tracks. 0=default, 1=no reverse, 2=all reverse, 3=Random") ); - PARAM_PREFIX IntUserConfigParam m_rand_gp_num_tracks - PARAM_DEFAULT( IntUserConfigParam(1, "random-gp-num-tracks", - &m_race_setup_group, "Default number of tracks for random GP.") ); - PARAM_PREFIX IntUserConfigParam m_ffa_time_limit - PARAM_DEFAULT(IntUserConfigParam(3, "ffa-time-limit", - &m_race_setup_group, "Time limit in ffa mode.")); - PARAM_PREFIX BoolUserConfigParam m_use_ffa_mode - PARAM_DEFAULT(BoolUserConfigParam(false, "use-ffa-mode", - &m_race_setup_group, "Use ffa mode instead of 3 strikes battle.")); - PARAM_PREFIX IntUserConfigParam m_lap_trial_time_limit - PARAM_DEFAULT(IntUserConfigParam(3, "lap-trial-time-limit", - &m_race_setup_group, "Time limit in lap trial mode.")); - PARAM_PREFIX IntUserConfigParam m_num_goals - PARAM_DEFAULT( IntUserConfigParam(3, "numgoals", - &m_race_setup_group, "Default number of goals in soccer mode.") ); - PARAM_PREFIX IntUserConfigParam m_soccer_default_team - PARAM_DEFAULT( IntUserConfigParam(0, "soccer-default-team", - &m_race_setup_group, "Default team in soccer mode for single player.") ); - PARAM_PREFIX IntUserConfigParam m_soccer_time_limit - PARAM_DEFAULT( IntUserConfigParam(3, "soccer-time-limit", - &m_race_setup_group, "Time limit in soccer mode.") ); - PARAM_PREFIX BoolUserConfigParam m_soccer_use_time_limit - PARAM_DEFAULT( BoolUserConfigParam(false, "soccer-use-time-limit", - &m_race_setup_group, "Enable time limit in soccer mode.") ); - PARAM_PREFIX BoolUserConfigParam m_random_arena_item - PARAM_DEFAULT( BoolUserConfigParam(false, "random-arena-item", - &m_race_setup_group, "Enable random location of items in an arena.") ); - PARAM_PREFIX IntUserConfigParam m_difficulty - PARAM_DEFAULT( IntUserConfigParam(0, "difficulty", - &m_race_setup_group, - "Default race difficulty. 0=easy, 1=medium, 2=hard, 3=supertux") ); - PARAM_PREFIX IntUserConfigParam m_game_mode - PARAM_DEFAULT( IntUserConfigParam(0, "game_mode", - &m_race_setup_group, - "Game mode. 0=standard, 1=time trial, 2=follow " - "the leader, 3=3 strikes, 4=easter egg hunt, " - "5=soccer, 6=ghost replay") ); - PARAM_PREFIX StringUserConfigParam m_default_kart - PARAM_DEFAULT( StringUserConfigParam("tux", "kart", - "Kart to select by default (the last used kart)") ); - PARAM_PREFIX StringUserConfigParam m_last_used_kart_group - PARAM_DEFAULT( StringUserConfigParam("all", "last_kart_group", - "Last selected kart group") ); - PARAM_PREFIX IntUserConfigParam m_soccer_red_ai_num - PARAM_DEFAULT( IntUserConfigParam(0, "soccer-red-ai-num", - &m_race_setup_group, "Number of red AI karts in soccer mode.") ); - PARAM_PREFIX IntUserConfigParam m_soccer_blue_ai_num - PARAM_DEFAULT( IntUserConfigParam(0, "soccer-blue-ai-num", - &m_race_setup_group, "Number of blue AI karts in soccer mode.") ); - PARAM_PREFIX BoolUserConfigParam m_karts_powerup_gui - PARAM_DEFAULT( BoolUserConfigParam(false, "karts-powerup-gui", - &m_race_setup_group, "Show other karts' held powerups in race gui.") ); - PARAM_PREFIX BoolUserConfigParam m_soccer_player_list - PARAM_DEFAULT( BoolUserConfigParam(false, "soccer-player-list", - &m_race_setup_group, "Show player list icon in soccer mode.") ); - PARAM_PREFIX BoolUserConfigParam m_addon_tux_online - PARAM_DEFAULT( BoolUserConfigParam(false, "addon-tux-online", - &m_race_setup_group, "Always show online addon karts as tux when live join is on.") ); - PARAM_PREFIX BoolUserConfigParam m_random_player_pos - PARAM_DEFAULT( BoolUserConfigParam(false, "random-player-pos", - &m_race_setup_group, "Randomize the position of the players at the start of a race. Doesn't apply to story mode.") ); - - // ---- Wiimote data - PARAM_PREFIX GroupUserConfigParam m_wiimote_group - PARAM_DEFAULT( GroupUserConfigParam("WiiMote", - "Settings for the wiimote") ); - PARAM_PREFIX FloatUserConfigParam m_wiimote_raw_max - PARAM_DEFAULT( FloatUserConfigParam(20.0f, "wiimote-raw-max", - &m_wiimote_group, - "At what raw input value maximum steering is reached (between 1 and 25).") ); - - PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_linear - PARAM_DEFAULT( FloatUserConfigParam(1.0f, "wiimote-weight-linear", - &m_wiimote_group, - "A weight applied to the linear component of mapping wiimote angle to steering angle")); - - PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_square - PARAM_DEFAULT( FloatUserConfigParam(0.0f, "wiimote-weight-square", - &m_wiimote_group, - "A weight applied to the square component of mapping wiimote angle to steering angle")); - - PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_asin - PARAM_DEFAULT( FloatUserConfigParam(0.0f, "wiimote-weight-asin", - &m_wiimote_group, - "A weight applied to the asin component of mapping wiimote angle to steering angle")); - - PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_sin - PARAM_DEFAULT( FloatUserConfigParam(0.0f, "wiimote-weight-sin", - &m_wiimote_group, - "A weight applied to the sin component of mapping wiimote angle to steering angle")); - - // ---- Multitouch device - PARAM_PREFIX GroupUserConfigParam m_multitouch_group - PARAM_DEFAULT( GroupUserConfigParam("Multitouch", - "Settings for the multitouch device") ); - - PARAM_PREFIX IntUserConfigParam m_multitouch_active - PARAM_DEFAULT( IntUserConfigParam(1, "multitouch_active", - &m_multitouch_group, - "Enable multitouch support: 0 = disabled, 1 = if available, 2 = enabled") ); - - PARAM_PREFIX BoolUserConfigParam m_multitouch_draw_gui - PARAM_DEFAULT( BoolUserConfigParam(false, "multitouch_draw_gui", - &m_multitouch_group, - "Enable multitouch race GUI")); - - PARAM_PREFIX BoolUserConfigParam m_multitouch_inverted - PARAM_DEFAULT( BoolUserConfigParam(false, "multitouch_inverted", - &m_multitouch_group, - "Draw steering wheel on right side.") ); - - PARAM_PREFIX BoolUserConfigParam m_multitouch_auto_acceleration - PARAM_DEFAULT( BoolUserConfigParam(false, "multitouch_auto_acceleration", - &m_multitouch_group, - "Auto acceleration for multitouch controls.") ); - - PARAM_PREFIX IntUserConfigParam m_multitouch_controls - PARAM_DEFAULT( IntUserConfigParam(0, "multitouch_controls", - &m_multitouch_group, - "Multitouch mode: 0 = undefined, 1 = steering wheel, 2 = accelerometer, 3 = gyroscope")); - - PARAM_PREFIX FloatUserConfigParam m_multitouch_deadzone - PARAM_DEFAULT( FloatUserConfigParam(0.1f, "multitouch_deadzone", - &m_multitouch_group, - "A parameter in range [0, 0.5] that determines the zone that is " - "considered as centered in steering button.")); - - PARAM_PREFIX FloatUserConfigParam m_multitouch_sensitivity_x - PARAM_DEFAULT( FloatUserConfigParam(0.2f, "multitouch_sensitivity_x", - &m_multitouch_group, - "A parameter in range [0, 1.0] that determines the sensitivity for x axis.")); - - PARAM_PREFIX FloatUserConfigParam m_multitouch_sensitivity_y - PARAM_DEFAULT( FloatUserConfigParam(0.65f, "multitouch_sensitivity_y", - &m_multitouch_group, - "A parameter in range [0, 1.0] that determines the sensitivity for y axis.")); - - PARAM_PREFIX FloatUserConfigParam m_multitouch_tilt_factor - PARAM_DEFAULT( FloatUserConfigParam(4.0f, "multitouch_tilt_factor", - &m_multitouch_group, - "A parameter that determines general accelerometer sensitivity.")); - - PARAM_PREFIX FloatUserConfigParam m_multitouch_scale - PARAM_DEFAULT( FloatUserConfigParam(1.2f, "multitouch_scale", - &m_multitouch_group, - "A parameter in range [0.5, 1.5] that determines the scale of the " - "multitouch interface.")); - - PARAM_PREFIX IntUserConfigParam m_screen_keyboard - PARAM_DEFAULT( IntUserConfigParam(0, "screen_keyboard_status", - &m_multitouch_group, - "STK screen keyboard status: 0 = disabled, 1 = enabled") ); - - // ---- GP start order - PARAM_PREFIX GroupUserConfigParam m_gp_start_order - PARAM_DEFAULT( GroupUserConfigParam("GpStartOrder", - "Order karts start in GP") ); - PARAM_PREFIX BoolUserConfigParam m_gp_most_points_first - PARAM_DEFAULT( BoolUserConfigParam(true, "most_points_first", - &m_gp_start_order, - "Starting order from most to least points (true) or other " - "way around (false)") ); - PARAM_PREFIX BoolUserConfigParam m_gp_player_last - PARAM_DEFAULT( BoolUserConfigParam(false, "player_last", - &m_gp_start_order, - "Always put the player at the back or not (Bully mode).") ); - PARAM_PREFIX StringUserConfigParam m_additional_gp_directory - PARAM_DEFAULT( StringUserConfigParam("", "additional_gp_directory", - "Directory with additional GP's.")); - - // ---- Video - PARAM_PREFIX GroupUserConfigParam m_video_group - PARAM_DEFAULT( GroupUserConfigParam("Video", "Video Settings") ); - - PARAM_PREFIX IntUserConfigParam m_real_width - PARAM_DEFAULT( IntUserConfigParam(1024, "real_width", &m_video_group, - "Screen/window real width in pixels before high dpi is applied") ); - PARAM_PREFIX IntUserConfigParam m_real_height - PARAM_DEFAULT( IntUserConfigParam(768, "real_height", &m_video_group, - "Screen/window real height in pixels before high dpi is applied") ); - PARAM_PREFIX IntUserConfigParam m_width - PARAM_DEFAULT( IntUserConfigParam(1024, "width", &m_video_group, - "Screen/window width in pixels, this value should not be edited") ); - PARAM_PREFIX IntUserConfigParam m_height - PARAM_DEFAULT( IntUserConfigParam(768, "height", &m_video_group, - "Screen/window height in pixels, this value should not be edited") ); - PARAM_PREFIX BoolUserConfigParam m_fullscreen - PARAM_DEFAULT( BoolUserConfigParam(false, "fullscreen", - &m_video_group) ); - PARAM_PREFIX IntUserConfigParam m_prev_real_width - PARAM_DEFAULT( IntUserConfigParam(1024, "prev_real_width", - &m_video_group, "Previous real screen/window width") ); - PARAM_PREFIX IntUserConfigParam m_prev_real_height - PARAM_DEFAULT( IntUserConfigParam(768, "prev_real_height", - &m_video_group,"Previous real screen/window height") ); - PARAM_PREFIX BoolUserConfigParam m_prev_fullscreen - PARAM_DEFAULT( BoolUserConfigParam(false, "prev_fullscreen", - &m_video_group) ); - - - PARAM_PREFIX BoolUserConfigParam m_remember_window_location - PARAM_DEFAULT( BoolUserConfigParam(false, "remember_window_location", - &m_video_group) ); - PARAM_PREFIX IntUserConfigParam m_window_x - PARAM_DEFAULT( IntUserConfigParam(-1, "window_x", - &m_video_group,"If remember_window_location is true") ); - PARAM_PREFIX IntUserConfigParam m_window_y - PARAM_DEFAULT( IntUserConfigParam(-1, "window_y", - &m_video_group,"If remember_window_location is true") ); - - PARAM_PREFIX BoolUserConfigParam m_display_fps - PARAM_DEFAULT( BoolUserConfigParam(false, "show_fps", - &m_video_group, "Display frame per seconds") ); - PARAM_PREFIX BoolUserConfigParam m_display_story_mode_timer - PARAM_DEFAULT( BoolUserConfigParam(true, "show_story_mode_timer", - &m_video_group, "Display the story mode timer") ); - PARAM_PREFIX BoolUserConfigParam m_speedrun_mode - PARAM_DEFAULT( BoolUserConfigParam(false, "show_speedrun_timer", - &m_video_group, "Display the speedrun timer") ); - PARAM_PREFIX IntUserConfigParam m_max_fps - PARAM_DEFAULT( IntUserConfigParam(120, "max_fps", - &m_video_group, "Maximum fps, should be at least 60") ); - PARAM_PREFIX BoolUserConfigParam m_force_legacy_device - PARAM_DEFAULT(BoolUserConfigParam(false, "force_legacy_device", - &m_video_group, "Force OpenGL 2 context, even if OpenGL 3 is available.")); - PARAM_PREFIX BoolUserConfigParam m_split_screen_horizontally - PARAM_DEFAULT(BoolUserConfigParam(true, "split_screen_horizontally", - &m_video_group, "When playing a non-square amount of players (e.g. 2)," - " should it split horizontally (top/bottom)")); - PARAM_PREFIX BoolUserConfigParam m_texture_compression - PARAM_DEFAULT(BoolUserConfigParam(true, "enable_texture_compression", - &m_video_group, "Enable Texture Compression")); - /** This is a bit flag: bit 0: enabled (1) or disabled(0). - * Bit 1: setting done by default(0), or by user choice (2). This allows - * to e.g. disable h.d. textures on hd3000 as default, but still allow the - * user to enable it. */ - PARAM_PREFIX IntUserConfigParam m_high_definition_textures - PARAM_DEFAULT(IntUserConfigParam(1, "enable_high_definition_textures", - &m_video_group, "Enable high definition textures. Bit flag: " - "bit 0 = enabled/disabled; bit 1 = set by user/set as default")); - PARAM_PREFIX BoolUserConfigParam m_glow - PARAM_DEFAULT(BoolUserConfigParam(false, "enable_glow", - &m_video_group, "Enable Glow")); - PARAM_PREFIX BoolUserConfigParam m_bloom - PARAM_DEFAULT(BoolUserConfigParam(false, "enable_bloom", - &m_video_group, "Enable Bloom")); - PARAM_PREFIX BoolUserConfigParam m_light_shaft - PARAM_DEFAULT(BoolUserConfigParam(false, "enable_light_shaft", - &m_video_group, "Enable Light Shafts")); - PARAM_PREFIX BoolUserConfigParam m_dynamic_lights - PARAM_DEFAULT(BoolUserConfigParam(true, "enable_dynamic_lights", - &m_video_group, "Enable Dynamic Lights")); - PARAM_PREFIX BoolUserConfigParam m_dof - PARAM_DEFAULT(BoolUserConfigParam(false, "enable_dof", - &m_video_group, "Enable Depth of Field")); - PARAM_PREFIX BoolUserConfigParam m_old_driver_popup - PARAM_DEFAULT(BoolUserConfigParam(true, "old_driver_popup", - &m_video_group, "Determines if popup message about too old drivers should be displayed.")); - PARAM_PREFIX FloatUserConfigParam m_scale_rtts_factor - PARAM_DEFAULT(FloatUserConfigParam(1.0f, "scale_rtts_factor", - &m_video_group, "Custom value for RTTs resolution. " - "Value should be smaller or equal to 1.0")); - PARAM_PREFIX IntUserConfigParam m_max_texture_size - PARAM_DEFAULT(IntUserConfigParam(512, "max_texture_size", - &m_video_group, "Max texture size when high definition textures are " - "disabled")); - PARAM_PREFIX BoolUserConfigParam m_ssr - PARAM_DEFAULT(BoolUserConfigParam(false, "ssr", - &m_video_group, "Enable screen space reflection")); - PARAM_PREFIX BoolUserConfigParam m_hq_mipmap - PARAM_DEFAULT(BoolUserConfigParam(false, "hq_mipmap", - &m_video_group, "Generate mipmap for textures using " - "high quality method with SSE")); - PARAM_PREFIX FloatUserConfigParam m_font_size - PARAM_DEFAULT( FloatUserConfigParam(3, "font_size", - &m_video_group, "The size of fonts. 0 is the smallest and 6 is the biggest") ); - -#if defined(_IRR_COMPILE_WITH_DIRECT3D_9_) && defined(_M_ARM) - PARAM_PREFIX StringUserConfigParam m_render_driver - PARAM_DEFAULT( StringUserConfigParam("directx9", "render_driver", - &m_video_group, "Render video driver to use, at the moment gl, vulkan or directx9 is supported.") ); -#else - PARAM_PREFIX StringUserConfigParam m_render_driver - PARAM_DEFAULT( StringUserConfigParam("gl", "render_driver", - &m_video_group, "Render video driver to use, at the moment gl, vulkan or directx9 is supported.") ); -#endif - -#if defined(MOBILE_STK) - PARAM_PREFIX BoolUserConfigParam m_vulkan_fullscreen_desktop - PARAM_DEFAULT(BoolUserConfigParam(false, "vulkan_fullscreen_desktop", - &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for vulkan device")); -#else - PARAM_PREFIX BoolUserConfigParam m_vulkan_fullscreen_desktop - PARAM_DEFAULT(BoolUserConfigParam(true, "vulkan_fullscreen_desktop", - &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for vulkan device")); -#endif - - PARAM_PREFIX BoolUserConfigParam m_non_ge_fullscreen_desktop - PARAM_DEFAULT(BoolUserConfigParam(false, "non_ge_fullscreen_desktop", - &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for non-ge device")); - - // ---- Recording - PARAM_PREFIX GroupUserConfigParam m_recording_group - PARAM_DEFAULT(GroupUserConfigParam("Recording", - "Recording Settings")); - - PARAM_PREFIX BoolUserConfigParam m_limit_game_fps - PARAM_DEFAULT(BoolUserConfigParam(true, "limit_game_fps", - &m_recording_group, "Limit game framerate not beyond the fps of" - " recording video.")); - PARAM_PREFIX IntUserConfigParam m_video_format - PARAM_DEFAULT(IntUserConfigParam(0, "video_format", - &m_recording_group, "Specify the video for record, which is the enum" - " of VideoFormat in libopenglrecorder. It will" - " auto fallback to MJPEG if libopenglrecorder was" - " not compiled with such video encoder.")); - - PARAM_PREFIX IntUserConfigParam m_audio_bitrate - PARAM_DEFAULT(IntUserConfigParam(112000, "audio_bitrate", - &m_recording_group, "Specify the bitrate for audio")); - - PARAM_PREFIX IntUserConfigParam m_video_bitrate - PARAM_DEFAULT(IntUserConfigParam(20000, "video_bitrate", - &m_recording_group, "Specify the bitrate for video")); - - PARAM_PREFIX IntUserConfigParam m_recorder_jpg_quality - PARAM_DEFAULT(IntUserConfigParam(90, "recorder_jpg_quality", - &m_recording_group, "Specify the jpg compression level of recorder")); - - PARAM_PREFIX IntUserConfigParam m_record_fps - PARAM_DEFAULT(IntUserConfigParam(30, "record_fps", - &m_recording_group, "Specify the fps of recording video")); - - // ---- Debug - not saved to config file - /** If high scores will not be saved. For repeated testing on tracks. */ - PARAM_PREFIX bool m_no_high_scores PARAM_DEFAULT(false); - - /** If unit testing is enabled. */ - PARAM_PREFIX bool m_unit_testing PARAM_DEFAULT(false); - - /** If gamepad debugging is enabled. */ - PARAM_PREFIX bool m_gamepad_debug PARAM_DEFAULT( false ); - - /** If keyboard debugging is enabled. */ - PARAM_PREFIX bool m_keyboard_debug PARAM_DEFAULT(false); - - /** Wiimote debugging. */ - PARAM_PREFIX bool m_wiimote_debug PARAM_DEFAULT( false ); - - /** Debug gamepads by visualising their values. */ - PARAM_PREFIX bool m_gamepad_visualisation PARAM_DEFAULT( false ); - - /** If material debugging (printing terrain specific slowdown) - * is enabled. */ - PARAM_PREFIX bool m_material_debug PARAM_DEFAULT( false ); - - /** If track debugging is enabled. */ - PARAM_PREFIX int m_track_debug PARAM_DEFAULT( false ); - - /** True if check structures should be debugged. */ - PARAM_PREFIX bool m_check_debug PARAM_DEFAULT( false ); - - /** True if physics debugging should be enabled. */ - PARAM_PREFIX bool m_physics_debug PARAM_DEFAULT( false ); - - /** True if FPS should be printed each frame. */ - PARAM_PREFIX bool m_fps_debug PARAM_DEFAULT(false); - - /** True if arena (battle/soccer) ai profiling. */ - PARAM_PREFIX bool m_arena_ai_stats PARAM_DEFAULT(false); - - /** True if slipstream debugging is activated. */ - PARAM_PREFIX bool m_slipstream_debug PARAM_DEFAULT( false ); - - /** True if follow-the-leader debug information should be printed. */ - PARAM_PREFIX bool m_ftl_debug PARAM_DEFAULT( false ); - - /** True if currently developed tutorial debugging is enabled. */ - PARAM_PREFIX bool m_tutorial_debug PARAM_DEFAULT( false ); - - /** Verbosity level for debug messages. Note that error and - * important warnings must always be printed. */ - PARAM_PREFIX int m_verbosity PARAM_DEFAULT( 0 ); - - PARAM_PREFIX bool m_no_start_screen PARAM_DEFAULT( false ); - - PARAM_PREFIX bool m_race_now PARAM_DEFAULT( false ); - - PARAM_PREFIX int m_default_keyboard PARAM_DEFAULT( -1 ); - - PARAM_PREFIX int m_default_gamepad PARAM_DEFAULT( -1 ); - - PARAM_PREFIX bool m_enforce_current_player PARAM_DEFAULT( false ); - - PARAM_PREFIX bool m_enable_sound PARAM_DEFAULT( true ); - - /** True to test funky ambient/diffuse/specularity in RGB & - * all anisotropic */ - PARAM_PREFIX bool m_rendering_debug PARAM_DEFAULT( false ); - - /** True if graphical profiler should be displayed */ - PARAM_PREFIX bool m_profiler_enabled PARAM_DEFAULT( false ); - - PARAM_PREFIX bool m_disable_addon_karts PARAM_DEFAULT( false ); - - PARAM_PREFIX bool m_disable_addon_tracks PARAM_DEFAULT( false ); - - PARAM_PREFIX bool m_benchmark PARAM_DEFAULT( false ); - - // ---- Networking - PARAM_PREFIX StringToUIntUserConfigParam m_server_bookmarks - PARAM_DEFAULT(StringToUIntUserConfigParam("server-bookmarks", - "Wan server bookmarks", - {{ "server-bookmarks", "server-name", "last-online" }}, {})); - - PARAM_PREFIX StringToUIntUserConfigParam m_server_bookmarks_order - PARAM_DEFAULT(StringToUIntUserConfigParam("server-bookmarks-order", - "Wan server bookmarks order", - {{ "server-bookmarks", "server-name", "id" }}, {})); - - PARAM_PREFIX StringToUIntUserConfigParam m_address_history - PARAM_DEFAULT(StringToUIntUserConfigParam("address-history", - "Last 5 IP addresses that user entered", - {{ "server-address", "address", "last-connection" }}, {})); - - // These stk domains have only a record to each ipv6 stun below, - // so we can use this to know ipv4 address of nat64 gateway (if any) - PARAM_PREFIX StringToUIntUserConfigParam m_stun_servers_v4 - PARAM_DEFAULT(StringToUIntUserConfigParam("ipv4-stun-servers", - "The stun servers that will be used to know the public address " - "(ipv4 only) with port", {{ "stun-server", "address", "ping" }}, - { - { "stunv4.linuxreviews.org:3478", 0u }, - { "stunv4.7.supertuxkart.net:3478", 0u }, - { "stunv4.8.supertuxkart.net:3478", 0u } - } - )); - - PARAM_PREFIX StringToUIntUserConfigParam m_stun_servers - PARAM_DEFAULT(StringToUIntUserConfigParam("ipv6-stun-servers", - "The stun servers that will be used to know the public address " - "(including ipv6) with port", {{ "stun-server", "address", "ping" }}, - { - { "stun.linuxreviews.org:3478", 0u }, - { "stun.supertuxkart.net:3478", 0u }, - { "stun.stunprotocol.org:3478", 0u } - } - )); - - PARAM_PREFIX GroupUserConfigParam m_network_group - PARAM_DEFAULT(GroupUserConfigParam("Network", "Network Settings")); - PARAM_PREFIX BoolUserConfigParam m_enable_network_splitscreen - PARAM_DEFAULT(BoolUserConfigParam(false, "enable-network-splitscreen", - &m_network_group, "The default value of enable splitscreen checkbox " - "in online screen.")); - PARAM_PREFIX BoolUserConfigParam m_log_packets - PARAM_DEFAULT(BoolUserConfigParam(false, "log-network-packets", - &m_network_group, "If all network packets should be logged")); - PARAM_PREFIX BoolUserConfigParam m_random_client_port - PARAM_DEFAULT(BoolUserConfigParam(true, "random-client-port", - &m_network_group, "Use random port for client connection " - "(check stk_config.xml for default value)")); - PARAM_PREFIX BoolUserConfigParam m_random_server_port - PARAM_DEFAULT(BoolUserConfigParam(false, "random-server-port", - &m_network_group, "Use random port for server connection " - "(check stk_config.xml for default value)")); - PARAM_PREFIX BoolUserConfigParam m_lobby_chat - PARAM_DEFAULT(BoolUserConfigParam(true, "lobby-chat", - &m_network_group, "Enable chatting in networking lobby, if off than " - "no chat message will be displayed from any players.")); - PARAM_PREFIX BoolUserConfigParam m_race_chat - PARAM_DEFAULT(BoolUserConfigParam(true, "race-chat", - &m_network_group, "Enable chatting during races.")); - PARAM_PREFIX BoolUserConfigParam m_ipv6_lan - PARAM_DEFAULT(BoolUserConfigParam(true, "ipv6-lan", - &m_network_group, "Enable IPv6 LAN server discovery.")); - PARAM_PREFIX IntUserConfigParam m_max_players - PARAM_DEFAULT(IntUserConfigParam(8, "max-players", - &m_network_group, "Maximum number of players on the server " - "(for gui server creation.")); - PARAM_PREFIX IntUserConfigParam m_timer_sync_difference_tolerance - PARAM_DEFAULT(IntUserConfigParam(5, "timer-sync-difference-tolerance", - &m_network_group, "Max time difference tolerance (in ms) to " - "synchronize timer with server.")); - PARAM_PREFIX IntUserConfigParam m_default_ip_type - PARAM_DEFAULT(IntUserConfigParam(0, "default-ip-type", - &m_network_group, "Default IP type of this machine, " - "0 detect every time, 1 IPv4, 2 IPv6, 3 IPv6 NAT64, 4 Dual stack.")); - PARAM_PREFIX BoolUserConfigParam m_lan_server_gp - PARAM_DEFAULT(BoolUserConfigParam(false, "lan-server-gp", - &m_network_group, "Show grand prix option in create LAN server " - "screen, false will show AI option.")); - PARAM_PREFIX BoolUserConfigParam m_wan_server_gp - PARAM_DEFAULT(BoolUserConfigParam(true, "wan-server-gp", - &m_network_group, "Show grand prix option in create WAN server " - "screen, false will show AI option.")); - - // ---- Gamemode setup - PARAM_PREFIX UIntToUIntUserConfigParam m_num_karts_per_gamemode - PARAM_DEFAULT(UIntToUIntUserConfigParam("num-karts-per-gamemode", - "The Number of karts per gamemode.", - {{ "gamemode-list", "gamemode", "num-karts" }}, - { - { 0u, 4u }, - { 1002u, 5u }, - { 1100u, 4u }, - { 1101u, 4u }, - { 2000u, 4u }, - { 2001u, 4u } - } - )); - - // ---- Graphic Quality - PARAM_PREFIX GroupUserConfigParam m_graphics_quality - PARAM_DEFAULT( GroupUserConfigParam("GFX", - "Graphics Quality Settings") ); - - PARAM_PREFIX IntUserConfigParam m_particles_effects - PARAM_DEFAULT( IntUserConfigParam(2, "particles-effecs", - &m_graphics_quality, "Particles effects: 0 disabled, 1 only important, 2 enabled") ); - - // This saves the actual user preference. - PARAM_PREFIX IntUserConfigParam m_xmas_mode - PARAM_DEFAULT( IntUserConfigParam(0, "christmas-mode", - &m_graphics_quality, "Christmas hats: 0 use current date, 1 always on, 2 always off") ); - - // This saves the actual user preference. - PARAM_PREFIX IntUserConfigParam m_easter_ear_mode - PARAM_DEFAULT(IntUserConfigParam(0, "easter-ear-mode", - &m_graphics_quality, "Easter Bunny Ears: 0 use current date, 1 always on, 2 always off")); - - PARAM_PREFIX BoolUserConfigParam m_animated_characters - PARAM_DEFAULT( BoolUserConfigParam(true, - "animated-characters", &m_graphics_quality, - "Whether to display animated characters") ); - - PARAM_PREFIX IntUserConfigParam m_geometry_level - PARAM_DEFAULT( IntUserConfigParam(2, - "geometry-level", &m_graphics_quality, - "Geometry quality 0=lowest level, no details; " - "5=everything is displayed") ); - - PARAM_PREFIX IntUserConfigParam m_anisotropic - PARAM_DEFAULT( IntUserConfigParam(4, "anisotropic", - &m_graphics_quality, - "Quality of anisotropic filtering (usual values include 2-4-8-16; 0 to disable)") ); - - PARAM_PREFIX IntUserConfigParam m_swap_interval - PARAM_DEFAULT( IntUserConfigParam(1, "swap-interval-vsync", - &m_graphics_quality, - "Swap interval for vsync: 0 = disabled, 1 = full") ); - PARAM_PREFIX BoolUserConfigParam m_motionblur - PARAM_DEFAULT( BoolUserConfigParam(false, - "motionblur_enabled", &m_graphics_quality, - "Whether motion blur should be enabled") ); - PARAM_PREFIX BoolUserConfigParam m_mlaa - PARAM_DEFAULT( BoolUserConfigParam(false, - "mlaa", &m_graphics_quality, - "Whether MLAA anti-aliasing should be enabled") ); - PARAM_PREFIX BoolUserConfigParam m_ssao - PARAM_DEFAULT(BoolUserConfigParam(false, - "ssao", &m_graphics_quality, - "Enable Screen Space Ambient Occlusion") ); - PARAM_PREFIX BoolUserConfigParam m_light_scatter - PARAM_DEFAULT(BoolUserConfigParam(false, - "light_scatter", &m_graphics_quality, - "Enable light scattering shaders") ); - PARAM_PREFIX IntUserConfigParam m_shadows_resolution - PARAM_DEFAULT( IntUserConfigParam(0, - "shadows_resolution", &m_graphics_quality, - "Shadow resolution (0 = disabled") ); - PARAM_PREFIX BoolUserConfigParam m_pcss - PARAM_DEFAULT( BoolUserConfigParam(false, - "pcss", &m_graphics_quality, - "Enable Percentage Closer Soft Shadows") ); - PARAM_PREFIX BoolUserConfigParam m_degraded_IBL - PARAM_DEFAULT(BoolUserConfigParam(true, - "Degraded_IBL", &m_graphics_quality, - "Disable specular IBL")); - - // ---- Misc - PARAM_PREFIX BoolUserConfigParam m_cache_overworld - PARAM_DEFAULT( BoolUserConfigParam(true, "cache-overworld") ); - - // TODO : is this used with new code? does it still work? - PARAM_PREFIX BoolUserConfigParam m_crashed - PARAM_DEFAULT( BoolUserConfigParam(false, "crashed") ); - - // ---- Camera - PARAM_PREFIX GroupUserConfigParam m_camera_normal - PARAM_DEFAULT( GroupUserConfigParam( - "camera-normal", - "Camera settings for player.") ); - - PARAM_PREFIX FloatUserConfigParam m_camera_distance - PARAM_DEFAULT( FloatUserConfigParam(1.0, "distance", - &m_camera_normal, - "Distance between kart and camera")); - - PARAM_PREFIX FloatUserConfigParam m_camera_forward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(0, "forward-up-angle", - &m_camera_normal, - "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); - - PARAM_PREFIX FloatUserConfigParam m_camera_forward_smooth_position - PARAM_DEFAULT( FloatUserConfigParam(0.2, "forward-smooth-position", - &m_camera_normal, - "The strength of smoothness of the position of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_camera_forward_smooth_rotation - PARAM_DEFAULT( FloatUserConfigParam(0.125, "forward-smooth-rotation", - &m_camera_normal, - "The strength of smoothness of the rotation of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_camera_backward_distance - PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", - &m_camera_normal, - "Distance between kart and camera (reverse)")); - - PARAM_PREFIX FloatUserConfigParam m_camera_backward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(5, "backward-up-angle", - &m_camera_normal, - "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); - - PARAM_PREFIX IntUserConfigParam m_camera_fov - PARAM_DEFAULT( IntUserConfigParam(80, "fov", - &m_camera_normal, - "Focal distance (single player)")); - - PARAM_PREFIX BoolUserConfigParam m_reverse_look_use_soccer_cam - PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", - "Use ball camera in soccer mode, instead of reverse") ); - - // ---- The present camera (default: Standard) - PARAM_PREFIX IntUserConfigParam m_camera_present - PARAM_DEFAULT( IntUserConfigParam(1, "camera-present", - "The current used camera. 0=Custom; 1=Standard; 2=Drone chase") ); - - // ---- Standard camera settings - PARAM_PREFIX GroupUserConfigParam m_standard_camera_settings - PARAM_DEFAULT( GroupUserConfigParam( - "standard-camera-settings", - "Standard camera settings for player.") ); - - PARAM_PREFIX FloatUserConfigParam m_standard_camera_distance - PARAM_DEFAULT( FloatUserConfigParam(1.0, "distance", - &m_standard_camera_settings, - "Distance between kart and camera")); - - PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(0, "forward-up-angle", - &m_standard_camera_settings, - "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); - - PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_smooth_position - PARAM_DEFAULT( FloatUserConfigParam(0.2, "forward-smooth-position", - &m_standard_camera_settings, - "The strength of smoothness of the position of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_smooth_rotation - PARAM_DEFAULT( FloatUserConfigParam(0.125, "forward-smooth-rotation", - &m_standard_camera_settings, - "The strength of smoothness of the rotation of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_standard_camera_backward_distance - PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", - &m_standard_camera_settings, - "Distance between kart and camera (reverse)")); - - PARAM_PREFIX FloatUserConfigParam m_standard_camera_backward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(5, "backward-up-angle", - &m_standard_camera_settings, - "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); - - PARAM_PREFIX IntUserConfigParam m_standard_camera_fov - PARAM_DEFAULT( IntUserConfigParam(80, "fov", - &m_standard_camera_settings, - "Focal distance (single player)")); - - PARAM_PREFIX BoolUserConfigParam m_standard_reverse_look_use_soccer_cam - PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", - &m_standard_camera_settings, - "Use ball camera in soccer mode, instead of reverse")); - - // ---- Drone chase camera settings - PARAM_PREFIX GroupUserConfigParam m_drone_camera_settings - PARAM_DEFAULT( GroupUserConfigParam( - "drone-camera-settings", - "Drone chase camera settings for player.") ); - - PARAM_PREFIX FloatUserConfigParam m_drone_camera_distance - PARAM_DEFAULT( FloatUserConfigParam(2.6, "distance", - &m_drone_camera_settings, - "Distance between kart and camera")); - - PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(33, "forward-up-angle", - &m_drone_camera_settings, - "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); - - PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_smooth_position - PARAM_DEFAULT( FloatUserConfigParam(0.0, "forward-smooth-position", - &m_drone_camera_settings, - "The strength of smoothness of the position of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_smooth_rotation - PARAM_DEFAULT( FloatUserConfigParam(0.0, "forward-smooth-rotation", - &m_drone_camera_settings, - "The strength of smoothness of the rotation of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_drone_camera_backward_distance - PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", - &m_drone_camera_settings, - "Distance between kart and camera (reverse)")); - - PARAM_PREFIX FloatUserConfigParam m_drone_camera_backward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(10, "backward-up-angle", - &m_drone_camera_settings, - "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); - - PARAM_PREFIX IntUserConfigParam m_drone_camera_fov - PARAM_DEFAULT( IntUserConfigParam(100, "fov", - &m_drone_camera_settings, - "Focal distance (single player)")); - - PARAM_PREFIX BoolUserConfigParam m_drone_reverse_look_use_soccer_cam - PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", - &m_drone_camera_settings, - "Use ball camera in soccer mode, instead of reverse")); - - // ---- Custom camera settings - PARAM_PREFIX GroupUserConfigParam m_saved_camera_settings - PARAM_DEFAULT( GroupUserConfigParam( - "saved-camera-settings", - "Saved custom camera settings for player.") ); - - PARAM_PREFIX FloatUserConfigParam m_saved_camera_distance - PARAM_DEFAULT( FloatUserConfigParam(1.8, "distance", - &m_saved_camera_settings, - "Distance between kart and camera")); - - PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(20, "forward-up-angle", - &m_saved_camera_settings, - "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); - - PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_smooth_position - PARAM_DEFAULT( FloatUserConfigParam(0.1, "forward-smooth-position", - &m_saved_camera_settings, - "The strength of smoothness of the position of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_smooth_rotation - PARAM_DEFAULT( FloatUserConfigParam(0.125, "forward-smooth-rotation", - &m_saved_camera_settings, - "The strength of smoothness of the rotation of the camera")); - - PARAM_PREFIX FloatUserConfigParam m_saved_camera_backward_distance - PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", - &m_saved_camera_settings, - "Distance between kart and camera (reverse)")); - - PARAM_PREFIX FloatUserConfigParam m_saved_camera_backward_up_angle - PARAM_DEFAULT( FloatUserConfigParam(5, "backward-up-angle", - &m_saved_camera_settings, - "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); - - PARAM_PREFIX IntUserConfigParam m_saved_camera_fov - PARAM_DEFAULT( IntUserConfigParam(85, "fov", - &m_saved_camera_settings, - "Focal distance (single player)")); - - PARAM_PREFIX BoolUserConfigParam m_saved_reverse_look_use_soccer_cam - PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", - &m_saved_camera_settings, - "Use ball camera in soccer mode, instead of reverse")); - - // camera in artist mode - PARAM_PREFIX GroupUserConfigParam m_camera - PARAM_DEFAULT( GroupUserConfigParam("camera", - "(Debug) camera settings.") ); - - PARAM_PREFIX IntUserConfigParam m_reverse_look_threshold - PARAM_DEFAULT( IntUserConfigParam(0, "reverse_look_threshold", - &m_camera, - "If the kart is driving backwards faster than this value,\n" - "switch automatically to reverse camera (set to 0 to disable).") ); - - PARAM_PREFIX FloatUserConfigParam m_fpscam_direction_speed - PARAM_DEFAULT( FloatUserConfigParam(0.003f, "fpscam_rotation_speed", - &m_camera, - "How fast the first person camera's direction speed changes when\n" - "moving the mouse (means acceleration).") ); - - PARAM_PREFIX FloatUserConfigParam m_fpscam_smooth_direction_max_speed - PARAM_DEFAULT( FloatUserConfigParam(0.04f, "fpscam_smooth_rotation_max_speed", - &m_camera, - "How fast the first person camera's direction can change.") ); - - PARAM_PREFIX FloatUserConfigParam m_fpscam_angular_velocity - PARAM_DEFAULT( FloatUserConfigParam(0.02f, "fpscam_angular_velocity", - &m_camera, - "How fast the first person camera's rotation speed changes.") ); - - PARAM_PREFIX FloatUserConfigParam m_fpscam_max_angular_velocity - PARAM_DEFAULT( FloatUserConfigParam(1.0f, "fpscam_max_angular_velocity", - &m_camera, - "How fast the first person camera can rotate.") ); - - PARAM_PREFIX StringUserConfigParam m_item_style - PARAM_DEFAULT( StringUserConfigParam("items", "item_style", - "Name of the .items file to use.") ); - - PARAM_PREFIX StringUserConfigParam m_last_track - PARAM_DEFAULT( StringUserConfigParam("olivermath", "last_track", - "Name of the last track used.") ); - PARAM_PREFIX StringUserConfigParam m_last_used_track_group - PARAM_DEFAULT( StringUserConfigParam("all", "last_track_group", - "Last selected track group") ); - - PARAM_PREFIX StringUserConfigParam m_discord_client_id - PARAM_DEFAULT( StringUserConfigParam("817760324983324753", "discord_client_id", - "Discord Client ID (Set to -1 to disable)") ); - - PARAM_PREFIX BoolUserConfigParam m_rich_presence_debug - PARAM_DEFAULT( BoolUserConfigParam(false, "rich_presence_debug", - "If debug logging should be enabled for rich presence") ); - - PARAM_PREFIX StringUserConfigParam m_skin_file - PARAM_DEFAULT( StringUserConfigParam("classic", "skin_name", - "Name of the skin to use") ); - - // ---- settings for minimap display - PARAM_PREFIX GroupUserConfigParam m_minimap_setup_group - PARAM_DEFAULT( GroupUserConfigParam("Minimap", - "Minimap Setup Settings") ); - - PARAM_PREFIX IntUserConfigParam m_minimap_display - PARAM_DEFAULT(IntUserConfigParam(0, "display", - &m_minimap_setup_group, "display: 0 bottom-left, 1 middle-right, 2 hidden, 3 center")); - - PARAM_PREFIX FloatUserConfigParam m_minimap_size - PARAM_DEFAULT( FloatUserConfigParam(180.0f, "size", - &m_minimap_setup_group, "Size of the the minimap (480 = full screen height; scaled afterwards)") ); - - PARAM_PREFIX FloatUserConfigParam m_minimap_ai_icon_size - PARAM_DEFAULT( FloatUserConfigParam(16.0f, "ai-icon", - &m_minimap_setup_group, "The size of the icons for the AI karts on the minimap.") ); - - PARAM_PREFIX FloatUserConfigParam m_minimap_player_icon_size - PARAM_DEFAULT( FloatUserConfigParam(20.0f, "player-icon", - &m_minimap_setup_group, "The size of the icons for the player kart.") ); - - // ---- settings for powerup display - PARAM_PREFIX GroupUserConfigParam m_powerup_setup_group - PARAM_DEFAULT( GroupUserConfigParam("PowerUp", - "PowerUp Setup Settings") ); - - PARAM_PREFIX IntUserConfigParam m_powerup_display - PARAM_DEFAULT(IntUserConfigParam(0, "display", - &m_powerup_setup_group, "display: 0 center, 1 right side, 2 hidden (see karts' held powerups)")); - PARAM_PREFIX FloatUserConfigParam m_powerup_size - PARAM_DEFAULT( FloatUserConfigParam(64.0f, "powerup-icon-size", - &m_powerup_setup_group, "Size of the powerup icon (scaled afterwards)") ); - - // ---- Settings for spectator camera - PARAM_PREFIX GroupUserConfigParam m_spectator - PARAM_DEFAULT( GroupUserConfigParam("Spectator", - "Everything related to spectator mode.") ); - - PARAM_PREFIX FloatUserConfigParam m_spectator_camera_distance - PARAM_DEFAULT( FloatUserConfigParam(6.75, "camera-distance", &m_spectator, - "Distance between kart and camera.") ); - PARAM_PREFIX FloatUserConfigParam m_spectator_camera_angle - PARAM_DEFAULT( FloatUserConfigParam(40.0, "camera-angle", &m_spectator, - "Angle between ground, kart and camera.") ); - - // ---- Handicap - PARAM_PREFIX GroupUserConfigParam m_handicap - PARAM_DEFAULT( GroupUserConfigParam("Handicap", - "Everything related to handicaps.") ); - - PARAM_PREFIX BoolUserConfigParam m_per_player_difficulty - PARAM_DEFAULT( BoolUserConfigParam(false, "per_player_difficulty", - &m_handicap, - "If handicapped users can be selected") ); - - // ---- Internet related - - PARAM_PREFIX IntUserConfigParam m_internet_status - PARAM_DEFAULT( IntUserConfigParam(0, "enable_internet", - "Status of internet: 0 user " - "wasn't asked, 1: allowed, 2: " - "not allowed") ); - - PARAM_PREFIX GroupUserConfigParam m_hw_report_group - PARAM_DEFAULT( GroupUserConfigParam("HWReport", - "Everything related to hardware configuration.") ); - - PARAM_PREFIX IntUserConfigParam m_last_hw_report_version - PARAM_DEFAULT( IntUserConfigParam(0, "report-version", &m_hw_report_group, - "Version of hardware report " - "that was reported last") ); - PARAM_PREFIX IntUserConfigParam m_random_identifier - PARAM_DEFAULT( IntUserConfigParam(0, "random-identifier", &m_hw_report_group, - "A random number to avoid duplicated reports.") ); - - PARAM_PREFIX BoolUserConfigParam m_hw_report_enable - PARAM_DEFAULT( BoolUserConfigParam( false, - "hw-report-enabled", - &m_hw_report_group, - "If HW reports are enabled.")); - - // ---- User management - - PARAM_PREFIX BoolUserConfigParam m_always_show_login_screen - PARAM_DEFAULT( BoolUserConfigParam(false, "always_show_login_screen", - "Always show the login screen even if last player's session was saved.")); - - - // ---- Addon server related entries - PARAM_PREFIX GroupUserConfigParam m_addon_group - PARAM_DEFAULT( GroupUserConfigParam("AddonServer", - "Addon and news related settings") ); - - PARAM_PREFIX TimeUserConfigParam m_news_last_updated - PARAM_DEFAULT( TimeUserConfigParam(0, "news_last_updated", - &m_addon_group, - "Time news was updated last.") ); - - PARAM_PREFIX IntUserConfigParam m_news_frequency - PARAM_DEFAULT( IntUserConfigParam(0, "news_frequency", - &m_addon_group, - "How often news should be updated.") ); - - PARAM_PREFIX StringUserConfigParam m_display_count - PARAM_DEFAULT( StringUserConfigParam("", "news_display_count", - &m_addon_group, - "How often all news messages " - "have been displayed") ); - - PARAM_PREFIX IntUserConfigParam m_last_important_message_id - PARAM_DEFAULT( IntUserConfigParam(-1, "last_important_message_id", - &m_addon_group, - "Don't show important message " - "with this or a lower id again") ); - - PARAM_PREFIX IntUserConfigParam m_news_list_shown_id - PARAM_DEFAULT( IntUserConfigParam(0, "news_list_shown_id", - &m_addon_group, - "News before this id has been " - "shown once so no red dot") ); - - PARAM_PREFIX TimeUserConfigParam m_addons_last_updated - PARAM_DEFAULT( TimeUserConfigParam(0, "addon_last_updated", - &m_addon_group, - "Time addon-list was updated last.") ); - - PARAM_PREFIX TimeUserConfigParam m_latest_addon_time - PARAM_DEFAULT( TimeUserConfigParam(0, "latest_addon_time", - &m_addon_group, - "Latest approved addon time.") ); - - PARAM_PREFIX StringUserConfigParam m_language - PARAM_DEFAULT( StringUserConfigParam("system", "language", - "Which language to use (language code or 'system')") ); - - PARAM_PREFIX BoolUserConfigParam m_artist_debug_mode - PARAM_DEFAULT( BoolUserConfigParam(false, "artist_debug_mode", - "Whether to enable track debugging features") ); - - PARAM_PREFIX BoolUserConfigParam m_hide_gui - PARAM_DEFAULT(BoolUserConfigParam(false, "debug_hide_gui", - "Whether to hide the GUI (artist debug mode)")); - - PARAM_PREFIX IntUserConfigParam m_unlock_everything - PARAM_DEFAULT( IntUserConfigParam(0, "unlock_everything", - "Enable all karts and tracks: 0 = disabled, " - "1 = everything except final race, 2 = everything") ); - - PARAM_PREFIX StringUserConfigParam m_commandline - PARAM_DEFAULT( StringUserConfigParam("", "commandline", - "Allows one to set commandline args in config file") ); - - // TODO? implement blacklist for new irrlicht device and GUI - PARAM_PREFIX std::vector m_blacklist_res; - - /** List of all saved GPs. */ - PARAM_PREFIX PtrVector m_saved_grand_prix_list; - - /** Some constants to bitmask to enable various messages to be printed. */ - enum { LOG_MEMORY = 0x0001, - LOG_GUI = 0x0002, - LOG_ADDONS = 0x0004, - LOG_MISC = 0x0008, - LOG_FLYABLE = 0x0010, - LOG_ALL = 0xffff }; - - /** Returns true if the user want additional messages for memory usage. */ - bool logMemory(); - /** Returns true if the user want additional messages related to GUI. */ - bool logGUI (); - /** Returns true if the user want additional messages related to addons. */ - bool logAddons(); - /** Returns true if the user want additional debug info for flyables */ - bool logFlyable(); - /** Returns true if the user want additional messages for general items. */ - bool logMisc (); - - -} -#undef PARAM_PREFIX -#undef PARAM_SUFFIX - -// ============================================================================ -/** - * \brief Class for managing general STK user configuration data. - * \ingroup config - */ -class UserConfig : public NoCopy -{ -private: - - /** Filename of the user config file. */ - std::string m_filename; - irr::core::stringw m_warning; - - static const int m_current_config_version; - -public: - /** Create the user config object; does not actually load it, - * UserConfig::loadConfig needs to be called. */ - UserConfig(); - ~UserConfig(); - - bool loadConfig(); - void saveConfig(); - - const irr::core::stringw& getWarning() { return m_warning; } - void resetWarning() { m_warning=""; } - void setWarning(irr::core::stringw& warning) { m_warning=warning; } - -}; // UserConfig - - -extern UserConfig *user_config; - -#endif - +// +// SuperTuxKart - a fun racing game with go-kart +// Copyright (C) 2006-2015 SuperTuxKart-Team +// Modelled after Supertux's configfile.h +// +// This program 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; either version 3 +// of the License, or (at your option) any later version. +// +// This program 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 this program; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + +#ifndef HEADER_USER_CONFIG_HPP +#define HEADER_USER_CONFIG_HPP + +/* The following config versions are currently used: + 0: the 0.2 release config file, without config-version number + (so that defaults to 0) + 1: Removed singleWindowMenu, newKeyboardStyle, oldStatusDisplay, + added config-version number + Version 1 can read version 0 without any problems, so + SUPPORTED_CONFIG_VERSION is 0. + 2: Changed to SDL keyboard bindings + 3: Added username (userid was used for ALL players) + 4: Added username per player + 5: Enabled jumping, which might cause a problem with old + config files (which have an unused entry for jump defined + --> if a kart control for (say) player 2 uses the same key as + jump for player 1, this problem is not noticed in 0.3, but will + cause an undefined game action now + 6: Added stick configurations. +*/ +#include +#include +#include +#include +#include +#include + +#include +#include + +using irr::core::stringc; +using irr::core::stringw; + +#include "utils/constants.hpp" +#include "utils/no_copy.hpp" +#include "utils/ptr_vector.hpp" +#include "utils/time.hpp" + +class PlayerProfile; +class SavedGrandPrix; +class XMLNode; +class UTFWriter; + +/** + * The base of a set of small utilities to enable quickly adding/removing + * stuff to/from config painlessly. + */ +class UserConfigParam +{ + friend class GroupUserConfigParam; +protected: + bool m_can_be_deleted = true; + std::string m_param_name; + std::string m_comment; +public: + virtual ~UserConfigParam(); + virtual void write(std::stringstream & stream) const = 0; + virtual void writeInner(std::stringstream & stream, int level = 0) const; + virtual void findYourDataInAChildOf(const XMLNode* node) = 0; + virtual void findYourDataInAnAttributeOf(const XMLNode* node) = 0; + virtual irr::core::stringc toString() const = 0; +}; // UserConfigParam + +// ============================================================================ +class GroupUserConfigParam : public UserConfigParam +{ + std::vector m_attributes; + std::vector m_children; +public: + GroupUserConfigParam(const char* name, const char* comment=NULL); + GroupUserConfigParam(const char* param_name, + GroupUserConfigParam* group, + const char* comment = NULL); + void write(std::stringstream& stream) const; + void writeInner(std::stringstream& stream, int level = 0) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + void addChild(UserConfigParam* child); + void addChild(GroupUserConfigParam* child); + void clearChildren(); + + irr::core::stringc toString() const; +}; // GroupUserConfigParam + +// ============================================================================ +/** ATM only map with 1 key and 1 value is supported + */ +template +class MapUserConfigParam : public UserConfigParam +{ +protected: + std::array m_key_names; + std::map m_elements; + MapUserConfigParam(const char* param_name, + const char* comment) + { + m_param_name = param_name; + if (comment != NULL) + m_comment = comment; + } + +public: + MapUserConfigParam(const char* param_name, + const char* comment, + std::array key_names, + std::map default_value); + MapUserConfigParam(const char* param_name, + GroupUserConfigParam* group, + const char* comment = NULL); + MapUserConfigParam(const char* param_name, + GroupUserConfigParam* group, + const char* comment, std::array key_names, + std::map default_value); + + void write(std::stringstream& stream) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + void addElement(T element, U value); + + irr::core::stringc toString() const; + + operator std::map&() + { + return m_elements; + } + typename std::map::iterator begin() + { + return m_elements.begin(); + } + typename std::map::iterator end() + { + return m_elements.end(); + } + typename std::map::iterator find(const T& key) + { + return m_elements.find(key); + } + size_t erase(const T& key) + { + return m_elements.erase(key); + } + bool empty() const + { + return m_elements.empty(); + } + std::map& operator=(const std::map& v) + { + m_elements = std::map(v); + return m_elements; + } + std::map& operator=(const MapUserConfigParam& v) + { + m_elements = std::map(v); + return m_elements; + } + size_t size() const + { + return m_elements.size(); + } + U& operator[] (const T key) + { + return m_elements[key]; + } + U& at(const T key) + { + return m_elements.at(key); + } +}; // MapUserConfigParam +typedef MapUserConfigParam UIntToUIntUserConfigParam; +typedef MapUserConfigParam StringToUIntUserConfigParam; +// ============================================================================ +class IntUserConfigParam : public UserConfigParam +{ +protected: + int m_value; + int m_default_value; + IntUserConfigParam(const char* param_name, const char* comment) + { + m_param_name = param_name; + if (comment != NULL) + m_comment = comment; + } + +public: + + IntUserConfigParam(int default_value, const char* param_name, + const char* comment = NULL); + IntUserConfigParam(int default_value, const char* param_name, + GroupUserConfigParam* group, + const char* comment = NULL); + + void write(std::stringstream& stream) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + irr::core::stringc toString() const; + void setDefaultValue(int v) { m_value = m_default_value = v; } + void revertToDefaults() { m_value = m_default_value; } + int getDefaultValue() { return m_default_value; } + operator int() const { return m_value; } + int& operator++(int dummy) { m_value++; return m_value; } + int& operator=(const int& v) { m_value = v; return m_value; } + int& operator=(const IntUserConfigParam& v) + { m_value = (int)v; return m_value; } +}; // IntUserConfigParam + +// ============================================================================ +class TimeUserConfigParam : public UserConfigParam +{ + StkTime::TimeType m_value; + StkTime::TimeType m_default_value; + +public: + + TimeUserConfigParam(StkTime::TimeType default_value, const char* param_name, + const char* comment = NULL); + TimeUserConfigParam(StkTime::TimeType default_value, const char* param_name, + GroupUserConfigParam* group, const char* comment=NULL); + + void write(std::stringstream& stream) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + irr::core::stringc toString() const; + void revertToDefaults() { m_value = m_default_value; } + operator StkTime::TimeType() const { return m_value; } + StkTime::TimeType& operator=(const StkTime::TimeType& v) + { m_value = v; return m_value; } + StkTime::TimeType& operator=(const TimeUserConfigParam& v) + { m_value = (int)v; return m_value; } +}; // TimeUserConfigParam + +// ============================================================================ +class StringUserConfigParam : public UserConfigParam +{ +protected: + std::string m_value; + std::string m_default_value; + StringUserConfigParam(const char* param_name, const char* comment) + { + m_param_name = param_name; + if (comment != NULL) + m_comment = comment; + } + +public: + + StringUserConfigParam(const char* default_value, const char* param_name, + const char* comment); + StringUserConfigParam(const char* default_value, const char* param_name, + GroupUserConfigParam* group, + const char* comment = NULL); + + void write(std::stringstream& stream) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + void revertToDefaults() { m_value = m_default_value; } + + std::string getDefaultValue() const { return m_default_value; } + + irr::core::stringc toString() const { return m_value.c_str(); } + + operator std::string() const { return m_value; } + std::string& operator=(const std::string& v) + { m_value = v; return m_value; } + std::string& operator=(const StringUserConfigParam& v) + { m_value = (std::string)v; return m_value; } + + const char* c_str() const { return m_value.c_str(); } +}; // StringUserConfigParam + +// ============================================================================ +class BoolUserConfigParam : public UserConfigParam +{ +protected: + bool m_value; + bool m_default_value; + BoolUserConfigParam(const char* param_name, const char* comment) + { + m_param_name = param_name; + if (comment != NULL) + m_comment = comment; + } + +public: + BoolUserConfigParam(bool default_value, const char* param_name, + const char* comment = NULL); + BoolUserConfigParam(bool default_value, const char* param_name, + GroupUserConfigParam* group, + const char* comment = NULL); + void write(std::stringstream& stream) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + irr::core::stringc toString() const; + void revertToDefaults() { m_value = m_default_value; } + void setDefaultValue(bool v) { m_value = m_default_value = v; } + + operator bool() const { return m_value; } + bool& operator=(const bool& v) { m_value = v; return m_value; } + bool& operator=(const BoolUserConfigParam& v) + { m_value = (bool)v; return m_value; } +}; // BoolUserConfigParam + +// ============================================================================ +class FloatUserConfigParam : public UserConfigParam +{ +protected: + float m_value; + float m_default_value; + FloatUserConfigParam(const char* param_name, const char* comment) + { + m_param_name = param_name; + if (comment != NULL) + m_comment = comment; + } + +public: + FloatUserConfigParam(float default_value, const char* param_name, + const char* comment = NULL); + FloatUserConfigParam(float default_value, const char* param_name, + GroupUserConfigParam* group, + const char* comment = NULL); + + void write(std::stringstream& stream) const; + void findYourDataInAChildOf(const XMLNode* node); + void findYourDataInAnAttributeOf(const XMLNode* node); + + irr::core::stringc toString() const; + void revertToDefaults() { m_value = m_default_value; } + void setDefaultValue(float v) { m_value = m_default_value = v; } + + operator float() const { return m_value; } + float& operator=(const float& v) { m_value = v; return m_value; } + float& operator=(const FloatUserConfigParam& v) + { m_value = (float)v; return m_value; } +}; // FloatUserConfigParam + +// ============================================================================ +enum AnimType {ANIMS_NONE = 0, + ANIMS_PLAYERS_ONLY = 1, + ANIMS_ALL = 2 }; + +enum GeometryLevel +{ + /** Display everything */ + GEOLEVEL_0 = 0, + /** a few details are displayed */ + GEOLEVEL_1 = 1, + /** Lowest level, no details are displayed. */ + GEOLEVEL_2 = 2 +}; + +enum MultitouchControls +{ + MULTITOUCH_CONTROLS_UNDEFINED = 0, + MULTITOUCH_CONTROLS_STEERING_WHEEL = 1, + MULTITOUCH_CONTROLS_ACCELEROMETER = 2, + MULTITOUCH_CONTROLS_GYROSCOPE = 3, +}; + +/** Using X-macros for setting-possible values is not very pretty, but it's a + * no-maintenance case : + * when you want to add a new parameter, just add one signle line below and + * everything else automagically works (including default value, saving to + * file, loading from file) + */ + +#ifndef PARAM_PREFIX +#define PARAM_PREFIX extern +#endif + +#ifndef PARAM_DEFAULT +#define PARAM_DEFAULT(X) +#endif + +// ============================================================================ +/** \brief Contains all parameters that are stored in the user's config file + * \ingroup config + */ +namespace UserConfigParams +{ + + // ---- Audio + PARAM_PREFIX GroupUserConfigParam m_audio_group + PARAM_DEFAULT( GroupUserConfigParam("Audio", "Audio Settings") ); + + PARAM_PREFIX BoolUserConfigParam m_sfx + PARAM_DEFAULT( BoolUserConfigParam(true, "sfx_on", &m_audio_group, + "Whether sound effects are enabled or not (true or false)") ); + PARAM_PREFIX BoolUserConfigParam m_music + PARAM_DEFAULT( BoolUserConfigParam(true, "music_on", + &m_audio_group, + "Whether musics are enabled or not (true or false)") ); + PARAM_PREFIX IntUserConfigParam m_sfx_numerator + PARAM_DEFAULT( IntUserConfigParam(10, "sfx_numerator", + &m_audio_group, "The value in the audio options SFX spinner") ); + PARAM_PREFIX FloatUserConfigParam m_sfx_volume + PARAM_DEFAULT( FloatUserConfigParam(0.2678f, "sfx_volume", + &m_audio_group, "Volume for sound effects, see openal AL_GAIN " + "for interpretation") ); + PARAM_PREFIX IntUserConfigParam m_music_numerator + PARAM_DEFAULT( IntUserConfigParam(10, "music_numerator", + &m_audio_group, "The value in the audio options music spinner") ); + PARAM_PREFIX FloatUserConfigParam m_music_volume + PARAM_DEFAULT( FloatUserConfigParam(0.2678f, "music_volume", + &m_audio_group, "Music volume from 0.0 to 1.0") ); + + PARAM_PREFIX IntUserConfigParam m_volume_denominator + PARAM_DEFAULT( IntUserConfigParam(15, "volume_denominator", + &m_audio_group, + "Number of steps for volume adjustment") ); + + // ---- Race setup + PARAM_PREFIX GroupUserConfigParam m_race_setup_group + PARAM_DEFAULT( GroupUserConfigParam("RaceSetup", + "Race Setup Settings") ); + + PARAM_PREFIX IntUserConfigParam m_default_num_karts + PARAM_DEFAULT( IntUserConfigParam(4, "numkarts", + &m_race_setup_group, + "Default number of karts. -1 means use all") ); + PARAM_PREFIX IntUserConfigParam m_num_laps + PARAM_DEFAULT( IntUserConfigParam(4, "numlaps", + &m_race_setup_group, "Default number of laps.") ); + PARAM_PREFIX IntUserConfigParam m_gp_reverse + PARAM_DEFAULT( IntUserConfigParam(0, "gp-reverse", + &m_race_setup_group, "Default direction of GP tracks. 0=default, 1=no reverse, 2=all reverse, 3=Random") ); + PARAM_PREFIX IntUserConfigParam m_rand_gp_num_tracks + PARAM_DEFAULT( IntUserConfigParam(1, "random-gp-num-tracks", + &m_race_setup_group, "Default number of tracks for random GP.") ); + PARAM_PREFIX IntUserConfigParam m_ffa_time_limit + PARAM_DEFAULT(IntUserConfigParam(3, "ffa-time-limit", + &m_race_setup_group, "Time limit in ffa mode.")); + PARAM_PREFIX BoolUserConfigParam m_use_ffa_mode + PARAM_DEFAULT(BoolUserConfigParam(false, "use-ffa-mode", + &m_race_setup_group, "Use ffa mode instead of 3 strikes battle.")); + PARAM_PREFIX IntUserConfigParam m_lap_trial_time_limit + PARAM_DEFAULT(IntUserConfigParam(3, "lap-trial-time-limit", + &m_race_setup_group, "Time limit in lap trial mode.")); + PARAM_PREFIX IntUserConfigParam m_num_goals + PARAM_DEFAULT( IntUserConfigParam(3, "numgoals", + &m_race_setup_group, "Default number of goals in soccer mode.") ); + PARAM_PREFIX IntUserConfigParam m_soccer_default_team + PARAM_DEFAULT( IntUserConfigParam(0, "soccer-default-team", + &m_race_setup_group, "Default team in soccer mode for single player.") ); + PARAM_PREFIX IntUserConfigParam m_soccer_time_limit + PARAM_DEFAULT( IntUserConfigParam(3, "soccer-time-limit", + &m_race_setup_group, "Time limit in soccer mode.") ); + PARAM_PREFIX BoolUserConfigParam m_soccer_use_time_limit + PARAM_DEFAULT( BoolUserConfigParam(false, "soccer-use-time-limit", + &m_race_setup_group, "Enable time limit in soccer mode.") ); + PARAM_PREFIX BoolUserConfigParam m_random_arena_item + PARAM_DEFAULT( BoolUserConfigParam(false, "random-arena-item", + &m_race_setup_group, "Enable random location of items in an arena.") ); + PARAM_PREFIX IntUserConfigParam m_difficulty + PARAM_DEFAULT( IntUserConfigParam(0, "difficulty", + &m_race_setup_group, + "Default race difficulty. 0=easy, 1=medium, 2=hard, 3=supertux") ); + PARAM_PREFIX IntUserConfigParam m_game_mode + PARAM_DEFAULT( IntUserConfigParam(0, "game_mode", + &m_race_setup_group, + "Game mode. 0=standard, 1=time trial, 2=follow " + "the leader, 3=3 strikes, 4=easter egg hunt, " + "5=soccer, 6=ghost replay") ); + PARAM_PREFIX StringUserConfigParam m_default_kart + PARAM_DEFAULT( StringUserConfigParam("tux", "kart", + "Kart to select by default (the last used kart)") ); + PARAM_PREFIX StringUserConfigParam m_last_used_kart_group + PARAM_DEFAULT( StringUserConfigParam("all", "last_kart_group", + "Last selected kart group") ); + PARAM_PREFIX IntUserConfigParam m_soccer_red_ai_num + PARAM_DEFAULT( IntUserConfigParam(0, "soccer-red-ai-num", + &m_race_setup_group, "Number of red AI karts in soccer mode.") ); + PARAM_PREFIX IntUserConfigParam m_soccer_blue_ai_num + PARAM_DEFAULT( IntUserConfigParam(0, "soccer-blue-ai-num", + &m_race_setup_group, "Number of blue AI karts in soccer mode.") ); + PARAM_PREFIX BoolUserConfigParam m_karts_powerup_gui + PARAM_DEFAULT( BoolUserConfigParam(false, "karts-powerup-gui", + &m_race_setup_group, "Show other karts' held powerups in race gui.") ); + PARAM_PREFIX BoolUserConfigParam m_soccer_player_list + PARAM_DEFAULT( BoolUserConfigParam(false, "soccer-player-list", + &m_race_setup_group, "Show player list icon in soccer mode.") ); + PARAM_PREFIX BoolUserConfigParam m_addon_tux_online + PARAM_DEFAULT( BoolUserConfigParam(false, "addon-tux-online", + &m_race_setup_group, "Always show online addon karts as tux when live join is on.") ); + PARAM_PREFIX BoolUserConfigParam m_random_player_pos + PARAM_DEFAULT( BoolUserConfigParam(false, "random-player-pos", + &m_race_setup_group, "Randomize the position of the players at the start of a race. Doesn't apply to story mode.") ); + + // ---- Wiimote data + PARAM_PREFIX GroupUserConfigParam m_wiimote_group + PARAM_DEFAULT( GroupUserConfigParam("WiiMote", + "Settings for the wiimote") ); + PARAM_PREFIX FloatUserConfigParam m_wiimote_raw_max + PARAM_DEFAULT( FloatUserConfigParam(20.0f, "wiimote-raw-max", + &m_wiimote_group, + "At what raw input value maximum steering is reached (between 1 and 25).") ); + + PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_linear + PARAM_DEFAULT( FloatUserConfigParam(1.0f, "wiimote-weight-linear", + &m_wiimote_group, + "A weight applied to the linear component of mapping wiimote angle to steering angle")); + + PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_square + PARAM_DEFAULT( FloatUserConfigParam(0.0f, "wiimote-weight-square", + &m_wiimote_group, + "A weight applied to the square component of mapping wiimote angle to steering angle")); + + PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_asin + PARAM_DEFAULT( FloatUserConfigParam(0.0f, "wiimote-weight-asin", + &m_wiimote_group, + "A weight applied to the asin component of mapping wiimote angle to steering angle")); + + PARAM_PREFIX FloatUserConfigParam m_wiimote_weight_sin + PARAM_DEFAULT( FloatUserConfigParam(0.0f, "wiimote-weight-sin", + &m_wiimote_group, + "A weight applied to the sin component of mapping wiimote angle to steering angle")); + + // ---- Multitouch device + PARAM_PREFIX GroupUserConfigParam m_multitouch_group + PARAM_DEFAULT( GroupUserConfigParam("Multitouch", + "Settings for the multitouch device") ); + + PARAM_PREFIX IntUserConfigParam m_multitouch_active + PARAM_DEFAULT( IntUserConfigParam(1, "multitouch_active", + &m_multitouch_group, + "Enable multitouch support: 0 = disabled, 1 = if available, 2 = enabled") ); + + PARAM_PREFIX BoolUserConfigParam m_multitouch_draw_gui + PARAM_DEFAULT( BoolUserConfigParam(false, "multitouch_draw_gui", + &m_multitouch_group, + "Enable multitouch race GUI")); + + PARAM_PREFIX BoolUserConfigParam m_multitouch_inverted + PARAM_DEFAULT( BoolUserConfigParam(false, "multitouch_inverted", + &m_multitouch_group, + "Draw steering wheel on right side.") ); + + PARAM_PREFIX BoolUserConfigParam m_multitouch_auto_acceleration + PARAM_DEFAULT( BoolUserConfigParam(false, "multitouch_auto_acceleration", + &m_multitouch_group, + "Auto acceleration for multitouch controls.") ); + + PARAM_PREFIX IntUserConfigParam m_multitouch_controls + PARAM_DEFAULT( IntUserConfigParam(0, "multitouch_controls", + &m_multitouch_group, + "Multitouch mode: 0 = undefined, 1 = steering wheel, 2 = accelerometer, 3 = gyroscope")); + + PARAM_PREFIX FloatUserConfigParam m_multitouch_deadzone + PARAM_DEFAULT( FloatUserConfigParam(0.1f, "multitouch_deadzone", + &m_multitouch_group, + "A parameter in range [0, 0.5] that determines the zone that is " + "considered as centered in steering button.")); + + PARAM_PREFIX FloatUserConfigParam m_multitouch_sensitivity_x + PARAM_DEFAULT( FloatUserConfigParam(0.2f, "multitouch_sensitivity_x", + &m_multitouch_group, + "A parameter in range [0, 1.0] that determines the sensitivity for x axis.")); + + PARAM_PREFIX FloatUserConfigParam m_multitouch_sensitivity_y + PARAM_DEFAULT( FloatUserConfigParam(0.65f, "multitouch_sensitivity_y", + &m_multitouch_group, + "A parameter in range [0, 1.0] that determines the sensitivity for y axis.")); + + PARAM_PREFIX FloatUserConfigParam m_multitouch_tilt_factor + PARAM_DEFAULT( FloatUserConfigParam(4.0f, "multitouch_tilt_factor", + &m_multitouch_group, + "A parameter that determines general accelerometer sensitivity.")); + + PARAM_PREFIX FloatUserConfigParam m_multitouch_scale + PARAM_DEFAULT( FloatUserConfigParam(1.2f, "multitouch_scale", + &m_multitouch_group, + "A parameter in range [0.5, 1.5] that determines the scale of the " + "multitouch interface.")); + + PARAM_PREFIX IntUserConfigParam m_screen_keyboard + PARAM_DEFAULT( IntUserConfigParam(0, "screen_keyboard_status", + &m_multitouch_group, + "STK screen keyboard status: 0 = disabled, 1 = enabled") ); + + // ---- GP start order + PARAM_PREFIX GroupUserConfigParam m_gp_start_order + PARAM_DEFAULT( GroupUserConfigParam("GpStartOrder", + "Order karts start in GP") ); + PARAM_PREFIX BoolUserConfigParam m_gp_most_points_first + PARAM_DEFAULT( BoolUserConfigParam(true, "most_points_first", + &m_gp_start_order, + "Starting order from most to least points (true) or other " + "way around (false)") ); + PARAM_PREFIX BoolUserConfigParam m_gp_player_last + PARAM_DEFAULT( BoolUserConfigParam(false, "player_last", + &m_gp_start_order, + "Always put the player at the back or not (Bully mode).") ); + PARAM_PREFIX StringUserConfigParam m_additional_gp_directory + PARAM_DEFAULT( StringUserConfigParam("", "additional_gp_directory", + "Directory with additional GP's.")); + + // ---- Video + PARAM_PREFIX GroupUserConfigParam m_video_group + PARAM_DEFAULT( GroupUserConfigParam("Video", "Video Settings") ); + + PARAM_PREFIX IntUserConfigParam m_real_width + PARAM_DEFAULT( IntUserConfigParam(1024, "real_width", &m_video_group, + "Screen/window real width in pixels before high dpi is applied") ); + PARAM_PREFIX IntUserConfigParam m_real_height + PARAM_DEFAULT( IntUserConfigParam(768, "real_height", &m_video_group, + "Screen/window real height in pixels before high dpi is applied") ); + PARAM_PREFIX IntUserConfigParam m_width + PARAM_DEFAULT( IntUserConfigParam(1024, "width", &m_video_group, + "Screen/window width in pixels, this value should not be edited") ); + PARAM_PREFIX IntUserConfigParam m_height + PARAM_DEFAULT( IntUserConfigParam(768, "height", &m_video_group, + "Screen/window height in pixels, this value should not be edited") ); + PARAM_PREFIX BoolUserConfigParam m_fullscreen + PARAM_DEFAULT( BoolUserConfigParam(false, "fullscreen", + &m_video_group) ); + PARAM_PREFIX IntUserConfigParam m_prev_real_width + PARAM_DEFAULT( IntUserConfigParam(1024, "prev_real_width", + &m_video_group, "Previous real screen/window width") ); + PARAM_PREFIX IntUserConfigParam m_prev_real_height + PARAM_DEFAULT( IntUserConfigParam(768, "prev_real_height", + &m_video_group,"Previous real screen/window height") ); + PARAM_PREFIX BoolUserConfigParam m_prev_fullscreen + PARAM_DEFAULT( BoolUserConfigParam(false, "prev_fullscreen", + &m_video_group) ); + + + PARAM_PREFIX BoolUserConfigParam m_remember_window_location + PARAM_DEFAULT( BoolUserConfigParam(false, "remember_window_location", + &m_video_group) ); + PARAM_PREFIX IntUserConfigParam m_window_x + PARAM_DEFAULT( IntUserConfigParam(-1, "window_x", + &m_video_group,"If remember_window_location is true") ); + PARAM_PREFIX IntUserConfigParam m_window_y + PARAM_DEFAULT( IntUserConfigParam(-1, "window_y", + &m_video_group,"If remember_window_location is true") ); + + PARAM_PREFIX BoolUserConfigParam m_display_fps + PARAM_DEFAULT( BoolUserConfigParam(false, "show_fps", + &m_video_group, "Display frame per seconds") ); + PARAM_PREFIX BoolUserConfigParam m_display_story_mode_timer + PARAM_DEFAULT( BoolUserConfigParam(true, "show_story_mode_timer", + &m_video_group, "Display the story mode timer") ); + PARAM_PREFIX BoolUserConfigParam m_speedrun_mode + PARAM_DEFAULT( BoolUserConfigParam(false, "show_speedrun_timer", + &m_video_group, "Display the speedrun timer") ); + PARAM_PREFIX BoolUserConfigParam m_speedmeter + PARAM_DEFAULT( BoolUserConfigParam(false, "show_speedmeter", + &m_video_group, "Display the speedmeter") ); + PARAM_PREFIX IntUserConfigParam m_max_fps + PARAM_DEFAULT( IntUserConfigParam(120, "max_fps", + &m_video_group, "Maximum fps, should be at least 60") ); + PARAM_PREFIX BoolUserConfigParam m_force_legacy_device + PARAM_DEFAULT(BoolUserConfigParam(false, "force_legacy_device", + &m_video_group, "Force OpenGL 2 context, even if OpenGL 3 is available.")); + PARAM_PREFIX BoolUserConfigParam m_split_screen_horizontally + PARAM_DEFAULT(BoolUserConfigParam(true, "split_screen_horizontally", + &m_video_group, "When playing a non-square amount of players (e.g. 2)," + " should it split horizontally (top/bottom)")); + PARAM_PREFIX BoolUserConfigParam m_texture_compression + PARAM_DEFAULT(BoolUserConfigParam(true, "enable_texture_compression", + &m_video_group, "Enable Texture Compression")); + /** This is a bit flag: bit 0: enabled (1) or disabled(0). + * Bit 1: setting done by default(0), or by user choice (2). This allows + * to e.g. disable h.d. textures on hd3000 as default, but still allow the + * user to enable it. */ + PARAM_PREFIX IntUserConfigParam m_high_definition_textures + PARAM_DEFAULT(IntUserConfigParam(1, "enable_high_definition_textures", + &m_video_group, "Enable high definition textures. Bit flag: " + "bit 0 = enabled/disabled; bit 1 = set by user/set as default")); + PARAM_PREFIX BoolUserConfigParam m_glow + PARAM_DEFAULT(BoolUserConfigParam(false, "enable_glow", + &m_video_group, "Enable Glow")); + PARAM_PREFIX BoolUserConfigParam m_bloom + PARAM_DEFAULT(BoolUserConfigParam(false, "enable_bloom", + &m_video_group, "Enable Bloom")); + PARAM_PREFIX BoolUserConfigParam m_light_shaft + PARAM_DEFAULT(BoolUserConfigParam(false, "enable_light_shaft", + &m_video_group, "Enable Light Shafts")); + PARAM_PREFIX BoolUserConfigParam m_dynamic_lights + PARAM_DEFAULT(BoolUserConfigParam(true, "enable_dynamic_lights", + &m_video_group, "Enable Dynamic Lights")); + PARAM_PREFIX BoolUserConfigParam m_dof + PARAM_DEFAULT(BoolUserConfigParam(false, "enable_dof", + &m_video_group, "Enable Depth of Field")); + PARAM_PREFIX BoolUserConfigParam m_old_driver_popup + PARAM_DEFAULT(BoolUserConfigParam(true, "old_driver_popup", + &m_video_group, "Determines if popup message about too old drivers should be displayed.")); + PARAM_PREFIX FloatUserConfigParam m_scale_rtts_factor + PARAM_DEFAULT(FloatUserConfigParam(1.0f, "scale_rtts_factor", + &m_video_group, "Custom value for RTTs resolution. " + "Value should be smaller or equal to 1.0")); + PARAM_PREFIX IntUserConfigParam m_max_texture_size + PARAM_DEFAULT(IntUserConfigParam(512, "max_texture_size", + &m_video_group, "Max texture size when high definition textures are " + "disabled")); + + PARAM_PREFIX BoolUserConfigParam m_hq_mipmap + PARAM_DEFAULT(BoolUserConfigParam(false, "hq_mipmap", + &m_video_group, "Generate mipmap for textures using " + "high quality method with SSE")); + PARAM_PREFIX FloatUserConfigParam m_font_size + PARAM_DEFAULT( FloatUserConfigParam(3, "font_size", + &m_video_group, "The size of fonts. 0 is the smallest and 6 is the biggest") ); + +#if defined(_IRR_COMPILE_WITH_DIRECT3D_9_) && defined(_M_ARM) + PARAM_PREFIX StringUserConfigParam m_render_driver + PARAM_DEFAULT( StringUserConfigParam("directx9", "render_driver", + &m_video_group, "Render video driver to use, at the moment gl, vulkan or directx9 is supported.") ); +#else + PARAM_PREFIX StringUserConfigParam m_render_driver + PARAM_DEFAULT( StringUserConfigParam("gl", "render_driver", + &m_video_group, "Render video driver to use, at the moment gl, vulkan or directx9 is supported.") ); +#endif + +#if defined(MOBILE_STK) + PARAM_PREFIX BoolUserConfigParam m_vulkan_fullscreen_desktop + PARAM_DEFAULT(BoolUserConfigParam(false, "vulkan_fullscreen_desktop", + &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for vulkan device")); +#else + PARAM_PREFIX BoolUserConfigParam m_vulkan_fullscreen_desktop + PARAM_DEFAULT(BoolUserConfigParam(true, "vulkan_fullscreen_desktop", + &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for vulkan device")); +#endif + + PARAM_PREFIX BoolUserConfigParam m_non_ge_fullscreen_desktop + PARAM_DEFAULT(BoolUserConfigParam(false, "non_ge_fullscreen_desktop", + &m_video_group, "Use SDL_WINDOW_FULLSCREEN_DESKTOP for non-ge device")); + + // ---- Recording + PARAM_PREFIX GroupUserConfigParam m_recording_group + PARAM_DEFAULT(GroupUserConfigParam("Recording", + "Recording Settings")); + + PARAM_PREFIX BoolUserConfigParam m_limit_game_fps + PARAM_DEFAULT(BoolUserConfigParam(true, "limit_game_fps", + &m_recording_group, "Limit game framerate not beyond the fps of" + " recording video.")); + PARAM_PREFIX IntUserConfigParam m_video_format + PARAM_DEFAULT(IntUserConfigParam(0, "video_format", + &m_recording_group, "Specify the video for record, which is the enum" + " of VideoFormat in libopenglrecorder. It will" + " auto fallback to MJPEG if libopenglrecorder was" + " not compiled with such video encoder.")); + + PARAM_PREFIX IntUserConfigParam m_audio_bitrate + PARAM_DEFAULT(IntUserConfigParam(112000, "audio_bitrate", + &m_recording_group, "Specify the bitrate for audio")); + + PARAM_PREFIX IntUserConfigParam m_video_bitrate + PARAM_DEFAULT(IntUserConfigParam(20000, "video_bitrate", + &m_recording_group, "Specify the bitrate for video")); + + PARAM_PREFIX IntUserConfigParam m_recorder_jpg_quality + PARAM_DEFAULT(IntUserConfigParam(90, "recorder_jpg_quality", + &m_recording_group, "Specify the jpg compression level of recorder")); + + PARAM_PREFIX IntUserConfigParam m_record_fps + PARAM_DEFAULT(IntUserConfigParam(30, "record_fps", + &m_recording_group, "Specify the fps of recording video")); + + // ---- Debug - not saved to config file + /** If high scores will not be saved. For repeated testing on tracks. */ + PARAM_PREFIX bool m_no_high_scores PARAM_DEFAULT(false); + + /** If unit testing is enabled. */ + PARAM_PREFIX bool m_unit_testing PARAM_DEFAULT(false); + + /** If gamepad debugging is enabled. */ + PARAM_PREFIX bool m_gamepad_debug PARAM_DEFAULT( false ); + + /** If keyboard debugging is enabled. */ + PARAM_PREFIX bool m_keyboard_debug PARAM_DEFAULT(false); + + /** Wiimote debugging. */ + PARAM_PREFIX bool m_wiimote_debug PARAM_DEFAULT( false ); + + /** Debug gamepads by visualising their values. */ + PARAM_PREFIX bool m_gamepad_visualisation PARAM_DEFAULT( false ); + + /** If material debugging (printing terrain specific slowdown) + * is enabled. */ + PARAM_PREFIX bool m_material_debug PARAM_DEFAULT( false ); + + /** If track debugging is enabled. */ + PARAM_PREFIX int m_track_debug PARAM_DEFAULT( false ); + + /** True if check structures should be debugged. */ + PARAM_PREFIX bool m_check_debug PARAM_DEFAULT( false ); + + /** True if physics debugging should be enabled. */ + PARAM_PREFIX bool m_physics_debug PARAM_DEFAULT( false ); + + /** True if FPS should be printed each frame. */ + PARAM_PREFIX bool m_fps_debug PARAM_DEFAULT(false); + + /** True if arena (battle/soccer) ai profiling. */ + PARAM_PREFIX bool m_arena_ai_stats PARAM_DEFAULT(false); + + /** True if slipstream debugging is activated. */ + PARAM_PREFIX bool m_slipstream_debug PARAM_DEFAULT( false ); + + /** True if follow-the-leader debug information should be printed. */ + PARAM_PREFIX bool m_ftl_debug PARAM_DEFAULT( false ); + + /** True if currently developed tutorial debugging is enabled. */ + PARAM_PREFIX bool m_tutorial_debug PARAM_DEFAULT( false ); + + /** Verbosity level for debug messages. Note that error and + * important warnings must always be printed. */ + PARAM_PREFIX int m_verbosity PARAM_DEFAULT( 0 ); + + PARAM_PREFIX bool m_no_start_screen PARAM_DEFAULT( false ); + + PARAM_PREFIX bool m_race_now PARAM_DEFAULT( false ); + + PARAM_PREFIX int m_default_keyboard PARAM_DEFAULT( -1 ); + + PARAM_PREFIX int m_default_gamepad PARAM_DEFAULT( -1 ); + + PARAM_PREFIX bool m_enforce_current_player PARAM_DEFAULT( false ); + + PARAM_PREFIX bool m_enable_sound PARAM_DEFAULT( true ); + + /** True to test funky ambient/diffuse/specularity in RGB & + * all anisotropic */ + PARAM_PREFIX bool m_rendering_debug PARAM_DEFAULT( false ); + + /** True if graphical profiler should be displayed */ + PARAM_PREFIX bool m_profiler_enabled PARAM_DEFAULT( false ); + + PARAM_PREFIX bool m_disable_addon_karts PARAM_DEFAULT( false ); + + PARAM_PREFIX bool m_disable_addon_tracks PARAM_DEFAULT( false ); + + PARAM_PREFIX bool m_benchmark PARAM_DEFAULT( false ); + + // ---- Networking + PARAM_PREFIX StringToUIntUserConfigParam m_server_bookmarks + PARAM_DEFAULT(StringToUIntUserConfigParam("server-bookmarks", + "Wan server bookmarks", + {{ "server-bookmarks", "server-name", "last-online" }}, {})); + + PARAM_PREFIX StringToUIntUserConfigParam m_server_bookmarks_order + PARAM_DEFAULT(StringToUIntUserConfigParam("server-bookmarks-order", + "Wan server bookmarks order", + {{ "server-bookmarks", "server-name", "id" }}, {})); + + PARAM_PREFIX StringToUIntUserConfigParam m_address_history + PARAM_DEFAULT(StringToUIntUserConfigParam("address-history", + "Last 5 IP addresses that user entered", + {{ "server-address", "address", "last-connection" }}, {})); + + // These stk domains have only a record to each ipv6 stun below, + // so we can use this to know ipv4 address of nat64 gateway (if any) + PARAM_PREFIX StringToUIntUserConfigParam m_stun_servers_v4 + PARAM_DEFAULT(StringToUIntUserConfigParam("ipv4-stun-servers", + "The stun servers that will be used to know the public address " + "(ipv4 only) with port", {{ "stun-server", "address", "ping" }}, + { + { "stunv4.linuxreviews.org:3478", 0u }, + { "stunv4.7.supertuxkart.net:3478", 0u }, + { "stunv4.8.supertuxkart.net:3478", 0u } + } + )); + + PARAM_PREFIX StringToUIntUserConfigParam m_stun_servers + PARAM_DEFAULT(StringToUIntUserConfigParam("ipv6-stun-servers", + "The stun servers that will be used to know the public address " + "(including ipv6) with port", {{ "stun-server", "address", "ping" }}, + { + { "stun.linuxreviews.org:3478", 0u }, + { "stun.supertuxkart.net:3478", 0u }, + { "stun.stunprotocol.org:3478", 0u } + } + )); + + PARAM_PREFIX GroupUserConfigParam m_network_group + PARAM_DEFAULT(GroupUserConfigParam("Network", "Network Settings")); + PARAM_PREFIX BoolUserConfigParam m_enable_network_splitscreen + PARAM_DEFAULT(BoolUserConfigParam(false, "enable-network-splitscreen", + &m_network_group, "The default value of enable splitscreen checkbox " + "in online screen.")); + PARAM_PREFIX BoolUserConfigParam m_log_packets + PARAM_DEFAULT(BoolUserConfigParam(false, "log-network-packets", + &m_network_group, "If all network packets should be logged")); + PARAM_PREFIX BoolUserConfigParam m_random_client_port + PARAM_DEFAULT(BoolUserConfigParam(true, "random-client-port", + &m_network_group, "Use random port for client connection " + "(check stk_config.xml for default value)")); + PARAM_PREFIX BoolUserConfigParam m_random_server_port + PARAM_DEFAULT(BoolUserConfigParam(false, "random-server-port", + &m_network_group, "Use random port for server connection " + "(check stk_config.xml for default value)")); + PARAM_PREFIX BoolUserConfigParam m_lobby_chat + PARAM_DEFAULT(BoolUserConfigParam(true, "lobby-chat", + &m_network_group, "Enable chatting in networking lobby, if off than " + "no chat message will be displayed from any players.")); + PARAM_PREFIX BoolUserConfigParam m_race_chat + PARAM_DEFAULT(BoolUserConfigParam(true, "race-chat", + &m_network_group, "Enable chatting during races.")); + PARAM_PREFIX BoolUserConfigParam m_ipv6_lan + PARAM_DEFAULT(BoolUserConfigParam(true, "ipv6-lan", + &m_network_group, "Enable IPv6 LAN server discovery.")); + PARAM_PREFIX IntUserConfigParam m_max_players + PARAM_DEFAULT(IntUserConfigParam(8, "max-players", + &m_network_group, "Maximum number of players on the server " + "(for gui server creation.")); + PARAM_PREFIX IntUserConfigParam m_timer_sync_difference_tolerance + PARAM_DEFAULT(IntUserConfigParam(5, "timer-sync-difference-tolerance", + &m_network_group, "Max time difference tolerance (in ms) to " + "synchronize timer with server.")); + PARAM_PREFIX IntUserConfigParam m_default_ip_type + PARAM_DEFAULT(IntUserConfigParam(0, "default-ip-type", + &m_network_group, "Default IP type of this machine, " + "0 detect every time, 1 IPv4, 2 IPv6, 3 IPv6 NAT64, 4 Dual stack.")); + PARAM_PREFIX BoolUserConfigParam m_lan_server_gp + PARAM_DEFAULT(BoolUserConfigParam(false, "lan-server-gp", + &m_network_group, "Show grand prix option in create LAN server " + "screen, false will show AI option.")); + PARAM_PREFIX BoolUserConfigParam m_wan_server_gp + PARAM_DEFAULT(BoolUserConfigParam(true, "wan-server-gp", + &m_network_group, "Show grand prix option in create WAN server " + "screen, false will show AI option.")); + + // ---- Gamemode setup + PARAM_PREFIX UIntToUIntUserConfigParam m_num_karts_per_gamemode + PARAM_DEFAULT(UIntToUIntUserConfigParam("num-karts-per-gamemode", + "The Number of karts per gamemode.", + {{ "gamemode-list", "gamemode", "num-karts" }}, + { + { 0u, 4u }, + { 1002u, 5u }, + { 1100u, 4u }, + { 1101u, 4u }, + { 2000u, 4u }, + { 2001u, 4u } + } + )); + + // ---- Graphic Quality + PARAM_PREFIX GroupUserConfigParam m_graphics_quality + PARAM_DEFAULT( GroupUserConfigParam("GFX", + "Graphics Quality Settings") ); + + PARAM_PREFIX IntUserConfigParam m_particles_effects + PARAM_DEFAULT( IntUserConfigParam(2, "particles-effecs", + &m_graphics_quality, "Particles effects: 0 disabled, 1 only important, 2 enabled") ); + + // This saves the actual user preference. + PARAM_PREFIX IntUserConfigParam m_xmas_mode + PARAM_DEFAULT( IntUserConfigParam(0, "christmas-mode", + &m_graphics_quality, "Christmas hats: 0 use current date, 1 always on, 2 always off") ); + + // This saves the actual user preference. + PARAM_PREFIX IntUserConfigParam m_easter_ear_mode + PARAM_DEFAULT(IntUserConfigParam(0, "easter-ear-mode", + &m_graphics_quality, "Easter Bunny Ears: 0 use current date, 1 always on, 2 always off")); + + PARAM_PREFIX BoolUserConfigParam m_animated_characters + PARAM_DEFAULT( BoolUserConfigParam(true, + "animated-characters", &m_graphics_quality, + "Whether to display animated characters") ); + + PARAM_PREFIX IntUserConfigParam m_geometry_level + PARAM_DEFAULT( IntUserConfigParam(GEOLEVEL_0, + "geometry_level", &m_graphics_quality, + "Geometry quality 0=everything is displayed; " + "1=a few details are displayed; 2=lowest level, no details") ); + + PARAM_PREFIX IntUserConfigParam m_anisotropic + PARAM_DEFAULT( IntUserConfigParam(4, "anisotropic", + &m_graphics_quality, + "Quality of anisotropic filtering (usual values include 2-4-8-16; 0 to disable)") ); + + PARAM_PREFIX IntUserConfigParam m_swap_interval + PARAM_DEFAULT( IntUserConfigParam(1, "swap-interval-vsync", + &m_graphics_quality, + "Swap interval for vsync: 0 = disabled, 1 = full") ); + PARAM_PREFIX BoolUserConfigParam m_motionblur + PARAM_DEFAULT( BoolUserConfigParam(false, + "motionblur_enabled", &m_graphics_quality, + "Whether motion blur should be enabled") ); + PARAM_PREFIX BoolUserConfigParam m_mlaa + PARAM_DEFAULT( BoolUserConfigParam(false, + "mlaa", &m_graphics_quality, + "Whether MLAA anti-aliasing should be enabled") ); + PARAM_PREFIX BoolUserConfigParam m_ssao + PARAM_DEFAULT(BoolUserConfigParam(false, + "ssao", &m_graphics_quality, + "Enable Screen Space Ambient Occlusion") ); + PARAM_PREFIX BoolUserConfigParam m_light_scatter + PARAM_DEFAULT(BoolUserConfigParam(true, + "light_scatter", &m_graphics_quality, + "Enable light scattering shaders") ); + PARAM_PREFIX IntUserConfigParam m_shadows_resolution + PARAM_DEFAULT( IntUserConfigParam(0, + "shadows_resolution", &m_graphics_quality, + "Shadow resolution (0 = disabled") ); + PARAM_PREFIX IntUserConfigParam m_pcss_threshold + PARAM_DEFAULT( IntUserConfigParam(2048, + "pcss_threshold", &m_graphics_quality, + "Enable Percentage Closer Soft Shadows when shadow resolution is higher than this value") ); + PARAM_PREFIX BoolUserConfigParam m_degraded_IBL + PARAM_DEFAULT(BoolUserConfigParam(true, + "Degraded_IBL", &m_graphics_quality, + "Disable specular IBL")); + + // ---- Misc + PARAM_PREFIX BoolUserConfigParam m_cache_overworld + PARAM_DEFAULT( BoolUserConfigParam(true, "cache-overworld") ); + + // TODO : is this used with new code? does it still work? + PARAM_PREFIX BoolUserConfigParam m_crashed + PARAM_DEFAULT( BoolUserConfigParam(false, "crashed") ); + + // ---- Camera + PARAM_PREFIX GroupUserConfigParam m_camera_normal + PARAM_DEFAULT( GroupUserConfigParam( + "camera-normal", + "Camera settings for player.") ); + + PARAM_PREFIX FloatUserConfigParam m_camera_distance + PARAM_DEFAULT( FloatUserConfigParam(1.0, "distance", + &m_camera_normal, + "Distance between kart and camera")); + + PARAM_PREFIX FloatUserConfigParam m_camera_forward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(0, "forward-up-angle", + &m_camera_normal, + "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); + + PARAM_PREFIX FloatUserConfigParam m_camera_forward_smooth_position + PARAM_DEFAULT( FloatUserConfigParam(0.2, "forward-smooth-position", + &m_camera_normal, + "The strength of smoothness of the position of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_camera_forward_smooth_rotation + PARAM_DEFAULT( FloatUserConfigParam(0.125, "forward-smooth-rotation", + &m_camera_normal, + "The strength of smoothness of the rotation of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_camera_backward_distance + PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", + &m_camera_normal, + "Distance between kart and camera (reverse)")); + + PARAM_PREFIX FloatUserConfigParam m_camera_backward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(5, "backward-up-angle", + &m_camera_normal, + "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); + + PARAM_PREFIX IntUserConfigParam m_camera_fov + PARAM_DEFAULT( IntUserConfigParam(80, "fov", + &m_camera_normal, + "Focal distance (single player)")); + + PARAM_PREFIX BoolUserConfigParam m_reverse_look_use_soccer_cam + PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", + "Use ball camera in soccer mode, instead of reverse") ); + + // ---- The present camera (default: Standard) + PARAM_PREFIX IntUserConfigParam m_camera_present + PARAM_DEFAULT( IntUserConfigParam(1, "camera-present", + "The current used camera. 0=Custom; 1=Standard; 2=Drone chase") ); + + // ---- Standard camera settings + PARAM_PREFIX GroupUserConfigParam m_standard_camera_settings + PARAM_DEFAULT( GroupUserConfigParam( + "standard-camera-settings", + "Standard camera settings for player.") ); + + PARAM_PREFIX FloatUserConfigParam m_standard_camera_distance + PARAM_DEFAULT( FloatUserConfigParam(1.0, "distance", + &m_standard_camera_settings, + "Distance between kart and camera")); + + PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(0, "forward-up-angle", + &m_standard_camera_settings, + "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); + + PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_smooth_position + PARAM_DEFAULT( FloatUserConfigParam(0.2, "forward-smooth-position", + &m_standard_camera_settings, + "The strength of smoothness of the position of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_standard_camera_forward_smooth_rotation + PARAM_DEFAULT( FloatUserConfigParam(0.125, "forward-smooth-rotation", + &m_standard_camera_settings, + "The strength of smoothness of the rotation of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_standard_camera_backward_distance + PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", + &m_standard_camera_settings, + "Distance between kart and camera (reverse)")); + + PARAM_PREFIX FloatUserConfigParam m_standard_camera_backward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(5, "backward-up-angle", + &m_standard_camera_settings, + "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); + + PARAM_PREFIX IntUserConfigParam m_standard_camera_fov + PARAM_DEFAULT( IntUserConfigParam(80, "fov", + &m_standard_camera_settings, + "Focal distance (single player)")); + + PARAM_PREFIX BoolUserConfigParam m_standard_reverse_look_use_soccer_cam + PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", + &m_standard_camera_settings, + "Use ball camera in soccer mode, instead of reverse")); + + // ---- Drone chase camera settings + PARAM_PREFIX GroupUserConfigParam m_drone_camera_settings + PARAM_DEFAULT( GroupUserConfigParam( + "drone-camera-settings", + "Drone chase camera settings for player.") ); + + PARAM_PREFIX FloatUserConfigParam m_drone_camera_distance + PARAM_DEFAULT( FloatUserConfigParam(2.6, "distance", + &m_drone_camera_settings, + "Distance between kart and camera")); + + PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(33, "forward-up-angle", + &m_drone_camera_settings, + "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); + + PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_smooth_position + PARAM_DEFAULT( FloatUserConfigParam(0.0, "forward-smooth-position", + &m_drone_camera_settings, + "The strength of smoothness of the position of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_drone_camera_forward_smooth_rotation + PARAM_DEFAULT( FloatUserConfigParam(0.0, "forward-smooth-rotation", + &m_drone_camera_settings, + "The strength of smoothness of the rotation of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_drone_camera_backward_distance + PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", + &m_drone_camera_settings, + "Distance between kart and camera (reverse)")); + + PARAM_PREFIX FloatUserConfigParam m_drone_camera_backward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(10, "backward-up-angle", + &m_drone_camera_settings, + "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); + + PARAM_PREFIX IntUserConfigParam m_drone_camera_fov + PARAM_DEFAULT( IntUserConfigParam(100, "fov", + &m_drone_camera_settings, + "Focal distance (single player)")); + + PARAM_PREFIX BoolUserConfigParam m_drone_reverse_look_use_soccer_cam + PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", + &m_drone_camera_settings, + "Use ball camera in soccer mode, instead of reverse")); + + // ---- Custom camera settings + PARAM_PREFIX GroupUserConfigParam m_saved_camera_settings + PARAM_DEFAULT( GroupUserConfigParam( + "saved-camera-settings", + "Saved custom camera settings for player.") ); + + PARAM_PREFIX FloatUserConfigParam m_saved_camera_distance + PARAM_DEFAULT( FloatUserConfigParam(1.8, "distance", + &m_saved_camera_settings, + "Distance between kart and camera")); + + PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(20, "forward-up-angle", + &m_saved_camera_settings, + "Angle between camera and plane of kart (pitch) when the camera is pointing forward")); + + PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_smooth_position + PARAM_DEFAULT( FloatUserConfigParam(0.1, "forward-smooth-position", + &m_saved_camera_settings, + "The strength of smoothness of the position of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_saved_camera_forward_smooth_rotation + PARAM_DEFAULT( FloatUserConfigParam(0.125, "forward-smooth-rotation", + &m_saved_camera_settings, + "The strength of smoothness of the rotation of the camera")); + + PARAM_PREFIX FloatUserConfigParam m_saved_camera_backward_distance + PARAM_DEFAULT( FloatUserConfigParam(2.0, "backward-distance", + &m_saved_camera_settings, + "Distance between kart and camera (reverse)")); + + PARAM_PREFIX FloatUserConfigParam m_saved_camera_backward_up_angle + PARAM_DEFAULT( FloatUserConfigParam(5, "backward-up-angle", + &m_saved_camera_settings, + "Angle between camera and plane of kart (pitch) when the camera is pointing backwards. This is usually larger than the forward-up-angle, since the kart itself otherwise obstricts too much of the view")); + + PARAM_PREFIX IntUserConfigParam m_saved_camera_fov + PARAM_DEFAULT( IntUserConfigParam(85, "fov", + &m_saved_camera_settings, + "Focal distance (single player)")); + + PARAM_PREFIX BoolUserConfigParam m_saved_reverse_look_use_soccer_cam + PARAM_DEFAULT( BoolUserConfigParam(false, "reverse-look-use-soccer-cam", + &m_saved_camera_settings, + "Use ball camera in soccer mode, instead of reverse")); + + // camera in artist mode + PARAM_PREFIX GroupUserConfigParam m_camera + PARAM_DEFAULT( GroupUserConfigParam("camera", + "(Debug) camera settings.") ); + + PARAM_PREFIX IntUserConfigParam m_reverse_look_threshold + PARAM_DEFAULT( IntUserConfigParam(0, "reverse_look_threshold", + &m_camera, + "If the kart is driving backwards faster than this value,\n" + "switch automatically to reverse camera (set to 0 to disable).") ); + + PARAM_PREFIX FloatUserConfigParam m_fpscam_direction_speed + PARAM_DEFAULT( FloatUserConfigParam(0.003f, "fpscam_rotation_speed", + &m_camera, + "How fast the first person camera's direction speed changes when\n" + "moving the mouse (means acceleration).") ); + + PARAM_PREFIX FloatUserConfigParam m_fpscam_smooth_direction_max_speed + PARAM_DEFAULT( FloatUserConfigParam(0.04f, "fpscam_smooth_rotation_max_speed", + &m_camera, + "How fast the first person camera's direction can change.") ); + + PARAM_PREFIX FloatUserConfigParam m_fpscam_angular_velocity + PARAM_DEFAULT( FloatUserConfigParam(0.02f, "fpscam_angular_velocity", + &m_camera, + "How fast the first person camera's rotation speed changes.") ); + + PARAM_PREFIX FloatUserConfigParam m_fpscam_max_angular_velocity + PARAM_DEFAULT( FloatUserConfigParam(1.0f, "fpscam_max_angular_velocity", + &m_camera, + "How fast the first person camera can rotate.") ); + + PARAM_PREFIX StringUserConfigParam m_item_style + PARAM_DEFAULT( StringUserConfigParam("items", "item_style", + "Name of the .items file to use.") ); + + PARAM_PREFIX StringUserConfigParam m_last_track + PARAM_DEFAULT( StringUserConfigParam("olivermath", "last_track", + "Name of the last track used.") ); + PARAM_PREFIX StringUserConfigParam m_last_used_track_group + PARAM_DEFAULT( StringUserConfigParam("all", "last_track_group", + "Last selected track group") ); + + PARAM_PREFIX StringUserConfigParam m_discord_client_id + PARAM_DEFAULT( StringUserConfigParam("817760324983324753", "discord_client_id", + "Discord Client ID (Set to -1 to disable)") ); + + PARAM_PREFIX BoolUserConfigParam m_rich_presence_debug + PARAM_DEFAULT( BoolUserConfigParam(false, "rich_presence_debug", + "If debug logging should be enabled for rich presence") ); + + PARAM_PREFIX StringUserConfigParam m_skin_file + PARAM_DEFAULT( StringUserConfigParam("classic", "skin_name", + "Name of the skin to use") ); + + // ---- settings for minimap display + PARAM_PREFIX GroupUserConfigParam m_minimap_setup_group + PARAM_DEFAULT( GroupUserConfigParam("Minimap", + "Minimap Setup Settings") ); + + PARAM_PREFIX IntUserConfigParam m_minimap_display + PARAM_DEFAULT(IntUserConfigParam(0, "display", + &m_minimap_setup_group, "display: 0 bottom-left, 1 middle-right, 2 hidden, 3 center")); + + PARAM_PREFIX FloatUserConfigParam m_minimap_size + PARAM_DEFAULT( FloatUserConfigParam(180.0f, "size", + &m_minimap_setup_group, "Size of the the minimap (480 = full screen height; scaled afterwards)") ); + + PARAM_PREFIX FloatUserConfigParam m_minimap_ai_icon_size + PARAM_DEFAULT( FloatUserConfigParam(16.0f, "ai-icon", + &m_minimap_setup_group, "The size of the icons for the AI karts on the minimap.") ); + + PARAM_PREFIX FloatUserConfigParam m_minimap_player_icon_size + PARAM_DEFAULT( FloatUserConfigParam(20.0f, "player-icon", + &m_minimap_setup_group, "The size of the icons for the player kart.") ); + + // ---- settings for powerup display + PARAM_PREFIX GroupUserConfigParam m_powerup_setup_group + PARAM_DEFAULT( GroupUserConfigParam("PowerUp", + "PowerUp Setup Settings") ); + + PARAM_PREFIX IntUserConfigParam m_powerup_display + PARAM_DEFAULT(IntUserConfigParam(0, "display", + &m_powerup_setup_group, "display: 0 center, 1 right side, 2 hidden (see karts' held powerups)")); + PARAM_PREFIX FloatUserConfigParam m_powerup_size + PARAM_DEFAULT( FloatUserConfigParam(64.0f, "powerup-icon-size", + &m_powerup_setup_group, "Size of the powerup icon (scaled afterwards)") ); + + // ---- Settings for spectator camera + PARAM_PREFIX GroupUserConfigParam m_spectator + PARAM_DEFAULT( GroupUserConfigParam("Spectator", + "Everything related to spectator mode.") ); + + PARAM_PREFIX FloatUserConfigParam m_spectator_camera_distance + PARAM_DEFAULT( FloatUserConfigParam(6.75, "camera-distance", &m_spectator, + "Distance between kart and camera.") ); + PARAM_PREFIX FloatUserConfigParam m_spectator_camera_angle + PARAM_DEFAULT( FloatUserConfigParam(40.0, "camera-angle", &m_spectator, + "Angle between ground, kart and camera.") ); + + // ---- Handicap + PARAM_PREFIX GroupUserConfigParam m_handicap + PARAM_DEFAULT( GroupUserConfigParam("Handicap", + "Everything related to handicaps.") ); + + PARAM_PREFIX BoolUserConfigParam m_per_player_difficulty + PARAM_DEFAULT( BoolUserConfigParam(false, "per_player_difficulty", + &m_handicap, + "If handicapped users can be selected") ); + + // ---- Internet related + + PARAM_PREFIX IntUserConfigParam m_internet_status + PARAM_DEFAULT( IntUserConfigParam(0, "enable_internet", + "Status of internet: 0 user " + "wasn't asked, 1: allowed, 2: " + "not allowed") ); + + PARAM_PREFIX GroupUserConfigParam m_hw_report_group + PARAM_DEFAULT( GroupUserConfigParam("HWReport", + "Everything related to hardware configuration.") ); + + PARAM_PREFIX IntUserConfigParam m_last_hw_report_version + PARAM_DEFAULT( IntUserConfigParam(0, "report-version", &m_hw_report_group, + "Version of hardware report " + "that was reported last") ); + PARAM_PREFIX IntUserConfigParam m_random_identifier + PARAM_DEFAULT( IntUserConfigParam(0, "random-identifier", &m_hw_report_group, + "A random number to avoid duplicated reports.") ); + + PARAM_PREFIX BoolUserConfigParam m_hw_report_enable + PARAM_DEFAULT( BoolUserConfigParam( false, + "hw-report-enabled", + &m_hw_report_group, + "If HW reports are enabled.")); + + // ---- User management + + PARAM_PREFIX BoolUserConfigParam m_always_show_login_screen + PARAM_DEFAULT( BoolUserConfigParam(false, "always_show_login_screen", + "Always show the login screen even if last player's session was saved.")); + + + // ---- Addon server related entries + PARAM_PREFIX GroupUserConfigParam m_addon_group + PARAM_DEFAULT( GroupUserConfigParam("AddonServer", + "Addon and news related settings") ); + + PARAM_PREFIX TimeUserConfigParam m_news_last_updated + PARAM_DEFAULT( TimeUserConfigParam(0, "news_last_updated", + &m_addon_group, + "Time news was updated last.") ); + + PARAM_PREFIX IntUserConfigParam m_news_frequency + PARAM_DEFAULT( IntUserConfigParam(0, "news_frequency", + &m_addon_group, + "How often news should be updated.") ); + + PARAM_PREFIX StringUserConfigParam m_display_count + PARAM_DEFAULT( StringUserConfigParam("", "news_display_count", + &m_addon_group, + "How often all news messages " + "have been displayed") ); + + PARAM_PREFIX IntUserConfigParam m_last_important_message_id + PARAM_DEFAULT( IntUserConfigParam(-1, "last_important_message_id", + &m_addon_group, + "Don't show important message " + "with this or a lower id again") ); + + PARAM_PREFIX IntUserConfigParam m_news_list_shown_id + PARAM_DEFAULT( IntUserConfigParam(0, "news_list_shown_id", + &m_addon_group, + "News before this id has been " + "shown once so no red dot") ); + + PARAM_PREFIX TimeUserConfigParam m_addons_last_updated + PARAM_DEFAULT( TimeUserConfigParam(0, "addon_last_updated", + &m_addon_group, + "Time addon-list was updated last.") ); + + PARAM_PREFIX TimeUserConfigParam m_latest_addon_time + PARAM_DEFAULT( TimeUserConfigParam(0, "latest_addon_time", + &m_addon_group, + "Latest approved addon time.") ); + + PARAM_PREFIX StringUserConfigParam m_language + PARAM_DEFAULT( StringUserConfigParam("system", "language", + "Which language to use (language code or 'system')") ); + + PARAM_PREFIX BoolUserConfigParam m_artist_debug_mode + PARAM_DEFAULT( BoolUserConfigParam(false, "artist_debug_mode", + "Whether to enable track debugging features") ); + + PARAM_PREFIX BoolUserConfigParam m_hide_gui + PARAM_DEFAULT(BoolUserConfigParam(false, "debug_hide_gui", + "Whether to hide the GUI (artist debug mode)")); + + PARAM_PREFIX IntUserConfigParam m_unlock_everything + PARAM_DEFAULT( IntUserConfigParam(0, "unlock_everything", + "Enable all karts and tracks: 0 = disabled, " + "1 = everything except final race, 2 = everything") ); + + PARAM_PREFIX StringUserConfigParam m_commandline + PARAM_DEFAULT( StringUserConfigParam("", "commandline", + "Allows one to set commandline args in config file") ); + + // TODO? implement blacklist for new irrlicht device and GUI + PARAM_PREFIX std::vector m_blacklist_res; + + /** List of all saved GPs. */ + PARAM_PREFIX PtrVector m_saved_grand_prix_list; + + /** Some constants to bitmask to enable various messages to be printed. */ + enum { LOG_MEMORY = 0x0001, + LOG_GUI = 0x0002, + LOG_ADDONS = 0x0004, + LOG_MISC = 0x0008, + LOG_FLYABLE = 0x0010, + LOG_ALL = 0xffff }; + + /** Returns true if the user want additional messages for memory usage. */ + bool logMemory(); + /** Returns true if the user want additional messages related to GUI. */ + bool logGUI (); + /** Returns true if the user want additional messages related to addons. */ + bool logAddons(); + /** Returns true if the user want additional debug info for flyables */ + bool logFlyable(); + /** Returns true if the user want additional messages for general items. */ + bool logMisc (); + + +} +#undef PARAM_PREFIX +#undef PARAM_SUFFIX + +// ============================================================================ +/** + * \brief Class for managing general STK user configuration data. + * \ingroup config + */ +class UserConfig : public NoCopy +{ +private: + + /** Filename of the user config file. */ + std::string m_filename; + irr::core::stringw m_warning; + + static const int m_current_config_version; + +public: + /** Create the user config object; does not actually load it, + * UserConfig::loadConfig needs to be called. */ + UserConfig(); + ~UserConfig(); + + bool loadConfig(); + void saveConfig(); + + const irr::core::stringw& getWarning() { return m_warning; } + void resetWarning() { m_warning=""; } + void setWarning(irr::core::stringw& warning) { m_warning=warning; } + +}; // UserConfig + + +extern UserConfig *user_config; + +#endif + /*EOF*/ \ No newline at end of file From 3ea93c63092a0652246cbdb764a0d5c16bd2a546 Mon Sep 17 00:00:00 2001 From: Gustavo Barreira <155913980+CreamBR-STK@users.noreply.github.com> Date: Tue, 19 Aug 2025 18:00:56 -0300 Subject: [PATCH 3/5] Update race_gui.cpp Speedmeter nearier of the buttons and new setting to activate/disable it. --- src/states_screens/race_gui.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/states_screens/race_gui.cpp b/src/states_screens/race_gui.cpp index 53ca4f5b55..9922f6b191 100644 --- a/src/states_screens/race_gui.cpp +++ b/src/states_screens/race_gui.cpp @@ -1018,6 +1018,8 @@ void RaceGUI::drawSpeedEnergyRank(const AbstractKart* kart, float dt) { #ifndef SERVER_ONLY + if (UserConfigParams::m_speedmeter == 0) return; //speedmeter hidden + float min_ratio = std::min(scaling.X, scaling.Y); const int SPEEDWIDTH = 128; int meter_width = (int)(SPEEDWIDTH*min_ratio); @@ -1039,7 +1041,7 @@ void RaceGUI::drawSpeedEnergyRank(const AbstractKart* kart, } else { - offset.X = (float)(viewport.LowerRightCorner.X-meter_width) - 250.0f*scaling.X; + offset.X = (float)(viewport.LowerRightCorner.X-meter_width) - 220.0f*scaling.X; offset.Y = viewport.LowerRightCorner.Y-60.0f*scaling.Y; } const core::rect meter_pos((int)offset.X, From d586fb6c3f6b2fbfe0629229398a88cb2302a48a Mon Sep 17 00:00:00 2001 From: Gustavo Barreira <155913980+CreamBR-STK@users.noreply.github.com> Date: Tue, 19 Aug 2025 18:02:02 -0300 Subject: [PATCH 4/5] Update options_screen_ui.cpp New option for speedmeter --- .../options/options_screen_ui.cpp | 1218 +++++++++-------- 1 file changed, 619 insertions(+), 599 deletions(-) diff --git a/src/states_screens/options/options_screen_ui.cpp b/src/states_screens/options/options_screen_ui.cpp index 93397cb8e1..79d35df156 100644 --- a/src/states_screens/options/options_screen_ui.cpp +++ b/src/states_screens/options/options_screen_ui.cpp @@ -1,599 +1,619 @@ -// SuperTuxKart - a fun racing game with go-kart -// Copyright (C) 2009-2015 Marianne Gagnon -// -// This program 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; either version 3 -// of the License, or (at your option) any later version. -// -// This program 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 this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -// Manages includes common to all options screens -#include "states_screens/options/options_common.hpp" - -#include "challenges/story_mode_timer.hpp" -#include "config/player_manager.hpp" -#include "font/font_manager.hpp" -#include "graphics/irr_driver.hpp" -#include "items/attachment_manager.hpp" -#include "items/powerup_manager.hpp" -#include "modes/world.hpp" -#include "states_screens/dialogs/message_dialog.hpp" -#include "states_screens/main_menu_screen.hpp" - -#include - -using namespace GUIEngine; -using namespace Online; - -// ----------------------------------------------------------------------------- - -OptionsScreenUI::OptionsScreenUI() : Screen("options/options_ui.stkgui") -{ - m_inited = false; -} // OptionsScreenVideo - -// ----------------------------------------------------------------------------- - -void OptionsScreenUI::loadedFromFile() -{ - m_inited = false; - - m_base_skin_selector = getWidget("base_skinchoice"); - m_variant_skin_selector = getWidget("variant_skinchoice"); - assert( m_base_skin_selector != NULL ); - assert( m_variant_skin_selector != NULL ); - - m_base_skin_selector->m_properties[PROP_WRAP_AROUND] = "true"; - m_variant_skin_selector->m_properties[PROP_WRAP_AROUND] = "true"; - - // Setup the minimap options spinner - GUIEngine::SpinnerWidget* minimap_options = getWidget("minimap"); - assert( minimap_options != NULL ); - - minimap_options->m_properties[PROP_WRAP_AROUND] = "true"; - minimap_options->clearLabels(); - //I18N: In the UI options, minimap position in the race UI - minimap_options->addLabel( core::stringw(_("In the bottom-left"))); - //I18N: In the UI options, minimap position in the race UI - minimap_options->addLabel( core::stringw(_("On the right side"))); - //I18N: In the UI options, minimap position in the race UI - minimap_options->addLabel( core::stringw(_("Hidden"))); - //I18N: In the UI options, minimap position in the race UI - minimap_options->addLabel( core::stringw(_("Centered"))); - minimap_options->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; - - bool multitouch_enabled = (UserConfigParams::m_multitouch_active == 1 && - irr_driver->getDevice()->supportsTouchDevice()) || - UserConfigParams::m_multitouch_active > 1; - - if (multitouch_enabled && UserConfigParams::m_multitouch_draw_gui) - minimap_options->m_properties[GUIEngine::PROP_MIN_VALUE] = "1"; - - minimap_options->m_properties[GUIEngine::PROP_MAX_VALUE] = "3"; - - // Setup the fontsize spinner - GUIEngine::SpinnerWidget* font_size = getWidget("font_size"); - assert( font_size != NULL ); - - font_size->clearLabels(); - font_size->addLabel(L"Extremely small"); - //I18N: In the UI options, Very small font size - font_size->addLabel(_("Very small")); - //I18N: In the UI options, Small font size - font_size->addLabel(_("Small")); - //I18N: In the UI options, Medium font size - font_size->addLabel(_("Medium")); - //I18N: In the UI options, Large font size - font_size->addLabel(_("Large")); - //I18N: In the UI options, Very large font size - font_size->addLabel(_("Very large")); - font_size->addLabel(L"Extremely large"); - - if (UserConfigParams::m_artist_debug_mode) - { - // Only show extreme size in artist debug mode - font_size->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; - font_size->m_properties[GUIEngine::PROP_MAX_VALUE] = "6"; - } - else - { - font_size->m_properties[GUIEngine::PROP_MIN_VALUE] = "1"; - font_size->m_properties[GUIEngine::PROP_MAX_VALUE] = "5"; - } - - font_size->setValueUpdatedCallback([this](SpinnerWidget* spinner) - { - // Add a special value updated callback so font size is updated when - // it's pressed instead of release to prevent multiple event - bool right = spinner->isButtonSelected(true/*right*/); - UserConfigParams::m_font_size = spinner->getValue(); - m_reload_option = std::unique_ptr(new ReloadOption); - m_reload_option->m_reload_font = true; - m_reload_option->m_reload_skin = false; - m_reload_option->m_focus_name = "font_size"; - m_reload_option->m_focus_right = right; - }); - -} // loadedFromFile - -// ----------------------------------------------------------------------------- - -void OptionsScreenUI::init() -{ - Screen::init(); - OptionsCommon::setTabStatus(); - - bool in_game = StateManager::get()->getGameState() == GUIEngine::INGAME_MENU; - - RibbonWidget* ribbon = getWidget("options_choice"); - assert(ribbon != NULL); - ribbon->setFocusForPlayer(PLAYER_ID_GAME_MASTER); - ribbon->select( "tab_ui", PLAYER_ID_GAME_MASTER ); - - m_skins.clear(); - m_base_skins.clear(); - m_current_skin_variants.clear(); - m_base_skin_selector ->clearLabels(); - m_variant_skin_selector->clearLabels(); - - std::set skin_files; - file_manager->listFiles(skin_files /* out */, file_manager->getAsset(FileManager::SKIN,""), - true /* make full path */ ); - std::set addon_skin_files; - file_manager->listFiles(addon_skin_files /* out */, file_manager->getAddonsFile("skins/"), - true /* make full path */ ); - - loadSkins(skin_files, false); - loadSkins(addon_skin_files, true); - - if (m_skins.size() == 0) - { - Log::warn("OptionsScreenUI", "Could not find a single skin, make sure that " - "the data files are correctly installed"); - m_base_skin_selector ->setActive(false); - m_variant_skin_selector->setActive(false); - return; - } - - const int base_skin_count = (int)m_base_skins.size(); - for (auto& p : m_base_skins) - m_base_skin_selector ->addLabel(p); - m_base_skin_selector ->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; - m_base_skin_selector ->m_properties[GUIEngine::PROP_MAX_VALUE] = StringUtils::toString(base_skin_count-1); - - // --- select the right skin in the spinner - bool currSkinFound = false; - const std::string& user_skin = UserConfigParams::m_skin_file; - m_base_skin_selector ->setActive(!in_game); - m_variant_skin_selector->setActive(!in_game); - - for (unsigned int i = 0; i < m_skins.size(); i++) - { - if (m_skins[i].m_folder_name == user_skin) - { - m_active_base_skin = m_skins[i].m_base_theme_name; - m_base_skin_selector ->setValue(getBaseID(m_skins[i])); - loadCurrentSkinVariants(); - m_variant_skin_selector->setValue(getVariantID(m_skins[i])); - currSkinFound = true; - break; - } - } - if (!currSkinFound) - { - Log::warn("OptionsScreenUI", "Couldn't find the current skin in the list of skins!"); - m_base_skin_selector ->setValue(0); - m_variant_skin_selector->setValue(0); - irr_driver->unsetMaxTextureSize(); - GUIEngine::reloadSkin(); - irr_driver->setMaxTextureSize(); - } - - // --- Setup other spinners and checkboxes - - GUIEngine::SpinnerWidget* minimap_options = getWidget("minimap"); - assert( minimap_options != NULL ); - - bool multitouch_enabled = (UserConfigParams::m_multitouch_active == 1 && - irr_driver->getDevice()->supportsTouchDevice()) || - UserConfigParams::m_multitouch_active > 1; - - if (multitouch_enabled && UserConfigParams::m_multitouch_draw_gui && - UserConfigParams::m_minimap_display == 0) - { - UserConfigParams::m_minimap_display = 1; - } - minimap_options->setValue(UserConfigParams::m_minimap_display); - - GUIEngine::SpinnerWidget* font_size = getWidget("font_size"); - assert( font_size != NULL ); - - int size_int = (int)roundf(UserConfigParams::m_font_size); - if (size_int < 0 || size_int > 6) - size_int = 3; - - if (!UserConfigParams::m_artist_debug_mode && - (size_int < 1 || size_int > 5)) - size_int = 3; - - font_size->setValue(size_int); - UserConfigParams::m_font_size = font_size->getValue(); - font_size->setActive(!in_game); - - CheckBoxWidget* karts_powerup_gui = getWidget("karts_powerup_gui"); - assert(karts_powerup_gui != NULL); - karts_powerup_gui->setState(UserConfigParams::m_karts_powerup_gui); - - CheckBoxWidget* fps = getWidget("showfps"); - assert( fps != NULL ); - fps->setState( UserConfigParams::m_display_fps ); - - CheckBoxWidget* story_timer = getWidget("story-mode-timer"); - assert( story_timer != NULL ); - story_timer->setState( UserConfigParams::m_display_story_mode_timer ); - CheckBoxWidget* speedrun_timer = getWidget("speedrun-timer"); - assert( speedrun_timer != NULL ); - if (story_mode_timer->getStoryModeTime() < 0) - { - story_timer->setActive(false); - speedrun_timer->setActive(false); - } - else - { - story_timer->setActive(true); - - speedrun_timer->setActive(UserConfigParams::m_display_story_mode_timer); - getWidget("speedrun-timer-text") - ->setActive(UserConfigParams::m_display_story_mode_timer); - } - if (UserConfigParams::m_speedrun_mode) - { - if (!story_mode_timer->playerCanRun()) - { - UserConfigParams::m_speedrun_mode = false; - new MessageDialog(_("Speedrun mode disabled. It can only be enabled if the game" - " has not been closed since the launch of the story mode.\n\n" - "Closing the game before the story mode's" - " completion invalidates the timer.\n\n" - "To use the speedrun mode, please use a new profile."), - MessageDialog::MESSAGE_DIALOG_OK, - NULL, false, false, 0.6f, 0.7f); - } - } - speedrun_timer->setState( UserConfigParams::m_speedrun_mode ); -} // init - -// ----------------------------------------------------------------------------- -void OptionsScreenUI::loadSkins(const std::set& files, bool addon) -{ - for (auto& f : files) - { - std::string stkskin = f + "/stkskin.xml"; - if (file_manager->fileExists(stkskin)) - { - XMLNode* root = file_manager->createXMLTree(stkskin); - if (!root) - continue; - - SkinID skin; - std::string folder_name = StringUtils::getBasename(f); - if (addon) - folder_name = std::string("addon_") + folder_name; - - if (root->get("base_theme_name", &skin.m_base_theme_name)) - { - if (!root->get("variant_name", &skin.m_variant_name)) - skin.m_variant_name = core::stringw(" "); - } - else if (root->get("name", &skin.m_base_theme_name)) - { - skin.m_variant_name = " "; - } - else - { - delete root; - return; - } - - skin.m_folder_name = folder_name; - m_skins.push_back(skin); - - // Add the base theme to the list of base Themes - bool new_base_theme = true; - for (int i = 0; i<(int)m_base_skins.size(); i++) - { - if (m_base_skins[i] == skin.m_base_theme_name) - new_base_theme = false; - } - if (new_base_theme) - m_base_skins.push_back(skin.m_base_theme_name); - - delete root; - } - } -} // loadSkins - -// ----------------------------------------------------------------------------- -/** Set up the variant spinner with the appropriate values based on the current base skin. */ -void OptionsScreenUI::loadCurrentSkinVariants() -{ - core::stringw old_label = m_variant_skin_selector->getStringValue(); - m_variant_skin_selector->clearLabels(); - m_current_skin_variants.clear(); - - for (int i=0; i<(int)m_skins.size();i++) - { - if (m_skins[i].m_base_theme_name == m_active_base_skin) - { - m_current_skin_variants.push_back(m_skins[i].m_variant_name); - m_variant_skin_selector->addLabel(m_skins[i].m_variant_name); - } - } - - m_variant_skin_selector->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; - m_variant_skin_selector->m_properties[GUIEngine::PROP_MAX_VALUE] = - StringUtils::toString(m_current_skin_variants.size()-1); - - // When switching base theme, don't reset the variant spinner - // if the variant exists for both the previous and the new base theme. - for (int i=0; i<(int)m_current_skin_variants.size();i++) - { - if(m_current_skin_variants[i] == old_label) - m_variant_skin_selector->setValue(i); - } - - bool in_game = StateManager::get()->getGameState() == GUIEngine::INGAME_MENU; - - if (m_current_skin_variants.size() == 1) - m_variant_skin_selector->setActive(false); - else - m_variant_skin_selector->setActive(!in_game); -} // loadCurrentSkinVariants - -// ----------------------------------------------------------------------------- -/** Returns the spinner value matching the given name */ -int OptionsScreenUI::getBaseID(SkinID skin) -{ - for (int i=0; i<(int)m_base_skins.size(); i++) - { - if (m_base_skins[i] == skin.m_base_theme_name) - return i; - } - return 0; -} // getBaseID - -// ----------------------------------------------------------------------------- -/** Returns the spinner value matching the given name */ -int OptionsScreenUI::getVariantID(SkinID skin) -{ - for (int i=0; i<(int)m_current_skin_variants.size(); i++) - { - if (m_current_skin_variants[i] == skin.m_variant_name) - return i; - } - return 0; -} // getVariantID - -// ----------------------------------------------------------------------------- -/** Returns the folder name of the current skin based on the spinners */ -std::string OptionsScreenUI::getCurrentSpinnerSkin() -{ - for (int i=0; i<(int)m_skins.size();i++) - { - if (m_skins[i].m_base_theme_name == m_base_skin_selector ->getStringValue() && - m_skins[i].m_variant_name == m_variant_skin_selector->getStringValue()) - return m_skins[i].m_folder_name; - } - return "classic"; // Default if nothing is found -} // getCurrentSpinnerSkin - -// ----------------------------------------------------------------------------- -void OptionsScreenUI::eventCallback(Widget* widget, const std::string& name, const int playerID) -{ -#ifndef SERVER_ONLY - if (name == "options_choice") - { - std::string selection = ((RibbonWidget*)widget)->getSelectionIDString(PLAYER_ID_GAME_MASTER); - - if (selection != "tab_ui") - OptionsCommon::switchTab(selection); - } - else if(name == "back") - { - StateManager::get()->escapePressed(); - } - else if (name == "base_skinchoice") - { - m_active_base_skin = m_base_skin_selector->getStringValue(); - loadCurrentSkinVariants(); - UserConfigParams::m_skin_file = getCurrentSpinnerSkin(); - onSkinChange(false); - m_reload_option->m_focus_name = "base_skinchoice"; - m_reload_option->m_focus_right = m_base_skin_selector->isButtonSelected(true/*right*/); - } - else if (name == "variant_skinchoice") - { - UserConfigParams::m_skin_file = getCurrentSpinnerSkin(); - onSkinChange(true); - m_reload_option->m_focus_name = "variant_skinchoice"; - m_reload_option->m_focus_right = m_variant_skin_selector->isButtonSelected(true/*right*/); - } - else if (name == "minimap") - { - GUIEngine::SpinnerWidget* minimap_options = getWidget("minimap"); - assert( minimap_options != NULL ); - UserConfigParams::m_minimap_display = minimap_options->getValue(); - if (World::getWorld()) - World::getWorld()->getRaceGUI()->recreateGUI(); - } - else if (name == "font_size") - { - GUIEngine::SpinnerWidget* font_size = getWidget("font_size"); - assert( font_size != NULL ); - bool right = font_size->isButtonSelected(true/*right*/); - UserConfigParams::m_font_size = font_size->getValue(); - // Reload GUIEngine will clear widgets so we don't do that in eventCallback - m_reload_option = std::unique_ptr(new ReloadOption); - m_reload_option->m_reload_font = true; - m_reload_option->m_reload_skin = false; - m_reload_option->m_focus_name = "font_size"; - m_reload_option->m_focus_right = right; - } - else if (name == "karts_powerup_gui") - { - CheckBoxWidget* karts_powerup_gui = getWidget("karts_powerup_gui"); - assert(karts_powerup_gui != NULL); - UserConfigParams::m_karts_powerup_gui = karts_powerup_gui->getState(); - } - else if (name == "showfps") - { - CheckBoxWidget* fps = getWidget("showfps"); - assert( fps != NULL ); - UserConfigParams::m_display_fps = fps->getState(); - } - else if (name == "story-mode-timer") - { - CheckBoxWidget* story_timer = getWidget("story-mode-timer"); - assert( story_timer != NULL ); - UserConfigParams::m_display_story_mode_timer = story_timer->getState(); - - CheckBoxWidget* speedrun_timer = getWidget("speedrun-timer"); - assert( speedrun_timer != NULL ); - speedrun_timer->setActive( UserConfigParams::m_display_story_mode_timer ); - getWidget("speedrun-timer-text") - ->setActive(UserConfigParams::m_display_story_mode_timer); - - // Disable speedrun mode if the story mode timer is disabled - if (!UserConfigParams::m_display_story_mode_timer) - { - UserConfigParams::m_speedrun_mode = false; - speedrun_timer->setState(false); - } - - } - else if (name == "speedrun-timer") - { - CheckBoxWidget* speedrun_timer = getWidget("speedrun-timer"); - assert( speedrun_timer != NULL ); - if (speedrun_timer->getState()) - { - if (!story_mode_timer->playerCanRun()) - { - speedrun_timer->setState(false); - new MessageDialog(_("Speedrun mode can only be enabled if the game has not" - " been closed since the launch of the story mode.\n\n" - "Closing the game before the story mode's" - " completion invalidates the timer.\n\n" - "To use the speedrun mode, please use a new profile."), - MessageDialog::MESSAGE_DIALOG_OK, - NULL, false, false, 0.6f, 0.7f); - } - } - UserConfigParams::m_speedrun_mode = speedrun_timer->getState(); - } -#endif -} // eventCallback - -// ----------------------------------------------------------------------------- - -void OptionsScreenUI::onUpdate(float delta) -{ - if (m_reload_option) - reloadGUIEngine(); -} // onUpdate - -// ----------------------------------------------------------------------------- - -void OptionsScreenUI::reloadGUIEngine() -{ - bool reload_font = m_reload_option->m_reload_font; - bool reload_skin = m_reload_option->m_reload_skin; - std::string focus_name = m_reload_option->m_focus_name; - bool focus_right = m_reload_option->m_focus_right; - - if (reload_skin || reload_font) - { - if (reload_font) - { - GUIEngine::clear(); - GUIEngine::cleanUp(); - } - - GUIEngine::clearScreenCache(); - - if (reload_font) - { - delete font_manager; - font_manager = new FontManager(); // Fonts are loaded in GUIEngine::init - GUIEngine::init(irr_driver->getDevice(), irr_driver->getVideoDriver(), - StateManager::get(), false/*loading*/); - } - - Screen* screen_list[] = - { - MainMenuScreen::getInstance(), - OptionsScreenUI::getInstance(), - nullptr - }; - GUIEngine::switchToScreen(MainMenuScreen::getInstance()); - StateManager::get()->resetAndSetStack(screen_list); - GUIEngine::SpinnerWidget* spinner = OptionsScreenUI::getInstance() - ->getWidget(focus_name.c_str()); - spinner->setFocusForPlayer(PLAYER_ID_GAME_MASTER); - spinner->setSelectedButton(focus_right); - } - if (reload_skin) - { - irr_driver->setMaxTextureSize(); - - delete powerup_manager; - powerup_manager = new PowerupManager(); - powerup_manager->loadPowerupsModels(); - - delete attachment_manager; - attachment_manager = new AttachmentManager(); - attachment_manager->loadModels(); - } - OptionsScreenUI::getInstance()->m_reload_option = nullptr; -} // reloadGUIEngine - -// ----------------------------------------------------------------------------- -void OptionsScreenUI::onSkinChange(bool is_variant) -{ - bool change_font = GUIEngine::getSkin()->hasFont(); - irr_driver->unsetMaxTextureSize(); - GUIEngine::reloadSkin(); - // Reload GUIEngine will clear widgets and set max texture Size so we don't do that here - m_reload_option = std::unique_ptr(new ReloadOption); - // Check either old or new skin use custom_font - change_font |= GUIEngine::getSkin()->hasFont(); - // Assume skin variants use the same font set - m_reload_option->m_reload_font = change_font && !is_variant; - m_reload_option->m_reload_skin = true; -} // onSkinChange - -// ----------------------------------------------------------------------------- - -void OptionsScreenUI::tearDown() -{ - Screen::tearDown(); - // save changes when leaving screen - user_config->saveConfig(); -} // tearDown - -// ----------------------------------------------------------------------------- - -void OptionsScreenUI::unloaded() -{ - m_inited = false; -} // unloaded - -// ----------------------------------------------------------------------------- +// SuperTuxKart - a fun racing game with go-kart +// Copyright (C) 2009-2015 Marianne Gagnon +// +// This program 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; either version 3 +// of the License, or (at your option) any later version. +// +// This program 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 this program; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + +// Manages includes common to all options screens +#include "states_screens/options/options_common.hpp" + +#include "challenges/story_mode_timer.hpp" +#include "config/player_manager.hpp" +#include "font/font_manager.hpp" +#include "graphics/irr_driver.hpp" +#include "items/attachment_manager.hpp" +#include "items/powerup_manager.hpp" +#include "modes/world.hpp" +#include "states_screens/dialogs/message_dialog.hpp" +#include "states_screens/main_menu_screen.hpp" +#include "states_screens/race_gui.hpp" + +#include + +using namespace GUIEngine; +using namespace Online; + +// ----------------------------------------------------------------------------- + +OptionsScreenUI::OptionsScreenUI() : Screen("options/options_ui.stkgui") +{ + m_inited = false; +} // OptionsScreenVideo + +// ----------------------------------------------------------------------------- + +void OptionsScreenUI::loadedFromFile() +{ + m_inited = false; + + m_base_skin_selector = getWidget("base_skinchoice"); + m_variant_skin_selector = getWidget("variant_skinchoice"); + assert( m_base_skin_selector != NULL ); + assert( m_variant_skin_selector != NULL ); + + m_base_skin_selector->m_properties[PROP_WRAP_AROUND] = "true"; + m_variant_skin_selector->m_properties[PROP_WRAP_AROUND] = "true"; + + // Setup the minimap options spinner + GUIEngine::SpinnerWidget* minimap_options = getWidget("minimap"); + assert( minimap_options != NULL ); + + minimap_options->m_properties[PROP_WRAP_AROUND] = "true"; + minimap_options->clearLabels(); + //I18N: In the UI options, minimap position in the race UI + minimap_options->addLabel( core::stringw(_("In the bottom-left"))); + //I18N: In the UI options, minimap position in the race UI + minimap_options->addLabel( core::stringw(_("On the right side"))); + //I18N: In the UI options, minimap position in the race UI + minimap_options->addLabel( core::stringw(_("Hidden"))); + //I18N: In the UI options, minimap position in the race UI + minimap_options->addLabel( core::stringw(_("Centered"))); + minimap_options->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; + + bool multitouch_enabled = (UserConfigParams::m_multitouch_active == 1 && + irr_driver->getDevice()->supportsTouchDevice()) || + UserConfigParams::m_multitouch_active > 1; + + if (multitouch_enabled && UserConfigParams::m_multitouch_draw_gui) + minimap_options->m_properties[GUIEngine::PROP_MIN_VALUE] = "1"; + + minimap_options->m_properties[GUIEngine::PROP_MAX_VALUE] = "3"; + + // Setup the fontsize spinner + GUIEngine::SpinnerWidget* font_size = getWidget("font_size"); + assert( font_size != NULL ); + + font_size->clearLabels(); + font_size->addLabel(L"Extremely small"); + //I18N: In the UI options, Very small font size + font_size->addLabel(_("Very small")); + //I18N: In the UI options, Small font size + font_size->addLabel(_("Small")); + //I18N: In the UI options, Medium font size + font_size->addLabel(_("Medium")); + //I18N: In the UI options, Large font size + font_size->addLabel(_("Large")); + //I18N: In the UI options, Very large font size + font_size->addLabel(_("Very large")); + font_size->addLabel(L"Extremely large"); + + if (UserConfigParams::m_artist_debug_mode) + { + // Only show extreme size in artist debug mode + font_size->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; + font_size->m_properties[GUIEngine::PROP_MAX_VALUE] = "6"; + } + else + { + font_size->m_properties[GUIEngine::PROP_MIN_VALUE] = "1"; + font_size->m_properties[GUIEngine::PROP_MAX_VALUE] = "5"; + } + + font_size->setValueUpdatedCallback([this](SpinnerWidget* spinner) + { + // Add a special value updated callback so font size is updated when + // it's pressed instead of release to prevent multiple event + bool right = spinner->isButtonSelected(true/*right*/); + UserConfigParams::m_font_size = spinner->getValue(); + m_reload_option = std::unique_ptr(new ReloadOption); + m_reload_option->m_reload_font = true; + m_reload_option->m_reload_skin = false; + m_reload_option->m_focus_name = "font_size"; + m_reload_option->m_focus_right = right; + }); + +} // loadedFromFile + +// ----------------------------------------------------------------------------- + +void OptionsScreenUI::init() +{ + Screen::init(); + OptionsCommon::setTabStatus(); + + bool in_game = StateManager::get()->getGameState() == GUIEngine::INGAME_MENU; + + RibbonWidget* ribbon = getWidget("options_choice"); + assert(ribbon != NULL); + ribbon->setFocusForPlayer(PLAYER_ID_GAME_MASTER); + ribbon->select( "tab_ui", PLAYER_ID_GAME_MASTER ); + + m_skins.clear(); + m_base_skins.clear(); + m_current_skin_variants.clear(); + m_base_skin_selector ->clearLabels(); + m_variant_skin_selector->clearLabels(); + + std::set skin_files; + file_manager->listFiles(skin_files /* out */, file_manager->getAsset(FileManager::SKIN,""), + true /* make full path */ ); + std::set addon_skin_files; + file_manager->listFiles(addon_skin_files /* out */, file_manager->getAddonsFile("skins/"), + true /* make full path */ ); + + loadSkins(skin_files, false); + loadSkins(addon_skin_files, true); + + if (m_skins.size() == 0) + { + Log::warn("OptionsScreenUI", "Could not find a single skin, make sure that " + "the data files are correctly installed"); + m_base_skin_selector ->setActive(false); + m_variant_skin_selector->setActive(false); + return; + } + + const int base_skin_count = (int)m_base_skins.size(); + for (auto& p : m_base_skins) + m_base_skin_selector ->addLabel(p); + m_base_skin_selector ->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; + m_base_skin_selector ->m_properties[GUIEngine::PROP_MAX_VALUE] = StringUtils::toString(base_skin_count-1); + + // --- select the right skin in the spinner + bool currSkinFound = false; + const std::string& user_skin = UserConfigParams::m_skin_file; + m_base_skin_selector ->setActive(!in_game); + m_variant_skin_selector->setActive(!in_game); + + for (unsigned int i = 0; i < m_skins.size(); i++) + { + if (m_skins[i].m_folder_name == user_skin) + { + m_active_base_skin = m_skins[i].m_base_theme_name; + m_base_skin_selector ->setValue(getBaseID(m_skins[i])); + loadCurrentSkinVariants(); + m_variant_skin_selector->setValue(getVariantID(m_skins[i])); + currSkinFound = true; + break; + } + } + if (!currSkinFound) + { + Log::warn("OptionsScreenUI", "Couldn't find the current skin in the list of skins!"); + m_base_skin_selector ->setValue(0); + m_variant_skin_selector->setValue(0); + irr_driver->unsetMaxTextureSize(); + GUIEngine::reloadSkin(); + irr_driver->setMaxTextureSize(); + } + + // --- Setup other spinners and checkboxes + + GUIEngine::SpinnerWidget* minimap_options = getWidget("minimap"); + assert( minimap_options != NULL ); + + bool multitouch_enabled = (UserConfigParams::m_multitouch_active == 1 && + irr_driver->getDevice()->supportsTouchDevice()) || + UserConfigParams::m_multitouch_active > 1; + + if (multitouch_enabled && UserConfigParams::m_multitouch_draw_gui && + UserConfigParams::m_minimap_display == 0) + { + UserConfigParams::m_minimap_display = 1; + } + minimap_options->setValue(UserConfigParams::m_minimap_display); + + GUIEngine::SpinnerWidget* font_size = getWidget("font_size"); + assert( font_size != NULL ); + + int size_int = (int)roundf(UserConfigParams::m_font_size); + if (size_int < 0 || size_int > 6) + size_int = 3; + + if (!UserConfigParams::m_artist_debug_mode && + (size_int < 1 || size_int > 5)) + size_int = 3; + + font_size->setValue(size_int); + UserConfigParams::m_font_size = font_size->getValue(); + font_size->setActive(!in_game); + + CheckBoxWidget* karts_powerup_gui = getWidget("karts_powerup_gui"); + assert(karts_powerup_gui != NULL); + karts_powerup_gui->setState(UserConfigParams::m_karts_powerup_gui); + + CheckBoxWidget* fps = getWidget("showfps"); + assert( fps != NULL ); + fps->setState( UserConfigParams::m_display_fps ); + + CheckBoxWidget* story_timer = getWidget("story-mode-timer"); + assert( story_timer != NULL ); + story_timer->setState( UserConfigParams::m_display_story_mode_timer ); + CheckBoxWidget* speedrun_timer = getWidget("speedrun-timer"); + assert( speedrun_timer != NULL ); + if (story_mode_timer->getStoryModeTime() < 0) + { + story_timer->setActive(false); + speedrun_timer->setActive(false); + } + else + { + story_timer->setActive(true); + + speedrun_timer->setActive(UserConfigParams::m_display_story_mode_timer); + getWidget("speedrun-timer-text") + ->setActive(UserConfigParams::m_display_story_mode_timer); + } + if (UserConfigParams::m_speedrun_mode) + { + if (!story_mode_timer->playerCanRun()) + { + UserConfigParams::m_speedrun_mode = false; + new MessageDialog(_("Speedrun mode disabled. It can only be enabled if the game" + " has not been closed since the launch of the story mode.\n\n" + "Closing the game before the story mode's" + " completion invalidates the timer.\n\n" + "To use the speedrun mode, please use a new profile."), + MessageDialog::MESSAGE_DIALOG_OK, + NULL, false, false, 0.6f, 0.7f); + } + } + speedrun_timer->setState( UserConfigParams::m_speedrun_mode ); + + CheckBoxWidget* speedmeter = getWidget("speedmeter"); + assert( speedmeter != NULL ); + + speedmeter->setState( UserConfigParams::m_speedmeter); + if (multitouch_enabled) + { + UserConfigParams::m_speedmeter = 0; + } + else + { + UserConfigParams::m_speedmeter = 1; + } +} // init + +// ----------------------------------------------------------------------------- +void OptionsScreenUI::loadSkins(const std::set& files, bool addon) +{ + for (auto& f : files) + { + std::string stkskin = f + "/stkskin.xml"; + if (file_manager->fileExists(stkskin)) + { + XMLNode* root = file_manager->createXMLTree(stkskin); + if (!root) + continue; + + SkinID skin; + std::string folder_name = StringUtils::getBasename(f); + if (addon) + folder_name = std::string("addon_") + folder_name; + + if (root->get("base_theme_name", &skin.m_base_theme_name)) + { + if (!root->get("variant_name", &skin.m_variant_name)) + skin.m_variant_name = core::stringw(" "); + } + else if (root->get("name", &skin.m_base_theme_name)) + { + skin.m_variant_name = " "; + } + else + { + delete root; + return; + } + + skin.m_folder_name = folder_name; + m_skins.push_back(skin); + + // Add the base theme to the list of base Themes + bool new_base_theme = true; + for (int i = 0; i<(int)m_base_skins.size(); i++) + { + if (m_base_skins[i] == skin.m_base_theme_name) + new_base_theme = false; + } + if (new_base_theme) + m_base_skins.push_back(skin.m_base_theme_name); + + delete root; + } + } +} // loadSkins + +// ----------------------------------------------------------------------------- +/** Set up the variant spinner with the appropriate values based on the current base skin. */ +void OptionsScreenUI::loadCurrentSkinVariants() +{ + core::stringw old_label = m_variant_skin_selector->getStringValue(); + m_variant_skin_selector->clearLabels(); + m_current_skin_variants.clear(); + + for (int i=0; i<(int)m_skins.size();i++) + { + if (m_skins[i].m_base_theme_name == m_active_base_skin) + { + m_current_skin_variants.push_back(m_skins[i].m_variant_name); + m_variant_skin_selector->addLabel(m_skins[i].m_variant_name); + } + } + + m_variant_skin_selector->m_properties[GUIEngine::PROP_MIN_VALUE] = "0"; + m_variant_skin_selector->m_properties[GUIEngine::PROP_MAX_VALUE] = + StringUtils::toString(m_current_skin_variants.size()-1); + + // When switching base theme, don't reset the variant spinner + // if the variant exists for both the previous and the new base theme. + for (int i=0; i<(int)m_current_skin_variants.size();i++) + { + if(m_current_skin_variants[i] == old_label) + m_variant_skin_selector->setValue(i); + } + + bool in_game = StateManager::get()->getGameState() == GUIEngine::INGAME_MENU; + + if (m_current_skin_variants.size() == 1) + m_variant_skin_selector->setActive(false); + else + m_variant_skin_selector->setActive(!in_game); +} // loadCurrentSkinVariants + +// ----------------------------------------------------------------------------- +/** Returns the spinner value matching the given name */ +int OptionsScreenUI::getBaseID(SkinID skin) +{ + for (int i=0; i<(int)m_base_skins.size(); i++) + { + if (m_base_skins[i] == skin.m_base_theme_name) + return i; + } + return 0; +} // getBaseID + +// ----------------------------------------------------------------------------- +/** Returns the spinner value matching the given name */ +int OptionsScreenUI::getVariantID(SkinID skin) +{ + for (int i=0; i<(int)m_current_skin_variants.size(); i++) + { + if (m_current_skin_variants[i] == skin.m_variant_name) + return i; + } + return 0; +} // getVariantID + +// ----------------------------------------------------------------------------- +/** Returns the folder name of the current skin based on the spinners */ +std::string OptionsScreenUI::getCurrentSpinnerSkin() +{ + for (int i=0; i<(int)m_skins.size();i++) + { + if (m_skins[i].m_base_theme_name == m_base_skin_selector ->getStringValue() && + m_skins[i].m_variant_name == m_variant_skin_selector->getStringValue()) + return m_skins[i].m_folder_name; + } + return "classic"; // Default if nothing is found +} // getCurrentSpinnerSkin + +// ----------------------------------------------------------------------------- +void OptionsScreenUI::eventCallback(Widget* widget, const std::string& name, const int playerID) +{ +#ifndef SERVER_ONLY + if (name == "options_choice") + { + std::string selection = ((RibbonWidget*)widget)->getSelectionIDString(PLAYER_ID_GAME_MASTER); + + if (selection != "tab_ui") + OptionsCommon::switchTab(selection); + } + else if(name == "back") + { + StateManager::get()->escapePressed(); + } + else if (name == "base_skinchoice") + { + m_active_base_skin = m_base_skin_selector->getStringValue(); + loadCurrentSkinVariants(); + UserConfigParams::m_skin_file = getCurrentSpinnerSkin(); + onSkinChange(false); + m_reload_option->m_focus_name = "base_skinchoice"; + m_reload_option->m_focus_right = m_base_skin_selector->isButtonSelected(true/*right*/); + } + else if (name == "variant_skinchoice") + { + UserConfigParams::m_skin_file = getCurrentSpinnerSkin(); + onSkinChange(true); + m_reload_option->m_focus_name = "variant_skinchoice"; + m_reload_option->m_focus_right = m_variant_skin_selector->isButtonSelected(true/*right*/); + } + else if (name == "minimap") + { + GUIEngine::SpinnerWidget* minimap_options = getWidget("minimap"); + assert( minimap_options != NULL ); + UserConfigParams::m_minimap_display = minimap_options->getValue(); + if (World::getWorld()) + World::getWorld()->getRaceGUI()->recreateGUI(); + } + else if (name == "font_size") + { + GUIEngine::SpinnerWidget* font_size = getWidget("font_size"); + assert( font_size != NULL ); + bool right = font_size->isButtonSelected(true/*right*/); + UserConfigParams::m_font_size = font_size->getValue(); + // Reload GUIEngine will clear widgets so we don't do that in eventCallback + m_reload_option = std::unique_ptr(new ReloadOption); + m_reload_option->m_reload_font = true; + m_reload_option->m_reload_skin = false; + m_reload_option->m_focus_name = "font_size"; + m_reload_option->m_focus_right = right; + } + else if (name == "karts_powerup_gui") + { + CheckBoxWidget* karts_powerup_gui = getWidget("karts_powerup_gui"); + assert(karts_powerup_gui != NULL); + UserConfigParams::m_karts_powerup_gui = karts_powerup_gui->getState(); + } + else if (name == "showfps") + { + CheckBoxWidget* fps = getWidget("showfps"); + assert( fps != NULL ); + UserConfigParams::m_display_fps = fps->getState(); + } + else if (name == "story-mode-timer") + { + CheckBoxWidget* story_timer = getWidget("story-mode-timer"); + assert( story_timer != NULL ); + UserConfigParams::m_display_story_mode_timer = story_timer->getState(); + + CheckBoxWidget* speedrun_timer = getWidget("speedrun-timer"); + assert( speedrun_timer != NULL ); + speedrun_timer->setActive( UserConfigParams::m_display_story_mode_timer ); + getWidget("speedrun-timer-text") + ->setActive(UserConfigParams::m_display_story_mode_timer); + + // Disable speedrun mode if the story mode timer is disabled + if (!UserConfigParams::m_display_story_mode_timer) + { + UserConfigParams::m_speedrun_mode = false; + speedrun_timer->setState(false); + } + + } + else if (name == "speedrun-timer") + { + CheckBoxWidget* speedrun_timer = getWidget("speedrun-timer"); + assert( speedrun_timer != NULL ); + if (speedrun_timer->getState()) + { + if (!story_mode_timer->playerCanRun()) + { + speedrun_timer->setState(false); + new MessageDialog(_("Speedrun mode can only be enabled if the game has not" + " been closed since the launch of the story mode.\n\n" + "Closing the game before the story mode's" + " completion invalidates the timer.\n\n" + "To use the speedrun mode, please use a new profile."), + MessageDialog::MESSAGE_DIALOG_OK, + NULL, false, false, 0.6f, 0.7f); + } + } + UserConfigParams::m_speedrun_mode = speedrun_timer->getState(); + } + else if (name == "speedmeter") + { + CheckBoxWidget* speedmeter = getWidget("speedmeter"); + assert( speedmeter != NULL ); + UserConfigParams::m_speedmeter = speedmeter->getState(); + } +#endif +} // eventCallback + +// ----------------------------------------------------------------------------- + +void OptionsScreenUI::onUpdate(float delta) +{ + if (m_reload_option) + reloadGUIEngine(); +} // onUpdate + +// ----------------------------------------------------------------------------- + +void OptionsScreenUI::reloadGUIEngine() +{ + bool reload_font = m_reload_option->m_reload_font; + bool reload_skin = m_reload_option->m_reload_skin; + std::string focus_name = m_reload_option->m_focus_name; + bool focus_right = m_reload_option->m_focus_right; + + if (reload_skin || reload_font) + { + if (reload_font) + { + GUIEngine::clear(); + GUIEngine::cleanUp(); + } + + GUIEngine::clearScreenCache(); + + if (reload_font) + { + delete font_manager; + font_manager = new FontManager(); // Fonts are loaded in GUIEngine::init + GUIEngine::init(irr_driver->getDevice(), irr_driver->getVideoDriver(), + StateManager::get(), false/*loading*/); + } + + Screen* screen_list[] = + { + MainMenuScreen::getInstance(), + OptionsScreenUI::getInstance(), + nullptr + }; + GUIEngine::switchToScreen(MainMenuScreen::getInstance()); + StateManager::get()->resetAndSetStack(screen_list); + GUIEngine::SpinnerWidget* spinner = OptionsScreenUI::getInstance() + ->getWidget(focus_name.c_str()); + spinner->setFocusForPlayer(PLAYER_ID_GAME_MASTER); + spinner->setSelectedButton(focus_right); + } + if (reload_skin) + { + irr_driver->setMaxTextureSize(); + + delete powerup_manager; + powerup_manager = new PowerupManager(); + powerup_manager->loadPowerupsModels(); + + delete attachment_manager; + attachment_manager = new AttachmentManager(); + attachment_manager->loadModels(); + } + OptionsScreenUI::getInstance()->m_reload_option = nullptr; +} // reloadGUIEngine + +// ----------------------------------------------------------------------------- +void OptionsScreenUI::onSkinChange(bool is_variant) +{ + bool change_font = GUIEngine::getSkin()->hasFont(); + irr_driver->unsetMaxTextureSize(); + GUIEngine::reloadSkin(); + // Reload GUIEngine will clear widgets and set max texture Size so we don't do that here + m_reload_option = std::unique_ptr(new ReloadOption); + // Check either old or new skin use custom_font + change_font |= GUIEngine::getSkin()->hasFont(); + // Assume skin variants use the same font set + m_reload_option->m_reload_font = change_font && !is_variant; + m_reload_option->m_reload_skin = true; +} // onSkinChange + +// ----------------------------------------------------------------------------- + +void OptionsScreenUI::tearDown() +{ + Screen::tearDown(); + // save changes when leaving screen + user_config->saveConfig(); +} // tearDown + +// ----------------------------------------------------------------------------- + +void OptionsScreenUI::unloaded() +{ + m_inited = false; +} // unloaded + +// ----------------------------------------------------------------------------- From 9d1dac9973c78b3a444674ce9d93f6c4a9c458a2 Mon Sep 17 00:00:00 2001 From: Gustavo Barreira <155913980+CreamBR-STK@users.noreply.github.com> Date: Tue, 19 Aug 2025 18:03:55 -0300 Subject: [PATCH 5/5] Update options_ui.stkgui Add checkbox for speedmeter setting --- data/gui/screens/options/options_ui.stkgui | 204 +++++++++++---------- 1 file changed, 105 insertions(+), 99 deletions(-) diff --git a/data/gui/screens/options/options_ui.stkgui b/data/gui/screens/options/options_ui.stkgui index 8738a47d7f..e54cf28d85 100644 --- a/data/gui/screens/options/options_ui.stkgui +++ b/data/gui/screens/options/options_ui.stkgui @@ -1,99 +1,105 @@ - - - -
-
- - -
- - - - - - - - - - - - - - - - - - - -
- -
- - - -
- -
- - - - -
- -
- - - -
- -
- - - -
- - -
- - - -
- - -
- - - -
- - -
- - - -
- - -
- - - -
-
- + + + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +
+ + + + +
+ +
+ + + +
+ +
+ + + +
+ + +
+ + + +
+ + +
+ + + +
+ + +
+ + + +
+ + +
+ + + +
+ + +
+ +
+
+