Vortex Engine

Descripcion

Vortex engine es una librería para crear videojuegos 2D simples en Java. Permite crear GameObjects y componentes instanciables de forma sencilla además de trabajar con escenas

📋 Características

• Manejo de objetos y componentes: El motor permite poder asignar diferente lógica a los objetos por medio de compontenes. Un objeto puede tener multiples componentes y trabajar con ellos es sencillo. Puede crear sus propios componentes fácilmente

• Estructuracion por escenas: Vortex Engine maneja los espacios renderizables por escena, permitiendo mostrar distintas escenas en la misma ventana de forma eficiente

💻 Importar librería (Maven)

Puede agregar la dependencia a su proyecto Maven con el siguiente código en su fichero pom.xml. Recuerde sustituir "xxxxx" por la versión de su preferencia. Puede ver las versiones aquí

<dependency>
  <groupId>com.asierso</groupId>
  <artifactId>vortex-engine</artifactId>
  <version>xxxxx</version>
</dependency>

Recuerde que para poder usar el paquete debe de agregar la URL del repositorio a su fichero pom.xml.

<distributionManagement>
    <repository>
        <id>github</id>
        <name>GitHub Asierso Apache Maven Packages</name>
        <url>https://maven.pkg.github.com/Asierso/vortex-engine</url>
    </repository>
</distributionManagement>

🛠️ Building

Requisitos previos

• Java Development Kit (JDK) 18 o superior. Puede descargarla aquí
• Instalación de Apache Maven. Puede descargarla aquí

Pasos de compilación

1. Clona el repositorio: git clone https://github.com/Asierso/VortexEngine.git o bien descargue una de las versiones "release" de VortexEngine
2. Configure la version de Java preferiblemente en la versión jdk 18
3. Compile el proyecto con Apache Maven usando mvn package

[!NOTE] No se han realizado tests en versiones de java inferiores a la 18.0 por lo que se pueden experimentar bugs o incompatibilidades

✍️ Ejemplos de codigo

Primera ventana

Se muestra el fragmento de un pequeño código para generar una nueva ventana y renderizar una escena vacía:

Window ventana = new Window(600,500);
ventana.setTitle("Mi primera ventana");
ventana.setScene(new MainScene());
ventana.instantiate();

public class MainScene implements Scene{
    @Override
    public void start() {
        //Se repite al iniciar la escena
    }

    @Override
    public void update(Window window, Iterable<Event> events) {
        //Se repite cada vez que se renderiza la escena
    }
}

---

Primer objeto

Se muestra un pequeño fragmento de código para generar un GameObject con forma de rectangulo blanco, el cual se puede manipular mediante su transform

public class Rectangle extends GameObject {
    @Override
    public void render(Window win) { 
        //Se repite al instanciar el objeto en cada actualizacion del render

        //Dibujar un pequeño rectangulo
        RectangleShape shape = new RectangleShape();
        shape.setFillColor(Color.WHITE);
        shape.setPosition(this.getPosition());
        shape.setRotation(this.getRotation());
        shape.setSize(new Vector2f(this.getBoxSize().x, this.getBoxSize().y));

        //Renderiza el objeto en la ventana actual
        win.getRender().draw(shape);
    }
}

Este objeto se puede instanciar en cualquier escena las veces que sea necesario. En el siguiente código se muestra un ejemplo de como se instancia un GameObject en una escena

public class MainScene implements Scene{
    private Rectangle rectangulo;
    
    @Override
    public void start() {
        //Se crea el objeto y se definen sus propiedades
        rectangulo = new Rectangle();
        rectangulo.setPosition(30,30);
        rectangulo.setBoxSize(20,10);
    }

    @Override
    public void update(Window window, Iterable<Event> events) {
        //Se instancia el objeto en la escena actual
        rectangulo.instantiate(window);
    }
}

[!TIP] Se pueden agregar componentes a los GameObject usando la sentencia gameObject.addComponent(new Component()) y acceder acceder al componente, usando el metodo gameObject.<Component>getComponent(Componente.class)

---

Componentes personalizados

Se pueden crear componentes personalizados para los GameObject creando una clase que implemente la interfaz "Component". El GameObject referenciado en el método implementado hace referencia al objeto que implementa el componente.

En el siguiente código se muestra un ejemplo de como se crea un componente que mueve los objetos a la derecha

public class ComponenteCustom implements Component{
    @Override
    public void run(GameObject target) {
        //Logica interna del componente (ejecutado en cada frame)
        target.setPosition(target.getPosition().x + 0.1f,target.getPosition().y);
    }
}