Introduction: Diviértete Con ArduPack (Videojuego2D Godot3 + Arduino ESP32)

Modelo Prototipo de un VideoJuego que le permitirá al usuario divertirse usando un control no convencional y para los mas entusiastas de la programación darles un punto de partida con la facilidad de los elementos software libres en los que fue desarrollado ArduPack.

-Juan Camilo Guzmán
-Sebastián Carmona
-Juan Diego Bustamante
-Jhonatan Rodriguez

Supplies

WEMOS LOLIN 32.

Dos sensores HC SR 04.

Pantalla LED 1920x1080,24, 24MK430H.

Altavoces 2.2W,3,5 mm, logitech S120.

Arduino IDE (Para el funcionamiento del control)

Piskel (Para los sprites y personajes).
Godot (Para la programación del Vídeo Juego).

Librerias:
pySerial (Para programar el firmware de la placa ESP32)
NewPing_v1.9.1 (para leer los datos de los sensores)
blekeyboard (Para comunicar el arduino con el videojuego simulando un teclado)

Step 1: Video Review Y Game Design Document

En esta sección mostramos la razón de ser de el proyecto y su Game Design Document

Step 2: Montaje Del Circuito

Se deben conectar los dos sensores a la placa Wemos Lolin32 como se aprecia en la imagen: Utilizamos 5v y el GND para la alimentación, cada sensor posee dos pines, un echo y un trigger, estos pueden ser cualesquiera pero en la imagen especificamos los que usamos en el código, de esta manera se lograra la detección de los movimientos de la mano para mover al personaje y el ángulo del disparo.

Step 3: Subir Código Del Funcionamiento Al Arduino

Primero debemos añadir las librerías necesarias, al descargarlas deberemos ir al Arduino IDE y en Sketch, include library, add .Zip Library.. buscamos y agregamos la librerías proporcionadas.

NewPing

BleKeyboard

Para poder usar correctamente la placa con arduino IDE usaremos pyserial.

-Primero, descargaremos Python , procederemos a descargar el archivo PIP, lo ubicaremos en una consola Python y escribiremos el comando get-pip.py, posteriormente en una consola nueva de Python escribiremos el comando: Python -m pip install pyserial, si todo ha funcionado correctamente ya podremos usar la placa con Arduino IDE

Después subimos el código para el funcionamiento del control, que se encuentra en el archivo controller.ino.

Este código permite leer los valores de dos sensores de proximidad, y dependiendo de los valores de cada sensor, usa la librería BleKeyboard para simular las pulsasiones de arriba, abajo, izquierda y derecha

Step 4: Creación De Sprites Y Personajes

Deberemos usar un creador de sprites libre para poder crear propios personajes, objetos, enemigos etc.

En este caso se uso el creador piskel (https://www.piskelapp.com) para la creación de los enemigos, el personaje controlable, este editor permite guardar los sprites como imagenes png (Para permitir transparencia).

Step 5: Importar Los Sprites a Godot Engine Para La Implementacion Del Vídeo Juego

Debemos importar los sprites anteriormente creados para poder empezar la creación del videojuego. Para importar los sprites al juego, añadimos un nodo de sprite y en sus propiedades elegimos como textura la imagen png de nuestro personaje, enemigo, fondo etc.

Step 6: Disposición De Los Elementos En Pantalla Y Configuración Del Proyecto

De esta manera se agregan cada uno de los elementos al entorno para desarrollar el videojuego, para agregar un nodo perteneciente a otro (Como el caso del jugador con su sprite y collider más su brazo) damos click en el nodo y damos click en añadir hijo.

Nota: Algunas configuraciones de los nodos son necesarios para el correcto funcionamiento, como verificar que los nodos tienen conectados correctamente los eventos (En este caso los eventos que implican a la bala, el enemigo y al jugador), Asignarle los grupos correspondientes a los nodos: Jugador y Enemigo tienen sus grupos con su mismo nombre y LimiteBalas tiene el grupo llamado Screen, configurar el tamaño de la ventana en Proyecto>ajustes de proyecto>ventana a un 1600x600, y tener en cuenta que algunos nodos deben tener los mismos nombres que se aprecian en la imagen para poder ser accedidos correctamente, también podemos definir los controles que se asignan a la altura y ángulo de disparo del personaje en la ventana Proyecto>ajustes del proyecto > mapas de entrada, aquí podemos definir las teclas que queremos utilizar, por defecto tenemos las flechas (Arriba y abajo para altura y izquierda y derecha para el angulo).

Step 7: Creación De Los Scripts.

Tendremos que crear los scripts de movimiento de personaje, enemigos, scripts de disparos, puntaje, enemigos derrotados, audio y la detección del fin del juego. Goodot engine te da la posibilidad de programar estos scripts usando C# o usar su propio lenguaje .GD.

A continuación se muestran las instancias de todos los scripts de esta manera:

"nombreScript.cs(NombreNodo) -> descripción"

Para agregar un script a un nodo, damos click derecho sobre él y damos click en añadir nodo, escogemos nombre y lenguaje para el script.

Scripts para el control del nivel: infinite_bg.cs(Level1) -> El movimiento infinito del fondo, calcular puntaje y determinar cuando pierde.

<p>using Godot;<br>using System;</p><p>public class infinite_bg : Node
{
	public double puntaje = 0;
	public bool vivo = true;
	
	private Sprite[] backgrounds = new Sprite[5];
	private float bg_width = 1598f;
	
	private float move_speed = 400f;
	
	private float min_X = -1300f;
	// Called when the node enters the scene tree for the first time.
	public override void _Ready()
	{
		for(int i = 1; i < 6; i++){
			backgrounds[i-1] = GetNode("Background" + i);
		}
	}</p><p>  // Called every frame. 'delta' is the elapsed time since the previous frame.
  public override void _Process(float delta)
  {
	  for(int i = 0; i < backgrounds.Length; i++){
		
		Vector2 temp = backgrounds[i].GetPosition();
		temp.x -= move_speed * delta;
		
		if(temp.x <= min_X){
			temp.x += bg_width * backgrounds.Length;
		}
		backgrounds[i].SetPosition(temp);
	}
	
	if(vivo){
		puntaje += 0.01;
		Area2D BotonReinicio = GetNode
("BotonReinicio");
		Vector2 escala = new Vector2(0,0);
		BotonReinicio.Scale = escala;
		Label Puntaje = GetNode("CanvasLayer/puntaje");
		Puntaje.Text = Math.Round(puntaje,0).ToString();
	}else{
		Area2D BotonReinicio = GetNode
("BotonReinicio");
		Vector2 escala = new Vector2(1,1);
		BotonReinicio.Scale = escala;
	}</p><p>  }</p><p>}</p>

Reinicio: botonReinicio.gd(botonReinicio) -> Controla el funcionamiento del botón para volver a empezar.

<p>extends Area2D</p><p>func _on_Area2D_input_event(viewport, event,shape_idx):
	if event is InputEventMouseButton:
		if event.is_pressed():
			get_tree().reload_current_scene()</p>

Jugador: jugador.gd(Jugador) -> Controla el movimiento del jugador.

<p>extends KinematicBody2D</p><p>var motion = Vector2()</p><p>func _ready():
	print(self.get_path());
func _physics_process(delta):
	
	if(position.y <= 50):
		motion.y = 150
	if(position.y >= 570):
		motion.y = -150
	
	else:
		if (Input.is_action_pressed("ui_up")):
			motion.y += -20
		else:
			if (Input.is_action_pressed("ui_down")):
				motion.y+=20
		
	
	motion= move_and_slide(motion)</p>

Disparo: Disparo_ Brazo.gd(Brazo) -> controla el angulo del arma y instancia un nuevo disparo cada cierto tiempo

<p>extends Area2D</p><p>var bala = preload("res://Escena/bala.tscn");
var disparo = true;
export var velocidad = 1000;
export var ratio = 0.4;</p><p># Called every frame. 'delta' is the elapsed time since the previous frame.
func _process(delta):
	
	
	
	if rotation_degrees > -40:
		if Input.is_action_pressed("ui_left"):
			rotation_degrees += -5
	if rotation_degrees < 45:
		if Input.is_action_pressed("ui_right"):
			rotation_degrees += 5
	if(disparo):
		var bala_creada = bala.instance();
		bala_creada.position = get_global_position();
		bala_creada.rotation_degrees = rotation_degrees;
		bala_creada.apply_impulse(Vector2(),Vector2(velocidad,0).rotated(rotation))
		get_tree().get_root().add_child(bala_creada);
		disparo = false;
		yield(get_tree().create_timer(ratio),"timeout")
		disparo = true;</p>

Colisiones: enemigo.gd (Enemigo)y bala.gd(Bala) -> verificar y actuar ante una colisión (Enemigo y bala) (Enemigo y jugador).

<p>extends KinematicBody2D</p><p>#Determina la velocidad del enemigo
var velocidad = -500;
func _process(delta):
	move_and_slide(Vector2(velocidad,0))
	pass</p><p>func _on_Area2D_body_entered(body):
	if body.is_in_group("Jugador"):
		body.queue_free();
		get_node("/root/Level1").vivo = false;
	if body.is_in_group("Screen"):
		queue_free();</p>
<p>extends RigidBody2D</p><p>#</p><p>func _on_Bala_body_entered(body):
	if body.is_in_group("Enemigo"):
		body.queue_free();
		queue_free();
		get_node("/root/Level1").puntaje += 5;
	if body.is_in_group("Screen"):
			queue_free();</p>

Enemigos: EnemySpawner.gd(EnemySpawner)-> aparición aleatoria de enemigos.

<p>extends Node</p><p>var enemy = preload("res://Escena/Enemigo.tscn");
var aparicion = 0.8;
export var aparecer = true;</p><p>func _process(delta):
	if(aparecer):
		spawn()
		aparecer = false;
		yield(get_tree().create_timer(aparicion),"timeout")
		aparecer = true;
	
func spawn():
	var enemigo = enemy.instance();
	var pos = Vector2();
	pos.x = 1632;
	pos.y = rand_range(32,592);
	enemigo.set_position(pos);
	get_node("container").add_child(enemigo)</p>

Los nodos Enemigo y bala se encuentran en dos escenas independientes, que toman su mismo nombre, bala.tscn y enemigo.tscn.

Git con video juego terminado:

https://github.com/jcamiloguzman/ArduPack

Step 8: Integración (Control + Videojuego)

Una vez tenemos el correcto funcionamiento de nuestro videojuego y de nuestro control, es hora de realizar la integración de los dos, este es el paso más fácil gracias a la forma en la que está implementado el control, ya que va a simular el teclado de nuestra computadora, para ello debemos conectar el circuito con el código y los sensores montados y funcionando y nuestro juego ejecutándose, en el momento de encender el control, estará buscando un emparejamiento vía Bluetooth, lo que haremos será emparejar y conectarlo con nuestra computadora y entrar al juego, si todo ha funcionado correctamente se podría disfrutar de ArduPack con su control no convencional.

Agregamos un nuevo dispositivo Bluetooth y lo buscamos con el nombre de ESP32 BLE keyboard, una vez seleccionado debería emparejarse y conectarse automáticamente.

A jugar!