Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asierso/vortex-engine
Librería para crear videojuegos simples en Java. Basado en el uso de GameObjects y componentes instanciables
https://github.com/asierso/vortex-engine
game-engine game-engine-2d java-library jsfml sfml sfml-graphics-library
Last synced: 6 days ago
JSON representation
Librería para crear videojuegos simples en Java. Basado en el uso de GameObjects y componentes instanciables
- Host: GitHub
- URL: https://github.com/asierso/vortex-engine
- Owner: Asierso
- License: cc0-1.0
- Created: 2023-10-02T20:26:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-15T19:40:43.000Z (4 months ago)
- Last Synced: 2024-07-15T23:57:42.948Z (4 months ago)
- Topics: game-engine, game-engine-2d, java-library, jsfml, sfml, sfml-graphics-library
- Language: Java
- Homepage:
- Size: 6.36 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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í](https://github.com/Asierso/vortex-engine/packages)
```xml
com.asierso
vortex-engine
xxxxx
```
Recuerde que para poder usar el paquete debe de agregar la URL del repositorio a su fichero `pom.xml`.
```xml
github
GitHub Asierso Apache Maven Packages
https://maven.pkg.github.com/Asierso/vortex-engine
```
## 🛠️ Building
### Requisitos previos
- Java Development Kit (JDK) 18 o superior. Puede descargarla [aquí](https://www.oracle.com/java/technologies/javase/jdk18-archive-downloads.html)
- Instalación de Apache Maven. Puede descargarla [aquí](https://maven.apache.org/download.cgi)
### 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](https://www.oracle.com/java/technologies/javase/jdk18-archive-downloads.html)
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:
```java
Window ventana = new Window(600,500);
ventana.setTitle("Mi primera ventana");
ventana.setScene(new MainScene());
ventana.instantiate();
```
```java
public class MainScene implements Scene{
@Override
public void start() {
//Se repite al iniciar la escena
}
@Override
public void update(Window window, Iterable 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
```java
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
```java
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 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.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
```java
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);
}
}
```