README.ja

[ English | 日本語 | Other Languages ]

Pyxel (ピクセル) はPython向けのレトロゲームエンジンです。

使える色は16色のみ、同時に再生できる音は4音までなど、レトロゲーム機を意識したシンプルな仕様で、Pythonでドット絵スタイルのゲームづくりが気軽に楽しめます。

Pyxelのゲーム機の仕様やAPI、パレットなどは、
PICO-8やTIC-80のデザインを参考にしています。

Pyxelはオープンソースで、無料で自由に使えます。Pyxelでレトロゲームづくりを始めましょう！

仕様

• Windows、Mac、Linux対応
• Python3によるコード記述
• 16色固定パレット
• 256x256サイズ、3画像バンク
• 4音同時再生、定義可能な64サウンドバンク
• キーボード、マウス、ジョイスティック (予定)
• 画像・サウンド編集ツール (予定)

カラーパレット

インストール方法

Windows

Python3をインストールした後に、以下のpipコマンドでPyxelをインストールします。

pip install pyxel

Mac

Python3とglfw (バージョン3.2.1以上) をインストールをした後に、pipコマンドでPyxelをインストールします。

Homebrewを導入している環境では、以下のコマンドで必要なパッケージが一通りインストールできます。

brew install python3 glfw
pip3 install pyxel

Linux

各ディストリビューションに適した方法で必要なパッケージをインストールしてください。glfwはバージョン3.2.1以上である必要があります。

Arch:

AURヘルパーでpython-pixelをインストールします。

yay -S python-pyxel

Debian:

apt-get install python3 python3-pip libglfw3 libportaudio2 libasound-dev
pip3 install pyxel

Fedora:

dnf install glfw portaudio
pip3 install pyxel

サンプルのインストール

Pyxelインストール後に、以下のコマンドでカレントディレクトリにPyxelのサンプルコード一式をコピーできます。

install_pyxel_examples

使い方

アプリケーションの作成方法

Pythonコード内でPyxelモジュールをインポートして、init関数でウィンドウサイズを指定した後に、run関数でPyxelアプリケーションを開始します。

import pyxel

pyxel.init(160, 120)

def update():
    if pyxel.btnp(pyxel.KEY_Q):
        pyxel.quit()

def draw():
    pyxel.cls(0)
    pyxel.rect(10, 10, 20, 20, 11)

pyxel.run(update, draw)

run関数の引数にはフレーム更新処理を行うupdate関数と、描画処理を行うdraw関数を指定します。

実際のアプリケーションでは、以下のようにクラスでPyxelの処理をラップするのがおすすめです。

import pyxel

class App:
    def __init__(self):
        pyxel.init(160, 120)
        self.x = 0
        pyxel.run(self.update, self.draw)

    def update(self):
        self.x = (self.x + 1) % pyxel.width

    def draw(self):
        pyxel.cls(0)
        pyxel.rect(self.x, 0, self.x + 7, 7, 9)

App()

特殊操作

Pyxelアプリケーション実行中に、以下の特殊操作を行うことができます。

• Alt(Option)+1
  スクリーンショットをデスクトップに保存する
• Alt(Option)+2
  画面キャプチャ動画の録画開始時刻をリセットする
• Alt(Option)+3
  画面キャプチャ動画 (gif) をデスクトップに保存する (最大30秒)
• Alt(Option)+0
  パフォーマンスモニタ (fps、update時間、draw時間) の表示を切り替える
• Alt(Option)+Enter
  フルスクリーン表示を切り替える

画像の作成方法

Pyxel用の画像を作成するには以下の方法があります。

• Image.set関数で文字列のリストから作成する
• Image.load関数でPyxel向け配色のpngファイルを読み込む
• Pyxelエディタで作成する (開発中)

Image.set、Image.loadの使い方はAPIリファレンスを参照してください。

PyxelはPICO-8と同じパレットを使用しているため、Pyxel向け配色のpngファイルを作成する場合は、AsepriteをPICO-8パレット設定にして使用するのがおすすめです。

APIリファレンス

システム

• width, height
  画面の幅と高さ

• frame_count
  経過フレーム数

• init(width, height, [caption], [scale], [palette], [fps], [border_width], [border_color])
  Pyxelアプリを画面サイズ (width, height) で初期化する。画面の最大の幅と高さは255
  captionでウィンドウタイトル、scaleで表示倍率、paletteでパレット色、fpsで動作フレームレート、border_widthとborder_colorで画面外側のマージン幅と色を指定できる。paletteは24ビットカラーの16要素のリスト、border_colorは24ビットカラーで指定する

• run(update, draw)
  Pyxelアプリを開始し、フレーム更新時にupdate関数、描画時にdraw関数を呼ぶ

• quit()
  現在フレーム終了時にPyxelアプリを終了する

入力

• mouse_x, mouse_y
  現在のマウスカーソル座標

• btn(key)
keyが押されていたらTrue、押されていなければFalseを返す (キー定義一覧)

• btnp(key, [hold], [period])
  そのフレームにkeyが押されたらTrue、押されなければFalseを返す。holdとperiodを指定すると、holdフレーム以上ボタンを押し続けた際にperiodフレーム間隔でTrueが返る

• btnr(key)
  そのフレームにkeyが離されたらTrue、離されなければFalseを返す

グラフィックス

• image(img, [system])
  イメージバンクimg(0-2) を操作する (イメージクラスを参照のこと)。systemにTrueを指定すると、システム用のイメージバンク3にアクセスできる
  例：pyxel.image(0).load(0, 0, 'title.png')

• clip(x1, y1, x2, y2)
  画面の描画領域を (x1, y1)-(x2, y2) にする。clip()で描画領域をリセットする

• pal(col1, col2)
  描画時に色col1をcol2に置き換える。pal()で初期状態にリセットする

• cls(col)
  画面を色colでクリアする

• pix(x, y, col)
  (x, y) に色colのピクセルを描画する

• line(x1, y1, x2, y2, col)
  色colの直線を (x1, y1)-(x2, y2) に描画する

• rect(x1, y1, x2, y2, col)
  色colの矩形を (x1, y1)-(x2, y2) に描画する

• rectb(x1, y1, x2, y2, col)
  色colの矩形の輪郭線を (x1, y1)-(x2, y2) に描画する

• circ(x, y, r, col)
  半径r、色colの円を (x, y) に描画する

• circb(x, y, r, col)
  半径r、色colの円の輪郭線を (x, y) に描画する

• blt(x, y, img, sx, sy, w, h, [colkey])
  イメージバンクimg(0-2) の (sx, sy) からサイズ (w, h) の領域を (x, y) にコピーする。w、hそれぞれに負の値を設定すると水平、垂直方向に反転する。colkeyに色を指定すると透明色として扱われる

• text(x, y, s, col)
  色colの文字列sを (x, y) に描画する

オーディオ

• sound(snd)
  サウンドバンクsnd(0-63) を操作する (サウンドクラスを参照のこと)
  例：pyxel.sound(0).speed = 60

• play(ch, snd, loop=False)
  チャンネルch(0-3) でサウンドバンクsnd(0-63) を再生する。sndがリストの場合順に再生する

• stop(ch)
  チャンネルch(0-3) の再生を停止する

イメージクラス

• width, height
  イメージの幅と高さ

• data
  イメージのデータ (NumPy配列)

• set(x, y, data)
  (x, y) に文字列のリストでイメージを設定する
  例：pyxel.image(0).set(10, 10, ['1234', '5678', '9abc', 'defg'])

• load(x, y, filename, [dirname])
  (x, y) に実行スクリプトのディレクトリまたはdirnameからpngファイルを読み込む

• copy(x, y, img, sx, sy, width, height)
  イメージバンクimg(0-2) の (sx, sy) からサイズ (width, height) の領域を (x, y) にコピーする

サウンドクラス

• note
  音程 (0-127) のリスト (33 = ‘A2’ = 440Hz)

• tone
  音色 (0:Triangle / 1:Square / 2:Pulse / 3:Noise) のリスト

• volume
  音量 (0-7) のリスト

• effect
  エフェクト (0:None / 1:Slide / 2:Vibrato / 3:FadeOut) のリスト

• speed
  1音の長さ (120 = 1音1秒)

• set(note, tone, volume, effect, speed)
  文字列で音程、音色、音量、エフェクトを設定する。音色、音量、エフェクトの長さが音程より短い場合は、先頭から繰り返される

• set_note(note)
  ‘CDEFGAB’+’#-‘+’0123’または’R’の文字列で音程を設定する。大文字と小文字を区別せず、空白は無視される
  例：pyxel.sound(0).set_note('G2B-2D3R RF3F3F3')

• set_tone(tone)
  ‘TSPN’の文字列で音色を設定する。大文字と小文字を区別せず、空白は無視される
  例：pyxel.sound(0).set_tone('TTSS PPPN')

• set_volume(volume)
  ‘01234567’の文字列で音量を設定する。大文字と小文字を区別せず、空白は無視される
  例：pyxel.sound(0).set_volume('7777 7531')

• set_effect(effect)
  ‘NSVF’の文字列でエフェクトを設定する。大文字と小文字を区別せず、空白は無視される
  例：pyxel.sound(0).set_effect('NFNF NVVS')

その他情報

• Pyxel Wiki

ライセンス

PyxelはMITライセンスです。ソースコードやライセンス表示用のファイル等で、著作権とライセンス全文の表示を行えば、自由に販売や配布をすることができます。