Antonoko/Chinese-font-for-playdate

Create Chinese font or other font asset for Playdate

Create Chinese font for Playdate

为 Playdate 生成中文字体

已生成字体

一些已转换、可直接用在 Playdate 上的字体。前往 Release 下载。

• 缝合像素字体 / Fusion Pixel Font
  • fusion-pixel-font-8px-proportional-zh_hans
  • fusion-pixel-font-10px-proportional-zh_hans
  • fusion-pixel-font-12px-proportional-zh_hans
  • fusion-pixel-font-24px-proportional-zh_hans （在 12px 字体上以两倍大小渲染）
• LXGW WenKai Screen / 霞鹜文楷屏幕阅读版
  • LXGWWenKaiGBScreen-24px
  • LXGWWenKaiGBScreen-24px-anti-aliasing （抗锯齿版本）
• SourceHanSansCN / 思源黑体
  • SourceHanSansCN-M-24px
• SourceHanSerifCN / 思源宋体
  • SourceHanSerifCN-SemiBold-30px
• OPPOSans
  • OPPOSans-M-24px
• Apple
  • PingFang-M-24px

如何转换字体

1. Clone 仓库到本地: git clone https://github.com/Antonoko/Chinese-font-for-playdate
2. 安装依赖 pip install -r requirements.txt
3. 准备要生成的字体文件（如.ttf），放在 font_asset 或其他目录下；
4. 使用 python jupyter notebook 环境执行 make_font.ipynb，填写字体文件路径、生成字号等信息，Run ALL 进行生成；
5. 执行 rotate_font_direction.ipynb 可以 +90°/-90°/180° 旋转字体，以适应为不同方向制作的 Playdate 程序；

Tip

如果你只需要显示一部分的中文文字，可以自定义 TEXT_TABLE_STR 来覆盖仅会用到的文本，以降低储存与性能开销、同时使所有文字都能正常显示。

Important

欢迎通过 issue/PR 提交你生成的新字体，我们会将它放在 release 文件夹下提供。😉（如有使用 license 也请一并附上）

如何使用字体

根据 Playdate 文档 正常引入使用即可。

import "CoreLibs/graphics"
local gfx <const> = playdate.graphics
local font_12 = gfx.font.new('font/fusion-pixel-font-12px-proportional-zh_hans')

function playdate.update()
    gfx.setFont(font_12)
    gfx.drawText('你好世界', 2, 2)
end

如何渲染字体

playdate.graphics.drawTextInRect 在渲染中文段落时会存在非正确换行排版的问题，此处提供一个替代函数。 需要注意的是，由于 lua 对 Unicode 支持较差，因此需要传入的 text_tbl 为包含若干独立字符的 table，而非 string。

function draw_text_area(text_tbl, lineheight_factor, char_kerning, font, draw_mode, start_x, start_y, width, height)
    -- example:
    -- draw_text_area({"你","好"}, 1.6, 0, gfx.font.new('font/SourceHanSansCN-M-20px'), playdate.graphics.kDrawModeCopy, 0, 0, 300, 200)
    --
    -- return:
    -- char_offset: how many chars has been drawn

    function _findNextSpaceIndex(tbl, index)
        if index >= #tbl then
            return -1
        end
        for i = index + 1, #tbl do
            if tbl[i] == " " then
                if i > 12 then  --max line break char length
                    return -1
                else
                    return i
                end
            end
        end
        return -1
    end

    local char_offset = 1
    local current_x = start_x
    local current_y = start_y
    gfx.setFont(font)
    gfx.setImageDrawMode(draw_mode)
    local max_zh_char_size = gfx.getTextSize("啊") + char_kerning
    local lineheight = max_zh_char_size * lineheight_factor

    function _linebreak_offset()
        current_x = start_x
        current_y += lineheight
    end

    for key, char in pairs(text_tbl) do
        if current_y > height - lineheight then
            break
        end

        if char == "\n" then
            _linebreak_offset()
        else
            if char == " " then  --word break
                local next_space_index = _findNextSpaceIndex(text_tbl, key)
                local word_width = 0
                if next_space_index > 1 and next_space_index > key then
                    for i = key+1, next_space_index do
                        word_width += gfx.getTextSize(text_tbl[i]) + char_kerning
                    end
                    if current_x + word_width > width - max_zh_char_size then
                        _linebreak_offset()
                    end
                end
            end
            
            gfx.drawTextAligned(char, current_x, current_y, kTextAlignment.left)
            current_x += gfx.getTextSize(char) + char_kerning
        end
        
        if current_x > width - max_zh_char_size then
            _linebreak_offset()
        end

        char_offset += 1
    end

    return char_offset
end