summaryrefslogtreecommitdiffhomepage
path: root/graphics/README.md
blob: 786260f28fc3c6bc7cb06b297902e6e22914921d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# Graphic assets

This folder contains graphic assets that are used to generate assets for either the app or platforms
where the app is distributed.

## Android

The `Android-feature-graphics.psd` file should be used to generate a PNG image to be used as the
feature graphics in the app's Google Play Store listing. The PNG image should be placed in the
`android/app/src/main/play/listings/en-US/graphics/feature-graphics/` directory.

## Icons (The mole logo in different versions)

### `icon.svg`

The main and official mole logo. Used to generate icons on a bunch of platforms.

If `icon.svg` is changed. You need to run the following to generate new assets:
* Desktop: `desktop/packages/mullvad-vpn/scripts/build-logo-icons.sh`
* Android: `android/scripts/generate-pngs.sh`

### `icon-square.svg`

This is the regular mole but instead of being placed in a blue circle the entire background is just blue.
The mole is placed slightly to the right compared to `icon.svg` to appear more centered. And the mole
is a little bit smaller so it fits better when corners are rounded off during icon creation.

#### Desktop

The square icon is used on desktop as the base for the macOS icons. To update them:

1. Create the macOS icons by inserting the updated `/graphics/icon-square.svg` into Apple's macOS
icon template available at https://developer.apple.com/design/resources/.
1. Save the icons to `/graphics/macOS/`
1. Run `scripts/build-logo-icons.sh`

#### Android

The `icon-square.svg` is used to generate Android's square icon used in the app's Google Play Store
listing. The resulting 512x512 PNG image should be placed in the
`android/app/src/main/play/listings/en-US/graphics/icon/` directory. The file can be generate with the
following command:

```
rsvg-convert ./icon-square.svg -w 512 -h 512 -o ../android/app/src/main/play/listings/en-US/graphics/icon/icon.png
```

### `icon-android.svg` & `icon-android-mono.svg`

The icon `icon-android.svg` is used for Android adaptive icon. The icon converted to
Android Vector Drawable format and used as foreground layer for adaptive icon. For background layer is used
solid color layer. Full documentation about adaptive icon available on link below:
https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive

`icon-android-mono.svg` is the monochromatic version. It's used as "themed icons" on Android.

### `icon-shaved.svg`

This is a simplified version of the logo with the whiskers and fur removed. This version should be used
when rendering the mole icon in tiny versions where the little details in the logo would not be visible
anyway, and would just make the small assets look less clean.

It is currently used to generate small icon assets for Android: `android/scripts/generate-pngs.sh`.