swadhin / fetchx public

docs: add example config file

Swadhin Biswas committed 7 months ago
5e327e2
1 parent 9b09809
commit 5e327e2
1 file changed
+153 -0
Showing 1 changed file+153-0
assets/config.example.toml
▼assets/config.example.toml
+153-0
@@ -0,0 +1,153 @@
1
+# =============================================================================
2
+# FetchX Configuration File
3
+# Location: ~/.config/fetchx/config.toml
4
+#
5
+# FetchX is a fast, modern system info tool (neofetch clone in Rust).
6
+# All options have sensible defaults — only set what you want to change.
7
+# =============================================================================
8
+
9
+# ─── Display Options ─────────────────────────────────────────────────────────
10
+
11
+# Disable all colors
12
+# no_color = false
13
+
14
+# Enable bold text
15
+# bold = true
16
+
17
+# Separator between label and value
18
+# separator = ": "
19
+
20
+
21
+# ─── Text Colors ─────────────────────────────────────────────────────────────
22
+# Either "distro" for automatic color matching, or an array of 6 color numbers:
23
+# [title, @, underline, subtitle, colon, info]
24
+#
25
+# Color numbers: 0=black, 1=red, 2=green, 3=yellow, 4=blue,
26
+# 5=magenta, 6=cyan, 7=white, 8-255=256-color palette
27
+#
28
+# Examples:
29
+# colors = "distro" # auto-detect from distro (default)
30
+# colors = [4, 6, 1, 8, 8, 6] # blue title, cyan @, red underline, etc.
31
+# colors = [6, 6] # cyan title & subtitle, rest default
32
+colors = "distro"
33
+
34
+
35
+# ─── ASCII Art / Logo ────────────────────────────────────────────────────────
36
+
37
+# Image backend: "ascii", "kitty", "sixel", "chafa", "off"
38
+# image_backend = "ascii"
39
+
40
+# Image source: "auto", "ascii", "wallpaper", "/path/to/image.png"
41
+# image_source = "auto"
42
+
43
+# Which distro's ASCII art to display (when image_backend = "ascii")
44
+# Values: "auto", "arch", "ubuntu", "debian", "fedora", "gentoo", "nixos",
45
+# "manjaro", "void", "pop", "cachyos", "endeavouros", "artix", "kali",
46
+# "opensuse", "linuxmint", "alpine", "garuda", "zorin", "elementary",
47
+# "rocky", "alma", "slackware", "centos", "solus", "deepin", "mx",
48
+# "raspbian", "freebsd", "openbsd", "macos", "windows", "android"
49
+# ascii_distro = "auto"
50
+
51
+# Path to a custom ASCII art file (overrides ascii_distro when set)
52
+# The file can use {c1}..{c6} color placeholders, one line per line of art.
53
+# Example: ascii_file = "/home/user/.config/fetchx/my_logo.txt"
54
+# ascii_file = null
55
+
56
+# Colors for ASCII art: "distro" or explicit color numbers
57
+# Examples:
58
+# ascii_colors = "distro" # use distro's default colors
59
+# ascii_colors = [4, 6, 1] # custom colors for {c1}, {c2}, {c3}
60
+ascii_colors = "distro"
61
+
62
+# Bold the ASCII art
63
+# ascii_bold = true
64
+
65
+
66
+# ─── Image Options (for kitty/sixel/chafa backends) ──────────────────────────
67
+
68
+# Path to a custom image file
69
+# custom_image = "/path/to/image.png"
70
+
71
+# Image size: "auto", "none", or dimensions like "300px", "50%"
72
+# image_size = "auto"
73
+
74
+# Crop mode: "normal", "fit", "fill"
75
+# crop_mode = "normal"
76
+
77
+# Crop offset: "center", "north", "south", "east", "west",
78
+# "northwest", "northeast", "southwest", "southeast"
79
+# crop_offset = "center"
80
+
81
+
82
+# ─── Extra Features ──────────────────────────────────────────────────────────
83
+
84
+# Use emoji art instead of ASCII art
85
+# emoji_mode = false
86
+
87
+# Use Nerd Font icons for info labels (requires a Nerd Font terminal font)
88
+# nerd_font = false
89
+
90
+
91
+# ─── Layout ──────────────────────────────────────────────────────────────────
92
+
93
+# Gap between logo/image and info text (characters)
94
+# gap = 3
95
+
96
+# Show only the logo, hide system info
97
+# logo_only = false
98
+
99
+
100
+# ─── Info Fields ─────────────────────────────────────────────────────────────
101
+# Toggle which info lines to display
102
+
103
+show_title = true
104
+show_underline = true
105
+show_os = true
106
+show_host = true
107
+show_kernel = true
108
+show_uptime = true
109
+show_packages = true
110
+show_shell = true
111
+show_resolution = true
112
+show_de = true
113
+show_wm = true
114
+show_wm_theme = true
115
+show_theme = true
116
+show_icons = true
117
+show_terminal = true
118
+show_term_font = true
119
+show_cpu = true
120
+show_gpu = true
121
+show_memory = true
122
+show_disk = false
123
+show_battery = false
124
+show_local_ip = false
125
+show_public_ip = false
126
+show_locale = false
127
+show_colors = true
128
+
129
+
130
+# ─── Color Blocks ───────────────────────────────────────────────────────────
131
+
132
+# Range of colors to display in color blocks
133
+# Default shows all 16 standard terminal colors (0-15)
134
+# block_range = [0, 15]
135
+
136
+# Width of each color block (in spaces)
137
+# block_width = 3
138
+
139
+# Height of color blocks (in lines)
140
+# block_height = 1
141
+
142
+
143
+# ─── Underline ───────────────────────────────────────────────────────────────
144
+
145
+# Character used for the title underline
146
+# underline_char = "-"
147
+
148
+
149
+# ─── Misc ────────────────────────────────────────────────────────────────────
150
+
151
+# Stdout mode: disable colors and image (useful for piping)
152
+# stdout = false
153
+
0
154