pyxel

library2.9.5pypypi✓ verified 86d ago

A retro game engine for Python, designed for creating pixel-art games. Latest version: 2.9.5. Release cadence: irregular, major updates every few months.

web-framework

pip install pyxel

github ↗package ↗changelog ↗

INSTALL

IMPORT

SIG · PYXEL

pyxel

web-frameworkpythonv2.9.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

pyxel

✓ import pyxel

✗ from pyxel import *

Wildcard imports discouraged; import pyxel then use pyxel.init(), etc.

Minimal Pyxel app with a window, update loop, and quit on Q.

import pyxel pyxel.init(160, 120) class App: def __init__(self): pyxel.run(self.update, self.draw) def update(self): if pyxel.btnp(pyxel.KEY_Q): pyxel.quit() def draw(self): pyxel.cls(0) pyxel.text(55, 41, "Hello, Pyxel!", 7) App()

pyxel --version

Debug

Known issues

breakingPyxel 2.0 introduced many breaking changes: API redesigned, removed old classes like `pyxel.App`, `pyxel.Image`, etc. Functions now use lower_case instead of camelCase.

fix

Rewrite to use new API: `pyxel.init()` instead of `pyxel.init(width, height, caption)`, `pyxel.run()` instead of `pyxel.App().run()`, `pyxel.btnp()` instead of `pyxel.btn()` for press detection.

affects: <2.0 (upgrade to 2.x)

gotchaOn macOS, Pyxel may fail to launch if the terminal doesn't have accessibility permissions. The window may appear but is unresponsive.

fix

Grant Accessibility permission to the terminal (System Preferences → Security & Privacy → Privacy → Accessibility → add your terminal app).

affects: all

breakingPyxel 2.2 changed the default palette from 16 colors to the PICO-8 palette. Existing projects may look different.

fix

Use `pyxel.colors.from_list(pyxel.COLORS_16)` to restore old palette, or adjust colors.

affects: >=2.2

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'pyxel'

Pyxel not installed or Python version <3.10.

fix

Install with `pip install pyxel` and ensure Python >=3.10.

pyxel.init() takes 2 positional arguments but 3 were given

Old code passing caption as third argument; modern pyxel.init() only takes width, height.

fix

Remove the caption argument: `pyxel.init(160, 120)` instead of `pyxel.init(160, 120, "My Game")`.

AttributeError: module 'pyxel' has no attribute 'App'

Old code using `pyxel.App` which was removed in 2.0.

fix

Use `pyxel.run(update, draw)` inside a class or functions. See quickstart.

Upgrade

Version history

2.9.5latest on PyPI · released May 3, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/kitao/pyxel ↗

packagehttps://pypi.org/project/pyxel/ ↗

changeloghttps://github.com/kitao/pyxel/blob/main/CHANGELOG.md ↗