Mobability

Version: 1.0.2
Author: Waky
License: GNU General Public License v3
Link: https://github.com/XavierRobles/MobAbility

⚠️ $${\color{orange}IMPORTANT}$$

This addon $${\color{red}has\space NOT\space been\space approved}$$ by $${\color{teal}HorizonXI}$$ for use on their server.
Its use is the sole responsibility of the user, who must respect the rules of the server they play on.

---

Este addon $${\color{red}NO\space ha\space sido\space aprobado}$$ por $${\color{teal}HorizonXI}$$ para su uso en su servidor.
Su uso queda bajo la responsabilidad del usuario, quien debe respetar las normas del servidor donde juegue.

---

📢 Notice

This addon is completely transparent in its operation: it acts only on the client, processing information that is already displayed in the game chat. It does not modify any game files, does not send data to the server, and consumes minimal resources, operating solely with the local data available.

---

Este addon es completamente transparente en su funcionamiento: actúa solo en el cliente, procesando la información que ya muestra el chat del juego. No modifica ningún archivo del juego, no envía datos al servidor y consume recursos mínimos, operando únicamente con los datos locales disponibles.

---

📌 Changelog

v1.0.2 (English)

• Fixed an issue where names were not displayed correctly in certain cases.
• Fixed an issue where mob self-targeted actions did not display the name properly.
• Names now display correctly even when the action's target is not part of the party or alliance.
• Fixed an issue where pet names were not displayed when they received an action.
• Added the summoner's name to the pet information.
• Added alerts for mobs using two-hour (2H) abilities.
• Added configurable background for alerts in the options menu.
• Fixed an issue where player-defined settings were not being saved correctly.
• Documented the code for better readability and maintenance.

---

v1.0.2 (Español)

• Se corrigió un error donde los nombres no se mostraban correctamente en ciertos casos.
• Se corrigió un error al mostrar acciones que un mob se hacía a sí mismo.
• Ahora los nombres se muestran correctamente incluso si el objetivo de la acción no está en la party o alianza.
• Se corrigió un error donde no se mostraban los nombres de los pets al recibir una acción.
• Se añadió el nombre del invocador en la información del pet.
• Se añadieron alertas para detectar habilidades 2H de los mobs.
• Se añadió un fondo configurable en las alertas desde el menú de opciones.
• Se corrigió un problema donde no se guardaban correctamente los ajustes definidos por el jugador.
• Se documentó el código para mejorar su legibilidad y mantenimiento.

---

v1.0.1

---

Description (English)

Mobability is an addon for Final Fantasy XI that displays real-time alerts for mob actions in combat based on your selected alert mode. The addon detects events such as when a mob begins to cast a spell or performs a TP move, and shows the alerts in a floating window. The notifications appear in different colors, which help differentiate between:

• The mob's name.
• The action performed (spell or TP move).
• The target of the action.

Mobability operates in two alert modes:

• Only your current target: Alerts are generated only for the mob that you have targeted.
• All party/ally mobs: Alerts are generated for all mobs attacking any party or allied member.

Additional features include configurable options such as limiting the number of alerts shown, sound notifications, and customizable colors. You can also open the configuration window via the chat command.

Installation

1. Step 1:
   Copy the Mobability folder into the Ashita addons directory or into the game client folder. For example:
   \Game\addons

2. Step 2:

   • Automatic Loading:
     To have the addon load automatically when the game starts, open the default.txt file located in the scripts folder and add the following line in the addons section or at the end of the file:

     /addon load mobability
     

   • Manual Loading:
     To load the addon manually in-game, type the following command in chat:

     /addon load mobability
     

Following these steps will load the addon so you can start using it.

Usage

• Opening the Configuration:
  In game, type /mb or /mobability in the chat to open the Mobability configuration window.

• Floating Alerts:
  Alerts will automatically appear on-screen during combat for up to 10 seconds (or until the action finishes).

• Alert Modes:

  • Only your current target: Displays alerts only for the mob you are targeting.
  • All party/ally mobs: Displays alerts for all mobs attacking any party or allied member.

• Sound Notifications:
  When enabled, a distinct sound is played for spells and TP moves.

Configuration In the configuration window you can: - Adjust the position and text size. - Set the maximum number of alerts to display (recommended: 5; set to 0 for unlimited). - Choose the alert mode: "Only your current target" or "All party/ally mobs". - Enable or disable alerts in the chat. - Enable or disable sound notifications. - Customize the colors for:    • Mob Name    • Fixed Message Text    • Spell Action    • TP Move Action    • Target Name - Test your settings with the "Test Alert" button. All settings are saved automatically when you close the configuration window.

Additional Notes

• Compatibility:
  Mobability has been designed for Ashita, aiming to enhance your combat experience in Final Fantasy XI with clear and configurable alerts.

• Server:
  his addon is optimized for private FFXI servers. It has not been tested on the Retail version.

• License:
  Mobability is distributed under the GNU General Public License v3.

---

Descripción (Español)

Mobability es un addon para Final Fantasy XI que muestra alertas en tiempo real sobre las acciones de los mobs durante el combate, en función del modo de alerta que selecciones. El addon detecta eventos, por ejemplo, cuando un mob empieza a lanzar un hechizo o ejecuta un movimiento especial (TP move), y muestra las alertas en una ventana flotante. Los avisos se presentan en distintos colores, lo que facilita distinguir entre:

• El nombre del mob.
• La acción que realiza (hechizo o TP move).
• El objetivo o receptor de la acción.

Mobability funciona en dos modos de alerta:

• Solo tu objetivo actual: Se generan alertas únicamente para el mob que tengas seleccionado.
• Todos los mobs de party/ally: Se generan alertas para todos los mobs que estén atacando a algún miembro de la party o aliado.

Entre sus características se incluyen opciones configurables para limitar el número de alertas en pantalla, notificaciones sonoras (si se activan) y personalización de colores. La ventana de configuración se abre escribiendo /mb o /mobability en el chat de Ashita.

Instalación

1. Paso 1:
   Copia la carpeta Mobability en el directorio de addons de Ashita o en la carpeta del cliente del juego. Por ejemplo:
   \Game\addons

2. Paso 2:

   • Carga automática:
     Para que el addon se ejecute automáticamente al iniciar el juego, abre el archivo default.txt que se encuentra en la carpeta scripts y añade la siguiente línea en la sección de addons o al final del archivo:

     /addon load mobability
     

   • Carga manual:
     Dentro del juego, abre el chat y escribe:

     /addon load mobability
     

Con estos pasos, el addon se cargará y estará listo para usar.

Uso

• Abrir la Configuración:
  En el juego, escribe /mb o /mobability en el chat para abrir la ventana de configuración de Mobability.

• Alertas Flotantes:
  Las alertas se mostrarán automáticamente en combate y permanecerán en pantalla hasta 10 segundos (o hasta que la acción finalice).

• Modos de Alerta:

  • Solo tu objetivo actual: Muestra alertas únicamente para el mob que tienes seleccionado.
  • Todos los mobs de party/ally: Muestra alertas para todos los mobs que estén atacando a la party o aliados.

• Notificaciones Sonoras:
  Si están habilitadas, se reproducirá un sonido distinto para los hechizos y los TP moves.

Configuración En la ventana de configuración puedes: - Ajustar la posición y el tamaño del texto. - Establecer el número máximo de alertas a mostrar (recomendado: 5; pon 0 para ilimitado). - Elegir el modo de alerta: "Sólo tu objetivo actual" o "Todos los mobs de party/ally". - Activar o desactivar las alertas en el chat. - Activar o desactivar las notificaciones de sonido. - Personalizar los colores para:    • Nombre del mob    • Texto fijo del mensaje    • Acción de hechizo    • Acción de TP Move    • Nombre del receptor - Probar la configuración con el botón "Alerta de prueba". Todos los ajustes se guardan automáticamente al cerrar la ventana de configuración.

Notas Adicionales

• Compatibilidad:
  Mobability ha sido diseñado para funcionar con Ashita y mejorar la experiencia de combate en Final Fantasy XI mediante alertas claras y configurables.

• Servidor:
  Este addon está optimizado para servidores privados de FFXI. No ha sido probado en la versión Retail.

• Licencia:
  Mobability se distribuye bajo la GNU General Public License v3.

---