You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -130,12 +132,14 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
130
132
```
131
133
132
134
**Options:**
135
+
133
136
-`enableLogo`: Enable/disable logo display (`true` or `false`)
134
137
-`type`: Logo type (`"ascii"` or `"file"` to load from a file)
135
138
-`content`: Custom ASCII content (when type is `"ascii"`)
136
139
-`location`: Text alignment (`"center"`, `"left"`, or `"right"`)
137
140
-`logoPath`: Directory containing logo files
138
141
-`position`: Position relative to system info (`"side"` or `"above"`)
142
+
139
143
</details>
140
144
141
145
<details>
@@ -162,6 +166,7 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
162
166
```
163
167
164
168
**Options:**
169
+
165
170
-`enableImage`/`enabled`: Enable/disable image display (`true` or `false`)
166
171
-`random`: Randomly select an image from the `imagePath` directory (`true` or `false`)
167
172
-`imagePath`: Path to image file or directory (for random selection)
@@ -190,6 +195,7 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
190
195
-`offset`: Offset from terminal edge (integer)
191
196
-`background`: Background color (`"transparent"` or a color value)
192
197
-`position`: Position relative to system info (`"side"` or `"above"`)
198
+
193
199
</details>
194
200
195
201
<details>
@@ -203,10 +209,12 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
203
209
```
204
210
205
211
**Options:**
212
+
206
213
-`showLogoFirst`: When `true`, logo appears before system info
207
214
-`showImageFirst`: When `true`, image appears before system info
208
215
209
216
Note: If both are `true`, logo takes precedence.
217
+
210
218
</details>
211
219
212
220
<details>
@@ -236,6 +244,7 @@ Note: If both are `true`, logo takes precedence.
236
244
```
237
245
238
246
You can also use emoji instead of Nerd Font icons:
247
+
239
248
```json
240
249
"icons": {
241
250
"host": "🏠",
@@ -258,6 +267,7 @@ You can also use emoji instead of Nerd Font icons:
258
267
"icons": "🔍"
259
268
}
260
269
```
270
+
261
271
</details>
262
272
263
273
<details>
@@ -287,6 +297,7 @@ You can also use emoji instead of Nerd Font icons:
287
297
```
288
298
289
299
Set any option to `false` to hide that specific information.
300
+
290
301
</details>
291
302
292
303
### Example Configurations
@@ -316,6 +327,7 @@ Set any option to `false` to hide that specific information.
316
327
}
317
328
}
318
329
```
330
+
319
331
</details>
320
332
321
333
<details>
@@ -352,6 +364,7 @@ Set any option to `false` to hide that specific information.
352
364
}
353
365
}
354
366
```
367
+
355
368
</details>
356
369
357
370
<details>
@@ -441,6 +454,7 @@ Set any option to `false` to hide that specific information.
441
454
}
442
455
}
443
456
```
457
+
444
458
</details>
445
459
446
460
## 🎨 Image Rendering and Dithering
@@ -458,35 +472,11 @@ LunarFetch supports various image rendering techniques to display images in your
458
472
LunarFetch supports multiple protocols for rendering images in the terminal:
459
473
460
474
1.**Chafa**: The most compatible option that works in virtually any terminal. Chafa converts images to colored text characters.
461
-
462
475
2.**Sixel**: A graphics format supported by terminals like xterm with sixel extension, mlterm, and mintty.
463
-
464
476
3.**Kitty Graphics Protocol**: A modern protocol for displaying images in the Kitty terminal.
465
-
466
477
4.**iTerm2 Graphics Protocol**: For displaying images in iTerm2 on macOS.
467
-
468
478
5.**Uberzug**: A Linux-specific tool for displaying images in the terminal.
469
479
470
-
### Understanding Dithering
471
-
472
-
Dithering is a technique used in image processing to create the illusion of color depth in images with a limited color palette. LunarFetch implements the Floyd-Steinberg dithering algorithm, which works as follows:
473
-
474
-
1.**Color Reduction**: When displaying images in terminals with limited color capabilities, dithering helps maintain visual quality while reducing the number of colors used.
475
-
476
-
2.**Error Diffusion**: The algorithm processes each pixel, finds the closest available color, and distributes the error (difference) to neighboring pixels according to a specific pattern:
477
-
```
478
-
X 7/16
479
-
3/16 5/16 1/16
480
-
```
481
-
Where X is the current pixel, and the fractions represent how much of the error is distributed to each neighboring pixel.
482
-
483
-
3.**Visual Benefits**: Dithering creates patterns of dots that, when viewed from a distance, appear to have more colors than are actually used. This is particularly useful for:
484
-
- Smooth gradients
485
-
- Detailed images
486
-
- Photos with subtle color variations
487
-
488
-
To enable dithering, set `"ditherMode": "floyd-steinberg"` in your configuration.
489
-
490
480
## 🤝 Contributing
491
481
492
482
Contributions are welcome! Please feel free to submit a Pull Request.
0 commit comments