Skip to content

Commit

Permalink
Merge remote-tracking branch 'lawnicons/develop' into shinka
Browse files Browse the repository at this point in the history
  • Loading branch information
project404bot committed Dec 3, 2023
2 parents f392c79 + c3eddfc commit 689a920
Show file tree
Hide file tree
Showing 148 changed files with 505 additions and 102 deletions.
4 changes: 3 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ij_kotlin_allow_trailing_comma = true
ij_kotlin_allow_trailing_comma_on_call_site = true
ktlint_code_style = intellij_idea
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_property-naming = disabled

[*.md]
trim_trailing_whitespace = false

[*.{yml,yaml}]
indent_size = 2
4 changes: 2 additions & 2 deletions .github/workflows/build_debug_apk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
uses: actions/checkout@v4
with:
submodules: true
- uses: actions/setup-java@v3
- uses: actions/setup-java@v4
with:
distribution: 'zulu'
java-version: 17
Expand Down Expand Up @@ -49,7 +49,7 @@ jobs:
- uses: actions/checkout@v4
with:
submodules: true
- uses: actions/setup-java@v3
- uses: actions/setup-java@v4
with:
distribution: 'zulu'
java-version: 17
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build_release_apk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
uses: actions/checkout@v4
with:
submodules: true
- uses: actions/setup-java@v3
- uses: actions/setup-java@v4
with:
distribution: 'zulu'
java-version: 17
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/first_pr_interaction.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
steps:
- name: Send message if first interaction
if: steps.outcome != 'failure'
uses: actions/first-interaction@v1.2.0
uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
pr-message: |
Expand Down
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[@lawnchairapp](https://twitter.com/lawnchairapp), [Telegram](https://t.co/qYev4OkvpT), or [Discord](https://discord.com/invite/3x8qNWxgGZ).
[@lawnchairapp](https://x.com/lawnchairapp), [Telegram](https://t.co/qYev4OkvpT), or [Discord](https://discord.com/invite/3x8qNWxgGZ).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
34 changes: 17 additions & 17 deletions .github/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,44 +10,44 @@ For additional information on designing icons and samples, see [the Lawnicons Fi

### Artboard & Grid

![](images/creating-icons-1-artboard.png)
![](docs/images/creating-icons-1-artboard.png)

Each icon must fit the `160x160px` or `144x144px` (depending on the shape) content area size. It must not be smaller nor bigger than the specified sizes.

### Foundation

![](images/creating-icons-2-foundation.png)
![](docs/images/creating-icons-2-foundation.png)

The stroke should be kept at `12px` in most cases. If `12px` is too thick, a stroke of `8px` can be used.
For finer detail, a stroke of `6px` can be used. The standard widths are `6px`, `8px`, `10px`, `12px` and `14px`.

In addition to the above, joins and start/end points must be rounded and the colour must be black `#000000`.
In addition to the above, joins and start/end points must be rounded and the colour must be black `#000000`.

### Details

![](images/creating-icons-3-detail.png)
![](docs/images/creating-icons-3-detail.png)

When designing icons, it's important to strike a balance with the level of detail. While some icons can be highly detailed, it's acceptable to remove certain details as long as the icon remains recognizable and stays true to its original concept. In some cases, you may need to completely rethink the icon to achieve a minimalist design.

A great example of this is the Subway Surfers icon as seen in the example above. In Lawnicons, it was reimagined by using the graffiti-styled "S" from the game's logo instead of depicting the character, which would have required intricate shapes and varying stroke thicknesses.

![](images/creating-icons-3-balance.png)
![](docs/images/creating-icons-3-balance.png)

In contrary, it's also important to avoid too few details, as they may not be easily recognizable. Take the Headspace icon, for instance, which consists only of a circle. This may pose a problem for users since Lawnicons are not colored, and a simple circle on its own is not easily identifiable. Whenever possible, incorporate additional details that align with the app's design language.
In contrary, it's also important to avoid too few details, as they may not be easily recognizable. Take the Headspace icon, for instance, which consists only of a circle. This may pose a problem for users since Lawnicons are not colored, and a simple circle on its own is not easily identifiable. Whenever possible, incorporate additional details that align with the app's design language.

In the Headspace example above, the circles usually have a face representing mood. By adding one of those faces to the circle, you can make the icon more recognizable.

### Maintaining Consistency

![](images/creating-icons-4-outline.png)
![](docs/images/creating-icons-4-outline.png)

All icons must adhere to an outline (not filled) to maintain a consistent theme. However, fill can be used sparingly for small details that require minimal contrast or for elements that cannot be accurately recreated with an outline.
All icons must adhere to an outline (not filled) to maintain a consistent theme. However, fill can be used sparingly for small details that require minimal contrast or for elements that cannot be accurately recreated with an outline.

The key is to ensure that any filled elements do not overwhelm the overall icon design and align with the outlined style to create a harmonious and coherent icon set.

### Maintaining Visual Balance

![](images/creating-icons-5-balance.png)
![](docs/images/creating-icons-5-balance.png)

Sharp contrast occurs when there is a drastic change in stroke thickness without a smooth transition. For instance, using a `12px` stroke and suddenly decreasing it to `8px` creates an unbalanced visual effect in the final icon.

Expand All @@ -64,21 +64,21 @@ Here's how to add an icon to Lawnicons:
* The package and activity name of the app.

### Via `icontool.py`
Please check the [icon tool guide](/.github/icontool_guide.md) for more information.
Please check the [icon tool guide](/docs/icontool_guide.md) for more information.

### Via manual process
1. Add the ready SVG to the `svgs` directory.

1. Add a new line to `app/assets/appfilter.xml` (in alphabetical order, by the `name` attribute), and map the new icon to a package name and app's activity. For example:

```xml
<item component="ComponentInfo{com.google.android.apps.nbu.files/com.google.android.apps.nbu.files.home.HomeActivity}" drawable="files_by_google" name="Files by Google"/>
<item component="ComponentInfo{com.google.android.apps.nbu.files/com.google.android.apps.nbu.files.home.HomeActivity}" drawable="files_by_google" name="Files by Google"/>
```

A general template is as follows:

```xml
<item component="ComponentInfo{[PACKAGE_NAME]/[APP_ACIVITY_NAME]}" drawable="[DRAWABLE NAME]" name="[APP NAME]"/>
<item component="ComponentInfo{[PACKAGE_NAME]/[APP_ACIVITY_NAME]}" drawable="[DRAWABLE NAME]" name="[APP NAME]"/>
```

1. Done! You're ready to open a pull request. Please set `develop` as the base branch.
Expand All @@ -92,26 +92,26 @@ Please check the [icon tool guide](/.github/icontool_guide.md) for more informat
**For Mac or Linux**:

```console
adb shell dumpsys window | grep 'mCurrentFocus'
adb shell dumpsys window | grep 'mCurrentFocus'
```

**For Windows**:

```console
adb shell dumpsys window | find "mCurrentFocus"
```
![](images/contributing-image-3.png)
![](docs/images/contributing-image-3.png)

The part before the `/` character in the above image, i.e. `org.telegram.messenger`, is the package name (`[PACKAGE_NAME]`). The part after it, i.e. `org.telegram.messenger.DefaultIcon`, is the activity name (`[APP_ACIVITY_NAME]`).

### Using 3rd-party apps
#### IconRequest app
1. Download the [IconRequest app](https://github.com/Kaiserdragon2/IconRequest/releases).
1. Download the [IconRequest app](https://github.com/Kaiserdragon2/IconRequest/releases).
2. Launch the app and click "REQUEST NEW" or "UPDATE EXISTING".
3. Get the Activity details for each app.

![](images/contributing-image-4.png)
![](docs/images/contributing-image-4.png)

#### Icon Pusher app
1. Download the [Icon Pusher app](https://play.google.com/store/apps/details?id=dev.southpaw.iconpusher&hl=en&gl=US).
2. Launch the app.
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions .github/README.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Build debug APK](https://github.com/LawnchairLauncher/lawnicons/actions/workflows/build_debug_apk.yml/badge.svg)](https://github.com/LawnchairLauncher/lawnicons/actions/workflows/build_debug_apk.yml)
[![Build release APK](https://github.com/LawnchairLauncher/lawnicons/actions/workflows/build_release_apk.yml/badge.svg)](https://github.com/LawnchairLauncher/lawnicons/actions/workflows/build_release_apk.yml)
[![Discord](https://img.shields.io/discord/803299970169700402?label=server&logo=discord)](https://discord.gg/lawnchair-803299970169700402)
[![License is Apache 2](https://img.shields.io/github/license/LawnchairLauncher/lawnicons)](./LICENSE)
[![License is Apache 2](https://img.shields.io/github/license/LawnchairLauncher/lawnicons)](LICENSE)

**Lawnicons** is an icon pack developed by the Lawnchair team.
Originally an addon for Lawnchair 12 Alpha 5 and above to implement themed icons, it can now be used on many launchers. Some launchers may also support Lawnicons for themed icons.
Expand All @@ -18,9 +18,9 @@ See the [Releases section](https://github.com/LawnchairLauncher/lawnicons/releas
## Contributing
Please see the [contributing guide](CONTRIBUTING.md) for information on adding icons or contributing code. It will help you avoid mistakes and save time.

Before you make the icons, you can check out the examples [in Figma](https://www.figma.com/community/file/1227718471680779613). In addition, you can see which icons users want in the [popular requests](https://docs.google.com/spreadsheets/d/10_o0DjhAGfP8ToDDNQ8M7eCZKtbzXLhIvxuF1XZEql0/edit#gid=327531090) or [raw requests](https://docs.google.com/spreadsheets/d/1h3eiJnG2nEdR1DbvemaF1lYthHkzYbXvVFPP0TEEt5k/edit?usp=sharing). If you make icons regularly or dozens at once, you can speed up contributing with [icontool.py](/.github/icontool_guide.md).
Before you make the icons, you can check out the examples [in Figma](https://www.figma.com/community/file/1227718471680779613). In addition, you can see which icons users want in the [popular requests](https://docs.google.com/spreadsheets/d/10_o0DjhAGfP8ToDDNQ8M7eCZKtbzXLhIvxuF1XZEql0/edit#gid=327531090) or [raw requests](https://docs.google.com/spreadsheets/d/1h3eiJnG2nEdR1DbvemaF1lYthHkzYbXvVFPP0TEEt5k/edit?usp=sharing). If you make icons regularly or dozens at once, you can speed up contributing with [icontool.py](/docs/icontool_guide.md).

If you are a developer, you may find the [contributing code section](https://github.com/LawnchairLauncher/lawnicons/blob/develop/.github/CONTRIBUTING.md#contributing-code) useful.
If you are a developer, you may find the [contributing code section](https://github.com/LawnchairLauncher/lawnicons/blob/develop/CONTRIBUTING.md#contributing-code) useful.

## Requesting icons
Please use the [icon request form](https://forms.gle/Fx8vZAiWdW1Tyjo57).
Expand Down
Loading

0 comments on commit 689a920

Please sign in to comment.