spotlight-dimmer/config.schema.json at main · thomazmoura/spotlight-dimmer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "https://github.com/thomazmoura/spotlight-dimmer/config.schema.json",
  "title": "SpotlightDimmer Configuration",
  "type": "object",
  "description": "Configuration schema for SpotlightDimmer overlay settings, system options, and profiles",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "type": "string"
    },
    "ConfigVersion": {
      "type": [
        "null",
        "string"
      ]
    },
    "Overlay": {
      "$ref": "#/definitions/OverlayConfig"
    },
    "System": {
      "$ref": "#/definitions/SystemConfig"
    },
    "Profiles": {
      "type": "array",
      "description": "List of saved profiles for quick overlay configuration switching",
      "items": {
        "$ref": "#/definitions/Profile"
      }
    },
    "CurrentProfile": {
      "type": [
        "null",
        "string"
      ],
      "description": "The name of the currently active profile, or null if using custom settings"
    }
  },
  "definitions": {
    "OverlayConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "Mode": {
          "type": "string",
          "description": "The dimming mode controlling overlay behavior"
        },
        "InactiveColor": {
          "type": "string",
          "description": "Inactive overlay color in hex format (e.g., '#000000' for black, '#1A1A1A' for dark gray)",
          "pattern": "^#[0-9A-Fa-f]{6}$"
        },
        "InactiveOpacity": {
          "type": "integer",
          "description": "Inactive overlay opacity (0 = fully transparent, 255 = fully opaque). Recommended: 153 (~60% opacity)",
          "format": "int32"
        },
        "ActiveColor": {
          "type": "string",
          "description": "Active overlay color in hex format (used only in PartialWithActive mode)",
          "pattern": "^#[0-9A-Fa-f]{6}$"
        },
        "ActiveOpacity": {
          "type": "integer",
          "description": "Active overlay opacity (used only in PartialWithActive mode). Should be less than InactiveOpacity for spotlight effect. Recommended: 102 (~40% opacity)",
          "format": "int32"
        },
        "ExcludeFromScreenCapture": {
          "type": "boolean",
          "description": "EXPERIMENTAL: Exclude overlay windows from screen captures/screenshots. May not work on all systems due to Windows API limitations with layered windows."
        }
      }
    },
    "SystemConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "EnableLogging": {
          "type": "boolean",
          "description": "Enable file-based logging to %AppData%\\SpotlightDimmer\\logs"
        },
        "LogLevel": {
          "type": "string",
          "description": "Log level for file output"
        },
        "LogRetentionDays": {
          "type": "integer",
          "description": "Number of days to retain log files. Older logs are automatically deleted.",
          "format": "int32"
        },
        "RendererBackend": {
          "type": "string"
        }
      }
    },
    "Profile": {
      "type": "object",
      "description": "A saved overlay configuration preset",
      "additionalProperties": false,
      "properties": {
        "Name": {
          "type": "string",
          "description": "The name of the profile (e.g., 'Light Mode', 'Dark Mode', 'Night Mode')"
        },
        "Mode": {
          "type": "string"
        },
        "InactiveColor": {
          "type": "string"
        },
        "InactiveOpacity": {
          "type": "integer",
          "format": "int32"
        },
        "ActiveColor": {
          "type": "string"
        },
        "ActiveOpacity": {
          "type": "integer",
          "format": "int32"
        }
      }
    }
  }
}