You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,38 +6,54 @@ A simple tool to create bitmap fonts from a texture sprite sheet to be used with
6
6
7
7
## How to use it
8
8
9
-
Select a texture, set the [options](#options) accondingly and hit _Create_. It will create a _Material_ and a _Font Settings_ asset with the same name as the texture and in the same folder.
9
+
Select a texture, change the [settings](#settings) accondingly and hit _Create_. It will create a _Material_ and a _Font Settings_ asset with the same name as the texture and in the same folder.
10
10
11
11
Make sure your texture has the _Read/Write_ enabled inside its properties.
12
12
13
13
Because of some [limitation](#limitations), it'll not set the _Line Spacing_ field. If you need support to multi-line text, set it on the generated Font Settings file.
14
14
15
-
## Options
15
+
## Settings
16
16
17
-
Options are for the project and saved inside the folder _Assets/Editor/Resources_.
17
+
Settings can be saved to [profiles](#profiles)and retrieved to be used later.
18
18
19
-
-**Texture**: Texture used for the font.
19
+
-**Texture**: Texture used for the font. This is not saved to the profile.
20
20
-**Orientation**: Order to look up for characters in the texture. Values: horizontal, vertical.
21
21
-**Cols**: Number of columns in the texture.
22
22
-**Rows**: Number of rows in the texture.
23
23
-**Alpha Threshold**: Alpha threshold to identify characters bounds.
24
24
-**Monospaced**: Whether the result font should be monospaced.
25
-
-**Character Set**: Predefined character set to use.
25
+
-**Character Set**: Predefined character set to use. This is not saved to the profile.
26
26
-**Characters**: Characters used in the font in order they appear in the texture. Use the space character to represent blank spaces in the texture.
27
27
-**Default Character Spacing**: Default spacing between characters.
28
28
-**Custom Character Properties**: Custom properties for each characters, if any. For now the only custom property is the spacing.
29
-
-**Profile**: Manage profiles. You can select, create, edit or delete profiles. Same as layout profiles in Unity.
30
29
31
30
## Preferences
32
31
33
-
Preferences are for the editor and saved inside the_EditorPrefs_.
32
+
Preferences are saved in the editor using_EditorPrefs_.
34
33
35
34
-**Warn before overwrite**. Warn before overwriting an existing font. This will replace the old font keeping the references.
36
35
-**Warn before replacing settings**. Warn before replacing settings when selecting a profile.
36
+
-**Warn before replacing profile**. Warn before replacing an existing profile.
37
+
38
+
## Buttons
39
+
40
+
-**Create**. Creates the font using the given settings.
41
+
-**Rollback**. Rollback settings to the selected profile or default if none is selected.
42
+
43
+
## Profiles
44
+
45
+
You can save profiles to retrieve them later, making easy to create patterns depending on the type of texture or font you are creating.
46
+
47
+
Profiles are saved to the each project inside the folder _Assets/Editor/Resources_.
48
+
49
+
All [settings](#settings) except for the _Texture_ and the _Character Set_ can be saved to the profile.
50
+
51
+
You can manage profiles by opening the _Profiles_ menu at the bottom left corner of the popup. Select, create, edit or delete profiles like you do with layout profiles in Unity.
37
52
38
53
## Limitations
39
54
40
-
This tool makes the most of the work to create a bitmap font to be used with the Text component but it has some limitations:
55
+
This tool makes the most of the work to create a bitmap font to be used with Text components but it has some limitations:
41
56
42
57
-**It works only with font sprite sheets not sprite atlases**. It means that the distance between characters in the texture are the same and there is a fixed value of rows and columns. In other words, it has to be a grid of characters. They can't be sparsed.
43
58
-**It can't set the line specing property**. For some reason, Unity doesn't allow us to edit the _line spacing_ field by code. You need to set it manually after running the tool.
59
+
-**The resultant font works only with Legacy Text Component**. It doens't work with TextMeshPro texts.
0 commit comments