Utiliser

Comment utiliser

Créer une application

Dans votre script Python, importez le module Pyxel, spécifiez la taille de la fenêtre avec la fonction init, puis démarrez l'application Pyxel avec la fonction run.

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)

Les arguments de la fonction run sont la fonction update, qui traite les mises à jour de trames, et la fonction draw, qui gère le dessin à l'écran.

Dans une application réelle, il est recommandé d'encapsuler le code Pyxel dans une classe, comme montré ci-dessous :

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()

Pour créer des graphiques simples sans animation, vous pouvez utiliser la fonction show pour simplifier votre code.

import pyxel

pyxel.init(120, 120)
pyxel.cls(1)
pyxel.circb(60, 60, 40, 7)
pyxel.show()

Exécuter l'application

Un script créé peut être exécuté en utilisant la commande python :

python PYTHON_SCRIPT_FILE

Il peut également être exécuté avec la commande pyxel run :

pyxel run PYTHON_SCRIPT_FILE

De plus, la commande pyxel watch surveille les modifications dans un répertoire spécifié et relance automatiquement le programme lorsque des changements sont détectés :

pyxel watch WATCH_DIR PYTHON_SCRIPT_FILE

La surveillance du répertoire peut être arrêtée en appuyant sur Ctrl(Command)+C.

Opérations de touches spéciales

Pendant l'exécution d'une application Pyxel, les opérations de touches spéciales suivantes peuvent être effectuées :

Esc
Quitter l'application
Alt(Option)+1
Enregistrer la capture d'écran sur le bureau
Alt(Option)+2
Réinitialiser le temps de début de l'enregistrement de la vidéo de capture d'écran
Alt(Option)+3
Enregistrer une vidéo de capture d'écran sur le bureau (jusqu'à 10 secondes)
Alt(Option)+8 ou A+B+X+Y+DL sur la manette
Alterne le mode de mise à l’échelle de l’écran entre maximal et entier
Alt(Option)+9 ou A+B+X+Y+DR sur la manette
Passer d'un mode d'écran à l'autre (Crisp/Smooth/Retro)
Alt(Option)+0 ou A+B+X+Y+DU sur la manette
Basculer le moniteur de performance (FPS/update temps/draw temps)
Alt(Option)+Enter ou A+B+X+Y+DD sur la manette
Basculer en plein écran
Shift+Alt(Option)+1/2/3
Enregistrer la banque d'images 0, 1 ou 2 sur le bureau
Shift+Alt(Option)+0
Enregistrer la palette de couleurs actuelle sur le bureau

Comment créer des ressources

Pyxel Editor peut créer des images et des sons utilisés dans une application Pyxel.

Vous pouvez démarrer Pyxel Editor avec la commande suivante :

pyxel edit PYXEL_RESOURCE_FILE

Si le fichier de ressources Pyxel spécifié (.pyxres) existe, il sera chargé. S'il n'existe pas, un nouveau fichier avec le nom spécifié sera créé. Si le fichier de ressources est omis, un nouveau fichier nommé my_resource.pyxres sera créé.

Après avoir démarré Pyxel Editor, vous pouvez passer à un autre fichier de ressources en le faisant glisser et en le déposant sur Pyxel Editor.

Le fichier de ressources créé peut être chargé en utilisant la fonction load.

Pyxel Editor a les modes d'édition suivants.

Éditeur d'images

Le mode pour éditer l'image dans chaque banque d'images.

Vous pouvez faire glisser et déposer un fichier d'image (PNG/GIF/JPEG) dans l'éditeur d'images pour charger l'image dans la banque d'images actuellement sélectionnée.

Éditeur de cartes de tuiles

Le mode pour éditer les cartes de tuiles qui organisent des images des banques d'images en un motif de tuiles.

Faites glisser et déposer un fichier TMX (Tiled Map File) dans l'éditeur de cartes de tuiles pour charger sa couche 0 dans la carte de tuiles actuellement sélectionnée.

Éditeur de sons

Le mode pour éditer les sons utilisés pour les mélodies et les effets sonores.

Éditeur de musique

Le mode pour éditer des musiques dans lequel les sons sont organisés dans l'ordre de lecture.

Autres méthodes de création de ressources

Les images et les cartes de tuiles Pyxel peuvent également être créées en utilisant les méthodes suivantes :

Créer une image à partir d'une liste de chaînes en utilisant la fonction Image.set ou la fonction Tilemap.set
Charger un fichier d'image (PNG/GIF/JPEG) avec la palette Pyxel en utilisant la fonction Image.load

Les sons Pyxel peuvent également être créés en utilisant la méthode suivante :

Créer un son à partir de chaînes avec la fonction Sound.set ou la fonction Music.set

Référez-vous à la documentation de l'API pour l'utilisation de ces fonctions.

Comment distribuer des applications

Pyxel prend en charge un format de fichier de distribution d'application dédié (fichier d'application Pyxel) qui est multiplateforme.

Un fichier d'application Pyxel (.pyxapp) est créé en utilisant la commande pyxel package :

pyxel package APP_DIR STARTUP_SCRIPT_FILE

Si vous avez besoin d'inclure des ressources ou des modules supplémentaires, placez-les dans le répertoire de l'application.

Les métadonnées peuvent être affichées à l'exécution en les spécifiant dans le format suivant dans le script de démarrage. Les champs autres que title et author sont facultatifs.

# title: Pyxel Platformer
# author: Takashi Kitao
# desc: A Pyxel platformer example
# site: https://github.com/kitao/pyxel
# license: MIT
# version: 1.0

Le fichier d'application créé peut être exécuté en utilisant la commande pyxel play :

pyxel play PYXEL_APP_FILE

Un fichier d'application Pyxel peut également être converti en un exécutable ou un fichier HTML en utilisant les commandes pyxel app2exe ou pyxel app2html.