ReadMe.txt - ClearFont (Original)This page is the most up-to-date location for help customising ClearFont (original).
Info mostly updated for ClearFont v20000-2.
- Step One (updated for v20000-2)
- Step Two
- Un-installing ClearFont
- Switching between font packs (updated for v20000-2)
- Changing the main UI font styles
- Remove the bold / italic / number substyles (without changing any code)
- Using your own fonts and font packs (updated for v20000-2)
- Changing text size (new for v11100-2)
- Currently implemented overrides (updated for v20000-2)
- Modifying/removing the addon overrides
- Step Two of the install - a simple and fast manual override
- How to override addons that supply their own fonts
d. Known Issues
- Text too large?
- Text showing as '...'? (new for patch 1.11)
e. Other Info
- Worried about slowdown / the download size?
- Does ClearFont use a Saved Variables file?
- People to thank!
Remember to delete previous versions when updating!
Step One (updated for v20000-2)
Simply unzip the files and place the ClearFont folder in the [WoW directory]\Interface\AddOns\ folder.
- These are the main files included in the download:
- Changelog.txt (full changelog)
- ClearFont official website.url (clearfont.co.uk link)
- ClearFont.lua (main addon file)
- ClearFont.toc (info file for the game)
- ClearFontAddons.lua (addon overrides file)
- How to use the font packs.txt (detailed instructions!)
- ClearFont.ttf (main fonts)
- ClearFontBold.ttf (small fonts)
- ClearFontBoldItalic.ttf (quest Log / mail)
- ClearFontItalic.ttf (zone change and map notifications)
- ClearFontNumber.ttf (action bar hotkeys, money, item stacks)
- Info.txt (details on this font pack)
- "Main folder font files" (folder) (files for use for Step Two, only in the Font Pack download)
This part overrides all the remaining WoW fonts - including the login screens! (this is included in the UI site downloads)
- Create the following folder:
- [WoW directory]\Fonts\
- Create four copies of ClearFont.ttf (or the font of your choice), place them in the above folder, and rename them to the following names:
- FRIZQT__.ttf (the main UI font)
- ARIALN.ttf (the normal number font)
- skurri.ttf (the 'huge' number font)
- MORPHEUS.ttf (Mail, Quest Log font)
- See Addon Overrides for an fuller explanation of this step.
To uninstall, just remove the !ClearFont and Fonts folders.
Switching between supplied font packs (updated for v20000-2)
Refer to "How to use the font packs.txt" in the AddOns\ClearFont\ folder for more details.
Note that you can download the Font Pack from: http://clearfont.gammatester.com/Font_Pack.zip .
Changing the main UI font styles
The ClearFont.lua file can be edited easily in notepad, and is annotated with extra information to help guide you.
Refer to ClearFont.lua for more details.
Remove the bold / italic / number substyles (without changing any code)
You can easily remove the different styles by copying over some files.
- Copy ClearFont.ttf to ClearFontBold.ttf
- Removes bold styles (small fonts)
- Copy ClearFont.ttf to ClearFontItalic.ttf
- Removes italic styles (quest Log / mail)
- Copy ClearFont.ttf to ClearFontBoldItalic.ttf
- Removes bold-italic styles (zone change and map notifications)
- Copy ClearFont.ttf to ClearFontNumber.ttf
- Removes number styles (action bar hotkeys, money, item stacks)
Using your own fonts and font packs (updated for v20000-2)
A font pack can be downloaded from: http://clearfont.gammatester.com/Font_Pack.zip!
It includes Perspective Sans, Baar Philos, Baar Sophia, Francophil Sans, Lucida Grande, Lucida Sans Demibold, Teen, Tin Birdhouse, and Bitstream Vera Sans.
It is simple to switch between fonts - check 'How to use the font packs.txt' in the AddOns\ClearFont folder.
If you would prefer to use your own font, I suggest creating a new font pack folder (e.g. Interface\AddOns\ClearFont\Fonts\YourFont).
Create the 5 font files that ClearFont uses (ClearFont.ttf, ClearFontBold.ttf, ClearFontItalic.ttf, ClearFontBoldItalic.ttf, and ClearFontNumber.ttf).
Next, follow the instructions in the "How to use the font packs.txt" file :)
If you want to do more advanced changes, this is also possible, and quite easy to do:
You can set up your own typeface styles near the start of the lua file, by following the given example in the lua.
Look for the relevant section in the ClearFont.lua file and change font styles to your own choices.
The fonts you choose to use must reside somewhere within the WoW directory, and should be TTF files. Other font file types may not work.
Changing text size (new with v11100-2)
There are two options - you can edit the specific line you want to change or you can change all sizes in one swoop:
You can change the scale of all the fonts by editing the CF_SCALE line in the ClearFont.lua and ClearFontAddons.lua files.
- local CF_SCALE = 1 (fonts at normal, 100%, size)
- local CF_SCALE = 0.8 (fonts at a slightly smaller, 80%, size)
- local CF_SCALE = 1.2 (fonts at a slightly larger, 120%, size)
Currently implemented overrides (updated for v20000-2)
See ClearFontAddons.lua for details. The overrides disabled by default.
Some addons may require Step Two of the install process, e.g. SCT (set font to default)
Modifying/removing the addon overrides
The addon override code follows a very similar format to the normal overrides.
Refer to the file ClearFontAddons.lua for more details.
To remove the all Addon overrides, delete the line ClearFontAddons.lua from ClearFont.toc
Step Two of the install - a simple and fast manual override
Follow Step Two of the install process (see Installation).
- This will override addons that reference stock WoW typefaces and has the added benefit of overriding the login screen fonts!
- Step Two forms part of my new override methodology - prevention before cure.
- If you still have problems with certain addons, please report them to me!
If SCT is not overridden by this, make sure the options are set to defaults, or follow the below.
How to override addons that use/supply their own fonts
Certain addons come with their own fonts which are easily overridden (if not already done so via my coded overrides)
In each case you can use a renamed copy of ClearFont.ttf in place the the supplied font.
If you mention the addon name to me, I'll see if I can add a specific override to the next CF version.
Text too large?
In many cases ClearFont makes the text size slightly larger.
Therefore, in some rare cases text may slightly overlap the bottom of some frames, such as in the Honor Panel.
See Modifying ClearFont for methods for changing the text sizes, if necessary.
Text showing as '...'? (appearing after patch 1.11)
This appears to be the result of a bug in WoW, and affects those with a screen resolution of around 1680x1050.
It is related to the UI scale, and is easily resolved!
- Fiddle with the UI scale settings in game.
- If that fails, you can try deleting the file 'config.wtf' found in the [WoW directory]\WTF\ folder.
- If that fails, try using the new CF_SCALE method to scale the fonts to somewhere around 80% (see Modifying ClearFont).
Worried about slowdown / the download size?
Although ClearFont may seem a large download (due to the inclusion of the font files), the actual in-game memory footprint is tiny.
It should have little effect on load times as it merely replaces fonts rather than adds extra 'functions' to WoW.
Does ClearFont use a Saved Variables file?
Currently ClearFont does not use these - this may change in the future, when I get around to coding the giant options menu.
People to thank!
- Devla for his FonTabulous addon which started it all off,
- Iriel for helping me code for Patch 1.10,
- Cairenn at WoW Interface for being wonderful,
- sancus, Kolth & Dark Imakuni and many others for their help testing CF,
- Plus many, many others for their support and help!