Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/torchedsammy/hilbifetch
Simple and small fetch written in Lua.
https://github.com/torchedsammy/hilbifetch
hibiscus hilbish lua neofetch pfetch screenfetch system-information
Last synced: 3 months ago
JSON representation
Simple and small fetch written in Lua.
- Host: GitHub
- URL: https://github.com/torchedsammy/hilbifetch
- Owner: TorchedSammy
- License: bsd-3-clause
- Created: 2021-04-29T01:07:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:07:10.000Z (about 2 years ago)
- Last Synced: 2024-07-28T22:53:21.555Z (6 months ago)
- Topics: hibiscus, hilbish, lua, neofetch, pfetch, screenfetch, system-information
- Language: Lua
- Homepage:
- Size: 258 KB
- Stars: 25
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hilbifetch
Simple and small fetch written in Lua.
Hilbifetch is your average system info fetch inspired by Neofetch, my own
[Bunnyfetch](https://github.com/Rosettea/Bunnyfetch) and the others.
But this time, it's written and configured in Lua.
# Requirements
- [Hilbish](https://github.com/Rosettea/Hilbish) master branch
# Setup
> Hilbifetch is in a very early state, expect it to look weird or have odd bugs.
```sh
git clone https://github.com/TorchedSammy/Hilbifetch
cd Hilbifetch
sudo ./install.lua
```
To install to a different directory (like `$HOME/bin`):
```
PREFIX=/usr/local ./install.lua
```
# Usage
`hilbifetch` (or `./hilbifetch.lua`)
Configuration is done via the Lua file `~/.config/hilbifetch/init.lua`.
There are a few functions and variables available. They are all accessed
via the global `hilbifetch` table.
- `sep`: Separator used for info.
- `ascii`: ASCII art.
- `order`: A table describing the order of info. The format for keys is either
a string of an info name or a table with the first entry being the name and other
options. Example:
```lua
hilbifetch.order = {
{'title', showName = false},
{'infosep', showName = false},
'os',
'kernel',
'uptime',
'terminal',
'shell',
{'padding', showName = false},
{'colors', showName = false}
}
```
This is the default order of info. The options available for info are:
`showName` - Whether to show the display name.
`color` - Color of the info text.
`nameColor` - Color of the display name.
- `addInfo(name, callback)`: adds info with `name`.
- `getInfo(name)`: gets info from `name`
- `setDisplay(name)`: sets the display name of `name`d info. if the display
name isn't set, it'll use the normal name instead.
- `getDisplay(name)`: gets the display name of the `name`d info.
# License
Hilbifetch is licensed under the BSD 3-Clause license.
[Read here](LICENSE) for more info.