modfetch/README.md
2024-02-12 14:15:28 +01:00

44 lines
888 B
Markdown

# modfetch
modular fetch
each printable thing is a separate module in a shared object
modfetch loads and calls them at runtime to print system info
## building
`make` to build everything
`make modfetch` for the main binary
`make modules` for all the default modules
write your own using `mod.h` if you want to
## config
by default `$XDG_CONFIG_HOME/modfetch.conf`, `~/.config/modfetch.conf` if `$XDG_CONFIG_HOME` doesn't exist
format:
```
/path/to/mod1.so
/path/to/mod2.so {
var1 = dupa
var2 = 2137
}
```
## TODO
- [x] ~~module api versioning~~
- [ ] module manager (url to module source, compiles and puts the binary somewhere)
- [ ] better config parsing
- [ ] more text positioning options aside from printing text vertically
- [ ] some way for modules to throw errors
- [ ] module related options (list module, print specific module info, etc.)
## license
mit