add debug settings

src/js/core/config.js

@@ -93,7 +93,7 @@ export const globalConfig = {
     },
 
     rendering: {},
-    debug: require("./config.local").default,
+    debug: G_IS_DEV ? require("./config.local").default : {},
 
     // Secret vars
     info: {

src/js/core/config.local.js

@@ -2,98 +2,98 @@ export default {
     // You can set any debug options here!
     /* dev:start */
     // -----------------------------------------------------------------------------------
-    // Quickly enters the game and skips the main menu - good for fast iterating
-    // fastGameEnter: true,
+    _fastGameEnter: "Quickly enters the game and skips the main menu - good for fast iterating",
+    fastGameEnter: false,
     // -----------------------------------------------------------------------------------
-    // Skips any delays like transitions between states and such
-    // noArtificialDelays: true,
+    _noArtificialDelays: "Skips any delays like transitions between states and such",
+    noArtificialDelays: false,
     // -----------------------------------------------------------------------------------
-    // Disables writing of savegames, useful for testing the same savegame over and over
-    // disableSavegameWrite: true,
+    _disableSavegameWrite: "Disables writing of savegames, useful for testing the same savegame over and over",
+    disableSavegameWrite: false,
     // -----------------------------------------------------------------------------------
-    // Shows bounds of all entities
-    // showEntityBounds: true,
+    _showEntityBounds: "Shows bounds of all entities",
+    showEntityBounds: false,
     // -----------------------------------------------------------------------------------
-    // Shows arrows for every ejector / acceptor
-    // showAcceptorEjectors: true,
+    _showAcceptorEjectors: "Shows arrows for every ejector / acceptor",
+    showAcceptorEjectors: false,
     // -----------------------------------------------------------------------------------
-    // Disables the music (Overrides any setting, can cause weird behaviour)
-    // disableMusic: true,
+    _disableMusic: "Disables the music (Overrides any setting, can cause weird behaviour)",
+    disableMusic: false,
     // -----------------------------------------------------------------------------------
-    // Do not render static map entities (=most buildings)
-    // doNotRenderStatics: true,
+    _doNotRenderStatics: "Do not render static map entities (=most buildings)",
+    doNotRenderStatics: false,
     // -----------------------------------------------------------------------------------
-    // Allow to zoom freely without limits
-    // disableZoomLimits: true,
+    _disableZoomLimits: "Allow to zoom freely without limits",
+    disableZoomLimits: false,
     // -----------------------------------------------------------------------------------
-    // Shows a border arround every chunk
-    // showChunkBorders: true,
+    _showChunkBorders: "Shows a border arround every chunk",
+    showChunkBorders: false,
     // -----------------------------------------------------------------------------------
-    // All rewards can be unlocked by passing just 1 of any shape
-    // rewardsInstant: true,
+    _rewardsInstant: "All rewards can be unlocked by passing just 1 of any shape",
+    rewardsInstant: false,
     // -----------------------------------------------------------------------------------
-    // Unlocks all buildings
-    // allBuildingsUnlocked: true,
+    _allBuildingsUnlocked: "Unlocks all buildings",
+    allBuildingsUnlocked: false,
     // -----------------------------------------------------------------------------------
-    // Disables cost of blueprints
-    // blueprintsNoCost: true,
+    _blueprintsNoCost: "Disables cost of blueprints",
+    blueprintsNoCost: false,
     // -----------------------------------------------------------------------------------
-    // Disables cost of upgrades
-    // upgradesNoCost: true,
+    _upgradesNoCost: "Disables cost of upgrades",
+    upgradesNoCost: false,
     // -----------------------------------------------------------------------------------
-    // Disables the dialog when completing a level
-    // disableUnlockDialog: true,
+    _disableUnlockDialog: "Disables the dialog when completing a level",
+    disableUnlockDialog: false,
     // -----------------------------------------------------------------------------------
-    // Disables the simulation - This effectively pauses the game.
-    // disableLogicTicks: true,
+    _disableLogicTicks: "Disables the simulation - This effectively pauses the game.",
+    disableLogicTicks: false,
     // -----------------------------------------------------------------------------------
-    // Test the rendering if everything is clipped out properly
-    // testClipping: true,
+    _testClipping: "Test the rendering if everything is clipped out properly",
+    testClipping: false,
     // -----------------------------------------------------------------------------------
     // Allows to render slower, useful for recording at half speed to avoid stuttering
     // framePausesBetweenTicks: 1,
     // -----------------------------------------------------------------------------------
-    // Replace all translations with emojis to see which texts are translateable
-    // testTranslations: true,
+    _testTranslations: "Replace all translations with emojis to see which texts are translateable",
+    testTranslations: false,
     // -----------------------------------------------------------------------------------
-    // Enables an inspector which shows information about the entity below the curosr
-    // enableEntityInspector: true,
+    _enableEntityInspector: "Enables an inspector which shows information about the entity below the curosr",
+    enableEntityInspector: false,
     // -----------------------------------------------------------------------------------
-    // Enables ads in the local build (normally they are deactivated there)
-    // testAds: true,
+    _testAds: "Enables ads in the local build (normally they are deactivated there)",
+    testAds: false,
     // -----------------------------------------------------------------------------------
-    // Disables the automatic switch to an overview when zooming out
-    // disableMapOverview: true,
+    _disableMapOverview: "Disables the automatic switch to an overview when zooming out",
+    disableMapOverview: false,
     // -----------------------------------------------------------------------------------
-    // Disables the notification when there are new entries in the changelog since last played
-    // disableUpgradeNotification: true,
+    _disableUpgradeNotification: "Disables the notification when there are new entries in the changelog since last played",
+    disableUpgradeNotification: false,
     // -----------------------------------------------------------------------------------
-    // Makes belts almost infinitely fast
-    // instantBelts: true,
+    _instantBelts: "Makes belts almost infinitely fast",
+    instantBelts: false,
     // -----------------------------------------------------------------------------------
-    // Makes item processors almost infinitely fast
-    // instantProcessors: true,
+    _instantProcessors: "Makes item processors almost infinitely fast",
+    instantProcessors: false,
     // -----------------------------------------------------------------------------------
-    // Makes miners almost infinitely fast
-    // instantMiners: true,
+    _instantMiners: "Makes miners almost infinitely fast",
+    instantMiners: false,
     // -----------------------------------------------------------------------------------
-    // When using fastGameEnter, controls whether a new game is started or the last one is resumed
-    // resumeGameOnFastEnter: true,
+    _resumeGameOnFastEnter: "When using fastGameEnter, controls whether a new game is started or the last one is resumed",
+    resumeGameOnFastEnter: false,
     // -----------------------------------------------------------------------------------
-    // Special option used to render the trailer
-    // renderForTrailer: true,
+    _renderForTrailer: "Special option used to render the trailer",
+    renderForTrailer: false,
     // -----------------------------------------------------------------------------------
-    // Whether to render changes
-    // renderChanges: true,
+    _renderChanges: "Whether to render changes",
+    renderChanges: false,
     // -----------------------------------------------------------------------------------
-    // Whether to render belt paths
-    // renderBeltPaths: true,
+    _renderBeltPaths: "Whether to render belt paths",
+    renderBeltPaths: false,
     // -----------------------------------------------------------------------------------
-    // Whether to check belt paths
-    // checkBeltPaths: true,
+    _checkBeltPaths: "Whether to check belt paths",
+    checkBeltPaths: false,
     // -----------------------------------------------------------------------------------
-    // Whether to items / s instead of items / m in stats
-    // detailedStatistics: true,
+    _detailedStatistics: "Whether to items / s instead of items / m in stats",
+    detailedStatistics: false,
     // -----------------------------------------------------------------------------------
     /* dev:end */
 };

src/js/profile/application_settings.js

@@ -10,6 +10,7 @@ import { THEMES, THEME, applyGameTheme } from "../game/theme";
 import { IS_DEMO } from "../core/config";
 import { T } from "../translations";
 import { LANGUAGES } from "../languages";
+import { globalConfig, IS_DEBUG } from "../core/config";
 
 const logger = createLogger("application_settings");
 
@@ -20,6 +21,7 @@ export const enumCategories = {
     general: "general",
     userInterface: "userInterface",
     advanced: "advanced",
+    debug: "debug",
 };
 
 export const uiScales = [
@@ -260,6 +262,21 @@ export const allApplicationSettings = [
     new BoolSetting("rotationByBuilding", enumCategories.advanced, (app, value) => {}),
 ];
 
+if (IS_DEBUG) {
+    for (let k in globalConfig.debug) {
+        if (k.startsWith('_')) continue;
+        const setting = new BoolSetting(`debug_${ k }`, enumCategories.debug, (app, value) => {
+            globalConfig.debug[k] = value;
+        });
+        setting.validate = () => true;
+        T.settings.labels[`debug_${ k }`] = {
+            title: k.replace(/(?!^)([A-Z])/g, " $1"),
+            description: globalConfig.debug[`_${ k }`],
+        };
+        allApplicationSettings.push(setting);
+    }
+}
+
 export function getApplicationSettingById(id) {
     return allApplicationSettings.find(setting => setting.id === id);
 }
@@ -332,7 +349,9 @@ export class ApplicationSettings extends ReadWriteProxy {
      * @param {string} key
      */
     getSetting(key) {
+        if (!key.startsWith('debug_')) {
             assert(this.getAllSettings().hasOwnProperty(key), "Setting not known: " + key);
+        }
         return this.getAllSettings()[key];
     }
 

src/js/profile/setting_types.js

@@ -185,6 +185,10 @@ export class BoolSetting extends BaseSetting {
     }
 
     getHtml() {
+        if (!T.settings.labels[this.id].description) {
+            let a = T;
+            let b = a;
+        }
         return `
         <div class="setting cardbox ${this.enabled ? "enabled" : "disabled"}">
             ${this.enabled ? "" : `<span class="standaloneOnlyHint">${T.demo.settingNotAvailable}</span>`}

translations/base-en.yaml

@@ -650,6 +650,7 @@ settings:
         general: General
         userInterface: User Interface
         advanced: Advanced
+        debug: Debug
 
     versionBadges:
         dev: Development