#
[](https://pypi.org/project/pyxel/)
[](https://github.com/kitao/pyxel)
[](https://github.com/kitao/pyxel)
[](https://github.com/sponsors/kitao)
[](https://ko-fi.com/H2H27VDKD)
[ [English](../README.md) | [中文](README.cn.md) | [Deutsch](README.de.md) | [Español](README.es.md) | [Français](README.fr.md) | [Italiano](README.it.md) | [日本語](README.ja.md) | [한국어](README.ko.md) | [Português](README.pt.md) | [Русский](README.ru.md) | [Türkçe](README.tr.md) | [Українська](README.uk.md) ]
**Pyxel** (/ˈpɪksəl/) é um motor de jogos retro para Python.
As especificações são inspiradas em consoles de jogos retro, como o suporte para apenas 16 cores e 4 canais de som, permitindo que você desfrute facilmente da criação de jogos em estilo pixel art.
[
](https://github.com/kitao/pyxel/wiki/Pyxel-User-Examples) [
](https://gihyo.jp/book/2025/978-4-297-14657-3)
O desenvolvimento do Pyxel é impulsionado pelo feedback dos usuários. Por favor, dê uma estrela ao Pyxel no GitHub!
## Como instalar
### Windows
Após instalar o [Python3](https://www.python.org/) (versão 3.8 ou superior), execute o seguinte comando:
```sh
pip install -U pyxel
```
Ao instalar o Python usando o instalador oficial, certifique-se de marcar a opção `Add Python 3.x to PATH` para habilitar o comando `pyxel`.
### Mac
Após instalar o [Homebrew](https://brew.sh/), execute os seguintes comandos:
```sh
brew install pipx
pipx ensurepath
pipx install pyxel
```
Para atualizar o Pyxel após a instalação, execute `pipx upgrade pyxel`.
### Linux
Após instalar o pacote SDL2 (`libsdl2-dev` para Ubuntu), [Python3](https://www.python.org/) (versão 3.8 ou superior) e `python3-pip`, execute o seguinte comando:
```sh
sudo pip3 install -U pyxel
```
Se o comando anterior falhar, considere construir o Pyxel a partir do código-fonte seguindo as instruções no [Makefile](../Makefile).
### Web
A versão Web do Pyxel funciona em PCs, smartphones e tablets com um navegador compatível, sem instalar Python ou Pyxel.
A maneira mais fácil de usá-la é através do IDE online [Pyxel Code Maker](https://kitao.github.io/pyxel/wasm/code-maker/).
Para outros padrões de uso, como incorporar aplicativos Pyxel em seu próprio site, consulte [esta página](pyxel-web-en.md).
### Executar exemplos
Após instalar o Pyxel, você pode copiar os exemplos para o diretório atual com o seguinte comando:
```sh
pyxel copy_examples
```
Os seguintes exemplos serão copiados para o diretório atual:
| 01_hello_pyxel.py | Aplicativo mais simples | Demonstração | Código |
| 02_jump_game.py | Jogo de salto com arquivo de recursos Pyxel | Demonstração | Código |
| 03_draw_api.py | Demonstração das APIs de desenho | Demonstração | Código |
| 04_sound_api.py | Demonstração das APIs de som | Demonstração | Código |
| 05_color_palette.py | Lista de paletas de cores | Demonstração | Código |
| 06_click_game.py | Jogo de clique do mouse | Demonstração | Código |
| 07_snake.py | Jogo da cobrinha com BGM | Demonstração | Código |
| 08_triangle_api.py | Demonstração das APIs de desenho de triângulos | Demonstração | Código |
| 09_shooter.py | Shoot'em up com transições de tela e MML | Demonstração | Código |
| 10_platformer.py | Jogo de plataforma em rolagem lateral com mapa | Demonstração | Código |
| 11_offscreen.py | Renderização offscreen com a classe Image | Demonstração | Código |
| 12_perlin_noise.py | Animação de ruído de Perlin | Demonstração | Código |
| 13_bitmap_font.py | Desenho de uma fonte bitmap | Demonstração | Código |
| 14_synthesizer.py | Sintetizador utilizando recursos de expansão de áudio | Demonstração | Código |
| 15_tiled_map_file.py | Carregando e desenhando um Tiled Map File (.tmx) | Demonstração | Código |
| 16_transform.py | Rotação e dimensionamento de imagens | Demonstração | Código |
| 17_app_launcher.py | Launcher de aplicativos Pyxel (você pode jogar vários jogos!) | Demonstração | Código |
| 99_flip_animation.py | Animação com a função `flip` (apenas para plataformas não web) | Demonstração | Código |
Você pode arrastar e soltar um arquivo de imagem (PNG/GIF/JPEG) no editor de imagem para carregar a imagem no banco de imagens atualmente selecionado.
**Editor de Mapas de Ladrilhos**
O modo para editar os **mapas de ladrilhos** que organizam imagens dos bancos de imagens em um padrão de ladrilhos.
Arraste e solte um arquivo TMX (Tiled Map File) no editor de mapas de ladrilhos para carregar sua camada 0 no mapa de ladrilhos atualmente selecionado.
**Editor de Som**
O modo para editar os **sons** utilizados para melodias e efeitos sonoros.
**Editor de Música**
O modo para editar as **faixas de música** em que os sons são organizados em ordem de reprodução.
### Outros Métodos de Criação de Recursos
Imagens e mapas de ladrilhos do Pyxel também podem ser criados usando os seguintes métodos:
- Crie imagens ou mapas de ladrilhos a partir de listas de strings com as funções `Image.set` ou `Tilemap.set`
- Carregue arquivos de imagem compatíveis com a paleta do Pyxel (PNG/GIF/JPEG) com a função `Image.load`
Os sons e as músicas do Pyxel também podem ser criados usando o seguinte método:
- Crie-os a partir de strings com as funções `Sound.set` ou `Music.set`
Consulte a referência da API para o uso dessas funções.
### Como Distribuir Aplicações
O Pyxel suporta um formato de distribuição multiplataforma chamado arquivo de aplicativo Pyxel.
Crie um arquivo de aplicativo Pyxel (.pyxapp) com o comando `pyxel package`:
```sh
pyxel package APP_DIR STARTUP_SCRIPT_FILE
```
Se você precisar incluir recursos ou módulos adicionais, coloque-os no diretório do aplicativo.
Os metadados podem ser exibidos em tempo de execução, especificando-os no seguinte formato dentro do script de inicialização. Os campos além de `title` e `author` são opcionais.
```python
# title: Pyxel Platformer
# author: Takashi Kitao
# desc: A Pyxel platformer example
# site: https://github.com/kitao/pyxel
# license: MIT
# version: 1.0
```
O arquivo de aplicativo criado pode ser executado usando o comando `pyxel play`:
```sh
pyxel play PYXEL_APP_FILE
```
Um arquivo de aplicativo Pyxel também pode ser convertido em um executável ou um arquivo HTML usando os comandos `pyxel app2exe` ou `pyxel app2html`.
## Referência da API
### Sistema
- `width`, `height`
- `bltm(x, y, tm, u, v, w, h, [colkey], [rotate], [scale])`
- `text(x, y, s, col)`