How to import a TTF file as font which isn't installed on the system

[RVFET]

I'm using a custom font and it isn't a system font, therefore it can't be imported by its name. Is there a way to import a font from an TTF or OTF file ?

[TheFallen-Cat]

It is possible, however it is not integrated into tkinter or customtkinter, and is only possible by doing some hacks. Due to this, your font won't be platform independent.

Here is the sample code to use external fonts on windows:

# Note : You'd still have to download the font in your system
import pyglet
import customtkinter

pyglet.font.add_file('file.ttf')

root = customtkinter.CTk()

MyLabel = customtkinter.CTkLabel(root,text="test",font=('font name',25))
MyLabel.pack()

root.mainloop()

# This is not going to work on linux

[sumeshir26]

There is a module called extrafont whixh does this on all systems.

[Akascape]

@RVFET No need to use any other package/module like pyglet, it's inbuilt in customtkinter.

customtkinter.FontManager.load_font("my_font.ttf")
# then simply use that font
button = customtkinter.CTkButton(app, font=("my_font",20))

Make sure that the name of the font is properly described.

[ghost]

This only works on Windows and Linux and is accomplished by installing the font in the system. However, for macOS I believe the font the user passes ignored and SF Display is used, Apple's default. I got this from looking at customtkinter/windows/widgets/font/font_manager.py.

[BarakXYZ]

Is there a way to make it work on macOS as well?
I will test later this week if it actually doesn't work on my mac

[alejooroncoy]

And, did work on macOS? @BarakXYZ

[ghost]

I have modified customtkinter/windows/widgets/font/font_manager.py to allow for custom fonts to be loaded from files on Windows, macOS, and Linux. Here is the code:

import sys
import os
import shutil
from typing import Union


class FontManager:

    linux_font_path = "~/.fonts/"

    @classmethod
    def init_font_manager(cls):
        # Linux
        if sys.platform.startswith("linux"):
            try:
                if not os.path.isdir(os.path.expanduser(cls.linux_font_path)):
                    os.mkdir(os.path.expanduser(cls.linux_font_path))
                return True
            except Exception as err:
                sys.stderr.write("FontManager error: " + str(err) + "\n")
                return False

        # other platforms
        else:
            return True

    @classmethod
    def windows_load_font(cls, font_path: Union[str, bytes], private: bool = True, enumerable: bool = False) -> bool:
        """ Function taken from: https://stackoverflow.com/questions/11993290/truly-custom-font-in-tkinter/30631309#30631309 """

        from ctypes import windll, byref, create_unicode_buffer, create_string_buffer

        FR_PRIVATE = 0x10
        FR_NOT_ENUM = 0x20

        if isinstance(font_path, bytes):
            path_buffer = create_string_buffer(font_path)
            add_font_resource_ex = windll.gdi32.AddFontResourceExA
        elif isinstance(font_path, str):
            path_buffer = create_unicode_buffer(font_path)
            add_font_resource_ex = windll.gdi32.AddFontResourceExW
        else:
            raise TypeError('font_path must be of type bytes or str')

        flags = (FR_PRIVATE if private else 0) | (FR_NOT_ENUM if not enumerable else 0)
        num_fonts_added = add_font_resource_ex(byref(path_buffer), flags, 0)
        return bool(min(num_fonts_added, 1))

    @classmethod
    def load_font(cls, font_path: str) -> bool:
        # Windows
        if sys.platform.startswith("win"):
            return cls.windows_load_font(font_path, private=True, enumerable=False)

        # Linux
        elif sys.platform.startswith("linux"):
            try:
                shutil.copy(font_path, os.path.expanduser(cls.linux_font_path))
                return True
            except Exception as err:
                sys.stderr.write("FontManager error: " + str(err) + "\n")
                return False

        # macOS
        elif sys.platform.startswith("darwin"):
            customtkinter_directory = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))))
            font_path = os.path.join(customtkinter_directory, "assets", "fonts", "noto_sans", "regular.ttf")
            try:
                # Define the path to the Fonts folder in the user's home directory
                fonts_folder = os.path.join(os.path.expanduser("~"), "Library", "Fonts")
                # Check if the Fonts folder exists, if not, create it
                if not os.path.exists(fonts_folder):
                    os.makedirs(fonts_folder)
                # Copy the font file to the Fonts folder
                shutil.copy(font_path, fonts_folder)
                return True
            except Exception as err:
                sys.stderr.write("FontManager error: " + str(err) + "\n")
                return False
            
        # others
        else:
            return

Not sure if it will be too helpful unless @TomSchimansky adds it.

[VoidMaker06]

I would like to share with u guys that the font name and name of the font file is different, so if anyone tries to import the font file and it dosent load the font style, then try using the font name. For eg. in the image below u can see the font name, i had imported the file but it was not loading the font so when i used the font name then only it loaded the font

[santvz6]

Muchas gracias :)