Plugins
Los plugins añaden lo que no todos los juegos necesitan: iniciar sesión con un servicio, los servidores de un servicio en línea, una tienda, analíticas… Los hacemos al lado de Gobu, cada uno en su propio repositorio.
Nada de un plugin está en Gobu ni en un juego que no lo usa. Cada uno es una biblioteca propia (una DLL en Windows, un side module de WebAssembly en la web) que Gobu carga solo en un proyecto que lo activó, y un juego exportado se lleva las bibliotecas de sus plugins activados.
Los plugins de un proyecto
Sección titulada «Los plugins de un proyecto»Un proyecto tiene sus plugins en su carpeta plugins/, al lado de resources/: una carpeta por plugin,
con su plugin.json y sus bibliotecas. Edit > Plugins abre la ventana de plugins, como la de Unreal:
los plugins de nuestro repositorio y los del proyecto, por categoría (a la izquierda, con cuántos hay), con
un buscador y una tarjeta por plugin (su imagen, nombre, versión, descripción, autor y las plataformas donde
funciona, según sus libraries; el buscador también las encuentra, “android”).
- Install baja el plugin a
plugins/del proyecto (comprobando que el paquete es el publicado) y lo activa. - Enabled enciende o apaga un plugin instalado. Un plugin activado se carga en el momento; uno desactivado sigue cargado hasta que el editor se reinicia (Restart Editor).
- Update to … aparece cuando el repositorio tiene una versión más nueva; Remove lo quita del proyecto. Un plugin en uso (cargado) se actualiza o se quita al abrir el editor otra vez.
- Documentation abre su página. Un plugin copiado a mano en
plugins/(el botón de la carpeta, arriba) también aparece.
Mientras un plugin no está activado, no existen sus clases, sus singletons ni sus ajustes.
Nuestros plugins
Sección titulada «Nuestros plugins»| Plugin | Qué hace | Dónde | Plataformas |
|---|---|---|---|
| Authentication | Los jugadores inician sesión con Google, Supabase, Firebase, Auth0 o cualquier otro servicio; el juego tiene su token y un servidor lo comprueba | gobuengine/plugins-authentication | Windows, web, Android |
| Colyseus | El cliente multijugador de Colyseus (salas, estado, mensajes) y el proveedor colyseus de los juegos en red | gobuengine/plugins-colyseus | Windows, web, Android |
| Poki | Publicar un juego web en Poki: sus anuncios, eventos de partida, enlaces y jugador a través de los servicios del juego | gobuengine/plugins-poki | Web |
| CrazyGames | Publicar un juego web en CrazyGames: sus anuncios, eventos de partida, enlaces de invitación y jugador a través de los servicios del juego | gobuengine/plugins-crazygames | Web |
En la web, los plugins funcionan en juegos exportados sin Thread Support (lo predeterminado); en
Android, en dispositivos de 64 bits (arm64-v8a, el lib/arm64-v8a del paquete). Linux, macOS e iOS vendrán
después.
Hacer un plugin
Sección titulada «Hacer un plugin»Un plugin habla con Gobu por una interfaz en C, gobu_plugin.h: una copia de ella es todo lo que un
plugin necesita de Gobu, así que puede escribirse en C, C++, Zig, Rust… (los repositorios de nuestros
plugins la tienen). Desde ahí un plugin registra sus clases, métodos, señales, propiedades y singletons,
y llega a cualquier clase o singleton del motor por su nombre.
Su plugin.json:
{ "id": "authentication", "name": "Authentication", "version": "1.0.0", "description": "Players sign in with Google, Supabase, Firebase, Auth0 or any other service...", "author": "Gobu", "category": "Services", "icon": "icon.svg", "api_version": 3, "entry": "gobu_plugin_init", "android_permissions": ["INTERNET"], "libraries": { "windows.x86_64": "bin/authentication.windows.x86_64.dll", "web.wasm32": "bin/libauthentication.web.wasm32.wasm", "android.arm64": "bin/libauthentication.android.arm64.so" }, "web_files": { "sign_in.html": "web/sign_in.html" }}libraries: por<plataforma>.<arquitectura>, o<plataforma>.<arquitectura>.<debug|release>para una biblioteca de cada tipo (el editor y los exports debug prefierendebug).api_version: la versión degobu_plugin.hque necesita (la 3 tiene singletons de plugins, la 4 los proveedores de servicios del juego, la 5 sus logros, tablas, estadísticas y partidas en la nube).icon: su imagen en la ventana de plugins, un SVG (se dibuja al tamaño en que se ve) o un PNG, relativo a su carpeta. Sin ella, la ventana muestra un enchufe.categorylo agrupa ahí.web_files: archivos del plugin que un export web escribe junto a la página del juego como<página>.<nombre>(el inicio de sesión de Authentication vuelve aindex.sign_in.html).web_head: una línea, o una lista de ellas, que un export web añade al<head>de la página del juego: el SDK de un servicio ("<script src=\"https://.../sdk.js\"></script>").$GOBU_PAGEes el nombre de la página, para susweb_files($GOBU_PAGE.<nombre>).android_permissions: lo que necesita de Android ("INTERNET"esandroid.permission.INTERNET). Activar el plugin los marca en los presets de Android del proyecto (Permissions, o Custom Permissions para uno sin casilla), y desactivarlo desmarca los que marcó; lo marcado a mano se queda. Si lo desmarcas a mano con el plugin activado, el export avisa. Un plugin que habla con un servidor necesitaINTERNET: sin él, Android no deja conectar al juego.
La ayuda del editor sobre las clases de un plugin (lo que el editor de código muestra al escribir y sobre
un nombre, las descripciones del inspector) sale de la carpeta doc_classes/ del plugin: un XML por
clase, con el formato de la referencia de clases del motor (la de Authentication es
doc_classes/Authentication.xml). Sin ella, el editor conoce sus métodos y señales, sin una palabra. Una
clase cuyo nombre empieza por _ es interna del plugin (como las de Colyseus, detrás de su módulo de
Grost): la ventana de plugins no la lista.
Publicar un plugin
Sección titulada «Publicar un plugin»La ventana de plugins lista los repositorios públicos gobuengine/plugins-<id> y, de la última release de
cada uno, baja tres archivos que hace forja package plugin <la carpeta del plugin> (en
Engine/Binaries/release/plugins/<id>):
<id>.zip: la carpeta del plugin, lo que va aplugins/<id>de un proyecto.plugin.json: su manifiesto, con el tamaño y el SHA-256 del paquete (zip_size,zip_sha256), que el editor comprueba antes de instalarlo.- Su imagen (
icon).
Súbelos a una release del repositorio del plugin: desde entonces todos los editores ofrecen la versión nueva. Un repositorio sin release no aparece.