An extension tool to add fonts to the public "pyxel" library.
Project description
PyxelUniversalFont
PyxelUniversalFontは、公開されている"pyxel"ライブラリにフォントを追加するための拡張ツールです。
目次
機能
- pyxelで使える追加のフォントを簡単にインストール
- カスタムフォントの追加サポート
- pyxelのゲームやアプリケーションでの文字表示を綺麗に、多様に
インストール方法
pip install pyxel-universal-font
その後、pyxelのプロジェクト内で以下のようにインポートしてください。
import PyxelUniversalFont
使用方法
PyxelUniversalFont(以下、puf)は、Pyxel内でさまざまなフォントを使用するためのツールキットです。このツールキットを使うことで、Pyxelのゲームやアプリケーションにカスタムフォントを簡単に追加することができます。
フォントの設定
まず、puf.Writer("フォントファイル名")
を使用して、使用したいフォントを指定します。例えば、puf.Writer("misaki_gothic.ttf")
とすることで、misaki_gothic.ttfというフォントを指定しています。
-
利用可能なフォントの一覧は
puf.get_available_fonts()
を使用して取得できます。 -
また、すべての利用可能なフォントを一度にアクティベートしたい場合は、
puf.get_writers()
を使用すると便利です。この関数は各フォントに対するwriterオブジェクトを含む辞書を返します。
テキストの描画
指定したフォントを用いて、テキストを描画するには、writer.draw()メソッドを使用します。このメソッドは以下の引数を取ります:
- x, y: テキストの描画開始位置
- text: 描画するテキスト内容
- font_size: フォントのサイズ(デフォルトは16)
- color: テキストの色(1〜15がPyxelのデフォルトカラー、16はモザイク。デフォルトは0、すなわち黒)
- bg_color: テキストの背景色(デフォルトは-1、すなわち透明)
このメソッドを使用することで、簡単にPyxel上にテキストを描画することができます。
サンプルコード
import pyxel
import PyxelUniversalFont as puf
pyxel.init(500, 50)
# フォントを指定
writer = puf.Writer("misaki_gothic.ttf")
pyxel.cls(7)
# draw(x座標, y座標, テキスト, フォントサイズ, 文字の色(16:モザイク))
# 背景色はデフォルト値(-1:透明)
writer.draw(25, 4, "PyselUniversalFont", 50, 16)
pyxel.show()
サポートしているフォント
以下は、デフォルトでサポートされているフォントです。
次のコマンドで開かれるディレクトリに、任意のフォントを追加できます。
puf edit
コマンド一覧
- サンプルアプリケーションの起動:
puf sample
- フォント保存用ディレクトリを開く:
puf edit
更新情報
- 2023.09.26:安定版(v1.1.1)が公開されました。
ライセンス
MITライセンスの下で公開されています。詳細はLICENSE
ファイルを参照してください。
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyxel-universal-font-1.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 481f7bb37b2ae546dfc16fedb32b536a7463a6efcf5289fd4aa6f28a9d166bf0 |
|
MD5 | c32b2973b247abbbebb6ad672fa5130c |
|
BLAKE2b-256 | 87f08972ba707774bbd7f3331b786a63548cae13391775d8fc7417a63eed1424 |
Hashes for pyxel_universal_font-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4f9945a595bf25ddec0ed7785ceaf6a408856c41c437a11ee600a8ddd8a0b36 |
|
MD5 | b781505fb7f0e62fb0f38561632c6dbb |
|
BLAKE2b-256 | 683dd1501d4b8454379471475d81c2ddad0c8879fc25a0a0f6dbc128dd2b934e |