options.lua

--[[
This file contains a table which defines options available to the user in the options dialog

tab data is what populates each tab and defines each option in a tab
Each tab has:
    .title - the text that will appear on the tab
    .key - the key that will group the options (ie in the prefs file gameplay.help_prompts or video.resolution)
    .items - an array of the items for this key (this is an array rather than a genericly keyed table so display order can be imposed)
        .title - the text that will label the option line item
        .tip - the text that will appear in the tooltip for the item
        .key - the prefs key to identify this property
        .default - the default value of the property
        .restart - if true, setting the option will require a restart and the user will be notified
        .verify - if true, prompts the user to veryfiy the change for 15 seconds, otherwise defaults back to prior setting
        .populate - an optional function which when called, will repopulate the options custom data. The value passed in is the current value of the control (function(value))
        .set - an optional function that takes a value parameter and is responsible for determining what happens when the option is applied (function(key, value))
        .ignore - an optional function called when the option is set, checks the value, and wont change it from its former setting, and if former setting is invalid, uses return value for new value (function(value))
        .cancel - called when the option is cancelled
        .beginChange - an option function for sliders when user begins modification
        .endChange - an option function for sliders when user ends modification
        .update - a optional function that is called when the control has a new value, also receives the control (function(control, value)), not always used,
                  but if you need additonal control (say of other controls) when this value changes (for example one control may change other controls) you can
                  set up that behavior here
        .type - the type of control used to display this property
            valid types are:
            toggle - multi state toggle button (TODO - add list to replace more than 2 states?)
            button - momentary button (usually open another dialog)
            slider - a value slider
        .custom - a table of data required by the control type, different for each control type.
            slider
                .min - the minimum value for the slider
                .max - the maximum value for the slider
                .inc - the increment between slider detents, if 0 its "analog"
            toggle
                .states - table of states the toggle switch can have
                    .text = text for each state
                    .key = the key or value for each state to be stored in the pref
            button
                .text - the text label of the button

the optionsOrder table is just an array of keys in to the option table, and their order will determine what
order the tabs show in the dialog

Note the behavior of the default value:
 - map / mod / lobby options: the index of the value we're interested in
 - game options: the key of the value that we're interested in

As an example:

{
    title = "<LOC OPTIONS_0212>Accept Build Templates",
    key = 'accept_build_templates',
    type = 'toggle',
    default = 'yes',                                    <-------- This is set to the actual value (instead of 1, which would be the index)
    set = function(key,value,startup)
    end,
    custom = {
        states = {
            {text = "<LOC _On>", key = 'yes' },         <-------- That is defined here as key
            {text = "<LOC _Off>", key = 'no' },
        },
    },
},

--]]

optionsOrder = {
    "gameplay",
    "ui",
    "video",
    "sound",
}

local Prefs = import("/lua/user/prefs.lua")
local SetMusicVolume = import("/lua/usermusic.lua").SetMusicVolume
local savedMasterVol = nil
local savedBloomIntensity = nil
local savedFXVol = nil
local savedMusicVol = nil
local savedVOVol = nil
local nomusicSwitchSet = HasCommandLineArg("/nomusic")
local savedBgMovie = nil
local noMovieSwitchSet = HasCommandLineArg("/nomovie")

function PlayTestSound()
    local sound = Sound { Bank = 'Interface', Cue = 'UI_Action_MouseDown' }
    PlaySound(sound)
end

local voiceHandle = nil
function PlayTestVoice()
    if not voiceHandle then
        local sound = Sound { Bank = 'XGG', Cue = 'Computer_Computer_MissileLaunch_01351' }
        ForkThread(
            function()
                WaitSeconds(0.5)
                voiceHandle = false
            end
        )
        if voiceHandle then
            StopSound(voiceHandle)
        end
        voiceHandle = PlayVoice(sound)
    end
end

local function getMusicVolumeOption()

    if not nomusicSwitchSet then

        -- original option
        return {
            title = "<LOC OPTIONS_0027>Music Volume",
            key = 'music_volume',
            type = 'slider',
            default = 100,

            init = function()
                savedMusicVol = GetVolume("Music")
                SetMusicVolume(savedMusicVol)
            end,

            cancel = function()
                if savedMusicVol then
                    SetMusicVolume(savedMusicVol)
                end
            end,

            set = function(key, value, startup)
                SetMusicVolume(value / 100)
                savedMusicVol = value / 100
            end,
            update = function(key, value)
                SetMusicVolume(value / 100)
            end,
            custom = {
                min = 0,
                max = 100,
                inc = 1,
            },
        }

    else

        -- replaced option with an "disableable" type. It preserves the original value in config.
        -- on empty profile it is defaulted to 100 as in original option
        return {
            title = "<LOC OPTIONS_0027>Music Volume",
            key = 'music_volume',
            type = 'toggle',
            default = 100,
            ignore = function(value)
                return savedMusicVol
            end,
            set = function(key, value, startup)
                savedMusicVol = value
            end,
            custom = {
                states = {
                    { text = "<LOC _Command_Line_Override>", key = 'overridden' },
                },
            },
        }

    end
end

options = {
    gameplay = {
        title = "<LOC _Gameplay>",
        key = 'gameplay',
        items = {
            {
                title = '<LOC OPTIONS_0326>Camera controls',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC INVERT_MOUSE_PAN>Invert pan direction with middle mouse button",
                key = 'invert_middle_mouse_button',
                type = 'toggle',
                default = 0,
                update = function(control,value)
                    SetInvertMidMouseButton(value == 1)
                end,
                set = function(key,value,startup)
                    SetInvertMidMouseButton(value == 1)
                end,
                custom = {
                    states = {
                        {text = "<LOC _Off>", key = 0},
                        {text = "<LOC _On>", key = 1},
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0158>Screen Edge Pans Main View",
                key = 'screen_edge_pans_main_view',
                type = 'toggle',
                default = 1,
                set = function(key, value, startup)
                    ConExecute("ui_ScreenEdgeScrollView " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0001>Zoom Wheel Sensitivity",
                key = 'wheel_sensitivity',
                type = 'slider',
                default = 40,
                set = function(key, value, startup)
                    ConExecute("cam_ZoomAmount " .. tostring(value / 100))
                end,
                custom = {
                    min = 1,
                    max = 100,
                    inc = 0,
                },
            },
            {
                title = "<LOC OPTIONS_0160>Pan Speed",
                key = 'keyboard_pan_speed',
                type = 'slider',
                default = 90,
                set = function(key, value, startup)
                    ConExecute("ui_KeyboardPanSpeed " .. tostring(value))
                end,
                custom = {
                    min = 10,
                    max = 400,
                    inc = 10,
                },
            },
            {
                title = "<LOC OPTIONS_0161>Accelerated Pan Speed Multiplier",
                key = 'keyboard_pan_accelerate_multiplier',
                type = 'slider',
                default = 4,
                set = function(key, value, startup)
                    ConExecute("ui_KeyboardPanAccelerateMultiplier " .. tostring(value))
                end,
                custom = {
                    min = 1,
                    max = 10,
                    inc = 1,
                },
            },
            {
                title = "<LOC OPTIONS_0174>Keyboard Rotation Speed",
                key = 'keyboard_rotate_speed',
                type = 'slider',
                default = 10,
                set = function(key, value, startup)
                    ConExecute("ui_KeyboardRotateSpeed " .. tostring(value))
                end,
                custom = {
                    min = 1,
                    max = 100,
                    inc = 0,
                },
            },
            {
                title = "<LOC OPTIONS_0163>Accelerated Keyboard Rotate Speed Multiplier",
                key = 'keyboard_rotate_accelerate_multiplier',
                type = 'slider',
                default = 2,
                set = function(key, value, startup)
                    ConExecute("ui_KeyboardRotateAccelerateMultiplier " .. tostring(value))
                end,
                custom = {
                    min = 1,
                    max = 10,
                    inc = 1,
                },
            },

            {
                title = "<LOC OPTIONS_0236>Zoom Pop Distance",
                key = 'gui_zoom_pop_distance',
                type = 'slider',
                default = 80,
                custom = {
                    min = 1,
                    max = 160,
                    inc = 1,
                },
            },

            -- TODO: what to do with this?
            {
                title = "<LOC OPTIONS_0159>Arrow Keys Pan Main View",
                key = 'arrow_keys_pan_main_view',
                type = 'toggle',
                default = 1,
                set = function(key, value, startup)
                    ConExecute("ui_ArrowKeysScrollView " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_CAMERA_SHAKE>Shake intensity",
                key = 'camera_shake_intensity',
                type = 'slider',
                set = function(key, value, startup)
                    ConExecute("cam_ShakeMult " .. tostring(0.01 * value))
                end,
                default = 100,
                custom = {
                    min = 0,
                    max = 100,
                    inc = 5,
                },
            },

            {
                title = '<LOC OPTIONS_0325>Build templates',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0212>Accept Build Templates",
                key = 'accept_build_templates',
                type = 'toggle',
                default = 'yes',
                set = function(key, value, startup)
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = 'yes' },
                        { text = "<LOC _Off>", key = 'no' },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0229>Template Rotation",
                key = 'gui_template_rotator',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0233>All Faction Templates",
                key = 'gui_all_race_templates',
                type = 'toggle',
                default = 1,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0237>Factory Build Queue Templates",
                key = 'gui_templates_factory',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0239>Visible Template Names",
                key = 'gui_visible_template_names',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0240>Template Name Cutoff",
                key = 'gui_template_name_cutoff',
                type = 'slider',
                default = 0,
                custom = {
                    min = 0,
                    max = 10,
                    inc = 1,
                },
            },

            {
                title = '<LOC OPTIONS_0324>Control groups',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC selectionsets0001>Steal from other control groups",
                key = 'steal_from_other_control_groups',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'Off' },
                        { text = "<LOC _On>On", key = 'On' },
                    },
                },
            },

            {
                title = "<LOC selectionsets0004>Add to factory control group",
                key = 'add_to_factory_control_group',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'Off' },
                        { text = "<LOC _On>On", key = 'On' },
                    },
                },
            },

            {
                title = "<LOC selectionsets0007>Double tap control group behavior",
                key = 'selection_sets_double_tap_behavior',
                type = 'toggle',
                default = 'translate-zoom',
                custom = {
                    states = {
                        { text = "<LOC selectionsets0008>Do nothing", key = 'none' },
                        { text = "<LOC selectionsets0009>Only translate", key = 'translate' },
                        { text = "<LOC selectionsets00010>Translate, zoom only out", key = 'translate-zoom-out-only' },
                        { text = "<LOC selectionsets00011>Translate and zoom", key = 'translate-zoom' },
                    },
                },
            },

            {
                title = "<LOC selectionsets0002>Double tap control group decay (in ms)",
                key = 'selection_sets_double_tap_decay',
                type = 'slider',
                default = 1000,
                custom = {
                    min = 100,
                    max = 2000,
                    inc = 10,
                },
            },

            {
                title = '<LOC OPTIONS_0323>Commands',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            -- {
            --     title = "Ignore mode via CTRL",
            --     key = 'commands_ignore_mode',
            --     type = 'toggle',
            --     default = 'off',
            --     custom = {
            --         states = {
            --             {text = "<LOC _Off>", key = 'off'},
            --             {text = "<LOC _On>", key = 'on'},
            --         },
            --     },
            -- },

            {
                title = "<LOC ASSIST_TO_UPGRADE_MASS>Assist to upgrade mass extractors",
                key = 'assist_to_upgrade',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 'Off' },
                        { text = "<LOC ASSIST_TO_UPGRADE_MASS_TECH1>Tech 1 extractors", key = 'Tech1Extractors' },
                        { text = "<LOC ASSIST_TO_UPGRADE_MASS_TECH1_TECH2>Tech 1 and tech 2 extractors",
                            key = 'Tech1Tech2Extractors' },
                    },
                },
            },

            {
                title = "<LOC ASSIST_TO_UPGRADE_RADAR>Assist to upgrade radars",
                key = 'assist_to_upgrade_radar',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 'Off' },
                        { text = "<LOC ASSIST_TO_UPGRADE_RADAR_TECH1>Only tech 1 radars", key = 'Tech1Radars' },
                        { text = "<LOC ASSIST_TO_UPGRADE_RADAR_TECH1_TECH2>Tech 1 and tech 2 radars", key = 'Tech1Tech2Radars' },
                    },
                },
            },

            {
                title = "<LOC ASSIST_TO_UNPAUSE>Assist to unpause",
                key = 'assist_to_unpause',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'Off' },
                        { text = "<LOC _ASSIST_TO_UNPAUSE_EXTRACTORS_AND_RADARS>Only extractors and radars",
                            key = 'ExtractorsAndRadars' },
                        { text = "<LOC _On>On", key = 'On' },
                    },
                },
            },

            {
                title = "<LOC ASSIST_TO_COPY_COMMAND_QUEUE>Assist to copy command queue",
                key = 'assist_to_copy_command_queue',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'Off' },
                        { text = "<LOC _ASSIST_TO_COPY_ENGINEERS>Engineers",
                            key = 'OnlyEngineers' },
                        { text = "<LOC _ASSIST_TO_COPY_ENGINEERS_ADD>Engineers and add to the selection",
                            key = 'OnlyEngineersAddToSelection' },
                    },
                },
            },

            {
                title = "<LOC structure_ringing_extractor_title>Assist to cap extractors with storages",
                key = 'structure_capping_feature_01',
                type = 'toggle',
                default = "on",
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/hotkeys/capping.lua").RingStorages = value == 'on'
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = "off" },
                        { text = "<LOC _On>On", key = "on" },
                    },
                },
            },

            {
                title = "<LOC structure_ringing_extractor_fabs_title>Assist to cap extractors with fabricators",
                key = 'structure_ringing_extractors_fabs',
                type = 'toggle',
                default = "4",
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/hotkeys/capping.lua").RingFabricatorsInner = value == "inner"
                        import("/lua/ui/game/hotkeys/capping.lua").RingFabricatorsAll = value == "all"
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = "off" },
                        { text = "<LOC structure_ringing_extractors_fabs_option_4>Up to 4 Mass Fabricators",
                            key = "inner" },
                        { text = "<LOC structure_ringing_extractors_fabs_option_8>Up to 8 Mass Fabricators", key = "all" },
                    },
                },
            },

            {
                title = "<LOC structure_ringing_radar_title>Assist to cap radar with power",
                key = 'structure_ringing_radar',
                type = 'toggle',
                default = "on",
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/hotkeys/capping.lua").RingRadars = value == 'on'
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = "off" },
                        { text = "<LOC _On>On", key = "on" },
                    },
                },
            },

            {
                title = "<LOC structure_ringing_artillery_title>Assist to cap tech 2 artillery with power",
                key = 'structure_ringing_artillery',
                type = 'toggle',
                default = "on",
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/hotkeys/capping.lua").RingArtillery = value == 'on'
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = "off" },
                        { text = "<LOC _On>On", key = "on" },
                    },
                },
            },

            {
                title = "<LOC structure_ringing_end_artillery_title>Assist to cap end game artillery with power",
                key = 'structure_ringing_artillery_end_game',
                type = 'toggle',
                default = "on",
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/hotkeys/capping.lua").RingArtilleryT3Exp = value == 'on'
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = "off" },
                        { text = "<LOC _On>On", key = "on" },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0287>Factories Default to Repeat Build",
                key = 'repeatbuild',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 'Off' },
                        { text = "<LOC _On>", key = 'On' },
                    },
                },
            },

            {
                title = "<LOC ASSIST_TO_UPGRADE>Hold alt to force attack move",
                key = 'alt_to_force_attack_move',
                type = 'toggle',
                default = 'Off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'Off' },
                        { text = "<LOC _On>On", key = 'On' },
                    },
                },
            },

            -- {
            --     title = '<LOC OPTIONS_0323>Area commands',
            --     type = 'header',

            --     -- these are expected everywhere
            --     default = '',
            --     key = '',
            -- },

            -- {
            --     title = "<LOC area_commands_key>Key to trigger area commands",
            --     key = 'area_commands_key',
            --     type = 'toggle',
            --     default = "no-key",
            --     set = function(key, value, startup)
            --         import("/lua/ui/game/hotkeys/area-reclaim-order.lua").SetDragKeyCode(value)
            --     end,
            --     custom = {
            --         states = {
            --             { text = "<LOC _Nokey>No key required", key = "no-key" },
            --             { text = "<LOC _Alt>Alt", key = "ALT" },
            --             { text = "<LOC _Control>Control", key = "CONTROL" },
            --         },
            --     },
            -- },

            {
                title = '<LOC OPTIONS_0322>Selection',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0232>Middle Click Avatars",
                key = 'gui_idle_engineer_avatars',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0238>Separate Idle Builders",
                key = 'gui_seperate_idle_builders',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0245>Improved Unit Deselection",
                key = 'gui_improved_unit_deselection',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0312>Default Selection Threshold",
                key = 'selection_threshold_regular',
                type = 'slider',
                default = 10,
                custom = {
                    min = 8,
                    max = 40,
                    inc = 2,
                },
            },
            {
                title = "<LOC OPTIONS_0313>Reclaim Mode Selection Threshold",
                key = 'selection_threshold_reclaim',
                type = 'slider',
                default = 10,
                custom = {
                    min = 8,
                    max = 40,
                    inc = 2,
                },
            },
            {
                title = "<LOC OPTIONS_0314>Replay Selection Threshold",
                key = 'selection_threshold_replay',
                type = 'slider',
                default = 20,
                custom = {
                    min = 8,
                    max = 80,
                    inc = 2,
                },
            },

            {
                title = '<LOC OPTIONS_0323>Painting features',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC options_painting_title>Painting",
                key = 'painting',
                type = 'toggle',
                default = 'on',
                custom = {
                    states = {
                        { text = "<LOC _Enabled>Enabled", key = 'on' },
                        { text = "<LOC _EnabledInReplays>Enabled when observing", key = 'observing' },
                        { text = "<LOC _Disabled>Disabled", key = 'off' },
                    },
                },
            },

            {
                title = "<LOC options_painting_duration_title>Duration of paintings",
                key = 'painting_duration',
                type = 'slider',
                default = 25,
                custom = {
                    min = 10,
                    max = 40,
                    inc = 1,
                },
            },


            {
                title = "<LOC options_painting_duration_title>Duration of paintings when observing",
                key = 'painting_duration_observing',
                type = 'slider',
                default = 15,
                custom = {
                    min = 10,
                    max = 40,
                    inc = 1,
                },
            },

            {
                title = '<LOC OPTIONS_0311>Cursor features',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC WATER_DEPTH_ASSISTANCE_TITLE>Water depth indication",
                key = 'cursor_depth_scanning',
                type = 'toggle',
                default = 'off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'off' },
                        { text = "<LOC _OnlyWhenBuilding>Only when building", key = 'building' },
                        { text = "<LOC _CommandMode>When you issue commands", key = 'commands' },
                        { text = "<LOC _On>On", key = 'on' },
                    },
                },
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/cursor/depth.lua").UpdatePreferenceOption(value)
                    end
                end,
            },

            {
                title = "<LOC PLANE_HEIGHT_ASSISTANCE_TITLE>Plane height indication",
                key = 'cursor_hover_scanning',
                type = 'toggle',
                default = 'off',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'off' },
                        { text = "<LOC _On>On", key = 'on' },
                    },
                },
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/cursor/hover.lua").UpdatePreferenceOption(value)
                    end
                end,
            },

            {
                title = "<LOC OPTIONS_0321>Always Show Splash Damage Indicator",
                key = 'cursor_splash_damage',
                type = 'toggle',
                default = 'off',
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 'off' },
                        { text = "<LOC _On>", key = 'on' },
                    },
                },
            },
        },
    },
    ui = {
        title = "<LOC OPTIONS_0164>Interface",
        key = 'ui',
        items = {
            {
                title = "<LOC OPTIONS_0006>Language",
                key = 'selectedlanguage',
                type = 'toggle',
                restart = true,
                default = __language,
                custom = {
                    states = __installedlanguages,
                },
            },
            {
                title = "<LOC OPTIONS_0151>Display Subtitles",
                key = 'subtitles',
                type = 'toggle',
                default = false,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true },
                        { text = "<LOC _Off>", key = false },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0283>UI Scale",
                key = 'ui_scale',
                restart = true,
                type = 'toggle',
                default = 1.0,
                custom = {
                    states = {
                        { text = "80%", key = 0.8, },
                        { text = "100%", key = 1.0, },
                        { text = "125%", key = 1.25, },
                        { text = "150%", key = 1.5, },
                        { text = "175%", key = 1.75, },
                        { text = "200%", key = 2.0, },
                    },
                },
            },

            {
                title = 'HUD',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC Show_Allied_Intel>Show intel of allies in strategic overlay",
                key = 'intel_overlay_allies',
                type = 'toggle',
                default = 1,
                set = function(key, value, startup)
                    ConExecute("ren_IntelRangeBehavior " .. tostring(value))
                end,
                update = function(control, value)
                    ConExecute("ren_IntelRangeBehavior " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0, },
                        { text = "<LOC _JustStructures>Only allied structures", key = 1, },
                        { text = "<LOC _On>", key = 2, },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0215>Show Waypoint ETAs",
                key = 'display_eta',
                type = 'toggle',
                default = true,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true, },
                        { text = "<LOC _Off>", key = false, },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0210>Show Lifebars of Attached Units",
                key = 'show_attached_unit_lifebars',
                type = 'toggle',
                default = true,
                set = function(key, value, startup)
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = false },
                        { text = "<LOC _On>", key = true },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0243>Always Show Enemy Lifebars",
                key = 'gui_render_enemy_lifebars',
                type = 'toggle',
                default = 0,
                set = function(key, value, startup)
                    ConExecute("UI_ForceLifbarsOnEnemy " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC options_show_player_names_title>Show Player Names",
                key = 'options_show_player_names',
                type = 'toggle',
                default = 'on',
                set = function(key, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/override/sessionclients.lua").OptionShowPlayerNames = value
                        import("/lua/ui/override/armiestable.lua").OptionShowPlayerNames = value
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = 'on' },
                        { text = "<LOC options_show_player_names_allies_only>Allies only", key = 'allies-only' },
                        -- { text = "<LOC _Off>", key = 'off' },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0242>Always Show Custom Names",
                key = 'gui_render_custom_names',
                type = 'toggle',
                default = 0,
                set = function(key, value, startup)
                    ConExecute("ui_RenderCustomNames " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0109>Always Show Strategic Icons",
                key = 'strat_icons_always_on',
                type = 'toggle',
                default = 0,
                set = function(key, value, startup)
                    ConExecute("ui_AlwaysRenderStrategicIcons " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_STRATEGIC_ICON_SCALE>Scale strategic icons",
                key = 'strat_icon_scale',
                type = 'toggle',
                default = 1.0,
                set = function(key, value, startup)
                    ConExecute("ui_StrategicIconScale " .. value)
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 1.0 },
                        { text = "<LOC strat_icon_scale_150>150% (may cause distortions)", key = 1.5 },
                        { text = "<LOC strat_icon_scale_200>200%", key = 2.0 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_RECLAIMBATCHING>Reclaim batching",
                key = 'reclaim_overview_batching',
                type = 'toggle',
                default = 1,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_RECLAIM_BATCHING_DISTANCE>Reclaim Batching Distance Threshold",
                key = 'reclaim_batching_distance_treshold',
                type = 'slider',
                default = 150,
                custom = {
                    min = 150,
                    max = 600,
                    inc = 10,
                },
            },

            {
                title = "<LOC OPTIONS_RECLAIMSIZE>Reclaim label scaling factor",
                key = 'reclaim_overview_size_scale',
                type = 'slider',
                default = 10,
                custom = {
                    min = 0,
                    max = 100,
                    inc = 1,
                },
            },

            {
                title = "<LOC OPTIONS_0327>Building",
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0228>Bigger Strategic Build Icons",
                key = 'gui_bigger_strat_build_icons',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC OPTIONS_0254>Bigger icons", key = 1 },
                        { text = "<LOC OPTIONS_0255>Bigger icons with TechMarker", key = 2 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0231>Draggable Build Queue",
                key = 'gui_draggable_queue',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0281>Hotkey Labels",
                key = 'show_hotkeylabels',
                type = 'toggle',
                default = true,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true },
                        { text = "<LOC _Off>", key = false },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0226>Enable Cycle Preview for Hotbuild",
                key = 'hotbuild_cycle_preview',
                type = 'toggle',
                default = 1,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0227>Cycle Reset Time (ms)",
                key = 'hotbuild_cycle_reset_time',
                type = 'slider',
                default = 1100,
                custom = {
                    min = 100,
                    max = 5000,
                    inc = 100,
                },
            },

            {
                title = 'UI',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0005>Display Tooltips",
                key = 'tooltips',
                type = 'toggle',
                default = true,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true },
                        { text = "<LOC _Off>", key = false },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0078>Tooltip Delay",
                key = 'tooltip_delay',
                type = 'slider',
                default = 0,
                set = function(key, value, startup)
                end,
                custom = {
                    min = 0,
                    max = 3,
                    inc = 0,
                },
            },
            {
                title = "<LOC OPTIONS_0211>Use Factional UI Skin",
                key = 'skin_change_on_start',
                type = 'toggle',
                default = 'yes',
                set = function(key, value, startup)
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = 'yes' },
                        { text = "<LOC _Off>", key = 'no' },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0279>Use Factional UI Font Color",
                key = 'faction_font_color',
                type = 'toggle',
                default = false,
                set = function(key, value, startup)
                    import('/lua/ui/uiutil.lua').UpdateCurrentSkin({ faction_font_color = value })
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true },
                        { text = "<LOC _Off>", key = false },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0076>Economy Warnings",
                key = 'econ_warnings',
                type = 'toggle',
                default = true,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true, },
                        { text = "<LOC _Off>", key = false, },
                    },
                },
            },


            {
                title = '<LOC OPTIONS_0310>Additional Information',
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0241>Display More Unit Stats",
                key = 'gui_detailed_unitview',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0234>Single Unit Selected Info",
                key = 'gui_enhanced_unitview',
                type = 'toggle',
                default = 0,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0107>Construction Tooltip Information",
                tip = "<LOC OPTIONS_0108>Change the layout that information is displayed in the rollover window for units in the construction manager.",
                key = 'uvd_format',
                type = 'toggle',
                default = 'full',
                set = function(key, value, startup)
                    -- needs logic to set priority (do we really want to do this though?)
                end,
                custom = {
                    states = {
                        { text = "<LOC _Full>", key = 'full' },
                        { text = "<LOC _Limited>", key = 'limited' },
                        { text = "<LOC _Off>", key = 'off' },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0244>Show Armament Build in Factory Menu",
                key = 'gui_render_armament_detail',
                type = 'toggle',
                default = 1,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0246>Show Factory Queue on Hover",
                key = 'gui_queue_on_hover_02',
                type = 'toggle',
                default = 'only-obs',
                custom = {
                    states = {
                        { text = "<LOC _Off>Off", key = 'off' },
                        { text = "<LOC _Obs>Only when observing", key = 'only-obs' },
                        { text = "<LOC _Always>Always", key = 'always' },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0328>Misc",
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0207>Main Menu Background Movie",
                key = 'mainmenu_bgmovie',
                type = 'toggle',
                default = true,
                set = function(key, value, startup)
                end,
                init = function()
                    savedBgMovie = Prefs.GetOption("mainmenu_bgmovie")
                end,
                custom = {
                    states = (function()
                        if noMovieSwitchSet then
                            return {
                                { text = "<LOC _Command_Line_Override>", key = savedBgMovie },
                            }
                        else
                            return {
                                { text = "<LOC _Off>", key = false },
                                { text = "<LOC _On>", key = true },
                            }
                        end
                    end)(),
                },
            },

            {
                title = "<LOC OPTIONS_0009>Show Loading Tips",
                key = 'loading_tips',
                type = 'toggle',
                default = true,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true },
                        { text = "<LOC _Off>", key = false },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0125>Quick Exit",
                tip = "<LOC OPTIONS_0126>When close box or alt-f4 are pressed, no confirmation dialog is shown",
                key = 'quick_exit',
                type = 'toggle',
                default = 'false',
                set = function(key, value, startup)
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = 'true' },
                        { text = "<LOC _Off>", key = 'false' },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0102>Multiplayer Taunts",
                tip = "<LOC OPTIONS_0103>Enable or Disable displaying taunts in multiplayer.",
                key = 'mp_taunt_head_enabled',
                type = 'toggle',
                default = 'true',
                set = function(key, value, startup)
                    -- needs logic to set priority (do we really want to do this though?)
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = 'true' },
                        { text = "<LOC _Off>", key = 'false' },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0329>Casting tools",
                type = 'header',

                -- these are expected everywhere
                default = '',
                key = '',
            },

            {
                title = "<LOC OPTIONS_0315>Show mouse locations of players",
                key = 'share_mouse',
                type = 'toggle',
                default = 'off',
                custom = {
                    states = {
                        { text = "<LOC _On>", key = 'on' },
                        { text = "<LOC _Off>", key = 'off' },
                    },
                },

                set = function(control, value, startup)
                    if GetCurrentUIState() == 'game' then
                        import("/lua/ui/game/casting/mouse.lua").UpdatePreferenceOption(value)
                    end
                end,
            },
        },
    },
    video = {
        title = "<LOC _Video>",
        key = 'video',
        items = {
            {
                title = "<LOC OPTIONS_0010>Primary Adapter",
                key = 'primary_adapter',
                type = 'toggle',
                default = '1024,768,60',
                verify = true,
                populate = function(value)
                    -- this is a bit odd, but the value of the primary determines how to populate the value of the secondary
                    ConExecute("SC_SecondaryAdapter " .. tostring('windowed' == value))
                end,
                update = function(control, value)
                    ConExecute("SC_SecondaryAdapter " .. tostring('windowed' == value))
                end,
                ignore = function(value)
                    if value == 'overridden' then
                        return '1024,768,60'
                    end
                end,
                set = function(key, value, startup)
                    if not startup then
                        ConExecute("SC_PrimaryAdapter " .. tostring(value))
                    end
                    ConExecute("SC_SecondaryAdapter " .. tostring('windowed' == value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Command_Line_Override>", key = 'overridden' },
                        { text = "<LOC OPTIONS_0070>Windowed", key = 'windowed' },
                        -- the remaining values are populated at runtime from device caps
                        -- what follows is just an example of the data which will be encountered
                        { text = "1024x768(60)", key = '1024,768,60' },
                        { text = "1152x864(60)", key = '1152,864,60' },
                        { text = "1280x768(60)", key = '1280,768,60' },
                        { text = "1280x800(60)", key = '1280,800,60' },
                        { text = "1280x1024(60)", key = '1280,1024,60' },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0147>Secondary Adapter",
                key = 'secondary_adapter',
                type = 'toggle',
                default = 'disabled',
                restart = true,
                ignore = function(value)
                    if value == 'overridden' then
                        return 'disabled'
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Command_Line_Override>", key = 'overridden' },
                        { text = "<LOC _Disabled>", key = 'disabled' },
                        -- the remaining values are populated at runtime from device caps
                        -- what follows is just an example of the data which will be encountered
                        { text = "1024x768(60)", key = '1024,768,60' },
                        { text = "1152x864(60)", key = '1152,864,60' },
                        { text = "1280x768(60)", key = '1280,768,60' },
                        { text = "1280x800(60)", key = '1280,800,60' },
                        { text = "1280x1024(60)", key = '1280,1024,60' },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0165>Lock Fullscreen Cursor To Window",
                key = 'lock_fullscreen_cursor_to_window',
                type = 'toggle',
                default = 0,
                set = function(key, value, startup)
                    ConExecute("SC_ToggleCursorClip " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_001>Fidelity Presets",
                key = 'fidelity_presets',
                type = 'toggle',
                default = 4,
                update = function(control, value)
                    logic = import("/lua/options/optionslogic.lua")

                    aaoptions = GetAntiAliasingOptions()

                    aahigh = 0
                    aamed = 0
                    if 0 < table.getn(aaoptions) then
                        aahigh = aaoptions[table.getn(aaoptions)]
                        aamed = aaoptions[math.ceil(table.getn(aaoptions) / 2)]
                    end

                    if 0 == value then
                        logic.SetValue('fidelity', 0, true)
                        logic.SetValue('shadow_quality', 0, true)
                        logic.SetValue('texture_level', 2, true)
                        logic.SetValue('antialiasing', 0, true)
                        logic.SetValue('level_of_detail', 0, true)
                        logic.SetValue('bloom_render', 0, true)
                        logic.SetValue('render_skydome', 0, true)
                    elseif 1 == value then
                        logic.SetValue('fidelity', 1, true)
                        logic.SetValue('shadow_quality', 1, true)
                        logic.SetValue('texture_level', 1, true)
                        logic.SetValue('antialiasing', 0, true)
                        logic.SetValue('level_of_detail', 1, true)
                        logic.SetValue('bloom_render', 0, true)
                        logic.SetValue('render_skydome', 1, true)
                    elseif 2 == value then
                        logic.SetValue('fidelity', 2, true)
                        logic.SetValue('shadow_quality', 2, true)
                        logic.SetValue('texture_level', 0, true)
                        logic.SetValue('antialiasing', aamed, true)
                        logic.SetValue('level_of_detail', 2, true)
                        logic.SetValue('bloom_render', 0, true)
                        logic.SetValue('render_skydome', 1, true)
                    elseif 3 == value then
                        logic.SetValue('fidelity', 2, true)
                        logic.SetValue('shadow_quality', 3, true)
                        logic.SetValue('texture_level', 0, true)
                        logic.SetValue('antialiasing', aahigh, true)
                        logic.SetValue('level_of_detail', 2, true)
                        logic.SetValue('bloom_render', 0, true)
                        logic.SetValue('render_skydome', 1, true)
                    else
                    end
                end,
                set = function(key, value, startup)
                end,
                custom = {
                    states = {
                        { text = "<LOC _Low>", key = 0 },
                        { text = "<LOC _Medium>", key = 1 },
                        { text = "<LOC _High>", key = 2 },
                        { text = "<LOC _Ultra>", key = 3 },
                        { text = "<LOC _Custom>", key = 4 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0168>Render Sky",
                key = 'render_skydome',
                type = 'toggle',
                default = 1,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    ConExecute("ren_Skydome " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_0223>Render World Border",
                key = 'world_border',
                type = 'toggle',
                default = true,
                set = function(key, value, startup)
                    import('/lua/ui/uiutil.lua').UpdateWorldBorderState(nil, value)
                end,
                custom = {
                    states = {
                        { text = "<LOC _On>", key = true },
                        { text = "<LOC _Off>", key = false },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0018>Fidelity",
                key = 'fidelity',
                type = 'toggle',
                default = 1,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    ConExecute("graphics_Fidelity " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Low>", key = 0 },
                        { text = "<LOC _Medium>", key = 1 },
                        { text = "<LOC _High>", key = 2 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0024>Shadow Fidelity",
                key = 'shadow_quality',
                type = 'toggle',
                default = 1,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    ConExecute("shadow_Fidelity " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _Low>", key = 1 },
                        { text = "<LOC _Medium>", key = 2 },
                        { text = "<LOC _High>", key = 3 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_SHADOW_RESOLUTION_TITLE>Shadow Resolution",
                key = 'shadow_resolution',
                type = 'slider',
                default = 1024,
                update = function(control, value)
                    ConExecute(string.format("ren_ShadowSize %d", value))
                end,
                set = function(key, value, startup)
                    ConExecute(string.format("ren_ShadowSize %d", value))
                end,
                custom = {
                    min = 512,
                    max = 2048,
                    inc = 256,
                },
            },
            {
                title = "<LOC OPTIONS_SHADOW_RENDER_DISTANCE_TITLE>Shadow render distance",
                key = 'shadow_render_distance',
                type = 'slider',
                default = 260,
                update = function(control, value)
                    ConExecute(string.format("ren_ShadowLOD %d", value))
                end,
                set = function(key, value, startup)
                    ConExecute(string.format("ren_ShadowLOD %d", value))
                end,
                custom = {
                    min = 200,
                    max = 440,
                    inc = 20,
                },
            },
            {
                title = "<LOC OPTIONS_0015>Anti-Aliasing",
                key = 'antialiasing',
                type = 'toggle',
                default = 0,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    if not startup then
                        ConExecute("SC_AntiAliasingSamples " .. tostring(value))
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC OPTIONS_0029>Off", key = 0 },
                        -- the remaining values are populated at runtime from device caps
                        -- what follows is just an example of the data which will be encountered
                        { text = "2", key = 2 },
                        { text = "4", key = 4 },
                        { text = "8", key = 8 },
                        { text = "16", key = 16 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0019>Texture Detail",
                key = 'texture_level',
                type = 'toggle',
                default = 1,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    ConExecute("ren_MipSkipLevels " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC OPTIONS_0112>Low", key = 2 },
                        { text = "<LOC OPTIONS_0111>Medium", key = 1 },
                        { text = "<LOC OPTIONS_0110>High", key = 0 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_002>Level Of Detail",
                key = 'level_of_detail',
                type = 'toggle',
                default = 1,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    ConExecute("SC_CameraScaleLOD " .. tostring(math.clamp(value, 0, 2)))

                    if SessionIsActive() then
                        -- feature: extend the rendering distance of the camera when settings are set to extreme
                        local worldViewManager = import("/lua/ui/game/worldview.lua")
                        if worldViewManager then
                            for k, worldview in worldViewManager.MapControls do
                                if value > 2 then
                                    ConExecute(string.format("cam_SetLOD %s 0.70", worldview._cameraName))
                                else
                                    ConExecute(string.format("cam_SetLOD %s 1.0", worldview._cameraName))
                                end
                            end
                        end
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Low>", key = 0 },
                        { text = "<LOC _Medium>", key = 1 },
                        { text = "<LOC _High>", key = 2 },

                        -- Note: we intentionally do not use a key of 3 for the "extreme" option
                        -- because it is not a valid value for the 'cam_SetLOD' console command. To
                        -- make sure we remain compatible with Steam, we instead set it to something 
                        -- that is rounded down to 2 by the engine.

                        { text = "<LOC _Extreme>Extreme", key = 2.1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_FRAMETIME>Frametime",
                key = 'frametime',
                type = 'slider',
                default = 8,
                update = function(control, value)
                    logic = import("/lua/options/optionslogic.lua")
                    logic.SetValue('vsync', 0)
                end,
                set = function(key, value, startup)
                    if not startup then
                        ConExecute("sc_FrameTimeClamp " .. tostring(value))
                    end
                end,
                custom = {
                    min = 2,
                    max = 16,
                    inc = 1,
                },
            },
            {
                title = "<LOC OPTIONS_0148>Vertical Sync",
                key = 'vsync',
                type = 'toggle',
                default = 1,
                update = function(control, value)
                    if value == 1 then
                        logic = import("/lua/options/optionslogic.lua")
                        logic.SetValue('frametime', 8)
                    end
                end,
                set = function(key, value, startup)
                    if not startup then
                        ConExecute("SC_VerticalSync " .. tostring(value))
                    end
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },
            {
                title = "<LOC OPTIONS_0169>Bloom Render",
                key = 'bloom_render',
                type = 'toggle',
                default = 0,
                update = function(control, value)
                    import("/lua/options/optionslogic.lua").SetValue('fidelity_presets', 4, true)
                end,
                set = function(key, value, startup)
                    ConExecute("ren_bloom " .. tostring(value))
                end,
                custom = {
                    states = {
                        { text = "<LOC _Off>", key = 0 },
                        { text = "<LOC _On>", key = 1 },
                    },
                },
            },

            {
                title = "<LOC OPTIONS_BLOOM_INTENSITY>Bloom Intensity",
                key = 'bloom_intensity',
                type = 'slider',
                default = 15,
                custom = {
                    min = 10,
                    max = 17,
                    inc = 1,
                },

                init = function()
                    savedBloomIntensity = Prefs.GetFromCurrentProfile('options.bloom_intensity')
                end,
                cancel = function()
                    if savedBloomIntensity then
                        ConExecute("ren_BloomBlurKernelScale " .. tostring(savedBloomIntensity / 10))
                    end
                end,
                update = function(control, value)
                    ConExecute("ren_BloomBlurKernelScale " .. tostring(value / 10))
                end,
                set = function(key, value, startup)
                    ConExecute("ren_BloomBlurKernelScale " .. tostring(value / 10))
                end,
            },
        },
    },
    sound = {
        title = "<LOC _Sound>",
        items = {
            {
                title = "<LOC OPTIONS_0028>Master Volume",
                key = 'master_volume',
                type = 'slider',
                default = 100,

                init = function()
                    savedMasterVol = GetVolume("Global")
                end,

                cancel = function()
                    if savedMasterVol then
                        SetVolume("Global", savedMasterVol)
                    end
                end,

                set = function(key, value, startup)
                    SetVolume("Global", value / 100)
                    savedMasterVol = value / 100
                end,
                update = function(control, value)
                    SetVolume("Global", value / 100)
                end,
                custom = {
                    min = 0,
                    max = 100,
                    inc = 1,
                },
            },
            {
                title = "<LOC OPTIONS_0026>FX Volume",
                key = 'fx_volume',
                type = 'slider',
                default = 100,

                init = function()
                    savedFXVol = GetVolume("World")
                end,

                cancel = function()
                    if savedFXVol then
                        SetVolume("World", savedFXVol)
                        SetVolume("Interface", savedFXVol)
                    end
                end,

                set = function(key, value, startup)
                    SetVolume("World", value / 100)
                    SetVolume("Interface", value / 100)
                    savedFXVol = value / 100
                end,

                update = function(control, value)
                    SetVolume("World", value / 100)
                    SetVolume("Interface", value / 100)
                    PlayTestSound()
                end,

                custom = {
                    min = 0,
                    max = 100,
                    inc = 1,
                },
            },
            getMusicVolumeOption(),
            {
                title = "<LOC OPTIONS_0066>VO Volume",
                key = 'vo_volume',
                type = 'slider',
                default = 100,

                init = function()
                    savedVOVol = GetVolume("VO")
                end,

                cancel = function()
                    if savedVOVol then
                        SetVolume("VO", savedVOVol)
                    end
                end,

                set = function(key, value, startup)
                    SetVolume("VO", value / 100)
                    savedVOVol = value / 100
                end,
                update = function(key, value)
                    SetVolume("VO", value / 100)
                    PlayTestVoice()
                end,
                custom = {
                    min = 0,
                    max = 100,
                    inc = 1,
                },
            },
        },
    },
}