Skip to content

Commit 114088b

Browse files
committed
Doc: add comments about displaying image logo on Windows [ci skip]
Fix #1686
1 parent 6e77b59 commit 114088b

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,56 @@ Set the key to a white space.
230230
}
231231
```
232232

233+
### Q: How can I display images on Windows?
234+
235+
As of April 2025:
236+
237+
#### mintty and Wezterm
238+
239+
mintty (used by Bash on Windows and MSYS2) and Wezterm (nightly build only) support the iTerm image protocol on Windows.
240+
241+
In `config.jsonc`:
242+
```json
243+
{
244+
"logo": {
245+
"type": "iterm",
246+
"source": "C:/path/to/image.png",
247+
"width": <num-in-chars>
248+
}
249+
}
250+
```
251+
252+
#### Windows Terminal
253+
254+
Windows Terminal supports the sixel image protocol only.
255+
256+
* If you installed fastfetch through MSYS2:
257+
1. Install imagemagick: `pacman -S mingw-w64-<subsystem>-x86_64-imagemagick`
258+
2. In `config.jsonc`:
259+
```jsonc
260+
{
261+
"logo": {
262+
"type": "sixel", // DO NOT USE "auto"
263+
"source": "C:/path/to/image.png", // Do NOT use `~` as fastfetch is a native Windows program and doesn't apply cygwin path conversion
264+
"width": <image-width-in-chars>, // Optional
265+
"height": <image-height-in-chars> // Optional
266+
}
267+
}
268+
```
269+
* If you installed fastfetch via scoop or downloaded the binary directly from the GitHub Releases page:
270+
1. Convert your image manually to sixel format using [any online image conversion service](https://www.google.com/search?q=convert+image+to+sixel)
271+
2. In `config.jsonc`:
272+
```jsonc
273+
{
274+
"logo": {
275+
"type": "raw", // DO NOT USE "auto"
276+
"source": "C:/path/to/image.sixel",
277+
"width": <image-width-in-chars>, // Required
278+
"height": <image-height-in-chars> // Required
279+
}
280+
}
281+
```
282+
233283
### Q: I want feature A / B / C. Will fastfetch support it?
234284

235285
Fastfetch is a system information tool. We only accept hardware or system-level software feature requests. For most personal uses, I recommend using the `Command` module to implement custom functionality, which can be used to grab output from a custom shell script:

0 commit comments

Comments
 (0)