summaryrefslogtreecommitdiff
path: root/Content/posts/2019-05-05-Custom-Snowboard-Anemone-Theme.md
blob: 5ae99701ea0944b26d38c946986e8ad93402cd0a (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
---
date: 2019-05-05 12:34
description: Tutorial on creating your own custom theme for Snowboard or Anemone
tags: Tutorial, Jailbreak, Designing, Snowboard, Anemone
---

# Creating your own custom theme for Snowboard or Anemone

### Contents
* Getting Started
* Theme Configuration
* Creating Icons
* Exporting Icons
* Icon Masks
* Packaging
* Building the DEB

## Getting Started

**Note: Without the proper folder structure, your theme may not show up!**

* Create a new folder called `themeName.theme` (Replace themeName with your desired theme name)
* Within `themeName.theme` folder, create another folder called `IconBundles` (**You cannot change this name**)

## Theme Configuration

* Now, inside the `themeName.theme` folder, create a file called `Info.plist` and paste the following

```
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  <plist version="1.0">
  <dict>
    <key>PackageName</key>
    <string>ThemeName</string>
    <key>ThemeType</key>
    <string>Icons</string>
  </dict>
</plist>
```

* Replace `PackageName` with the name of the Package and replace `ThemeName` with the Theme Name

Now, you might ask what is the difference between `PackageName` and `ThemeName`?

Well, if for example you want to publish two variants of your icons, one dark and one white but you do not want the user to seperately install them.
Then, you would name the package `MyTheme` and include two themes `Blackie` and `White` thus creating two entries. More about this in the end

## Creating Icons

* Open up the Image Editor of your choice and create a new file having a resolution of 512x512

**Note: Due to IconBundles, we just need to create the icons in one size and they get resized automatically** :ghost:

**Want to create rounded icons?**
Create them squared only, we will learn how to apply masks!

## Exporting Icons
**Note: All icons must be saved as `*.png` (Tip: This means you can even create partially transparent icons!)**

* All Icons must be saved in `themeName.theme>IconBundles` as `bundleID-large.png`

##### Finding BundleIDs

**Stock Application BundleIDs**

| Name        | BundleID             |
|-------------|----------------------|
| App Store   | com.apple.AppStore   |
| Apple Watch | com.apple.Bridge     |
| Calculator  | com.apple.calculator |
| Calendar | com.apple.mobilecal |
| Camera | com.apple.camera |
| Classroom | com.apple.classroom |
| Clock | com.apple.mobiletimer |
| Compass | com.apple.compass |
| FaceTime | com.apple.facetime |
| Files | com.apple.DocumentsApp |
| Game Center | com.apple.gamecenter |
| Health | com.apple.Health |
| Home | com.apple.Home |
| iBooks | com.apple.iBooks |
| iTunes Store | com.apple.MobileStore |
| Mail | com.apple.mobilemail |
| Maps | com.apple.Maps |
| Measure | com.apple.measure |
| Messages | com.apple.MobileSMS |
| Music | com.apple.Music |
| News | com.apple.news |
| Notes | com.apple.mobilenotes |
| Phone | com.apple.mobilephone |
| Photo Booth | com.apple.Photo-Booth |
| Photos | com.apple.mobileslideshow |
| Playgrounds | come.apple.Playgrounds |
| Podcasts | com.apple.podcasts |
| Reminders | com.apple.reminders |
| Safari | com.apple.mobilesafari |
| Settings | com.apple.Preferences |
| Stocks | com.apple.stocks |
| Tips | com.apple.tips |
| TV | com.apple.tv |
| Videos | com.apple.videos |
| Voice Memos | com.apple.VoiceMemos |
| Wallet | com.apple.Passbook |
| Weather | com.apple.weather |

**3rd Party Applications BundleID**
Click [here](http://offcornerdev.com/bundleid.html)

### Icon Masks

* Getting the Classic Rounded Rectangle Masks

In your `Info.plist` file add the following value between `<dict>` and </dict>

```
<key>IB-MaskIcons</key>
    <true/>
```

* Custom Icon Masks

**NOTE: This is an optional step, if you do not want Icon Masks, skip this step**

* Inside your `themeName.theme` folder, create another folder called 'Bundles'
  * Inside `Bundles` create another folder called `com.apple.mobileicons.framework`
  
#### Designing Masks

**Masking does not support IconBundles, therefore you need to save the masks for each of the following**

| File | Resolution |
|------|------------|
| AppIconMask@2x~ipad.png    | 152x512 |
| AppIconMask@2x~iphone.png    | 120x120 |
| AppIconMask@3x~ipad.png    | 180x180 |
| AppIconMask@3x~iphone.png    | 180x180 |
| AppIconMask~ipad.png    | 76x76 |
| DocumentBadgeMask-20@2x.png    | 40x40 |
| DocumentBadgeMask-145@2x.png    | 145x145 |
| GameAppIconMask@2x.png    | 84x84 |
| NotificationAppIconMask@2x.png    | 40x40 |
| NotificationAppIconMask@3x.png    | 60x60 |
| SpotlightAppIconMask@2x.png    | 80x80 |
| SpotlightAppIconMask@3x.png    | 120x120 |
| TableIconMask@2x.png    | 58x58 |
| TableIconOutline@2x.png    | 58x58 |

* While creating the mask, make sure that the background is not a solid colour and is transparent
* Whichever area you want to make visible, it should be coloured in black

Example (Credits: Pinpal):

![Credit: Pinpal](https://pinpal.github.io/assets/theme-guide/mask-demo.png)

would result in

![Credit: Pinpal](https://pinpal.github.io/assets/theme-guide/mask-result.png)

### Packaging

* Create a new folder outside `themeName.theme` with the name you want to be shown on Cydia, e.g `themeNameForCydia`
* Create another folder called `DEBIAN` in `themeNameForCydia` (It needs to be uppercase)
* In `DEBIAN` create an extension-less file called `control` and edit it using your favourite text editor

Paste the following in it, replacing `yourname`, `themename`, `Theme Name`, `A theme with beautiful icons!` and `Your Name` with your details:

```
Package: com.yourname.themename
Name: Theme Name
Version: 1.0
Architecture: iphoneos-arm
Description: A theme with beautiful icons!
Author: Your Name
Maintainer: Your Name
Section: Themes
```

* Important Notes:
  * The package field **MUST** be lower case!
  * The version field **MUST** be changed every-time you update your theme!
  * The control file **MUST** have an extra blank line at the bottom!
  
* Now, Create another folder called `Library` in `themeNameForCydia`
* In `Library` create another folder called `Themes`
* Finally, copy `themeName.theme` to the `Themes` folder (**Copy the entire folder, not just the contents**)

### Building the DEB

**For building the deb you need a `*nix` system, otherwise you can build it using your iPhones**

##### Pre-Requisite for MacOS users
1) Install Homenbrew `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` (Run this in the terminal)
2) Install dpkg, by running `brew install dpkg`

**There is a terrible thing called .DS_Store which if not removed, will cause a problem during either build or installation**

* To remove this we first need to open the folder in the terminal

* Launch the Terminal and then drag-and-drop the 'themeNameForCydia' folder on the Terminal icon in the dock
* Now, run `find . -name "*.DS_Store" -type f -delete`

##### Pre-Requisite for Windows Users
* SSH into your iPhone and drag and drop the `themeNameForCyia` folder on the terminal

##### Common Instructions

* You should be at the root of the folder in the terminal, i.e Inside `themeNameForCydia`
* running `ls` should show the following output

```
DEBIAN  Library
```

* Now, in the terminal enter the following `cd .. && dpkg -b themeNameForCydia `

**Now you will have the `themeNameForCydia.deb` in the same directory**

You can share this with your friends :+1: