|
35 | 35 | ## Key Features |
36 | 36 | * Run customfetch as a **terminal** or **GTK3 application** or even as an [android widget](https://github.com/Toni500github/customfetch-android-app) |
37 | 37 | * Really easy to [customize](#How-to-customize) |
38 | | -* Incredibly extensible information fetchings via external plugins |
| 38 | +* Flexible [plugin](#Plugins) system |
| 39 | +* Incredibly extensible information fetchings |
39 | 40 | * Super lightweight, 3.3MB max (GTK3 application) |
40 | 41 |
|
41 | 42 | # Dependencies |
@@ -208,15 +209,24 @@ They can be used in the ascii art text file and layout, but how to use them? |
208 | 209 | If you're using the GUI app and the source path is an image, all the auto colors will be the same colors as the distro ascii art. |
209 | 210 |
|
210 | 211 | * **The Percentage tag (`$%%`)** is used for displaying the percentage between 2 numbers.\ |
211 | | - It **Must** contain a comma for separating the 2. They can be either be taken from a tag or it put yourself.\ |
| 212 | + It **must** contain a comma for separating the 2. They can be either be taken from a tag or it put yourself.\ |
212 | 213 | For example: $%10,5% |
213 | 214 | For inverting colors of bad and great (red and green), before the first `%` a put `!` |
214 | 215 |
|
215 | 216 | Any `$` or brackets can be escaped with a backslash `\`. You need to escape backslashes too :(\ |
216 | 217 | **NOTE:** For having compatibility with the GUI app, you need to escape `<` (EXCEPT if you are using in a info tag, like `$<os.name>`) and `&`\ |
217 | | -e.g `the number 50 is \\< than 100 \\&\\& 98` |
| 218 | +e.g `the number 50 is \\< 100 \\&\\& 98` |
218 | 219 | Won't affect the printing in terminal. |
219 | 220 |
|
| 221 | +## Plugins |
| 222 | +Thanks to plugins, `customfetch` is able to query way more information than just system information, unlike regular neofetch-like programs. |
| 223 | + |
| 224 | +You can easily install community-made plugins by using `cufetchpm`, example: `cufetchpm install https://github.com/Toni500github/customfetch-plugins-github`. |
| 225 | +This example installs a repository, which can have multiple plugins. read `cufetchpm --help` for more information. |
| 226 | + |
| 227 | +## Writing your own plugins |
| 228 | +Plugins are mostly just shared libraries, so you could easily write your own plugin! there's an [example](https://github.com/Toni500github/customfetch/blob/main/examples/mod-library.cc) with detailed comments that explain everything! |
| 229 | + |
220 | 230 | ## Star History |
221 | 231 |
|
222 | 232 | <a href="https://www.star-history.com/#Toni500github/customfetch&Date"> |
|
0 commit comments