Allods Online Addons (2/10): Estructura

Temas: Allods Lua MMORPG Stratos
Juan Mellado, 21 Agosto, 2010 - 08:45

Los addons de Allods son pequeños programas que se componen de las distintas partes de las que habitualmente consta una aplicación: interface de usuario, código de proceso, ficheros de recursos y librerías adicionales. El conjunto de estos ficheros es lo que se conoce como addon.

Para crear un addon en Allods hay que crear un directorio dentro de la carpeta "data/Mods/Addons" donde se encuentra instalado el juego y poner en él todos los ficheros que forman el addon. Por ejemplo, si queremos crear un addon llamado "Prueba", debemos crear un directorio "data/Mods/Addons/Prueba" y poner en él todos sus ficheros. Aunque también es posible crearlos con varios niveles de directorios como "data/Mods/Addons/Pruebas/Prueba01".

¿Pero qué ficheros forman un addon en Allods? Pues lo mejor es verlo con un ejemplo real de un addon que viene con el juego que se llama "SampleInit". Se encuentra en el directorio "Mods/SampleAddons/SampleInit", y consta de tres ficheros:

AddonDesc.(UIAddon).xdb
MainForm.(WidgetForm).xdb
ScriptSampleInit.lua

El primer fichero es obligatorio para todos los addons y tiene que tener siempre ese nombre fijo de "AddonDesc.(UIAddon).xdb". Es un XML en formato UTF-8 con una serie de etiquetas obligatorias que describe al addon. Veámoslas.

La etiqueta <Name> contiene el nombre del addon.

<Name>SampleInit</>

La etiqueta <AutoStart> indica si el addon tiene que ejecutarse automáticamente al arrancar el juego. Es un simple valor booleano.

<AutoStart>True</>

La etiqueta <ScriptFileRefs> contiene la lista de ficheros con los scripts, escritos en Lua, que utiliza el addon. Cada entrada de la lista contiene el nombre de un fichero, que puede ser absoluto con respecto al directorio "data" del juego, o relativo a la ruta donde se encuentra el addon:

<ScriptFileRefs>
  <Item href="/Mods/SampleCommon/SampleAddonBase.lua" />
  <Item href="ScriptSampleInit.lua" />
</ScriptFileRefs>

La etiqueta <Forms> contiene la lista de formularios que utiliza el addon. Cada elemento de la lista se compone de un identificador único y una referencia a un fichero .xdb donde se encuentra descrito el formulario correspondiente. Se utiliza la notación XPointer, que es una notación estándar que permite desde un fichero XML hacer referencia a una sección de otro fichero XML.

<Forms>
  <Item>
    <Id>Main</Id>
    <Form href="MainForm.(WidgetForm).xdb#xpointer(/WidgetForm)"/>
  </Item>
</Forms>

En el ejemplo de esta última etiqueta se define un formulario identificado como "Main" que se encuentra definido dentro de la sección "WidgetForm" de un fichero llamado "MainForm.(WidgetForm).xdb".

La etiqueta <MainFormId> contiene el nombre del formulario principal del addon, que debe ser un identificador definido dentro de la lista contenida en la etiqueta <Forms>:

<MainFormId>Main</MainFormId>

De igual forma, es posible añadir otras etiquetas predefinidas, o incluso propias, como el nombre del autor, la versión de addon o la fecha de última actualización, aunque en la documentación no se indica más detalle acerca de ellas.

El fichero "AddonDesc.(UIAddon).xdb" de este addon "SampleInit", al completo, contiene lo siguiente:

<?xml version="1.0" encoding="UTF-8" ?>
<UIAddon>
  <Name>SampleInit</Name>
  <AutoStart>true</AutoStart>
  <ScriptFileRefs>
    <Item href="/Mods/SampleCommon/SampleAddonBase.lua" />
    <Item href="ScriptSampleInit.lua" />
  </ScriptFileRefs>
  <MainFormId>Main</MainFormId>
  <Forms>
    <Item>
      <Id>Main</Id>
      <Form href="MainForm.(WidgetForm).xdb#xpointer(/WidgetForm)" />
    </Item>
  </Forms>
  <visObjects href="" />
  <texts href="" />
  <textures href="" />
</UIAddon>

A estas alturas ya debería adivinarse el patrón que sigue el nombre de los ficheros .xdb, con un título (AddonDesc, MainForm, ...) seguido de un tipo (UIAddon, WidgetForm, ...) Estos tipos están predefinidos y sirven para indicar la clase de información que contiene el fichero, que además de información en formato de texto también admite ficheros de recursos binarios como pueden ser texturas.

A continuación el fichero "MainForm.(WidgetForm).xdb" correspondiente a este mismo addon y que resulta bastante fácil de entender leyendo entre líneas:

<?xml version="1.0" encoding="UTF-8" ?>
<WidgetForm>
  <Name>SampleInit</Name>
  <Priority>0</Priority>
  <Children>
  </Children>
  <BackLayer href="" />
  <FrontLayer href="" />
  <Placement>
    <QuantumScale>false</QuantumScale>
    <X>
      <Align>WIDGET_ALIGN_LOW</Align>
      <Sizing>WIDGET_SIZING_DEFAULT</Sizing>
      <Pos>0</Pos>
      <HighPos>0</HighPos>
      <Size>0</Size>
    </X>
    <Y>
      <Align>WIDGET_ALIGN_LOW</Align>
      <Sizing>WIDGET_SIZING_DEFAULT</Sizing>
      <Pos>0</Pos>
      <HighPos>0</HighPos>
      <Size>0</Size>
    </Y>
  </Placement>
  <Visible>true</Visible>
  <Enabled>true</Enabled>
  <TransparentInput>true</TransparentInput
  <PickChildrenOnly>false</PickChildrenOnly>
</WidgetForm>

Y por último, el contenido del fichero "ScriptSampleInit.lua" de este mismo addon que se limita a dejar constancia de su arranque en el fichero de log predefinido por el juego que se llama "mods.txt" y que se encuentra en el directorio "Personal/Logs":

-----------------
-- INITIALIZATION
-----------------
function Init()
  LogInfo("Initialization sample")
end
-----------------
Init()
-----------------

Para probar este simple addon de ejemplo basta con copiar la carpeta "SampleInit" de "data/Mods/SampleAddons" a "data/Mods/Addons". Al arrancar el juego aparecerá un nuevo botón, en la ventana de login, que nos permite activar o desactivar los addons, que por defecto se encuentran desactivados. Al entrar en el juego propiamente dicho, después de la ventana de selección de personaje, veremos como se graba el mensaje en el fichero de log, señal de que el addon se encuentra correctamente instalado y funcionando.

¿No encontró lo que buscaba?

Utilice el buscador para encontrar más páginas en esta web o en toda Internet.
 
Web www.inmensia.com