Capítulo 5.3: Credits.json

Inicio | << Anterior: inputs.xml | Credits.json | Siguiente: Formato ImageSet >>

---

Resumen: El archivo Credits.json define los créditos que DayZ muestra para tu mod en el menú de mods del juego. Lista los miembros del equipo, colaboradores y reconocimientos organizados por departamentos y secciones. Aunque es puramente cosmético, es la forma estándar de dar crédito a tu equipo de desarrollo.

---

Tabla de Contenidos

• Descripción General
• Ubicación del Archivo
• Estructura JSON
• Cómo DayZ Muestra los Créditos
• Uso de Nombres de Sección Localizados
• Plantillas
• Ejemplos Reales
• Errores Comunes

---

Descripción General

Cuando un jugador selecciona tu mod en el launcher de DayZ o en el menú de mods del juego, el motor busca un archivo Credits.json dentro del PBO de tu mod. Si lo encuentra, los créditos se muestran en una vista con desplazamiento organizada en departamentos y secciones --- similar a los créditos de una película.

El archivo es opcional. Si está ausente, no aparece sección de créditos para tu mod. Pero incluir uno es buena práctica: reconoce el trabajo de tu equipo y le da a tu mod una apariencia profesional.

---

Ubicación del Archivo

Coloca Credits.json dentro de una subcarpeta Data de tu directorio Scripts, o directamente en la raíz de Scripts:

@MyMod/
  Addons/
    MyMod_Scripts.pbo
      Scripts/
        Data/
          Credits.json       <-- Ubicación común (COT, Expansion, DayZ Editor)
        Credits.json         <-- También válido (DabsFramework, Colorful-UI)

Ambas ubicaciones funcionan. El motor escanea el contenido del PBO buscando un archivo llamado Credits.json (sensible a mayúsculas en algunas plataformas).

---

Estructura JSON

El archivo usa una estructura JSON directa con tres niveles de jerarquía:

{
    "Header": "My Mod Name",
    "Departments": [
        {
            "DepartmentName": "Department Title",
            "Sections": [
                {
                    "SectionName": "Section Title",
                    "Names": ["Person 1", "Person 2"]
                }
            ]
        }
    ]
}

Campos de Nivel Superior

Campo	Tipo	Obligatorio	Descripción
Header	string	No	Título principal mostrado en la parte superior de los créditos. Si se omite, no se muestra encabezado.
Departments	array	Sí	Array de objetos de departamento

Objeto Department

Campo	Tipo	Obligatorio	Descripción
DepartmentName	string	Sí	Texto del encabezado de sección. Puede ser vacío "" para agrupación visual sin encabezado.
Sections	array	Sí	Array de objetos de sección dentro de este departamento

Objeto Section

Existen dos variantes en la práctica para listar nombres. El motor soporta ambas.

Variante 1: array Names (usado por MyMod Core)

Campo	Tipo	Obligatorio	Descripción
SectionName	string	Sí	Sub-encabezado dentro del departamento
Names	array de strings	Sí	Lista de nombres de colaboradores

Variante 2: array SectionLines (usado por COT, Expansion, DabsFramework)

Campo	Tipo	Obligatorio	Descripción
SectionName	string	Sí	Sub-encabezado dentro del departamento
SectionLines	array de strings	Sí	Lista de nombres de colaboradores o líneas de texto

Tanto Names como SectionLines sirven el mismo propósito. Usa el que prefieras --- el motor los renderiza de forma idéntica.

---

Cómo DayZ Muestra los Créditos

La visualización de créditos sigue esta jerarquía visual:

+==================================+
|         MI NOMBRE DE MOD          |  <-- Header (grande, centrado)
|                                   |
|     NOMBRE DEL DEPARTAMENTO       |  <-- DepartmentName (mediano, centrado)
|                                   |
|     Nombre de Sección             |  <-- SectionName (pequeño, centrado)
|     Persona 1                     |  <-- Names/SectionLines (lista)
|     Persona 2                     |
|     Persona 3                     |
|                                   |
|     Otra Sección                  |
|     Persona A                     |
|     Persona B                     |
|                                   |
|     OTRO DEPARTAMENTO             |
|     ...                           |
+==================================+

• El Header aparece una vez en la parte superior
• Cada DepartmentName actúa como un separador de sección principal
• Cada SectionName actúa como un sub-encabezado
• Los nombres se desplazan verticalmente en la vista de créditos

Strings Vacíos para Espaciado

Expansion usa strings vacíos de DepartmentName y SectionName, más entradas de solo espacios en SectionLines, para crear espaciado visual:

{
    "DepartmentName": "",
    "Sections": [{
        "SectionName": "",
        "SectionLines": ["           "]
    }]
}

Este es un truco común para controlar el diseño visual en el desplazamiento de créditos.

---

Uso de Nombres de Sección Localizados

Los nombres de sección pueden referenciar claves de stringtable usando el prefijo #, igual que el texto de UI:

{
    "SectionName": "#STR_EXPANSION_CREDITS_SCRIPTERS",
    "SectionLines": ["Steve aka Salutesh", "LieutenantMaster"]
}

Cuando el motor renderiza esto, resuelve #STR_EXPANSION_CREDITS_SCRIPTERS al texto localizado que coincide con el idioma del jugador. Esto es útil si tu mod soporta múltiples idiomas y quieres que los encabezados de sección de créditos sean traducidos.

Los nombres de departamento también pueden usar referencias de stringtable:

{
    "DepartmentName": "#legal_notices",
    "Sections": [...]
}

---

Plantillas

Desarrollador Solo

{
    "Header": "My Awesome Mod",
    "Departments": [
        {
            "DepartmentName": "Development",
            "Sections": [
                {
                    "SectionName": "Developer",
                    "Names": ["YourName"]
                }
            ]
        }
    ]
}

Equipo Pequeño

{
    "Header": "My Mod",
    "Departments": [
        {
            "DepartmentName": "Development",
            "Sections": [
                {
                    "SectionName": "Developers",
                    "Names": ["Lead Dev", "Co-Developer"]
                },
                {
                    "SectionName": "3D Artists",
                    "Names": ["Modeler1", "Modeler2"]
                },
                {
                    "SectionName": "Translators",
                    "Names": [
                        "Translator1 (French)",
                        "Translator2 (German)",
                        "Translator3 (Russian)"
                    ]
                }
            ]
        }
    ]
}

Estructura Profesional Completa

{
    "Header": "My Big Mod",
    "Departments": [
        {
            "DepartmentName": "Core Team",
            "Sections": [
                {
                    "SectionName": "Lead Developer",
                    "Names": ["ProjectLead"]
                },
                {
                    "SectionName": "Scripters",
                    "Names": ["Dev1", "Dev2", "Dev3"]
                },
                {
                    "SectionName": "3D Artists",
                    "Names": ["Artist1", "Artist2"]
                },
                {
                    "SectionName": "Mapping",
                    "Names": ["Mapper1"]
                }
            ]
        },
        {
            "DepartmentName": "Community",
            "Sections": [
                {
                    "SectionName": "Translators",
                    "Names": [
                        "Translator1 (Czech)",
                        "Translator2 (German)",
                        "Translator3 (Russian)"
                    ]
                },
                {
                    "SectionName": "Testers",
                    "Names": ["Tester1", "Tester2", "Tester3"]
                }
            ]
        },
        {
            "DepartmentName": "Legal Notices",
            "Sections": [
                {
                    "SectionName": "Licenses",
                    "Names": [
                        "Font Awesome - CC BY 4.0 License",
                        "Some assets licensed under ADPL-SA"
                    ]
                }
            ]
        }
    ]
}

---

Ejemplos Reales

MyMod Core

Un archivo de créditos mínimo pero completo usando la variante Names:

{
    "Header": "MyMod Core",
    "Departments": [
        {
            "DepartmentName": "Development",
            "Sections": [
                {
                    "SectionName": "Framework",
                    "Names": ["Documentation Team"]
                }
            ]
        }
    ]
}

Community Online Tools (COT)

Usa la variante SectionLines con múltiples secciones y reconocimientos:

{
    "Departments": [
        {
            "DepartmentName": "Community Online Tools",
            "Sections": [
                {
                    "SectionName": "Active Developers",
                    "SectionLines": [
                        "LieutenantMaster",
                        "LAVA (liquidrock)"
                    ]
                },
                {
                    "SectionName": "Inactive Developers",
                    "SectionLines": [
                        "Jacob_Mango",
                        "Arkensor",
                        "DannyDog68",
                        "Thurston",
                        "GrosTon1"
                    ]
                },
                {
                    "SectionName": "Thank you to the following communities",
                    "SectionLines": [
                        "PIPSI.NET AU/NZ",
                        "1SKGaming",
                        "AWG",
                        "Expansion Mod Team",
                        "Bohemia Interactive"
                    ]
                }
            ]
        }
    ]
}

Notable: COT omite el campo Header por completo. El nombre del mod proviene de otros metadatos (config.cpp CfgMods).

DabsFramework

{
    "Departments": [{
        "DepartmentName": "Development",
        "Sections": [{
                "SectionName": "Developers",
                "SectionLines": [
                    "InclementDab",
                    "Gormirn"
                ]
            },
            {
                "SectionName": "Translators",
                "SectionLines": [
                    "InclementDab",
                    "DanceOfJesus (French)",
                    "MarioE (Spanish)",
                    "Dubinek (Czech)",
                    "Steve AKA Salutesh (German)",
                    "Yuki (Russian)",
                    ".magik34 (Polish)",
                    "Daze (Hungarian)"
                ]
            }
        ]
    }]
}

DayZ Expansion

Expansion demuestra el uso más sofisticado de Credits.json, incluyendo:

• Nombres de sección localizados vía referencias de stringtable (#STR_EXPANSION_CREDITS_SCRIPTERS)
• Avisos legales como departamento separado
• Nombres de departamento y sección vacíos para espaciado visual
• Una lista de supporters con docenas de nombres

---

Errores Comunes

Sintaxis JSON Inválida

El problema más común. JSON es estricto respecto a:

• Comas finales: ["a", "b",] es JSON inválido (la coma final después de "b")
• Comillas simples: Usa "comillas dobles", no 'comillas simples'
• Claves sin comillas: DepartmentName debe ser "DepartmentName"

Usa un validador de JSON antes de publicar.

Nombre de Archivo Incorrecto

El archivo debe llamarse exactamente Credits.json (C mayúscula). En sistemas de archivos sensibles a mayúsculas, credits.json o CREDITS.JSON no serán encontrados.

Mezcla de Names y SectionLines

Dentro de una sola sección, usa uno u otro:

{
    "SectionName": "Developers",
    "Names": ["Dev1"],
    "SectionLines": ["Dev2"]
}

Esto es ambiguo. Elige un formato y úsalo consistentemente en todo el archivo.

Problemas de Codificación

Guarda el archivo como UTF-8. Los caracteres no ASCII (nombres con acentos, caracteres CJK) requieren codificación UTF-8 para mostrarse correctamente en el juego.

---

Mejores Prácticas

• Valida tu JSON con una herramienta externa antes de empaquetarlo en un PBO -- el motor no da ningún mensaje de error útil para JSON malformado.
• Usa la variante SectionLines para consistencia, ya que es el formato usado por COT, Expansion y DabsFramework.
• Incluye un departamento de "Legal Notices" si tu mod incluye assets de terceros (fuentes, íconos, sonidos) con requisitos de atribución.
• Mantén el campo Header coincidiendo con el name de tu mod en mod.cpp y config.cpp para una identidad consistente.
• Usa strings vacíos de DepartmentName y SectionName con moderación para espaciado visual -- el uso excesivo hace que los créditos se vean fragmentados.

---

Compatibilidad e Impacto

• Multi-Mod: Cada mod tiene su propio Credits.json independiente. No hay riesgo de colisión -- el motor lee el archivo desde dentro del PBO de cada mod por separado.
• Rendimiento: Los créditos se cargan solo cuando el jugador abre la pantalla de detalles del mod. El tamaño del archivo no tiene impacto en el rendimiento del juego.