Yotsuba ShaderAprende

Plugins

2 min de lectura

Instala, actualiza y usa los plugins que añaden formatos de engine al compilador.

El compilador trae SPIR-V, GLSL, GLSL ES, HLSL, Metal y C++. Cualquier otro formato es un plugin: un paquete NuGet pequeño que le enseña a la CLI una salida más. Hoy existen los plugins de MonoGame, KNI, FNA y Godot.

Un plugin lo usa solo la CLI, mientras compila. Tu juego no lo referencia.

Usar un plugin#

Pídelo con --target. La CLI lo descarga la primera vez y comprueba si hay una versión nueva cada vez que se ejecuta:

dotnet yotsuba add MyShaders/MyShaders.csproj --target spirv --target monogame

Sin internet, la CLI avisa de que no pudo buscar actualizaciones y usa la copia instalada. Si el plugin nunca se instaló, el comando falla.

El comando plugin#

yotsuba plugin list | install <nombre> | update [nombre] | remove <nombre>
ComandoQué hace
plugin listImprime los plugins del catálogo y si cada uno está instalado y en qué versión.
plugin install <nombre>Descarga la última versión del plugin antes de que la necesites. No hace nada si ya es la última.
plugin update <nombre>Igual que install: trae la última versión.
plugin updateActualiza todos los plugins que tienes instalados.
plugin remove <nombre>Borra el plugin instalado.

Códigos de salida: 0 si todo sale bien, 1 cuando falla el plugin o la red, 2 por argumentos incorrectos.

Plugin--targetPaquete NuGetSalidaMétodo que genera add
monogamemonogame (o mgfx)YotsubaShader.Extensions.MonoGame.mgfx, uno por plataformaToMGFX(MonoGamePlatform)
knikni (o kni-webgl)YotsubaShader.Extensions.KNI.knifxToKNIWebGL_FX()
fnafnaYotsubaShader.Extensions.FNA.fxbToFNA_FX()
godotgodot (o gdshader)YotsubaShader.Extensions.Godot.gdshader, uno por tipo (Spatial, CanvasItem)ToGodotShader(GodotShaderType)

Cada entrada del catálogo declara su nombre, descripción, paquete, extensión, el método que genera add y, opcionalmente, un enum de opciones con sus valores y si el resultado es texto. add y compile leen esa entrada para decidir qué escribir.

Dónde vive cada cosa#

QuéPor defectoCómo cambiarlo
Plugins instalados~/.yotsuba/plugins/<nombre>Define YOTSUBA_HOME con otra carpeta.
Catálogohttps://yotsubashader.com/plugins.jsonDefine YOTSUBA_PLUGINS_URL con una URL o una ruta de archivo. La CLI guarda una copia en YOTSUBA_HOME y la usa cuando no hay conexión.
Feed de NuGethttps://api.nuget.org/v3-flatcontainer/Define YOTSUBA_NUGET_SOURCE con un feed privado o de pruebas.

De qué está hecho un plugin#

Un paquete de plugin contiene un ensamblado con una clase que implementa IShaderTargetBackend. La CLI lo carga en su propio contexto, crea la clase y llama a su método Compile una vez por shader (y una vez por opción, cuando el plugin tiene opciones). Compile recibe el shader compilado y el valor numérico de la opción, y devuelve los bytes del archivo. En los formatos de texto, esos bytes son texto UTF-8.

Para los detalles de cada plugin en su engine (cómo el engine carga lo que se genera, datos de vértice, uniforms), mira MonoGame, KNI, FNA y Godot.

Los comandos que usan plugins son 0 y 1.