Skip to content

Latest commit

 

History

History
99 lines (76 loc) · 6.17 KB

README.md

File metadata and controls

99 lines (76 loc) · 6.17 KB
Raw

fastfetch

fastfetch is a neofetch-like tool for fetching system information and displaying them in a pretty way. It is written in c to achieve much better performance, in return only Linux and Android are supported. It also uses mechanisms like multithreading and caching to finish as fast as possible.

The output on my personal machine with default configurations looks like this: example output

Customization

With customization and speed being two competing goals, this project actually builds two executables.
The main one being fastfetch, which can be very greatly configured via flags. These flags can be made persistent in ~/.config/fastfetch/config.conf. To view the available options run fastfetch --help.
The second executable being buildt is called flashfetch, which is configured at compile time to eliminate any possible overhead. Configuration of it can be very easily done in src/flashfetch.c.
At the moment the performance difference is measurable, but too small to be human recognizable. But the leap will get bigger with more and more options coming, and on slow machines this might actually make a difference.

There are some presets defined for fastfech in presets, you can can load them with --load-config. They may also serve as a good example for format arguments.

Dependencies

Fastfetch dynamically loads needed libraries if they are available. Therefore its only hard dependencies are libc (any implementation of the c standard library), libdl and libpthread. They are all shipped with glibc, which is already installed on most linux distributions, so you probably don't have to worry about it.

The following libraries are used if present at runtime:

  • libpci: GPU output.
  • libvulkan: Fallback for GPU output.
  • libxcb-randr, libXrandr, libxcb, libX11: At least one of them sould be present in X11 sessions for better resolution detection and faster WM detection. The *randr ones provide multi monitor support. The libxcb* ones usually have better performance.
  • libwayland-client: Better resolution performance and output in wayland sessions. Supports different refresh rates per monitor.
  • libGIO: Needed for values that are only stored GSettings.
  • libDConf: Needed for values that are only stored in DConf + Fallback for GSettings.
  • libDBus: Needed for detecting current media player and song.
  • libXFConf: Needed for XFWM theme and XFCE Terminal font.
  • librpm: Needed for rpm package count.

Support status

All categories not listed here should work without needing a specific implementation.

Available Modules
Title, Separator, OS, Host, Kernel, Uptime, Processes, Packages, Shell, Resolution, DE, WM, WMTheme, Theme, Icons, Font, Cursor, Terminal, Terminal Font, CPU, CPUUsage, GPU, Memory, Disk, Battery, Player, Song, LocalIP, PublicIP, DateTime, Date, Time, Locale, Colors, Break, Custom
Logos
Android, Arch, Arco, Artix, CachyOS, CentOS, Debian, Endeavour, Fedora, Garuda, Gentoo, Manjaro, Mint, Pop!_OS, RebornOS, Ubuntu, Void, Zorin
  • Most of the logos have a small variant. Access it by appending _small to the logo name.
  • Some logos have an old variant. Access it by appending _old to the logo name.
  • Unknown/unsupported logos will be replaced with a question mark when running fastfetch.
  • Get a list of all available logos with fastfetch --print-logos.
Package managers
Pacman, dpkg, rpm, emerge, xbps, Flatpak, Snap
WM themes
KWin, Mutter, Muffin, Marco, XFWM, Openbox (LXDE, LXQT & without DE)
DE versions
KDE Plasma, Gnome, Cinnamon, Mate, XFCE4, LXQt
Terminal fonts
konsole, gnome-terminal-server, tilix, xfce4-terminal, lxterminal, TTY

Building

fastfetch uses cmake and pkg-config for building. The simplest steps to build the fastfetch and flashfetch binaries are:

mkdir -p build
cd build
cmake ..
cmake --build . -j$(nproc) --target fastfetch --target flashfetch

If pkg-config fails to find the headers for a library listed in dependencies, fastfetch will simply build without support for that specific feature. This means, it won't look for it at runtime and just act like it isn't available.

Packaging

  • AUR: Packaged by me. Will install the fastfetch binary, bash completion and the presets. Git version
  • Manjaro Repositories: Packaged by a manjaro maintainer. Usually a bit outdated.
  • DEB: You need to build deb packages yourself. Run packaging/deb/create-deb-pkg.sh for that.
  • Manually:
    • Build: Follow the build instructions.
    • Install: sudo cmake --install build --prefix /usr/local

FAQ

Q: Why do you need a very performant version of neofetch?

I like putting neofetch in my ~/.bashrc to have a system overwiew whenever i use the terminal, but the slow speed annoyed me, so i created this. Also neofetch didn't output everything correctly (e.g Font is displayed as "[Plasma], Noto Sans, 10 [GTK2/3]") and writing my own tool gave me the possibility to fine tune it to run perfectly on at least my configuration.

Q: It does not display [*] correctly for me, what can i do?

This is most likely because your system is not implemented (yet). At the moment i am focusing more on making the core app better, than adding more configurations. Feel free to open a pull request if you want to add support for your configuration