config.lua

December 19, 2023 ยท View on GitHub

The lua file is a user defined file which generates the fetch part of the program.
The hayabusa binary injects the system information into a global object named system_info.

system_info

FieldData TypePurpose
distroStringHolds the name of the distribution.
cpuStringStores the CPU name.
motherboardStringContains the motherboard name.
kernelStringProvides the kernel version.
gpusTable (List)An indexed list of GPU names.
memoryTableTable containing memory usage details.
disksTable (List)A table with disk information.
local_ipStringThe local IP address.
public_ipStringThe public IP address.
hostnameStringThe hostname of the system.
boot_timeNumberSystem boot time (usually for finding uptime).
packagesTable (List)An indexed list of package manager counts.

memory

FieldData TypePurpose
usedNumberAmount of memory currently in use.
totalNumberTotal amount of memory in the system.

disks

FieldData TypePurpose
nameStringName of the disk.
usedNumberUsed space of the disk.
totalNumberTotal space of the disk.

packages

FieldData TypePurpose
pacmanNumberCount of packages managed by Pacman.
wingetNumberCount of packages managed by WinGet.
dnfNumberCount of packages managed by DNF.
xbpsNumberCount of packages managed by XBPS.

config.toml

ConfigurationData TypeDescriptionOptions (if applicable) or Comments
spacingStructSettings for spacing within the display.
- middle_paddingu8 (Number)Padding between the art and the fetch.
- inner_paddingStructPadding inside the border.
- - topu8 (Number)Inner top padding.
- - bottomu8 (Number)Inner bottom padding.
- - leftu8 (Number)Inner left padding.
- - rightu8 (Number)Inner right padding.
- outer_paddingStructPadding outside the border.
- - topu8 (Number)Outer top padding.
- - bottomu8 (Number)Outer bottom padding.
- - leftu8 (Number)Outer left padding.
- - rightu8 (Number)Outer right padding.
borderStructSettings for the border.
- enabledboolToggle border on/off.
- ansi_colorStringANSI color code for the border.
- border_charsStructCharacters used for drawing the border.
- - top_leftcharCharacter for top-left corner of the border.
- - top_rightcharCharacter for top-right corner of the border.
- - bottom_leftcharCharacter for bottom-left corner of the border.
- - bottom_rightcharCharacter for bottom-right corner of the border.
- - horizontalcharCharacter for horizontal lines of the border.
- - verticalcharCharacter for vertical lines of the border.
ascii_artStructSettings for art display.
- sizeEnumSize of the ASCII art.Small, Big
- placementEnumPlacement of art.Top, Bottom, Left, Right
- alignmentEnumAlignment of art.Left, Center, Right, Top, Bottom
- backendStructBackend settings for the art.
- - engineEnumEngine used for the art.Ascii, Kitty, None
- - image_pathStringPath to the image file (if used).Program will Panic is not a valid path
- - image_widthu16 (Number)Width of the image (if used).In character cells
- ascii_art_fileStringFile path for ASCII art.Leave empty("") for default