Conceptos Generales

Como ya se comentó con anterioridad en ¿Qué es Hexssentials?, en esta documentación encontrarás todo lo necesario para entender el plugin.

En este documento se explican conceptos generales que debes tener en cuenta al momento de leer el resto de la documentación.

Sugerencias y Advertencias

En varias partes de la documentación encontrarás pequeños bloques con información extra para ayudarte o advertirte sobre cosas relacionadas con comandos o configuraciones.

Ejemplos:

Sugerencias o información extra:

💡 Nota: Hola!!!

Advertencias o prohibiciones:

⚠️ Advertencia: ¡Cuidaoo!

Translates

Siempre que en la documentación se mencionen translates, nos referimos a las keys en el archivo translates.json (o archivos de traducción equivalentes) de cada módulo.

Siempre encontrarás estos archivos en:

• La carpeta principal del módulo, o
• Una carpeta designada para los translates dentro de la carpeta principal.

Ejemplo: Carpeta principal

MiModulo/translates.json

Ejemplo: Carpeta designada

MiModulo/Translations/Spanish.json

Los translates son las keys que están dentro de estos archivos.
Un ejemplo de archivo podría ser:

"icon": "Here the icon for the messages!",
"SyntaxError": "El comando fue ingresado incorrectamente. intente con este Syntaxis: /{0} {1}",
"DontHavePermissionForGiveKits": "No tienes los permisos necesarios para entregar este kit a otro jugador",
"NotEnoughMoney": "No tienes suficiente dinero para obtener el kit {0}, necesitas {1} mas!"

Cuando se dice:

Se avisará mediante el siguiente translate: SyntaxError

La key es SyntaxError y el mensaje que se enviará es el valor asignado después de los :.
En este caso:

"El comando fue ingresado incorrectamente. intente con este Syntaxis: /{0} {1}"

Si modificas los translates, asegúrate de modificar el valor de las keys, no la key como tal.
De lo contrario, provocarás que no se envíen los mensajes correctamente.

Preguntas generales sobre los translates

Algunas dudas frecuentes:

¿Puedo modificar los valores?

Sí.
El objetivo de los translates es que puedas cambiar los textos a tu gusto, incluso agregando RichText.

¿Puedo eliminar los números entre llaves? (Ej: {0})

No.
Esos números indican que el plugin enviará algún valor ahí (texto, números, nombres, etc.).
Si los eliminas, puedes provocar un mal funcionamiento del comando.

💡 Nota: En el futuro se agregará soporte para poder controlar mejor estos valores.

¿Puedo eliminar o modificar las keys?

No.
Como se mencionó antes, no debes modificar las claves (keys) que anteceden a los valores de texto, ya que son, por llamarlas de alguna forma, el “DNI” de los mensajes.

• Si las eliminas o cambias:
  • El plugin seguirá buscando las keys originales.
  • Al no encontrarlas, los mensajes no se enviarán o el comando podría dejar de funcionar.

¿Pierdo para siempre los translates si elimino el archivo?

No del todo.

• Si eliminas el archivo:
  • Cuando recargues el plugin o reinicies el servidor, el plugin creará automáticamente una copia del archivo original.
• Lo que sí se pierde:
  • Todas las modificaciones personalizadas que hubieras hecho a los valores.
  • Los textos volverán a estar en su versión por defecto.

¿Puedo renombrar el archivo de translates?

No.

• Si lo haces, el plugin dejará de tomar en cuenta ese archivo y:
  • Creará otro archivo nuevo automáticamente, al detectar que el original “se perdió”.
• Resultado:
  • Tus cambios no se usarán y tendrás un archivo extra que no será leído.

¿Puedo tener 2 archivos de translates al mismo tiempo?

No, y no deberías.

• No puedes ni deberías tener dos archivos de translates con el mismo nombre generados por el plugin.
• Si tienes, por ejemplo, 2 archivos llamados:

Translates.json
Translates.json

O:

Spanish.json
Spanish.json

(en el caso de AdminHelper)

y ambos cumplen el mismo rol, el plugin puede confundirse y no funcionar correctamente.

💡 Nota: Esta advertencia se refiere a no tener duplicados del archivo oficial de traducciones (mismo nombre esperado por el plugin).
Si obtienes dos archivos de forma automática (ambos generados por el plugin), es un error: ¡contáctanos a la brevedad!

Palabras claves en las keys

Aquí encontrarás algunas palabras clave que suelen aparecer en las keys, para que entiendas qué significan:

• Success → se envía cuando el comando se ejecuta correctamente.
• Error → se envía cuando el comando falla.
• Fail → se envía cuando el comando falla mientras calcula algo interno.
• NotFound → se envía cuando el comando falla porque no se encuentra algo (jugador, ítem, vehículo, etc.).
• ByOther → se envía al jugador que se ve afectado por un comando, avisándole que otra persona ejecutó ese comando sobre él.
• Target → se usa para el mensaje que informa que pudiste ejecutar el comando sobre otro jugador.
• Icon → se utiliza para que agregues un link a una imagen (ícono) que acompañará al mensaje.

Errores generales

En cada documentación de módulo encontrarás un documento de Errores Generales, donde se listan los translates que se repiten en muchos comandos para que los tengas en cuenta y no tengas que buscarlos uno por uno.

Permisos

En cada módulo, cada comando traerá sus permisos necesarios para su funcionamiento en un apartado llamado:

Resumen de permisos

No puedes cambiar ni modificar estos permisos desde la configuración del plugin.
Son las rutas internas que el plugin utiliza para validar accesos.

Por lo general tienen un indicador para guiarte sobre qué tipo de permiso es, por ejemplo:

• mimodulo.Command.Comando → permiso para usar un comando.
• mimodulo.Extra.permiso → permiso que agrega funcionalidades extra a algún comando si lo tienes.

Además:

• Si eres administrador del servidor, normalmente no necesitas asignarte estos permisos manualmente, ya que los obtienes automáticamente.

Sintaxis

Las reglas de sintaxis son sencillas:

• Si en la sintaxis aparecen los símbolos < o >, ese parámetro es obligatorio.
• Si aparecen los símbolos [ o ], ese parámetro es opcional.

Por ejemplo:

/comando <obligatorio> [opcional]

En este caso:

• obligatorio → debe ser siempre especificado.
• opcional → puede omitirse según el uso del comando.