Source Types

The following source types are supported:

• GlobalValue
• GameSetting
• INIPrefSetting

Source types are used in conjunction with Control Types to describe settings.

GlobalValue

Most mod-added gameplay settings would use the GlobalValue source type. The value of the setting will be retrieved from a GlobalVariable form from the game.

Example

{
  "text": "$Survival Mode",
  "help": "Survival adds the need to eat, sleep, and stay warm. It also adds additional challenges, such as no fast travel, reduced carry weight, and leveling up only when you sleep.",
  "type": "toggle",
  "valueOptions": {
    "defaultValue": 0,
    "sourceType": "GlobalValue",
    "sourceForm": "ccQDRSSE001-SurvivalMode.esl|828"
  }
}

GameSetting

Game settings modify various aspects of the game engine and are sometimes used to specify numbers for balancing purposes. Generally, these would not be exposed to players, but if you do want to make a setting configurable, you can use this source type. Use the id property to identify the specific setting to modify.

{
  "id": "fXPPerSkillRank",
  "text": "XP Handicap",
  "help": "Configure the amount of level up XP gained when gaining a skill rank.",
  "type": "slider",
  "valueOptions": {
    "defaultValue": 1.0,
    "min": 0.0,
    "max": 2.0,
    "step": 0.1
  }
}

INIPrefSetting

INI Pref Settings are user-level preferences, usually related to graphics, controls, etc. There are also a few gameplay options available which you may wish to expose. Use the id property to identify the specific preference to modify.

Example

{
  "id": "bShowFloatingQuestMarkers:GamePlay",
  "text": "$Show Floating Markers",
  "type": "toggle",
  "help": "Show floating quest markers.",
  "valueOptions": {
    "sourceType": "INIPrefSetting"
  }
}