Json Schema

JSON config

1. Property JSON config > $schema
2. Property JSON config > logo
3. Property JSON config > general
4. Property JSON config > display
5. Property JSON config > modules
- 5.1. JSON config > modules > modules items
  - 5.1.1. Property JSON config > modules > modules items > anyOf > item 0
  - 5.1.2. Property JSON config > modules > modules items > anyOf > item 1

Title: JSON config


Type	`object`
Required	No
Additional properties	Not allowed

Description: JSON config file for fastfetch. Usually located at ~/.config/fastfetch/config.jsonc

Property	Pattern	Type	Deprecated	Definition	Title/Description
- $schema	No	string	No	-	JSON schema URL, for JSON validation and IDE intelligence
- logo	No	Combination	No	-	Fastfetch logo configurations See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options
- general	No	object	No	-	Fastfetch general configurations
- display	No	object	No	-	Configure how things should be displayed
- modules	No	array	No	-	Fastfetch modules to run

1. Property `JSON config > $schema`


Type	`string`
Required	No
Format	`uri`
Default	`"https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json"`

Description: JSON schema URL, for JSON validation and IDE intelligence

2. Property `JSON config > logo`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Fastfetch logo configurations See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options

One of(Option)
item 0
item 1
item 2

2.1. Property `JSON config > logo > oneOf > item 0`


Type	`const`
Required	No

Description: Disable logo

Specific value: null

2.2. Property `JSON config > logo > oneOf > item 1`


Type	`string`
Required	No

Description: Set the source file of the logo or built-in ASCII art name

2.3. Property `JSON config > logo > oneOf > item 2`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Fastfetch logo configurations

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	Combination	No	-	Set the type of the logo
- source	No	string	No	-	Set the source file of the logo
- color	No	object	No	-	Override colors in the logo
- width	No	Combination	No	-	-
- height	No	Combination	No	-	-
- padding	No	object	No	-	Set the padding of the logo
- printRemaining	No	boolean	No	-	Whether to print the remaining logo if it has more lines than modules to display
- preserveAspectRatio	No	boolean	No	-	Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol only
- recache	No	boolean	No	-	If true, regenerate image logo cache
- position	No	enum (of string)	No	-	Set the position where the logo should be displayed
- chafa	No	object	No	-	Chafa configuration. See chafa documentation for details

2.3.1. Property `JSON config > logo > oneOf > item 2 > type`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"auto"`

Description: Set the type of the logo

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
item 9
item 10
item 11
item 12
item 13
item 14

2.3.1.1. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 0`


Type	`const`
Required	No

Description: If something is given, first try built-in, then file. Otherwise detect logo

Specific value: "auto"

2.3.1.2. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 1`


Type	`const`
Required	No

Description: Built-in ASCII art

Specific value: "builtin"

2.3.1.3. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 2`


Type	`const`
Required	No

Description: Built-in ASCII art, small version (not all logos support this option)

Specific value: "small"

2.3.1.4. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 3`


Type	`const`
Required	No

Description: Text file, printed with color code replacement

Specific value: "file"

2.3.1.5. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 4`


Type	`const`
Required	No

Description: Text file, printed as is

Specific value: "file-raw"

2.3.1.6. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 5`


Type	`const`
Required	No

Description: Text data, printed with color code replacement

Specific value: "data"

2.3.1.7. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 6`


Type	`const`
Required	No

Description: Text data, printed as is

Specific value: "data-raw"

2.3.1.8. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 7`


Type	`const`
Required	No

Description: Image file, printed as sixel codes

Specific value: "sixel"

2.3.1.9. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 8`


Type	`const`
Required	No

Description: Image file, printed using kitty graphics protocol

Specific value: "kitty"

2.3.1.10. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 9`


Type	`const`
Required	No

Description: Image file, tells the terminal emulator to read image data from the specified file

Specific value: "kitty-direct"

2.3.1.11. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 10`


Type	`const`
Required	No

Description: Image file, uses kitten icat to display the image. Requires binary kitten to be installed

Specific value: "kitty-icat"

2.3.1.12. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 11`


Type	`const`
Required	No

Description: Image file, uses iTerm image protocol

Specific value: "iterm"

2.3.1.13. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 12`


Type	`const`
Required	No

Description: Image file, prints ASCII art image generated by libchafa

Specific value: "chafa"

2.3.1.14. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 13`


Type	`const`
Required	No

Description: Image file, printed as raw binary string image

Specific value: "raw"

2.3.1.15. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 14`


Type	`const`
Required	No

Description: Disable logo printing

Specific value: "none"

2.3.2. Property `JSON config > logo > oneOf > item 2 > source`


Type	`string`
Required	No

Description: Set the source file of the logo

2.3.3. Property `JSON config > logo > oneOf > item 2 > color`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Override colors in the logo

Property	Pattern	Type	Deprecated	Definition	Title/Description
- 1	No	object	No	In #/$defs/colors	Color 1
- 2	No	object	No	Same as 1	Color 2
- 3	No	object	No	Same as 1	Color 3
- 4	No	object	No	Same as 1	Color 4
- 5	No	object	No	Same as 1	Color 5
- 6	No	object	No	Same as 1	Color 6
- 7	No	object	No	Same as 1	Color 7
- 8	No	object	No	Same as 1	Color 8
- 9	No	object	No	Same as 1	Color 9

2.3.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1`


Type	`combining`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/colors

Description: Color 1

One of(Option)
item 0
item 1

2.3.3.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

2.3.3.1.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

2.3.3.2. Property `JSON config > logo > oneOf > item 2 > color > 2`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 2

2.3.3.3. Property `JSON config > logo > oneOf > item 2 > color > 3`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 3

2.3.3.4. Property `JSON config > logo > oneOf > item 2 > color > 4`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 4

2.3.3.5. Property `JSON config > logo > oneOf > item 2 > color > 5`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 5

2.3.3.6. Property `JSON config > logo > oneOf > item 2 > color > 6`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 6

2.3.3.7. Property `JSON config > logo > oneOf > item 2 > color > 7`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 7

2.3.3.8. Property `JSON config > logo > oneOf > item 2 > color > 8`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 8

2.3.3.9. Property `JSON config > logo > oneOf > item 2 > color > 9`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 9

2.3.4. Property `JSON config > logo > oneOf > item 2 > width`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

2.3.4.1. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 0`


Type	`null`
Required	No

Description: Auto detect width (default)

2.3.4.2. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 1`


Type	`integer`
Required	No

Description: Set the width of the logo (in characters). Required for some image protocols

Restrictions
Minimum	≥ 1

2.3.5. Property `JSON config > logo > oneOf > item 2 > height`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

2.3.5.1. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 0`


Type	`null`
Required	No

Description: Auto detect width (default)

2.3.5.2. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 1`


Type	`integer`
Required	No

Description: Set the height of the logo (in characters). Required for some image protocols

Restrictions
Minimum	≥ 1

2.3.6. Property `JSON config > logo > oneOf > item 2 > padding`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the padding of the logo

Property	Pattern	Type	Deprecated	Definition	Title/Description
- top	No	integer	No	-	Set the top padding of the logo
- left	No	integer	No	-	Set the left padding of the logo
- right	No	integer	No	-	Set the right padding of the logo

2.3.6.1. Property `JSON config > logo > oneOf > item 2 > padding > top`


Type	`integer`
Required	No

Description: Set the top padding of the logo

Restrictions
Minimum	≥ 0

2.3.6.2. Property `JSON config > logo > oneOf > item 2 > padding > left`


Type	`integer`
Required	No

Description: Set the left padding of the logo

Restrictions
Minimum	≥ 0

2.3.6.3. Property `JSON config > logo > oneOf > item 2 > padding > right`


Type	`integer`
Required	No

Description: Set the right padding of the logo

Restrictions
Minimum	≥ 0

2.3.7. Property `JSON config > logo > oneOf > item 2 > printRemaining`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to print the remaining logo if it has more lines than modules to display

2.3.8. Property `JSON config > logo > oneOf > item 2 > preserveAspectRatio`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol only

2.3.9. Property `JSON config > logo > oneOf > item 2 > recache`


Type	`boolean`
Required	No
Default	`false`

Description: If true, regenerate image logo cache

2.3.10. Property `JSON config > logo > oneOf > item 2 > position`


Type	`enum (of string)`
Required	No
Default	`"left"`

Description: Set the position where the logo should be displayed

Must be one of:

"left"
"top"
"right"

2.3.11. Property `JSON config > logo > oneOf > item 2 > chafa`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Chafa configuration. See chafa documentation for details

Property	Pattern	Type	Deprecated	Definition	Title/Description
- fgOnly	No	boolean	No	-	Produce character-cell output using foreground colors only
- symbols	No	string	No	-	Specify character symbols to employ in final output
- canvasMode	No	Combination	No	-	Determine how colors are used in the output. This value maps to enum ChafaCanvasMode.
- colorSpace	No	Combination	No	-	Set color space used for quantization. This value maps to enum ChafaColorSpace.
- ditherMode	No	Combination	No	-	Set output dither mode (No effect with 24-bit color). This value maps to enum ChafaDitherMode.

2.3.11.1. Property `JSON config > logo > oneOf > item 2 > chafa > fgOnly`


Type	`boolean`
Required	No
Default	`false`

Description: Produce character-cell output using foreground colors only

2.3.11.2. Property `JSON config > logo > oneOf > item 2 > chafa > symbols`


Type	`string`
Required	No

Description: Specify character symbols to employ in final output

2.3.11.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode`


Type	`combining`
Required	No

Description: Determine how colors are used in the output. This value maps to enum ChafaCanvasMode.

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7

2.3.11.3.1. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0`


Type	`const`
Required	No

Description: Use 24-bit true colors

Specific value: "TRUECOLOR"

2.3.11.3.2. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1`


Type	`const`
Required	No

Description: Use 256 colors

Specific value: "INDEXED_256"

2.3.11.3.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2`


Type	`const`
Required	No

Description: Use 240 colors, but avoid using the lower 16 whose values vary between terminal environments

Specific value: "INDEXED_240"

2.3.11.3.4. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3`


Type	`const`
Required	No

Description: Use 16 colors using the aixterm ANSI extension

Specific value: "INDEXED_16"

2.3.11.3.5. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4`


Type	`const`
Required	No

Description: Use default foreground and background colors, plus inversion

Specific value: "FGBG_BGFG"

2.3.11.3.6. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5`


Type	`const`
Required	No

Description: Use default foreground and background colors. No ANSI codes will be used

Specific value: "FGBG"

2.3.11.3.7. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6`


Type	`const`
Required	No

Description: Use 8 colors, compatible with original ANSI X3.64

Specific value: "INDEXED_8"

2.3.11.3.8. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7`


Type	`const`
Required	No

Description: Use 16 FG colors (8 of which enabled with bold/bright) and 8 BG colors

Specific value: "INDEXED_16_8"

2.3.11.4. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace`


Type	`combining`
Required	No

Description: Set color space used for quantization. This value maps to enum ChafaColorSpace.

One of(Option)
item 0
item 1

2.3.11.4.1. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0`


Type	`const`
Required	No

Description: RGB color space. Fast but imprecise

Specific value: "RGB"

2.3.11.4.2. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1`


Type	`const`
Required	No

Description: DIN99d color space. Slower, but good perceptual color precision

Specific value: "DIN99D"

2.3.11.5. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode`


Type	`combining`
Required	No

Description: Set output dither mode (No effect with 24-bit color). This value maps to enum ChafaDitherMode.

One of(Option)
item 0
item 1
item 2

2.3.11.5.1. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0`


Type	`const`
Required	No

Description: No dithering

Specific value: "NONE"

2.3.11.5.2. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1`


Type	`const`
Required	No

Description: Ordered dithering (Bayer or similar)

Specific value: "ORDERED"

2.3.11.5.3. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2`


Type	`const`
Required	No

Description: Error diffusion dithering (Floyd-Steinberg or similar)

Specific value: "DIFFUSION"

3. Property `JSON config > general`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Fastfetch general configurations

Property	Pattern	Type	Deprecated	Definition	Title/Description
- thread	No	boolean	No	-	Use separate threads for HTTP requests
- escapeBedrock	No	boolean	No	-	On Bedrock Linux, whether to escape the bedrock jail
- playerName	No	string	No	-	The name of the player to use for Media and Player modules. Linux only
- dsForceDrm	No	Combination	No	-	Force display detection to use DRM. Linux only
- wmiTimeout	No	integer	No	-	Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only
- processingTimeout	No	integer	No	-	Set the timeout (ms) when waiting for child processes, `-1` for no timeout
- preRun	No	string	No	-	Set the command to be executed before printing logos
- detectVersion	No	boolean	No	-	Whether to detect and display component versions. Mainly for benchmarking

3.1. Property `JSON config > general > thread`


Type	`boolean`
Required	No
Default	`true`

Description: Use separate threads for HTTP requests

3.2. Property `JSON config > general > escapeBedrock`


Type	`boolean`
Required	No
Default	`true`

Description: On Bedrock Linux, whether to escape the bedrock jail

3.3. Property `JSON config > general > playerName`


Type	`string`
Required	No

Description: The name of the player to use for Media and Player modules. Linux only

3.4. Property `JSON config > general > dsForceDrm`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`false`

Description: Force display detection to use DRM. Linux only

One of(Option)
item 0
item 1
item 2

3.4.1. Property `JSON config > general > dsForceDrm > oneOf > item 0`


Type	`const`
Required	No

Description: Try wayland, then x11, then drm

Specific value: false

3.4.2. Property `JSON config > general > dsForceDrm > oneOf > item 1`


Type	`const`
Required	No

Description: Use /sys/class/drm only

Specific value: "sysfs-only"

3.4.3. Property `JSON config > general > dsForceDrm > oneOf > item 2`


Type	`const`
Required	No

Description: Try libdrm first, then sysfs if libdrm fails

Specific value: true

3.5. Property `JSON config > general > wmiTimeout`


Type	`integer`
Required	No
Default	`5000`

Description: Set the timeout (ms) for WMI queries, -1 for no timeout. Windows only

3.6. Property `JSON config > general > processingTimeout`


Type	`integer`
Required	No
Default	`5000`

Description: Set the timeout (ms) when waiting for child processes, -1 for no timeout

3.7. Property `JSON config > general > preRun`


Type	`string`
Required	No
Default	`""`

Description: Set the command to be executed before printing logos

3.8. Property `JSON config > general > detectVersion`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to detect and display component versions. Mainly for benchmarking

4. Property `JSON config > display`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how things should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- stat	No	Combination	No	-	Show time usage (in ms) for individual modules with optional threshold
- pipe	No	boolean	No	-	Whether to disable colors (auto-detected based on isatty(1) by default)
- showErrors	No	boolean	No	-	Print occurring errors to the console. False to ignore errored modules
- disableLinewrap	No	boolean	No	-	Whether to disable line wrap during execution
- hideCursor	No	boolean	No	-	Whether to hide the cursor during execution
- separator	No	string	No	-	Set the separator between key and value
- color	No	Combination	No	-	Set the color of the keys and title
- brightColor	No	boolean	No	-	Set if the keys, title and ASCII logo should be printed in bright color
- key	No	object	No	-	Set how module keys should be displayed
- size	No	object	No	-	Set how size values should be displayed
- temp	No	object	No	-	Set how temperature values should be displayed
- bar	No	object	No	-	Set the bar configuration
- percent	No	object	No	-	Set how percentage values should be displayed
- freq	No	object	No	-	Set how frequency values should be displayed
- duration	No	object	No	-	Set how duration values should be displayed
- fraction	No	object	No	-	Set how ordinary fraction numbers should be displayed
- noBuffer	No	boolean	No	-	Whether to disable the stdout application buffer
- constants	No	array of string	No	-	List of strings to be used in custom format of modules

4.1. Property `JSON config > display > stat`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Show time usage (in ms) for individual modules with optional threshold

One of(Option)
item 0
item 1

4.1.1. Property `JSON config > display > stat > oneOf > item 0`


Type	`boolean`
Required	No
Default	`false`

4.1.2. Property `JSON config > display > stat > oneOf > item 1`


Type	`integer`
Required	No

Restrictions
Minimum	≥ 1

4.2. Property `JSON config > display > pipe`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to disable colors (auto-detected based on isatty(1) by default)

4.3. Property `JSON config > display > showErrors`


Type	`boolean`
Required	No
Default	`false`

Description: Print occurring errors to the console. False to ignore errored modules

4.4. Property `JSON config > display > disableLinewrap`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to disable line wrap during execution

4.5. Property `JSON config > display > hideCursor`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to hide the cursor during execution

4.6. Property `JSON config > display > separator`


Type	`string`
Required	No
Default	`": "`

Description: Set the separator between key and value

4.7. Property `JSON config > display > color`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Set the color of the keys and title

One of(Option)
colors
item 1

4.7.1. Property `JSON config > display > color > oneOf > colors`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Set both the colors of keys and title

4.7.2. Property `JSON config > display > color > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- keys	No	object	No	Same as 1	Set the color of the keys
- title	No	object	No	Same as 1	Set the color of the title
- output	No	object	No	Same as 1	Set the color of the module output
- separator	No	object	No	Same as 1	Set the color of the key-value separator

4.7.2.1. Property `JSON config > display > color > oneOf > item 1 > keys`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Set the color of the keys

4.7.2.2. Property `JSON config > display > color > oneOf > item 1 > title`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Set the color of the title

4.7.2.3. Property `JSON config > display > color > oneOf > item 1 > output`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Set the color of the module output

4.7.2.4. Property `JSON config > display > color > oneOf > item 1 > separator`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Set the color of the key-value separator

4.8. Property `JSON config > display > brightColor`


Type	`boolean`
Required	No
Default	`true`

Description: Set if the keys, title and ASCII logo should be printed in bright color

4.9. Property `JSON config > display > key`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how module keys should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- width	No	integer	No	-	Align the width of keys to number of characters, 0 to disable
- type	No	Combination	No	-	Set whether to show icon before string keys
- paddingLeft	No	integer	No	-	Set the left padding of keys

4.9.1. Property `JSON config > display > key > width`


Type	`integer`
Required	No
Default	`0`

Description: Align the width of keys to number of characters, 0 to disable

Restrictions
Minimum	≥ 0

4.9.2. Property `JSON config > display > key > type`


Type	`combining`
Required	No
Default	`"string"`

Description: Set whether to show icon before string keys

One of(Option)
item 0
item 1
item 2
item 3

4.9.2.1. Property `JSON config > display > key > type > oneOf > item 0`


Type	`const`
Required	No

Description: Disable keys

Specific value: "none"

4.9.2.2. Property `JSON config > display > key > type > oneOf > item 1`


Type	`const`
Required	No

Description: Show string keys

Specific value: "string"

4.9.2.3. Property `JSON config > display > key > type > oneOf > item 2`


Type	`const`
Required	No

Description: Show icon keys (requires newest nerd font)

Specific value: "icon"

4.9.2.4. Property `JSON config > display > key > type > oneOf > item 3`


Type	`const`
Required	No

Description: Show both icon and string keys

Specific value: "both"

4.9.3. Property `JSON config > display > key > paddingLeft`


Type	`integer`
Required	No
Default	`0`

Description: Set the left padding of keys

Restrictions
Minimum	≥ 0

4.10. Property `JSON config > display > size`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how size values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- binaryPrefix	No	Combination	No	-	Set the binary prefix to use when formatting sizes
- maxPrefix	No	enum (of string)	No	-	Set the largest binary prefix to use when formatting sizes
- ndigits	No	integer	No	-	Set the number of digits to keep after the decimal point when formatting sizes
- spaceBeforeUnit	No	string	No	In #/$defs/spaceBeforeUnit	Whether to put a space before the unit

4.10.1. Property `JSON config > display > size > binaryPrefix`


Type	`combining`
Required	No
Default	`"iec"`

Description: Set the binary prefix to use when formatting sizes

One of(Option)
item 0
item 1
item 2

4.10.1.1. Property `JSON config > display > size > binaryPrefix > oneOf > item 0`


Type	`const`
Required	No

Description: 1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)

Specific value: "iec"

4.10.1.2. Property `JSON config > display > size > binaryPrefix > oneOf > item 1`


Type	`const`
Required	No

Description: 1000 Bytes = 1 kB, 1000 kB = 1 MB, ...

Specific value: "si"

4.10.1.3. Property `JSON config > display > size > binaryPrefix > oneOf > item 2`


Type	`const`
Required	No

Description: 1024 Bytes = 1 KB, 1024 KB = 1 MB, ...

Specific value: "jedec"

4.10.2. Property `JSON config > display > size > maxPrefix`


Type	`enum (of string)`
Required	No
Default	`"YB"`

Description: Set the largest binary prefix to use when formatting sizes

Must be one of:

"B"
"kB"
"MB"
"GB"
"TB"
"PB"
"EB"
"ZB"
"YB"

4.10.3. Property `JSON config > display > size > ndigits`


Type	`integer`
Required	No
Default	`2`

Description: Set the number of digits to keep after the decimal point when formatting sizes

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.10.4. Property `JSON config > display > size > spaceBeforeUnit`


Type	`combining`
Required	No
Defined in	#/$defs/spaceBeforeUnit

Description: Whether to put a space before the unit

One of(Option)
item 0
item 1
item 2

4.10.4.1. Property `JSON config > display > size > spaceBeforeUnit > oneOf > item 0`


Type	`const`
Required	No

Description: Use the default behavior of the module

Specific value: "default"

4.10.4.2. Property `JSON config > display > size > spaceBeforeUnit > oneOf > item 1`


Type	`const`
Required	No

Description: Always add a space before the unit

Specific value: "always"

4.10.4.3. Property `JSON config > display > size > spaceBeforeUnit > oneOf > item 2`


Type	`const`
Required	No

Description: Never add a space before the unit

Specific value: "never"

4.11. Property `JSON config > display > temp`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how temperature values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- unit	No	Combination	No	-	Set the unit of temperature
- ndigits	No	integer	No	-	Set the number of digits to keep after the decimal point when formatting temperature values
- color	No	object	No	-	Set colors used in different states of temperature values
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to put a space before the unit

4.11.1. Property `JSON config > display > temp > unit`


Type	`combining`
Required	No
Default	`"D"`

Description: Set the unit of temperature

One of(Option)
item 0
item 1
item 2
item 3

4.11.1.1. Property `JSON config > display > temp > unit > oneOf > item 0`


Type	`const`
Required	No

Description: Celsius

Specific value: "C"

4.11.1.2. Property `JSON config > display > temp > unit > oneOf > item 1`


Type	`const`
Required	No

Description: Fahrenheit

Specific value: "F"

4.11.1.3. Property `JSON config > display > temp > unit > oneOf > item 2`


Type	`const`
Required	No

Description: Kelvin

Specific value: "K"

4.11.1.4. Property `JSON config > display > temp > unit > oneOf > item 3`


Type	`const`
Required	No

Description: Default (alias for Celsius)

Specific value: "D"

4.11.2. Property `JSON config > display > temp > ndigits`


Type	`integer`
Required	No
Default	`1`

Description: Set the number of digits to keep after the decimal point when formatting temperature values

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.11.3. Property `JSON config > display > temp > color`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set colors used in different states of temperature values

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	object	No	In #/$defs/colors	Color used in green state
- yellow	No	object	No	In #/$defs/colors	Color used in yellow state
- red	No	object	No	In #/$defs/colors	Color used in red state

4.11.3.1. Property `JSON config > display > temp > color > green`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"green"`
Defined in	#/$defs/colors

Description: Color used in green state

One of(Option)
item 0
item 1

4.11.3.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.11.3.1.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.11.3.2. Property `JSON config > display > temp > color > yellow`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_yellow"`
Defined in	#/$defs/colors

Description: Color used in yellow state

One of(Option)
item 0
item 1

4.11.3.2.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.11.3.2.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.11.3.3. Property `JSON config > display > temp > color > red`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_red"`
Defined in	#/$defs/colors

Description: Color used in red state

One of(Option)
item 0
item 1

4.11.3.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.11.3.3.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.11.4. Property `JSON config > display > temp > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to put a space before the unit

4.12. Property `JSON config > display > bar`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the bar configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
- char	No	object	No	-	Set the characters used in the bar
- border	No	Combination	No	-	-
- color	No	Combination	No	-	-
- width	No	integer	No	-	Set the width of the bar, in number of characters

4.12.1. Property `JSON config > display > bar > char`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the characters used in the bar

Property	Pattern	Type	Deprecated	Definition	Title/Description
- elapsed	No	string	No	-	Set the character to use in elapsed part
- total	No	string	No	-	Set the character to use in total part

4.12.1.1. Property `JSON config > display > bar > char > elapsed`


Type	`string`
Required	No
Default	`"■"`

Description: Set the character to use in elapsed part

4.12.1.2. Property `JSON config > display > bar > char > total`


Type	`string`
Required	No
Default	`"-"`

Description: Set the character to use in total part

4.12.2. Property `JSON config > display > bar > border`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

4.12.2.1. Property `JSON config > display > bar > border > oneOf > item 0`


Type	`null`
Required	No

Description: Disable bar borders

4.12.2.2. Property `JSON config > display > bar > border > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the string to use of borders of percentage bars

Property	Pattern	Type	Deprecated	Definition	Title/Description
- left	No	string	No	-	Set the string to use at left border
- right	No	string	No	-	Set the string to use at right border
- leftElapsed	No	string	No	-	If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content
- rightElapsed	No	string	No	-	If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content

4.12.2.2.1. Property `JSON config > display > bar > border > oneOf > item 1 > left`


Type	`string`
Required	No
Default	`"[ "`

Description: Set the string to use at left border

4.12.2.2.2. Property `JSON config > display > bar > border > oneOf > item 1 > right`


Type	`string`
Required	No
Default	`" ]"`

Description: Set the string to use at right border

4.12.2.2.3. Property `JSON config > display > bar > border > oneOf > item 1 > leftElapsed`


Type	`string`
Required	No
Default	`""`

Description: If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content

4.12.2.2.4. Property `JSON config > display > bar > border > oneOf > item 1 > rightElapsed`


Type	`string`
Required	No
Default	`""`

Description: If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content

4.12.3. Property `JSON config > display > bar > color`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

4.12.3.1. Property `JSON config > display > bar > color > oneOf > item 0`


Type	`null`
Required	No

Description: Disable color in percentage bars

4.12.3.2. Property `JSON config > display > bar > color > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the color to use of percentage bars

Property	Pattern	Type	Deprecated	Definition	Title/Description
- elapsed	No	object	No	In #/$defs/colors	Color to use in the elapsed part of percentage bars By default, auto selected by percent.color.{green,yellow,red}
- total	No	object	No	In #/$defs/colors	Color to use in the total part of percentage bars
- border	No	object	No	In #/$defs/colors	Color to use in the borders of percentage bars

4.12.3.2.1. Property `JSON config > display > bar > color > oneOf > item 1 > elapsed`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"auto"`
Defined in	#/$defs/colors

Description: Color to use in the elapsed part of percentage bars By default, auto selected by percent.color.{green,yellow,red}

One of(Option)
item 0
item 1

4.12.3.2.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.12.3.2.1.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.12.3.2.2. Property `JSON config > display > bar > color > oneOf > item 1 > total`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_white"`
Defined in	#/$defs/colors

Description: Color to use in the total part of percentage bars

One of(Option)
item 0
item 1

4.12.3.2.2.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.12.3.2.2.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.12.3.2.3. Property `JSON config > display > bar > color > oneOf > item 1 > border`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_white"`
Defined in	#/$defs/colors

Description: Color to use in the borders of percentage bars

One of(Option)
item 0
item 1

4.12.3.2.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.12.3.2.3.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.12.4. Property `JSON config > display > bar > width`


Type	`integer`
Required	No
Default	`10`

Description: Set the width of the bar, in number of characters

Restrictions
Minimum	≥ 1

4.13. Property `JSON config > display > percent`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how percentage values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	object	No	In #/$defs/percentType	Set the percentage output type
- ndigits	No	number	No	-	Set the number of digits to keep after the decimal point when formatting percentage numbers
- color	No	object	No	-	Set colors used in different states of percentage bars and numbers
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to put a space before the unit
- width	No	integer	No	-	Set the width of the percentage number, in number of characters

4.13.1. Property `JSON config > display > percent > type`


Type	`combining`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/percentType

Description: Set the percentage output type

One of(Option)
item 0
item 1

4.13.1.1. Property `JSON config > display > percent > type > oneOf > item 0`


Type	`number`
Required	No
Default	`9`

Description: 0 to use global setting, 1 for percentage number, 2 for multi-color bar, 3 for both, 6 for bar only, 9 for colored number, 10 for monochrome bar

Restrictions
Minimum	≥ 0
Maximum	≤ 255

4.13.1.2. Property `JSON config > display > percent > type > oneOf > item 1`


Type	`array of enum (of string)`
Required	No
Default	`["num", "num-color"]`

Description: Array of string flags

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 1 items	-

4.13.1.2.1. JSON config > display > percent > type > oneOf > item 1 > item 1 items


Type	`enum (of string)`
Required	No

Must be one of:

"num"
"bar"
"hide-others"
"num-color"
"bar-monochrome"

4.13.2. Property `JSON config > display > percent > ndigits`


Type	`number`
Required	No
Default	`0`

Description: Set the number of digits to keep after the decimal point when formatting percentage numbers

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.13.3. Property `JSON config > display > percent > color`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set colors used in different states of percentage bars and numbers

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	object	No	In #/$defs/colors	Color used in green state
- yellow	No	object	No	In #/$defs/colors	Color used in yellow state
- red	No	object	No	In #/$defs/colors	Color used in red state

4.13.3.1. Property `JSON config > display > percent > color > green`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"green"`
Defined in	#/$defs/colors

Description: Color used in green state

One of(Option)
item 0
item 1

4.13.3.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.13.3.1.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.13.3.2. Property `JSON config > display > percent > color > yellow`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_yellow"`
Defined in	#/$defs/colors

Description: Color used in yellow state

One of(Option)
item 0
item 1

4.13.3.2.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.13.3.2.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.13.3.3. Property `JSON config > display > percent > color > red`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_red"`
Defined in	#/$defs/colors

Description: Color used in red state

One of(Option)
item 0
item 1

4.13.3.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

Examples:

"reset_"

"bright_"

"dim_"

"italic_"

"underline_"

"blink_"

"inverse_"

"hidden_"

"strike_"

"light_"

"black"

"red"

"green"

"yellow"

"blue"

"magenta"

"cyan"

"white"

"default"

4.13.3.3.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.13.4. Property `JSON config > display > percent > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to put a space before the unit

4.13.5. Property `JSON config > display > percent > width`


Type	`integer`
Required	No
Default	`0`

Description: Set the width of the percentage number, in number of characters

Restrictions
Minimum	≥ 0

4.14. Property `JSON config > display > freq`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how frequency values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- ndigits	No	Combination	No	-	Set the number of decimal places to display when formatting frequency values
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to put a space before the unit

4.14.1. Property `JSON config > display > freq > ndigits`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`2`

Description: Set the number of decimal places to display when formatting frequency values

One of(Option)
item 0
item 1

4.14.1.1. Property `JSON config > display > freq > ndigits > oneOf > item 0`


Type	`integer`
Required	No

Description: Integer value displays the frequency in GHz with specified decimal places

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.14.1.2. Property `JSON config > display > freq > ndigits > oneOf > item 1`


Type	`null`
Required	No

Description: Null value display the frequency as integer MHz

4.14.2. Property `JSON config > display > freq > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to put a space before the unit

4.15. Property `JSON config > display > duration`


Type	`object`
Required	No
Additional properties	Any type allowed

Description: Set how duration values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- abbreviation	No	boolean	No	-	Set whether to abbreviate duration values If true, the output will be in the form of "1h 2m" instead of "1 hour, 2 mins"
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to put a space before the unit

4.15.1. Property `JSON config > display > duration > abbreviation`


Type	`boolean`
Required	No
Default	`false`

Description: Set whether to abbreviate duration values If true, the output will be in the form of "1h 2m" instead of "1 hour, 2 mins"

4.15.2. Property `JSON config > display > duration > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to put a space before the unit

4.16. Property `JSON config > display > fraction`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how ordinary fraction numbers should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- ndigits	No	Combination	No	-	-
- trailingZeros	No	Combination	No	-	Set when to keep trailing zeros

4.16.1. Property `JSON config > display > fraction > ndigits`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`2`

One of(Option)
item 0
item 1

4.16.1.1. Property `JSON config > display > fraction > ndigits > oneOf > item 0`


Type	`number`
Required	No

Description: Set the number of digits to keep after the decimal point when formatting ordinary fraction numbers

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.16.1.2. Property `JSON config > display > fraction > ndigits > oneOf > item 1`


Type	`null`
Required	No

Description: The number of digits will be automatically determined based on the value

4.16.2. Property `JSON config > display > fraction > trailingZeros`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`null`

Description: Set when to keep trailing zeros

One of(Option)
item 0
item 1
item 2
item 3

4.16.2.1. Property `JSON config > display > fraction > trailingZeros > oneOf > item 0`


Type	`null`
Required	No

Description: Same as default

4.16.2.2. Property `JSON config > display > fraction > trailingZeros > oneOf > item 1`


Type	`const`
Required	No

Description: Use the behavior defined internally

Specific value: "default"

4.16.2.3. Property `JSON config > display > fraction > trailingZeros > oneOf > item 2`


Type	`const`
Required	No

Description: Always keep trailing zeros

Specific value: "always"

4.16.2.4. Property `JSON config > display > fraction > trailingZeros > oneOf > item 3`


Type	`const`
Required	No

Description: Never keep trailing zeros

Specific value: "never"

4.17. Property `JSON config > display > noBuffer`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to disable the stdout application buffer

4.18. Property `JSON config > display > constants`


Type	`array of string`
Required	No

Description: List of strings to be used in custom format of modules

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
constants items	-

4.18.1. JSON config > display > constants > constants items


Type	`string`
Required	No

5. Property `JSON config > modules`


Type	`array`
Required	No

Description: Fastfetch modules to run

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
modules items	-

5.1. JSON config > modules > modules items


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1

5.1.1. Property `JSON config > modules > modules items > anyOf > item 0`


Type	`enum (of string)`
Required	No

Description: Run module with default configurations

Must be one of:

"battery"
"bios"
"bluetooth"
"bluetoothradio"
"board"
"bootmgr"
"break"
"brightness"
"btrfs"
"camera"
"chassis"
"cpu"
"cpucache"
"cpuusage"
"command"
"colors"
"cursor"
"datetime"
"display"
"disk"
"diskio"
"de"
"dns"
"editor"
"font"
"gamepad"
"gpu"
"host"
"icons"
"initsystem"
"keyboard"
"kernel"
"lm"
"loadavg"
"locale"
"localip"
"media"
"memory"
"monitor"
"mouse"
"netio"
"opencl"
"opengl"
"os"
"packages"
"physicaldisk"
"physicalmemory"
"player"
"poweradapter"
"processes"
"publicip"
"separator"
"shell"
"sound"
"swap"
"terminal"
"terminalfont"
"terminalsize"
"terminaltheme"
"title"
"theme"
"tpm"
"uptime"
"users"
"version"
"vulkan"
"wallpaper"
"weather"
"wm"
"wifi"
"wmtheme"
"zpool"

5.1.2. Property `JSON config > modules > modules items > anyOf > item 1`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Run module with custom configurations

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ type	No	string	No	-	-

One of(Option)
Break
Battery
BIOS
Bluetooth
Bluetooth Radio
Board
Boot Manager
Brightness
BTRFS
Camera
Chassis
CPU
CPU Cache
CPU Usage
Colors
Command
Cursor
Custom
Date Time
Display
Disk
DiskIO
Desktop Environment
DNS
Editor
Font
Gamepad
GPU
Host
Icons
Init System
Kernel
Keyboard
Login Manager
Local IP
Loadavg
Locale
Media
Memory
Mouse
Monitor
NetIO
OpenCL
OpenGL
Operating System
Packages
Physical Disk
Physical Memory
Player
Power Adapter
Processes
Public IP
Separator
Shell
Sound
Swap
Terminal
Terminal Font
Terminal Size
Terminal Theme
Theme
Title
TPM
Users
Uptime
Version
Vulkan
Wallpaper
Weather
Wi-Fi
Window Manager
WM Theme
Zpool

5.1.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break`

Title: Break


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print a empty line
- condition	No	object	No	In #/$defs/conditions	Only show the module if conditions are met

5.1.2.1.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > type`


Type	`const`
Required	No

Description: Print a empty line

Specific value: "break"

5.1.2.1.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Defined in	#/$defs/conditions

Description: Only show the module if conditions are met

Property	Pattern	Type	Deprecated	Definition	Title/Description
- system	No	Combination	No	-	System name to match
- !system	No	Combination	No	-	System name to not match
- arch	No	Combination	No	-	Architecture to match
- !arch	No	Combination	No	-	Architecture to not match
- succeeded	No	Combination	No	-	Whether the module succeeded in the last run

5.1.2.1.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: System name to match

One of(Option)
systems
item 1
item 2

5.1.2.1.2.1.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > systems`


Type	`enum (of string)`
Required	No
Defined in	#/$defs/systems

Must be one of:

"Android"
"Linux"
"DragonFly"
"MidnightBSD"
"FreeBSD"
"macOS"
"Windows"
"SunOS"
"OpenBSD"
"NetBSD"
"Haiku"

5.1.2.1.2.1.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1`


Type	`array`
Required	No

Description: Array of system names to match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
systems	-

5.1.2.1.2.1.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1 > systems


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0

5.1.2.1.2.1.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 2`


Type	`null`
Required	No

Description: Null to disable this condition

5.1.2.1.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: System name to not match

One of(Option)
systems
item 1
item 2

5.1.2.1.2.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > systems`


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0

5.1.2.1.2.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1`


Type	`array`
Required	No

Description: Array of system names to not match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
systems	-

5.1.2.1.2.2.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1 > systems


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0

5.1.2.1.2.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 2`


Type	`null`
Required	No

Description: Null to disable this condition

5.1.2.1.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Architecture to match

One of(Option)
architectures
item 1
item 2

5.1.2.1.2.3.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > architectures`


Type	`enum (of string)`
Required	No
Defined in	#/$defs/architectures

Must be one of:

"x86_64"
"i386"
"ia64"
"aarch64"
"arm"
"mips"
"powerpc"
"riscv"
"s390x"
"loongarch"
"sparc"
"alpha"
"hppa"
"m68k"

5.1.2.1.2.3.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1`


Type	`array`
Required	No

Description: Array of architectures to match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
architectures	-

5.1.2.1.2.3.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1 > architectures


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0

5.1.2.1.2.3.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 2`


Type	`null`
Required	No

Description: Null to disable this condition

5.1.2.1.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Architecture to not match

One of(Option)
architectures
item 1
item 2

5.1.2.1.2.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > architectures`


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0

5.1.2.1.2.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1`


Type	`array`
Required	No

Description: Array of architectures to not match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
architectures	-

5.1.2.1.2.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1 > architectures


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0

5.1.2.1.2.4.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 2`


Type	`null`
Required	No

Description: Null to disable this condition

5.1.2.1.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Whether the module succeeded in the last run

One of(Option)
item 0
item 1

5.1.2.1.2.5.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 0`


Type	`boolean`
Required	No

Description: True to only show the module if it succeeded, false to only show it if it failed

5.1.2.1.2.5.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 1`


Type	`null`
Required	No

Description: Null to disable this condition

5.1.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery`

Title: Battery


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print battery capacity, status, etc
- useSetupApi	No	boolean	No	-	Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only
- temp	No	object	No	In #/$defs/temperature	Detect and display temperature if supported
- percent	No	object	No	In #/$defs/percent	Thresholds for percentage colors
- key	No	string	No	In #/$defs/key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	In #/$defs/keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	In #/$defs/keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	In #/$defs/keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	In #/$defs/outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/batteryFormat	Output format of the module `Battery`. See Wiki for formatting syntax 1. {manufacturer}: Battery manufacturer 2. {model-name}: Battery model name 3. {technology}: Battery technology 4. {capacity}: Battery capacity (percentage num) 5. {status}: Battery status 6. {temperature}: Battery temperature (formatted) 7. {cycle-count}: Battery cycle count 8. {serial}: Battery serial number 9. {manufacture-date}: Battery manufactor date 10. {capacity-bar}: Battery capacity (percentage bar) 11. {time-days}: Battery time remaining days 12. {time-hours}: Battery time remaining hours 13. {time-minutes}: Battery time remaining minutes 14. {time-seconds}: Battery time remaining seconds 15. {time-formatted}: Battery time remaining (formatted)
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > type`


Type	`const`
Required	No

Description: Print battery capacity, status, etc

Specific value: "battery"

5.1.2.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > useSetupApi`


Type	`boolean`
Required	No
Default	`false`

Description: Set if SetupAPI should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only

5.1.2.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp`


Type	`combining`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/temperature

Description: Detect and display temperature if supported

One of(Option)
item 0
item 1

5.1.2.2.3.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 0`


Type	`boolean`
Required	No
Default	`false`

5.1.2.2.3.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	integer	No	-	Values (in celsius) less than green will be shown in green
- yellow	No	integer	No	-	Values (in celsius) greater than green and less than yellow will be shown in yellow. Values greater than yellow will be shown in red

5.1.2.2.3.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > green`


Type	`integer`
Required	No

Description: Values (in celsius) less than green will be shown in green

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.3.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > yellow`


Type	`integer`
Required	No

Description: Values (in celsius) greater than green and less than yellow will be shown in yellow. Values greater than yellow will be shown in red

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Defined in	#/$defs/percent

Description: Thresholds for percentage colors

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	integer	No	-	Values less than green will be shown in green
- yellow	No	integer	No	-	Values greater than green and less than yellow will be shown in yellow. Values greater than yellow will be shown in red
- type	No	object	No	Same as type	Set the percentage output type

5.1.2.2.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > green`


Type	`integer`
Required	No

Description: Values less than green will be shown in green

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > yellow`


Type	`integer`
Required	No

Description: Values greater than green and less than yellow will be shown in yellow. Values greater than yellow will be shown in red

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.4.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > type`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	type

Description: Set the percentage output type

5.1.2.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > key`


Type	`string`
Required	No
Defined in	#/$defs/key

Description: Key of the module One whitespace character ( ) can be used to hide the key

Restrictions
Min length	1

5.1.2.2.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.2.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyIcon`


Type	`string`
Required	No
Defined in	#/$defs/keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.2.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyWidth`


Type	`integer`
Required	No
Defined in	#/$defs/keyWidth

Description: Width of the module key to override the global setting display.keyWidth

Restrictions
Minimum	≥ 1

5.1.2.2.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.2.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > format`


Type	`string`
Required	No
Defined in	#/$defs/batteryFormat

Description: Output format of the module Battery. See Wiki for formatting syntax 1. {manufacturer}: Battery manufacturer 2. {model-name}: Battery model name 3. {technology}: Battery technology 4. {capacity}: Battery capacity (percentage num) 5. {status}: Battery status 6. {temperature}: Battery temperature (formatted) 7. {cycle-count}: Battery cycle count 8. {serial}: Battery serial number 9. {manufacture-date}: Battery manufactor date 10. {capacity-bar}: Battery capacity (percentage bar) 11. {time-days}: Battery time remaining days 12. {time-hours}: Battery time remaining hours 13. {time-minutes}: Battery time remaining minutes 14. {time-seconds}: Battery time remaining seconds 15. {time-formatted}: Battery time remaining (formatted)

5.1.2.2.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS`

Title: BIOS


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print information of 1st-stage bootloader (name, version, release date, etc)
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/biosFormat	Output format of the module `BIOS`. See Wiki for formatting syntax 1. {date}: Bios date 2. {release}: Bios release 3. {vendor}: Bios vendor 4. {version}: Bios version 5. {type}: Firmware type
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.3.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > type`


Type	`const`
Required	No

Description: Print information of 1st-stage bootloader (name, version, release date, etc)

Specific value: "bios"

5.1.2.3.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.3.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.3.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.3.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.3.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.3.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > format`


Type	`string`
Required	No
Defined in	#/$defs/biosFormat

Description: Output format of the module BIOS. See Wiki for formatting syntax 1. {date}: Bios date 2. {release}: Bios release 3. {vendor}: Bios vendor 4. {version}: Bios version 5. {type}: Firmware type

5.1.2.3.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth`

Title: Bluetooth


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	List (connected) bluetooth devices
- showDisconnected	No	boolean	No	-	Set if disconnected bluetooth devices should be printed
- percent	No	object	No	Same as percent	Thresholds for percentage colors
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/bluetoothFormat	Output format of the module `Bluetooth`. See Wiki for formatting syntax 1. {name}: Name 2. {address}: Address 3. {type}: Type 4. {battery-percentage}: Battery percentage number 5. {connected}: Is connected 6. {battery-percentage-bar}: Battery percentage bar
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > type`


Type	`const`
Required	No

Description: List (connected) bluetooth devices

Specific value: "bluetooth"

5.1.2.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > showDisconnected`


Type	`boolean`
Required	No
Default	`false`

Description: Set if disconnected bluetooth devices should be printed

5.1.2.4.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Thresholds for percentage colors

5.1.2.4.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.4.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.4.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.4.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.4.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.4.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > format`


Type	`string`
Required	No
Defined in	#/$defs/bluetoothFormat

Description: Output format of the module Bluetooth. See Wiki for formatting syntax 1. {name}: Name 2. {address}: Address 3. {type}: Type 4. {battery-percentage}: Battery percentage number 5. {connected}: Is connected 6. {battery-percentage-bar}: Battery percentage bar

5.1.2.4.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio`

Title: Bluetooth Radio


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	List bluetooth radios width supported version and vendor
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/bluetoothradioFormat	Output format of the module `BluetoothRadio`. See Wiki for formatting syntax 1. {name}: Radio name for discovering 2. {address}: Address 3. {lmp-version}: LMP version 4. {lmp-subversion}: LMP subversion 5. {version}: Bluetooth version 6. {vendor}: Vendor 7. {discoverable}: Discoverable 8. {connectable}: Connectable / Pairable
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.5.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > type`


Type	`const`
Required	No

Description: List bluetooth radios width supported version and vendor

Specific value: "bluetoothradio"

5.1.2.5.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.5.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.5.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.5.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.5.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.5.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > format`


Type	`string`
Required	No
Defined in	#/$defs/bluetoothradioFormat

Description: Output format of the module BluetoothRadio. See Wiki for formatting syntax 1. {name}: Radio name for discovering 2. {address}: Address 3. {lmp-version}: LMP version 4. {lmp-subversion}: LMP subversion 5. {version}: Bluetooth version 6. {vendor}: Vendor 7. {discoverable}: Discoverable 8. {connectable}: Connectable / Pairable

5.1.2.5.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board`

Title: Board


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print motherboard name and other info
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/boardFormat	Output format of the module `Board`. See Wiki for formatting syntax 1. {name}: Board name 2. {vendor}: Board vendor 3. {version}: Board version 4. {serial}: Board serial number
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.6.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > type`


Type	`const`
Required	No

Description: Print motherboard name and other info

Specific value: "board"

5.1.2.6.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.6.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.6.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.6.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.6.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.6.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > format`


Type	`string`
Required	No
Defined in	#/$defs/boardFormat

Description: Output format of the module Board. See Wiki for formatting syntax 1. {name}: Board name 2. {vendor}: Board vendor 3. {version}: Board version 4. {serial}: Board serial number

5.1.2.6.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager`

Title: Boot Manager


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print information of 2nd-stage bootloader (name, firmware, etc)
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/bootmgrFormat	Output format of the module `Bootmgr`. See Wiki for formatting syntax 1. {name}: Name / description 2. {firmware-path}: Firmware file path 3. {firmware-name}: Firmware file name 4. {secure-boot}: Is secure boot enabled 5. {order}: Boot order
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.7.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > type`


Type	`const`
Required	No

Description: Print information of 2nd-stage bootloader (name, firmware, etc)

Specific value: "bootmgr"

5.1.2.7.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.7.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.7.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.7.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.7.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.7.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > format`


Type	`string`
Required	No
Defined in	#/$defs/bootmgrFormat

Description: Output format of the module Bootmgr. See Wiki for formatting syntax 1. {name}: Name / description 2. {firmware-path}: Firmware file path 3. {firmware-name}: Firmware file name 4. {secure-boot}: Is secure boot enabled 5. {order}: Boot order

5.1.2.7.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness`

Title: Brightness


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print current brightness level of your monitors
- percent	No	object	No	Same as percent	Thresholds for percentage colors
- ddcciSleep	No	integer	No	-	Set the sleep times (in ms) when sending DDC/CI requests. See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for detail
- compact	No	boolean	No	-	Set if multiple results should be printed in one line
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/brightnessFormat	Output format of the module `Brightness`. See Wiki for formatting syntax 1. {percentage}: Screen brightness (percentage num) 2. {name}: Screen name 3. {max}: Maximum brightness value 4. {min}: Minimum brightness value 5. {current}: Current brightness value 6. {percentage-bar}: Screen brightness (percentage bar) 7. {is-builtin}: Is built-in screen
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.8.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > type`


Type	`const`
Required	No

Description: Print current brightness level of your monitors

Specific value: "brightness"

5.1.2.8.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Thresholds for percentage colors

5.1.2.8.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep`


Type	`integer`
Required	No
Default	`10`

Description: Set the sleep times (in ms) when sending DDC/CI requests. See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for detail

Restrictions
Minimum	≥ 0
Maximum	≤ 400

5.1.2.8.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > compact`


Type	`boolean`
Required	No
Default	`false`

Description: Set if multiple results should be printed in one line

5.1.2.8.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.8.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.8.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.8.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.8.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.8.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > format`


Type	`string`
Required	No
Defined in	#/$defs/brightnessFormat

Description: Output format of the module Brightness. See Wiki for formatting syntax 1. {percentage}: Screen brightness (percentage num) 2. {name}: Screen name 3. {max}: Maximum brightness value 4. {min}: Minimum brightness value 5. {current}: Current brightness value 6. {percentage-bar}: Screen brightness (percentage bar) 7. {is-builtin}: Is built-in screen

5.1.2.8.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS`

Title: BTRFS


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print Linux BTRFS volumes
- percent	No	object	No	Same as percent	Thresholds for percentage colors
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/btrfsFormat	Output format of the module `Btrfs`. See Wiki for formatting syntax 1. {name}: Name / Label 2. {uuid}: UUID 3. {devices}: Associated devices 4. {features}: Enabled features 5. {used}: Size used 6. {allocated}: Size allocated 7. {total}: Size total 8. {used-percentage}: Used percentage num 9. {allocated-percentage}: Allocated percentage num 10. {used-percentage-bar}: Used percentage bar 11. {allocated-percentage-bar}: Allocated percentage bar 12. {node-size}: Node size 13. {sector-size}: Sector size
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.9.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > type`


Type	`const`
Required	No

Description: Print Linux BTRFS volumes

Specific value: "btrfs"

5.1.2.9.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Thresholds for percentage colors

5.1.2.9.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.9.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.9.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.9.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.9.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.9.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > format`


Type	`string`
Required	No
Defined in	#/$defs/btrfsFormat

Description: Output format of the module Btrfs. See Wiki for formatting syntax 1. {name}: Name / Label 2. {uuid}: UUID 3. {devices}: Associated devices 4. {features}: Enabled features 5. {used}: Size used 6. {allocated}: Size allocated 7. {total}: Size total 8. {used-percentage}: Used percentage num 9. {allocated-percentage}: Allocated percentage num 10. {used-percentage-bar}: Used percentage bar 11. {allocated-percentage-bar}: Allocated percentage bar 12. {node-size}: Node size 13. {sector-size}: Sector size

5.1.2.9.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera`

Title: Camera


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print available cameras
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/cameraFormat	Output format of the module `Camera`. See Wiki for formatting syntax 1. {name}: Device name 2. {vendor}: Vendor 3. {colorspace}: Color space 4. {id}: Identifier 5. {width}: Width (in px) 6. {height}: Height (in px)
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.10.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > type`


Type	`const`
Required	No

Description: Print available cameras

Specific value: "camera"

5.1.2.10.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.10.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.10.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.10.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.10.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.10.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > format`


Type	`string`
Required	No
Defined in	#/$defs/cameraFormat

Description: Output format of the module Camera. See Wiki for formatting syntax 1. {name}: Device name 2. {vendor}: Vendor 3. {colorspace}: Color space 4. {id}: Identifier 5. {width}: Width (in px) 6. {height}: Height (in px)

5.1.2.10.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis`

Title: Chassis


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print chassis type (desktop, laptop, etc)
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/chassisFormat	Output format of the module `Chassis`. See Wiki for formatting syntax 1. {type}: Chassis type 2. {vendor}: Chassis vendor 3. {version}: Chassis version 4. {serial}: Chassis serial number
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.11.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > type`


Type	`const`
Required	No

Description: Print chassis type (desktop, laptop, etc)

Specific value: "chassis"

5.1.2.11.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.11.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.11.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.11.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.11.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.11.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > format`


Type	`string`
Required	No
Defined in	#/$defs/chassisFormat

Description: Output format of the module Chassis. See Wiki for formatting syntax 1. {type}: Chassis type 2. {vendor}: Chassis vendor 3. {version}: Chassis version 4. {serial}: Chassis serial number

5.1.2.11.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.12. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU`

Title: CPU


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print CPU name, frequency, etc
- temp	No	object	No	Same as temp	Detect and display temperature if supported
- showPeCoreCount	No	boolean	No	-	Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/cpuFormat	Output format of the module `CPU`. See Wiki for formatting syntax 1. {name}: Name 2. {vendor}: Vendor 3. {cores-physical}: Physical core count 4. {cores-logical}: Logical core count 5. {cores-online}: Online core count 6. {freq-base}: Base frequency (formatted) 7. {freq-max}: Max frequency (formatted) 8. {temperature}: Temperature (formatted) 9. {core-types}: Logical core count grouped by frequency 10. {packages}: Processor package count 11. {march}: X86-64 CPU microarchitecture
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.12.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > type`


Type	`const`
Required	No

Description: Print CPU name, frequency, etc

Specific value: "cpu"

5.1.2.12.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > temp`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	temp

Description: Detect and display temperature if supported

5.1.2.12.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > showPeCoreCount`


Type	`boolean`
Required	No
Default	`false`

Description: Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported

5.1.2.12.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.12.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.12.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.12.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.12.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.12.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > format`


Type	`string`
Required	No
Defined in	#/$defs/cpuFormat

Description: Output format of the module CPU. See Wiki for formatting syntax 1. {name}: Name 2. {vendor}: Vendor 3. {cores-physical}: Physical core count 4. {cores-logical}: Logical core count 5. {cores-online}: Online core count 6. {freq-base}: Base frequency (formatted) 7. {freq-max}: Max frequency (formatted) 8. {temperature}: Temperature (formatted) 9. {core-types}: Logical core count grouped by frequency 10. {packages}: Processor package count 11. {march}: X86-64 CPU microarchitecture

5.1.2.12.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.13. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache`

Title: CPU Cache


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print CPU cache sizes
- percent	No	object	No	Same as percent	Thresholds for percentage colors
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/cpucacheFormat	Output format of the module `CPUCache`. See Wiki for formatting syntax 1. {result}: Separate result 2. {sum}: Sum result
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.13.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > type`


Type	`const`
Required	No

Description: Print CPU cache sizes

Specific value: "cpucache"

5.1.2.13.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Thresholds for percentage colors

5.1.2.13.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.13.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.13.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.13.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.13.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.13.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > format`


Type	`string`
Required	No
Defined in	#/$defs/cpucacheFormat

Description: Output format of the module CPUCache. See Wiki for formatting syntax 1. {result}: Separate result 2. {sum}: Sum result

5.1.2.13.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.14. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage`

Title: CPU Usage


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print CPU usage. Costs some time to collect data
- percent	No	object	No	Same as percent	Thresholds for percentage colors
- separate	No	boolean	No	-	Display CPU usage per CPU logical core, instead of an average result
- waitTime	No	integer	No	-	Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/cpuusageFormat	Output format of the module `CPUUsage`. See Wiki for formatting syntax 1. {avg}: CPU usage (percentage num, average) 2. {max}: CPU usage (percentage num, maximum) 3. {max-index}: CPU core index of maximum usage 4. {min}: CPU usage (percentage num, minimum) 5. {min-index}: CPU core index of minimum usage 6. {avg-bar}: CPU usage (percentage bar, average) 7. {max-bar}: CPU usage (percentage bar, maximum) 8. {min-bar}: CPU usage (percentage bar, minimum)
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.14.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > type`


Type	`const`
Required	No

Description: Print CPU usage. Costs some time to collect data

Specific value: "cpuusage"

5.1.2.14.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Thresholds for percentage colors

5.1.2.14.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > separate`


Type	`boolean`
Required	No
Default	`false`

Description: Display CPU usage per CPU logical core, instead of an average result

5.1.2.14.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > waitTime`


Type	`integer`
Required	No
Default	`200`

Description: Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime

Restrictions
Minimum	≥ 1

5.1.2.14.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.14.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.14.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.14.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.14.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.14.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > format`


Type	`string`
Required	No
Defined in	#/$defs/cpuusageFormat

Description: Output format of the module CPUUsage. See Wiki for formatting syntax 1. {avg}: CPU usage (percentage num, average) 2. {max}: CPU usage (percentage num, maximum) 3. {max-index}: CPU core index of maximum usage 4. {min}: CPU usage (percentage num, minimum) 5. {min-index}: CPU core index of minimum usage 6. {avg-bar}: CPU usage (percentage bar, average) 7. {max-bar}: CPU usage (percentage bar, maximum) 8. {min-bar}: CPU usage (percentage bar, minimum)

5.1.2.14.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.15. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors`

Title: Colors


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print some colored blocks
- symbol	No	Combination	No	-	Set the symbol to use
- paddingLeft	No	integer	No	-	Set the number of white spaces to print before the symbol
- block	No	object	No	-	Set behavior of block printing
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.15.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > type`


Type	`const`
Required	No

Description: Print some colored blocks

Specific value: "colors"

5.1.2.15.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol`


Type	`combining`
Required	No
Default	`"background"`

Description: Set the symbol to use

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6

5.1.2.15.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 0`


Type	`const`
Required	No

Description: ███

Specific value: "block"

5.1.2.15.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 1`


Type	`const`
Required	No

Description: (whitespaces with background)

Specific value: "background"

5.1.2.15.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 2`


Type	`const`
Required	No

Description: ●

Specific value: "circle"

5.1.2.15.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 3`


Type	`const`
Required	No

Description: ◆

Specific value: "diamond"

5.1.2.15.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 4`


Type	`const`
Required	No

Description: ▲

Specific value: "triangle"

5.1.2.15.2.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 5`


Type	`const`
Required	No

Description: ■

Specific value: "square"

5.1.2.15.2.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 6`


Type	`const`
Required	No

Description: ★

Specific value: "star"

5.1.2.15.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > paddingLeft`


Type	`integer`
Required	No
Default	`0`

Description: Set the number of white spaces to print before the symbol

Restrictions
Minimum	≥ 0

5.1.2.15.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set behavior of block printing

Property	Pattern	Type	Deprecated	Definition	Title/Description
- width	No	integer	No	-	Set the block width in spaces
- range	No	array of integer	No	-	Set the range of colors in the blocks to print

5.1.2.15.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > width`


Type	`integer`
Required	No
Default	`3`

Description: Set the block width in spaces

Restrictions
Minimum	≥ 1

5.1.2.15.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range`


Type	`array of integer`
Required	No

Description: Set the range of colors in the blocks to print

	Array restrictions
Min items	2
Max items	2
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
range items	-

5.1.2.15.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range > range items


Type	`integer`
Required	No

Restrictions
Minimum	≥ 0
Maximum	≤ 15

5.1.2.15.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.15.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.15.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.15.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.15.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.16. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command`

Title: Command


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Running custom shell scripts
- shell	No	string	No	-	Set the shell program to execute the command text Default: cmd for Windows, /bin/sh for *nix
- param	No	string	No	-	Set the parameter used when starting the shell If set to an empty string, it will be ignored Default: /c for Windows, -c for *nix
- text	No	string	No	-	Set the command text to be executed
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/commandFormat	Output format of the module `Command`. See Wiki for formatting syntax 1. {result}: Command result
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.16.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > type`


Type	`const`
Required	No

Description: Running custom shell scripts

Specific value: "command"

5.1.2.16.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > shell`


Type	`string`
Required	No

Description: Set the shell program to execute the command text Default: cmd for Windows, /bin/sh for *nix

5.1.2.16.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > param`


Type	`string`
Required	No

Description: Set the parameter used when starting the shell If set to an empty string, it will be ignored Default: /c for Windows, -c for *nix

5.1.2.16.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > text`


Type	`string`
Required	No

Description: Set the command text to be executed

5.1.2.16.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.16.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.16.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.16.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.16.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.16.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > format`


Type	`string`
Required	No
Defined in	#/$defs/commandFormat

Description: Output format of the module Command. See Wiki for formatting syntax 1. {result}: Command result

5.1.2.16.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.17. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor`

Title: Cursor


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print cursor style name
- percent	No	object	No	Same as percent	Thresholds for percentage colors
- key	No	string	No	Same as key	Key of the module One whitespace character (` `) can be used to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	In #/$defs/cursorFormat	Output format of the module `Cursor`. See Wiki for formatting syntax 1. {theme}: Cursor theme 2. {size}: Cursor size
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.17.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > type`


Type	`const`
Required	No

Description: Print cursor style name

Specific value: "cursor"

5.1.2.17.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Thresholds for percentage colors

5.1.2.17.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module One whitespace character ( ) can be used to hide the key

5.1.2.17.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.17.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.17.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.17.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.17.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > format`


Type	`string`
Required	No
Defined in	#/$defs/cursorFormat

Description: Output format of the module Cursor. See Wiki for formatting syntax 1. {theme}: Cursor theme 2. {size}: Cursor size

5.1.2.17.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Only show the module if conditions are met

5.1.2.18. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom`

Title: Custom


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print a custom string, with or without key
- key	No	string	No	-	Leave empty not to print the key
- keyColor	No	object	No	Same as keyColor	Color of the module key to override the global setting `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key to override the global setting `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Output color of the module to override the global setting `display.color.output`
- format	No	string	No	-	Text to print
- condition	No	object	No	Same as condition	Only show the module if conditions are met

5.1.2.18.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > type`


Type	`const`
Required	No

Description: Print a custom string, with or without key

Specific value: "custom"

5.1.2.18.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > key`


Type	`string`
Required	No

Description: Leave empty not to print the key

5.1.2.18.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key to override the global setting display.color.key

5.1.2.18.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.18.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key to override the global setting display.keyWidth

5.1.2.18.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Output color of the module to override the global setting display.color.output

5.1.2.18.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > format`


Type	`string`
Required	No

Description: Text to print

5.1.2.18.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > condition`

| |

Uh oh!

Json Schema

JSON config

1. Property JSON config > $schema

2. Property JSON config > logo

2.1. Property JSON config > logo > oneOf > item 0

2.2. Property JSON config > logo > oneOf > item 1

2.3. Property JSON config > logo > oneOf > item 2

2.3.1. Property JSON config > logo > oneOf > item 2 > type

2.3.1.1. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 0

2.3.1.2. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 1

2.3.1.3. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 2

2.3.1.4. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 3

2.3.1.5. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 4

2.3.1.6. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 5

2.3.1.7. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 6

2.3.1.8. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 7

2.3.1.9. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 8

2.3.1.10. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 9

2.3.1.11. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 10

2.3.1.12. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 11

2.3.1.13. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 12

2.3.1.14. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 13

2.3.1.15. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 14

2.3.2. Property JSON config > logo > oneOf > item 2 > source

2.3.3. Property JSON config > logo > oneOf > item 2 > color

2.3.3.1. Property JSON config > logo > oneOf > item 2 > color > 1

2.3.3.1.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0

2.3.3.1.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1

2.3.3.2. Property JSON config > logo > oneOf > item 2 > color > 2

2.3.3.3. Property JSON config > logo > oneOf > item 2 > color > 3

2.3.3.4. Property JSON config > logo > oneOf > item 2 > color > 4

2.3.3.5. Property JSON config > logo > oneOf > item 2 > color > 5

2.3.3.6. Property JSON config > logo > oneOf > item 2 > color > 6

2.3.3.7. Property JSON config > logo > oneOf > item 2 > color > 7

2.3.3.8. Property JSON config > logo > oneOf > item 2 > color > 8

2.3.3.9. Property JSON config > logo > oneOf > item 2 > color > 9

2.3.4. Property JSON config > logo > oneOf > item 2 > width

2.3.4.1. Property JSON config > logo > oneOf > item 2 > width > oneOf > item 0

2.3.4.2. Property JSON config > logo > oneOf > item 2 > width > oneOf > item 1

2.3.5. Property JSON config > logo > oneOf > item 2 > height

2.3.5.1. Property JSON config > logo > oneOf > item 2 > height > oneOf > item 0

2.3.5.2. Property JSON config > logo > oneOf > item 2 > height > oneOf > item 1

2.3.6. Property JSON config > logo > oneOf > item 2 > padding

2.3.6.1. Property JSON config > logo > oneOf > item 2 > padding > top

2.3.6.2. Property JSON config > logo > oneOf > item 2 > padding > left

2.3.6.3. Property JSON config > logo > oneOf > item 2 > padding > right

2.3.7. Property JSON config > logo > oneOf > item 2 > printRemaining

2.3.8. Property JSON config > logo > oneOf > item 2 > preserveAspectRatio

2.3.9. Property JSON config > logo > oneOf > item 2 > recache

2.3.10. Property JSON config > logo > oneOf > item 2 > position

2.3.11. Property JSON config > logo > oneOf > item 2 > chafa

2.3.11.1. Property JSON config > logo > oneOf > item 2 > chafa > fgOnly

2.3.11.2. Property JSON config > logo > oneOf > item 2 > chafa > symbols

2.3.11.3. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode

2.3.11.3.1. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0

2.3.11.3.2. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1

2.3.11.3.3. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2

2.3.11.3.4. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3

2.3.11.3.5. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4

2.3.11.3.6. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5

2.3.11.3.7. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6

2.3.11.3.8. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7

2.3.11.4. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace

2.3.11.4.1. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0

2.3.11.4.2. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1

2.3.11.5. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode

2.3.11.5.1. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0

2.3.11.5.2. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1

2.3.11.5.3. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2

3. Property JSON config > general

3.1. Property JSON config > general > thread

3.2. Property JSON config > general > escapeBedrock

3.3. Property JSON config > general > playerName

3.4. Property JSON config > general > dsForceDrm

3.4.1. Property JSON config > general > dsForceDrm > oneOf > item 0

3.4.2. Property JSON config > general > dsForceDrm > oneOf > item 1

3.4.3. Property JSON config > general > dsForceDrm > oneOf > item 2

3.5. Property JSON config > general > wmiTimeout

3.6. Property JSON config > general > processingTimeout

1. Property `JSON config > $schema`

2. Property `JSON config > logo`

2.1. Property `JSON config > logo > oneOf > item 0`

2.2. Property `JSON config > logo > oneOf > item 1`

2.3. Property `JSON config > logo > oneOf > item 2`

2.3.1. Property `JSON config > logo > oneOf > item 2 > type`

2.3.1.1. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 0`

2.3.1.2. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 1`

2.3.1.3. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 2`

2.3.1.4. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 3`

2.3.1.5. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 4`

2.3.1.6. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 5`

2.3.1.7. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 6`

2.3.1.8. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 7`

2.3.1.9. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 8`

2.3.1.10. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 9`

2.3.1.11. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 10`

2.3.1.12. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 11`

2.3.1.13. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 12`

2.3.1.14. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 13`

2.3.1.15. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 14`

2.3.2. Property `JSON config > logo > oneOf > item 2 > source`

2.3.3. Property `JSON config > logo > oneOf > item 2 > color`

2.3.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1`

2.3.3.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`

2.3.3.1.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`

2.3.3.2. Property `JSON config > logo > oneOf > item 2 > color > 2`

2.3.3.3. Property `JSON config > logo > oneOf > item 2 > color > 3`

2.3.3.4. Property `JSON config > logo > oneOf > item 2 > color > 4`

2.3.3.5. Property `JSON config > logo > oneOf > item 2 > color > 5`

2.3.3.6. Property `JSON config > logo > oneOf > item 2 > color > 6`

2.3.3.7. Property `JSON config > logo > oneOf > item 2 > color > 7`

2.3.3.8. Property `JSON config > logo > oneOf > item 2 > color > 8`

2.3.3.9. Property `JSON config > logo > oneOf > item 2 > color > 9`

2.3.4. Property `JSON config > logo > oneOf > item 2 > width`

2.3.4.1. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 0`

2.3.4.2. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 1`

2.3.5. Property `JSON config > logo > oneOf > item 2 > height`

2.3.5.1. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 0`

2.3.5.2. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 1`

2.3.6. Property `JSON config > logo > oneOf > item 2 > padding`

2.3.6.1. Property `JSON config > logo > oneOf > item 2 > padding > top`

2.3.6.2. Property `JSON config > logo > oneOf > item 2 > padding > left`

2.3.6.3. Property `JSON config > logo > oneOf > item 2 > padding > right`

2.3.7. Property `JSON config > logo > oneOf > item 2 > printRemaining`

2.3.8. Property `JSON config > logo > oneOf > item 2 > preserveAspectRatio`

2.3.9. Property `JSON config > logo > oneOf > item 2 > recache`

2.3.10. Property `JSON config > logo > oneOf > item 2 > position`

2.3.11. Property `JSON config > logo > oneOf > item 2 > chafa`

2.3.11.1. Property `JSON config > logo > oneOf > item 2 > chafa > fgOnly`

2.3.11.2. Property `JSON config > logo > oneOf > item 2 > chafa > symbols`

2.3.11.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode`

2.3.11.3.1. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0`

2.3.11.3.2. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1`

2.3.11.3.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2`

2.3.11.3.4. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3`

2.3.11.3.5. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4`

2.3.11.3.6. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5`

2.3.11.3.7. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6`

2.3.11.3.8. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7`

2.3.11.4. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace`

2.3.11.4.1. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0`

2.3.11.4.2. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1`

2.3.11.5. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode`

2.3.11.5.1. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0`

2.3.11.5.2. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1`

2.3.11.5.3. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2`

3. Property `JSON config > general`

3.1. Property `JSON config > general > thread`

3.2. Property `JSON config > general > escapeBedrock`

3.3. Property `JSON config > general > playerName`

3.4. Property `JSON config > general > dsForceDrm`

3.4.1. Property `JSON config > general > dsForceDrm > oneOf > item 0`

3.4.2. Property `JSON config > general > dsForceDrm > oneOf > item 1`

3.4.3. Property `JSON config > general > dsForceDrm > oneOf > item 2`

3.5. Property `JSON config > general > wmiTimeout`

3.6. Property `JSON config > general > processingTimeout`

3.7. Property `JSON config > general > preRun`

3.8. Property `JSON config > general > detectVersion`

4. Property `JSON config > display`