lun_admin/NeoLaunch_From_Kvaesitso
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update icon pack docs

Browse Source
This commit is contained in:
MM20 2024-05-20 14:01:46 +02:00
parent 1ea05db334
commit bb8a0d4c0d
No known key found for this signature in database
GPG Key ID: 0B61A8F2DEAFA389
1 changed files with 40 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/docs/developer-guide/integrations/icon-packs.md
View File

@ -1,3 +1,7 @@
---
outline: deep
---
# Icon Packs # Icon Packs
Kvaesitso has built-in support for the ADW launcher icon pack format (the format that is nowadays Kvaesitso has built-in support for the ADW launcher icon pack format (the format that is nowadays
@ -5,7 +9,7 @@ used by virtually all icon packs and supported by all major custom launchers).
## Get started ## Get started
### Android Manifest ### AndroidManifest.xml
In order to be recognized as an icon pack, your app must declare an activity with at least one of In order to be recognized as an icon pack, your app must declare an activity with at least one of
the following intent filters in your `AndroidManifest.xml`: the following intent filters in your `AndroidManifest.xml`:
@ -26,7 +30,7 @@ the following intent filters in your `AndroidManifest.xml`:
</activity> </activity>
``` ```
### Appfilter ### appfilter.xml
Icons are mapped to apps using a file called `appfilter.xml`. This file must be located in one of Icons are mapped to apps using a file called `appfilter.xml`. This file must be located in one of
these locations: these locations:
@ -44,7 +48,27 @@ The file has the following structure:
</resources> </resources>
``` ```
## Add icons ### drawable.xml
`drawable.xml` is a file that lists all icons that are included in the icon pack. This file is
required for manual icon picking.
The file lives in `res/xml/drawable.xml`, and looks like this:
```xml
<?xml version="1.0" encoding="utf-8"?>
<resources>
<item drawable="messages" />
<category title="System" />
<item drawable="settings" />
<item drawable="settings_alt_1" />
</resources>
```
Every icon that should be available for manual icon picking must be listed in this file. You can
optionally group icons by adding `<category>` elements, but these categories aren't used by
Kvaesitso.
## Static icons
Icons are added to the `appfilter.xml` file using the `<item>` tag: Icons are added to the `appfilter.xml` file using the `<item>` tag:
@ -60,7 +84,7 @@ Icons are added to the `appfilter.xml` file using the `<item>` tag:
- `drawable` is the name of the icon drawable which must be located in the `res/drawable/` folder - `drawable` is the name of the icon drawable which must be located in the `res/drawable/` folder
(or any of its variants, e.g. `res/drawable-hdpi/`) (or any of its variants, e.g. `res/drawable-hdpi/`)
### Autogenerated icons ## Autogenerated icons
The launcher can generate fallback icons for apps that don't have an icon in the icon pack. The launcher can generate fallback icons for apps that don't have an icon in the icon pack.
Fallback icons consist of four parts: Fallback icons consist of four parts:
@ -89,9 +113,9 @@ You can provide multiple variants of each part by adding a number to the `img` a
The launcher will then randomly pick one of the variants for each icon. The launcher will then randomly pick one of the variants for each icon.
### Dynamic icons ## Dynamic icons
#### Calendar icons ### Calendar icons
Kvaesitso supports Nova Kvaesitso supports Nova
launcher's [dynamic calendar icon standard](https://github.com/teslacoil/Example_NovaTheme/blob/master/DynamicCalendarIconAPI.md): launcher's [dynamic calendar icon standard](https://github.com/teslacoil/Example_NovaTheme/blob/master/DynamicCalendarIconAPI.md):
@ -111,7 +135,7 @@ month (`calendar_1`, `calendar_2`, etc. up to `calendar_31`).
> Single digit days must not be zero-padded (e.g. `calendar_1` is correct but `calendar_01` is not). > Single digit days must not be zero-padded (e.g. `calendar_1` is correct but `calendar_01` is not).
> Make sure that all 31 drawables are present, or the launcher will reject the icon. > Make sure that all 31 drawables are present, or the launcher will reject the icon.
#### Clock icons ### Clock icons
Dynamic clock icons are supported as well but they work a bit differently than calendar icons. Dynamic clock icons are supported as well but they work a bit differently than calendar icons.
A dynamic clock icon needs at least two entries in your `appfilter.xml` file: A dynamic clock icon needs at least two entries in your `appfilter.xml` file:
@ -168,7 +192,8 @@ Here is an example of a clock icon:
</adaptive-icon> </adaptive-icon>
``` ```
Pay attention to how each of the three clock hand layers is wrapped in a `RotateDrawable` and how there are Pay attention to how each of the three clock hand layers is wrapped in a `RotateDrawable` and how
there are
very very
specific values set for `android:fromDegrees` and `android:toDegrees`. This is required for specific values set for `android:fromDegrees` and `android:toDegrees`. This is required for
launchers launchers
@ -191,7 +216,8 @@ must follow these rules:
> [!NOTE] > [!NOTE]
> >
> `defaultHour`, `defaultMinute` and `defaultSecond` are independent from each other. If you > `defaultHour`, `defaultMinute` and `defaultSecond` are independent from each other. If you
> set `defaultHour` to 10, then it is expected that the hour hand drawable is rotated by exactly 300°, > set `defaultHour` to 10, then it is expected that the hour hand drawable is rotated by exactly
> 300°,
> regardless of the positions of the minute and second hands even if that means that the clock shows > regardless of the positions of the minute and second hands even if that means that the clock shows
> an impossible time. > an impossible time.
@ -213,13 +239,14 @@ must follow these rules:
> For the minute layer, one level is equal to one minute so 60 levels are equal to a full rotation. > For the minute layer, one level is equal to one minute so 60 levels are equal to a full rotation.
> This means that the total angle must be `360/60 * 10000 = 60000` degrees. > This means that the total angle must be `360/60 * 10000 = 60000` degrees.
> >
> For the hour layer, one level is also equal to one minute, so there are `12 * 60 = 720` levels in a > For the hour layer, one level is also equal to one minute, so there are `12 * 60 = 720` levels in
> a
> full rotation. `360/720 * 10000 = 5000` degrees. > full rotation. `360/720 * 10000 = 5000` degrees.
> >
> Technically, you could also use other kinds of drawables that support the `android:level` > Technically, you could also use other kinds of drawables that support the `android:level`
> attribute (such as a `LevelListDrawable`), as long as you follow the rules above. > attribute (such as a `LevelListDrawable`), as long as you follow the rules above.
### Themed icons ## Themed icons
Themed icons are monochrome icons that are tinted to match the theme color of the launcher. Themed icons are monochrome icons that are tinted to match the theme color of the launcher.
@ -240,7 +267,8 @@ Themed icons can be provided in any of the following ways:
- If the icon is an adaptive icon, and the drawable has - If the icon is an adaptive icon, and the drawable has
a `<monochrome>` layer, this icon will be used as the themed icon. a `<monochrome>` layer, this icon will be used as the themed icon.
- If the icon is an adaptive icon, and it does not have a `<monochrome>` layer, the foreground layer will be used. - If the icon is an adaptive icon, and it does not have a `<monochrome>` layer, the foreground layer
will be used.
- If the icon is not an adaptive icon, the entire icon will be used. - If the icon is not an adaptive icon, the entire icon will be used.
In any case, the icon will be tinted using the theme color and the background will be set to a solid In any case, the icon will be tinted using the theme color and the background will be set to a solid