tatiana 0.0.2.1

Un pobre intento de hacer un pequeño motor de videojuegos utilizando Python (≥ 3.10) y pygame

---

sitio web principal • página del proyecto • repositorio de código

---

Un pobre intento de hacer un pequeño motor de videojuegos utilizando Python (≥ 3.10) y pygame

Tatiana es un pequeño intento de implementar un motor de videojuegos 2D competente utilizando Python (en una versión superior o igual a 3.10) y el módulo pygame como dependencia obligatoria, además de estar construido y regirse enteramente mediante el paradigma ECS (en castellano: sistema entidad-componente).

Como es obvio debido a la versión en la que actualmente se encuentra este proyecto, debe tratarse por el momento como una prueba de concepto más que como un producto estable y seguro, pues todavía quedan multitud de funcionalidades esenciales en cualquier motor de videojuegos por implementar a la par que muchos errores (que podrían ser considerados como graves) por corregir; por no mencionar el detalle de estar escrito enteramente en Python, lo que hace de este motor algo lento en comparación.

No obstante y a causa de los importantes avances que ha estado teniendo este proyecto, he decidido hacer público este proyecto para facilitar su uso y, en caso de tener sugerencias para el mismo o querer asistir en el desarrollo, hacer posible la contribución por parte de cualquiera.

instalación del paquete

Puede instalar remotamente la versión más reciente del paquete Tatiana en su entorno local ejecutando el siguiente comando desde su terminal:

pip3 install git+https://github.com/soyeltata/tatiana

Esto, en el caso de que se encuentre en un entorno UNIX, si está bajo una máquina Windows habrá de reemplazar pip3 por pip, como se muestra a continuación:

pip install git+https://github.com/soyeltata/tatiana

Además, a partir de la versión v0.0.2, puede instalar Tatiana a través de los repositorios oficiales de PyPI, como se muestra a continuación:

pip3 install tatiana

De nuevo, si está en una máquina con Windows, habrá de reemplazar pip3 por pip:

pip install tatiana

Sin embargo y en el caso de que quiera instalar Tatiana manualmente con el fin de modificar su código fuente o con cualquier otro propósito, habrá de seguir las siguientes instrucciones, no sin antes asegurarse de que tiene instalados los paquetes git y make:

1. Clone el repositorio en su máquina local mediante el siguiente comando (funciona indistintamente de su sistema operativo):

   git clone https://github.com/soyeltata/tatiana.git tatiana-main && cd tatiana-main
   

   O, si no posee git en su máquina, puede descargar el código fuente como un archivo .zip y posteriormente descomprimirlo y moverse al directorio tatiana-main.

2. Una vez realizados dichos pasos, proceda a ejecutar el siguiente comando si posee el paquete make instalado en su máquina para instalar Tatiana:

   make install
   

   Si por el contrario sólo quiere compilar el paquete (por cualquier motivo), ejecute el siguiente comando en su lugar:

   make all
   

   Los binarios se encontrarán en el directorio dist/ que se acabará de crear. Para configurar correctamente y adaptar la compilación a su dispositivo con precisión, visite y lea el archivo Makefile que encontrará en la carpeta en la que se sitúa en el momento. En el caso de que no posea make instalado en su dispositivo, puede instalar Tatiana manualmente con el siguiente comando:

   pip3 install -e .
   

   Reitero en que, si está en un sistema Windows, habrá de cambiar pip3 por pip, como se muestra más abajo:

   pip install -e .
   

3. Luego de haber completado la instalación de Tatiana, puede, ahora sí, eliminar el directorio tatiana-main y el archivo .zip que haya descargado.

un pequeño ejemplo del motor

Una vez instalado Tatiana en su dispositivo, ya puede empezar a trastear y juguetear con el pequeño motor de videojuegos que acaba de obtener. Aquí, en esta pequeña sección podrá encontrar varios ejemplos útiles hechos utilizando Tatiana que quizás le ayuden en el desarrollo de su proyecto:

dibujar una imagen en pantalla

Para este primer ejemplo, necesitará de una imagen cualquiera de formato PNG a la que nombraremos como image.png dentro del código. Este archivo será nombrado una única vez en el código en la declaración de la constante SPRITE, por lo que modifíquela si el nombre de su imagen es otro:

from tatiana import World, Entity
from os.path import abspath

RESX = 800
RESY = 600
SPRITE = 'image.png'

player = Entity('mainobj', (0, 0), abspath(SPRITE))

w = World(RESX, RESY)
w.add_entity(player)
w.set_target_fps(30)
w.run()

movimiento 2D básico

Ahora, para este segundo ejemplo nos basaremos en el extracto de código anterior, salvo que crearemos un módulo llamado movement.py que contendrá el sistema de movimiento del personaje. El código de este módulo será el siguiente:

import keyboard
from tatiana import World
from tatiana.components import TransformComponent, SpriteComponent

SPEED = 5


def MovementSystem(
    _,
    environment: World
) -> None:
    player = environment.get_entity('mainobj')
    position = player.get_component(TransformComponent)
    # camera = environment.get_camera()

    try:
        if keyboard.is_pressed('a'):
            position.X -= SPEED

        elif keyboard.is_pressed('d'):
            position.X += SPEED

        elif keyboard.is_pressed('w'):
            position.Y -= SPEED

        elif keyboard.is_pressed('s'):
            position.Y += SPEED

    except Exception as e:
        print(e)

La velocidad del personaje vendrá determinada por la variable SPEED, por lo que modifíquela para variar la velocidad del personaje. Para este segundo ejemplo necesitaremos tener instalado además el módulo keyboard, sin este no se ejecutará el programa. El código de el archivo principal será, de nuevo, el siguiente (con una modificación con respecto a el extracto anterior):

from tatiana import World, Entity
from movement import MovementSystem
from os.path import abspath

RESX = 800
RESY = 600
SPRITE = 'image.png'

player = Entity('mainobj', (0, 0), abspath(SPRITE))

w = World(RESX, RESY)
w.add_entity(player)
w.add_system('movement', MovementSystem)
w.set_target_fps(30)
w.run()

más ejemplos varios

Además, contamos con una pequeña galería de ejemplos varios llevados a cabo con el motor Tatiana, puedes visitarla en el directorio examples, y siéntete libre de añadir los tuyos propios.

características por implementar

Aún habiéndose implementado varias características dentro del motor Tatiana, el desarrollo de este apenas comienza, por lo que la mayoría de las que pensamos como posibles o que nos gustaría ver implementadas aún no lo están. Por ello, a continuación se muestra el plan de programación que se tiene pensado para el proyecto (aunque sin fecha alguna, puede que no se acaben cumpliendo nuestras intenciones):

• Un sistema de entidad-componente (ECS) funcional.
• Dibujado de imágenes y sistemas para el escalado, la rotación y la opacidad de las mismas.
• Animaciones funcionales y sistemas para manejar varias a la vez.
• Sistemas para la limitación de FPS en la ejecución.
• Refactorizar el proyecto según la guía de estilo PEP 8.
• Seguridad de tipos garantizada gracias a la herramienta mypy.
• Pequeña galería con ejemplos sencillos del motor.
• Escribir la documentación del proyecto mediante la herramienta pdoc.
• Movimiento fluido mediante interpolaciones.
• Importación de "atlas" y "spritesheets".
• Físicas realistas mediante el paquete Pymunk.
• Clases base para crear rectángulos, círculos, triángulos, texto...
• Una interfaz de línea de comandos para crear y manejar los proyectos.

demostración de las capacidades de Tatiana

En general, es posible resumir el estado actual del proyecto con la siguiente imagen:

Y es que en esta pequeña demostración se puede apreciar el manejo de imágenes, animaciones y el límite de FPS que es capaz de realizar el motor. Siendo muy poco, ilustra perfectamente el estado del proyecto y el hecho de que aún necesita tiempo de desarrollo.

licencia del proyecto

Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

Este proyecto está dedicado, cómo no, a Tatiana. Sé que no es mucho, pero es trabajo honrado y, si he podido llevar a cabo esta idea, ha sido pensando en ti ;)