A retro game engine for Python
Project description
[ English | 中文 | Deutsch | Español | Français | Italiano | 日本語 | 한국어 | Português | Русский | Türkçe | Українська ]
Pyxel is a retro game engine for Python.
Thanks to its simple specifications inspired by retro gaming consoles, such as only 16 colors can be displayed and only 4 sounds can be played back at the same time, you can feel free to enjoy making pixel art style games.
The motivation for the development of Pyxel is the feedback from users. Please give Pyxel a star on GitHub!
Pyxel's specifications and APIs are inspired by PICO-8 and TIC-80.
Pyxel is open source and free to use. Let's start making a retro game with Pyxel!
Specifications
- Runs on Windows, Mac, Linux, and Web
- Programming with Python
- 16 color palette
- 256x256 sized 3 image banks
- 256x256 sized 8 tilemaps
- 4 channels with 64 definable sounds
- 8 musics which can combine arbitrary sounds
- Keyboard, mouse, and gamepad inputs
- Image and sound editor
Color Palette
How to Install
Windows
After installing Python3 (version 3.8 or higher), run the following command:
pip install -U pyxel
If you install Python using the official installer, please check the Add Python 3.x to PATH
checkbox to enable pyxel
command.
Mac
After installing Homebrew, run the following commands:
brew install pipx
pipx ensurepath
pipx install pyxel
To update the version after installing Pyxel, run pipx upgrade pyxel
.
Linux
After installing the SDL2 package (libsdl2-dev
for Ubuntu), Python3 (version 3.8 or higher), and python3-pip
, run the following command:
sudo pip3 install -U pyxel
If the above doesn't work, try self-building according to the instructions in Makefile.
Web
The web version of Pyxel does not require Python or Pyxel installation and runs on PCs as well as smartphones and tablets with supported web browsers.
For specific instructions, please refer to this page.
Try Pyxel Examples
After installing Pyxel, the examples of Pyxel will be copied to the current directory with the following command:
pyxel copy_examples
The examples to be copied are as follows:
01_hello_pyxel.py | Simplest application | Demo | Code |
02_jump_game.py | Jump game with Pyxel resource file | Demo | Code |
03_draw_api.py | Demonstration of drawing APIs | Demo | Code |
04_sound_api.py | Demonstration of sound APIs | Demo | Code |
05_color_palette.py | Color palette list | Demo | Code |
06_click_game.py | Mouse click game | Demo | Code |
07_snake.py | Snake game with BGM | Demo | Code |
08_triangle_api.py | Demonstration of triangle drawing APIs | Demo | Code |
09_shooter.py | Shoot'em up game with screen transition | Demo | Code |
10_platformer.py | Side-scrolling platform game with map | Demo | Code |
11_offscreen.py | Offscreen rendering with Image class | Demo | Code |
12_perlin_noise.py | Perlin noise animation | Demo | Code |
13_bitmap_font.py | Drawing a bitmap font | Demo | Code |
14_synthesizer.py | Synthesizer utilizing audio expantion features | Demo | Code |
15_tiled_map_file.py | Loading and drawing a Tile Map File (.tmx) | Demo | Code |
99_flip_animation.py | Animation with flip function (non-web platforms only) | Demo | Code |
30SecondsOfDaylight.pyxapp | 1st Pyxel Jam winning game by Adam | Demo | Code |
megaball.pyxapp | Arcade ball physics game by Adam | Demo | Code |
8bit-bgm-gen.pyxapp | Background music generator by frenchbread | Demo | Code |
An examples can be executed with the following commands:
cd pyxel_examples
pyxel run 01_hello_pyxel.py
pyxel play 30SecondsOfDaylight.pyxapp
How to Use
Create Pyxel Application
After importing the Pyxel module in your python script, specify the window size with init
function first, then starts the Pyxel application with run
function.
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)
The arguments of run
function are update
function to update each frame and draw
function to draw screen when necessary.
In an actual application, it is recommended to wrap pyxel code in a class as below:
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, 8, 8, 9)
App()
When creating simple graphics without animation, show
function can be used to make the code more concise.
import pyxel
pyxel.init(120, 120)
pyxel.cls(1)
pyxel.circb(60, 60, 40, 7)
pyxel.show()
Run Pyxel Application
The created Python script can be executed with the following command:
pyxel run PYTHON_SCRIPT_FILE
It can also be executed like a normal Python script:
python3 PYTHON_SCRIPT_FILE
Special Controls
The following special controls can be performed while a Pyxel application is running:
Esc
Quit the applicationAlt(Option)+1
Save the screenshot to the desktopAlt(Option)+2
Reset the recording start time of the screen capture videoAlt(Option)+3
Save the screen capture video to the desktop (up to 10 seconds)Alt(Option)+9
Switch between screen modes (Crisp/Smooth/Retro)Alt(Option)+0
Toggle the performance monitor (fps, update time, and draw time)Alt(Option)+Enter
Toggle full screenShift+Alt(Option)+1/2/3
Save the corresponding image bank to the desktopShift+Alt(Option)+0
Save the current color palette to the desktop
How to Create Resources
Pyxel Editor can create images and sounds used in a Pyxel application.
It starts with the following command:
pyxel edit PYXEL_RESOURCE_FILE
If the specified Pyxel resource file (.pyxres) exists, the file is loaded, and if it does not exist, a new file is created with the specified name. If the resource file is omitted, the name is my_resource.pyxres
.
After starting Pyxel Editor, the file can be switched by dragging and dropping another resource file.
The created resource file can be loaded with load
function.
Pyxel Editor has the following edit modes.
Image Editor
The mode to edit the image banks.
Drag and drop an image file (PNG/GIF/JPEG) onto the Image Editor to load the image into the currently selected image bank.
Tilemap Editor
The mode to edit tilemaps in which images of the image banks are arranged in a tile pattern.
Drag and drop a TMX file (Tiled Map File) onto the Tilemap Editor to load its layer in the drawing order that corresponds to the currently selected tilemap number.
Sound Editor
The mode to edit sounds.
Music Editor
The mode to edit musics in which the sounds are arranged in order of playback.
Other Resource Creation Methods
Pyxel images and tilemaps can also be created by the following methods:
- Create an image from a list of strings with
Image.set
function orTilemap.set
function - Load an image file (PNG/GIF/JPEG) in Pyxel palette with
Image.load
function
Pyxel sounds can also be created in the following method:
- Create a sound from strings with
Sound.set
function orMusic.set
function
Please refer to the API reference for usage of these functions.
How to Distribute Applications
Pyxel supports a dedicated application distribution file format (Pyxel application file) that works across platforms.
Create the Pyxel application file (.pyxapp) with the following command:
pyxel package APP_DIR STARTUP_SCRIPT_FILE
If the application should include resources or additional modules, place them in the application directory.
The created application file can be executed with the following command:
pyxel play PYXEL_APP_FILE
Pyxel application file also can be converted to an executable or an HTML file with the pyxel app2exe
or pyxel app2html
commands.
API Reference
System
-
width
,height
The width and height of the screen -
frame_count
The number of the elapsed frames -
init(width, height, [title], [fps], [quit_key], [display_scale], [capture_scale], [capture_sec])
Initialize the Pyxel application with screen size (width
,height
). The following can be specified as options: the window title withtitle
, the frame rate withfps
, the key to quit the application withquit_key
, the scale of the display withdisplay_scale
, the scale of the screen capture withcapture_scale
, and the maximum recording time of the screen capture video withcapture_sec
.
e.g.pyxel.init(160, 120, title="My Pyxel App", fps=60, quit_key=pyxel.KEY_NONE, capture_scale=3, capture_sec=0)
-
run(update, draw)
Start the Pyxel application and callupdate
function for frame update anddraw
function for drawing. -
show()
Show the screen and wait until theEsc
key is pressed. -
flip()
Refresh the screen by one frame. The application exits when theEsc
key is pressed. This function does not work in the web version. -
quit()
Quit the Pyxel application.
Resource
load(filename, [excl_images], [excl_tilemaps], [excl_sounds], [excl_musics])
Load the resource file (.pyxres). If an option isTrue
, the resource will not be loaded. If a palette file (.pyxpal) of the same name exists in the same location as the resource file, the palette display color will also be changed. The palette file is a hexadecimal entry of the display colors (e.g.1100FF
), separated by newlines. The palette file can also be used to change the colors displayed in Pyxel Editor.
Input
-
mouse_x
,mouse_y
The current position of the mouse cursor -
mouse_wheel
The current value of the mouse wheel -
btn(key)
ReturnTrue
ifkey
is pressed, otherwise returnFalse
. (Key definition list) -
btnp(key, [hold], [repeat])
ReturnTrue
ifkey
is pressed at that frame, otherwise returnFalse
. Whenhold
andrepeat
are specified,True
will be returned at therepeat
frame interval when thekey
is held down for more thanhold
frames. -
btnr(key)
ReturnTrue
ifkey
is released at that frame, otherwise returnFalse
. -
mouse(visible)
Ifvisible
isTrue
, show the mouse cursor. IfFalse
, hide it. Even if the mouse cursor is not displayed, its position is updated.
Graphics
-
colors
List of the palette display colors. The display color is specified by a 24-bit numerical value. Usecolors.from_list
andcolors.to_list
to directly assign and retrieve Python lists.
e.g.old_colors = pyxel.colors.to_list(); pyxel.colors.from_list([0x111111, 0x222222, 0x333333]); pyxel.colors[15] = 0x112233
-
images
List of the image banks (0-2). (See the Image class)
e.g.pyxel.images[0].load(0, 0, "title.png")
-
tilemaps
List of the tilemaps (0-7). (See the Tilemap class) -
clip(x, y, w, h)
Set the drawing area of the screen from (x
,y
) to widthw
and heighth
. Reset the drawing area to full screen withclip()
. -
camera(x, y)
Change the upper left corner coordinates of the screen to (x
,y
). Reset the upper left corner coordinates to (0
,0
) withcamera()
. -
pal(col1, col2)
Replace colorcol1
withcol2
at drawing.pal()
to reset to the initial palette. -
dither(alpha)
Applies dithering (pseudo-transparency) at drawing. Setalpha
in the range 0.0-1.0, where 0.0 is transparent and 1.0 is opaque. -
cls(col)
Clear screen with colorcol
. -
pget(x, y)
Get the color of the pixel at (x
,y
). -
pset(x, y, col)
Draw a pixel of colorcol
at (x
,y
). -
line(x1, y1, x2, y2, col)
Draw a line of colorcol
from (x1
,y1
) to (x2
,y2
). -
rect(x, y, w, h, col)
Draw a rectangle of widthw
, heighth
and colorcol
from (x
,y
). -
rectb(x, y, w, h, col)
Draw the outline of a rectangle of widthw
, heighth
and colorcol
from (x
,y
). -
circ(x, y, r, col)
Draw a circle of radiusr
and colorcol
at (x
,y
). -
circb(x, y, r, col)
Draw the outline of a circle of radiusr
and colorcol
at (x
,y
). -
elli(x, y, w, h, col)
Draw an ellipse of widthw
, heighth
and colorcol
from (x
,y
). -
ellib(x, y, w, h, col)
Draw the outline of an ellipse of widthw
, heighth
and colorcol
from (x
,y
). -
tri(x1, y1, x2, y2, x3, y3, col)
Draw a triangle with vertices (x1
,y1
), (x2
,y2
), (x3
,y3
) and colorcol
. -
trib(x1, y1, x2, y2, x3, y3, col)
Draw the outline of a triangle with vertices (x1
,y1
), (x2
,y2
), (x3
,y3
) and colorcol
. -
fill(x, y, col)
Fill the area connected with the same color as (x
,y
) with colorcol
. -
blt(x, y, img, u, v, w, h, [colkey])
Copy the region of size (w
,h
) from (u
,v
) of the image bankimg
(0-2) to (x
,y
). If negative value is set forw
and/orh
, it will reverse horizontally and/or vertically. Ifcolkey
is specified, treated as transparent color.
bltm(x, y, tm, u, v, w, h, [colkey])
Copy the region of size (w
,h
) from (u
,v
) of the tilemaptm
(0-7) to (x
,y
). If negative value is set forw
and/orh
, it will reverse horizontally and/or vertically. Ifcolkey
is specified, treated as transparent color. The size of a tile is 8x8 pixels and is stored in a tilemap as a tuple of(tile_x, tile_y)
.
text(x, y, s, col)
Draw a strings
of colorcol
at (x
,y
).
Audio
-
sounds
List of the sounds (0-63). (See the Sound class)
e.g.pyxel.sounds[0].speed = 60
-
musics
List of the musics (0-7). (See the Music class) -
play(ch, snd, [tick], [loop], [resume])
Play the soundsnd
(0-63) on channelch
(0-3). Ifsnd
is a list, it will be played in order. The playback start position can be specified bytick
(1 tick = 1/120 seconds). IfTrue
is specified forloop
, loop playback is performed. To resume the previous sound after playback ends, setresume
toTrue
. -
playm(msc, [tick], [loop])
Play the musicmsc
(0-7). The playback start position can be specified bytick
(1 tick = 1/120 seconds). IfTrue
is specified forloop
, loop playback is performed. -
stop([ch])
Stops playback of the specified channelch
(0-3).stop()
to stop playing all channels. -
play_pos(ch)
Get the sound playback position of channelch
(0-3) as a tuple of(sound no, note no)
. ReturnsNone
when playback is stopped.
Math
-
ceil(x)
Returns the smallest integer greater than or equal tox
. -
floor(x)
Returns the largest integer less than or equal tox
. -
sgn(x)
Returns 1 whenx
is positive, 0 when it is zero, and -1 when it is negative. -
sqrt(x)
Returns the square root ofx
. -
sin(deg)
Returns the sine ofdeg
degrees. -
cos(deg)
Returns the cosine ofdeg
degrees. -
atan2(y, x)
Returns the arctangent ofy
/x
in degrees. -
rseed(seed)
Sets the seed of the random number generator. -
rndi(a, b)
Returns an random integer greater than or equal toa
and less than or equal tob
. -
rndf(a, b)
Returns a random decimal greater than or equal toa
and less than or equal tob
. -
nseed(seed)
Sets the seed of Perlin noise. -
noise(x, [y], [z])
Returns the Perlin noise value for the specified coordinates.
Image Class
-
width
,height
The width and height of the image -
set(x, y, data)
Set the image at (x
,y
) by a list of strings.
e.g.pyxel.images[0].set(10, 10, ["0123", "4567", "89ab", "cdef"])
-
load(x, y, filename)
Load the image file (PNG/GIF/JPEG) at (x
,y
). -
pget(x, y)
Get the pixel color at (x
,y
). -
pset(x, y, col)
Draw a pixel of colorcol
at (x
,y
).
Tilemap Class
-
width
,height
The width and height of the tilemap -
imgsrc
The image bank (0-2) referenced by the tilemap -
set(x, y, data)
Set the tilemap at (x
,y
) by a list of strings.
e.g.pyxel.tilemap(0).set(0, 0, ["0000 0100 a0b0", "0001 0101 a1b1"])
-
load(x, y, filename, layer)
Load the layer in the drawing orderlayer
(0-) from the TMX file (Tiled Map File) at (x
,y
). -
pget(x, y)
Get the tile at (x
,y
). A tile is a tuple of(tile_x, tile_y)
. -
pset(x, y, tile)
Draw atile
at (x
,y
). A tile is a tuple of(tile_x, tile_y)
.
Sound Class
-
notes
List of notes (0-127). The higher the number, the higher the pitch, and at 33 it becomes 'A2'(440Hz). The rest is -1. -
tones
List of tones (0:Triangle / 1:Square / 2:Pulse / 3:Noise) -
volumes
List of volumes (0-7) -
effects
List of effects (0:None / 1:Slide / 2:Vibrato / 3:FadeOut / 4:Half-FadeOut / 5:Quarter-FadeOut) -
speed
Playback speed. 1 is the fastest, and the larger the number, the slower the playback speed. At 120, the length of one note becomes 1 second. -
set(notes, tones, volumes, effects, speed)
Set notes, tones, volumes, and effects with a string. If the tones, volumes, and effects length are shorter than the notes, it is repeated from the beginning. -
set_notes(notes)
Set the notes with a string made of 'CDEFGAB'+'#-'+'01234' or 'R'. Case-insensitive and whitespace is ignored.
e.g.pyxel.sounds[0].set_notes("G2B-2D3R RF3F3F3")
-
set_tones(tones)
Set the tones with a string made of 'TSPN'. Case-insensitive and whitespace is ignored.
e.g.pyxel.sounds[0].set_tones("TTSS PPPN")
-
set_volumes(volumes)
Set the volumes with a string made of '01234567'. Case-insensitive and whitespace is ignored.
e.g.pyxel.sounds[0].set_volumes("7777 7531")
-
set_effects(effects)
Set the effects with a string made of 'NSVFHQ'. Case-insensitive and whitespace is ignored.
e.g.pyxel.sounds[0].set_effects("NFNF NVVS")
Music Class
-
seqs
Two-dimensional list of sounds (0-63) with the number of channels -
set(seq0, seq1, seq2, ...)
Set the lists of sound (0-63) of channels. If an empty list is specified, that channel is not used for playback.
e.g.pyxel.musics[0].set([0, 1], [], [3])
Advanced APIs
Pyxel has "advanced APIs" that are not mentioned in this reference because they "may confuse users" or "need specialized knowledge to use".
If you are familiar with your skills, try to create amazing works with this as a clue!
How to Contribute
Submitting Issues
Use the Issue Tracker to submit bug reports and feature/enhancement requests. Before submitting a new issue, ensure that there is no similar open issue.
Manual Testing
Anyone manually testing the code and reporting bugs or suggestions for enhancements in the Issue Tracker are very welcome!
Submitting Pull Requests
Patches/fixes are accepted in form of pull requests (PRs). Make sure the issue the pull request addresses is open in the Issue Tracker.
Submitted pull request is deemed to have agreed to publish under MIT License.
Other Information
License
Pyxel is under MIT License. It can be reused within proprietary software, provided that all copies of the software or its substantial portions include a copy of the terms of the MIT License and also a copyright notice.
Recruiting Sponsors
Pyxel is looking for sponsors on GitHub Sponsors. Consider sponsoring Pyxel for continued maintenance and feature additions. Sponsors can consult about Pyxel as a benefit. Please see here for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for pyxel-2.1.9-cp38-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e80046362658a03dbfc942af9ca37f7f43046d31094dfdaf3f1e5aa750978c4a |
|
MD5 | c9926e239d69b7d40d957aff110b3cec |
|
BLAKE2b-256 | 01a7f85930bf236f6c8e08bc81607aefc76c4cbaf81d4a8c40552efdeae8132a |
Hashes for pyxel-2.1.9-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2930b6dc7b710cbcf7ef27366c36bb55a4a1a15b50f32312ddcc1c8b13e05017 |
|
MD5 | e2f33e2dea88760cfb94fed2e3041141 |
|
BLAKE2b-256 | d7d2978926937cfe6a461725642a2dec4fad579ca4e841c52275175baabb62c6 |
Hashes for pyxel-2.1.9-cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a00e15b20bb31e7a5abb3fdcffad9f31c8e18a2b08b0e796b6ada8989534e76 |
|
MD5 | 7ec23aad989a3c090cd40a0ffdbc21e6 |
|
BLAKE2b-256 | 3ff32cccb309f9a0d97cbf7307d51ae0fb5a4129c9de9aba6e3e89580e896555 |
Hashes for pyxel-2.1.9-cp38-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0a2726fe47836c28d415e4be3082beb6c4fb1599e7f2582bcd1c7e13200f9b2 |
|
MD5 | 5502fa5a83ebd260d98687f1ec6410e0 |
|
BLAKE2b-256 | 501225388e8e464df5d211cbccd025144cba3a6354abfea7d8f8c168a93fe5b8 |
Hashes for pyxel-2.1.9-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b5dda96710edbbff1c649ad1b7d9d7703ec00ed6d7b2af557560cabc732f0dc |
|
MD5 | 778885b320f5b1ded8845f4cfcf09dbb |
|
BLAKE2b-256 | 5d97da146e6e853d17bdb189a3979088c838a2ce7133f62dbc9d2a25b0e86682 |
Hashes for pyxel-2.1.9-cp38-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a61b06bd15e211afbde8d50323c218a11a2911eb4d67384654fb0db9104641a |
|
MD5 | 3c5b7568e3f55b25136e7444a3b721d2 |
|
BLAKE2b-256 | 9d304da1a953479723d861255a3e3f1c3b4512dca818d17afffc33d91d46256c |
Hashes for pyxel-2.1.9-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c9947c13831455ab4787744cd09d94e35b0e5e88d75aa52ceb9fa7b1bc17748 |
|
MD5 | 6ed077769bd060c900f4810c1ac34792 |
|
BLAKE2b-256 | 08ec6ac110bcaebdf68abd149287a28c5020592bae058511af3d4d86520a41e5 |