Kapitola 5.3: Credits.json

Domů | << Předchozí: inputs.xml | Credits.json | Další: Formát ImageSet >>

---

Shrnutí: Soubor Credits.json definuje titulky, které DayZ zobrazuje pro váš mod v herním menu modů. Obsahuje seznam členů týmu, přispěvatelů a poděkování uspořádaných podle oddělení a sekcí. Ačkoli je čistě kosmetický, jedná se o standardní způsob, jak ocenit práci vašeho vývojového týmu.

---

Obsah

• Přehled
• Umístění souboru
• Struktura JSON
• Jak DayZ zobrazuje titulky
• Použití lokalizovaných názvů sekcí
• Šablony
• Reálné příklady
• Časté chyby

---

Přehled

Když hráč vybere váš mod v launcheru DayZ nebo v herním menu modů, engine hledá soubor Credits.json uvnitř PBO vašeho modu. Pokud je nalezen, titulky se zobrazí v rolujícím zobrazení uspořádaném do oddělení a sekcí --- podobně jako filmové titulky.

Soubor je volitelný. Pokud chybí, pro váš mod se žádná sekce titulků nezobrazí. Nicméně jeho zahrnutí je dobrým postupem: oceňuje práci vašeho týmu a dodává modu profesionální vzhled.

---

Umístění souboru

Umístěte Credits.json do podsložky Data vašeho adresáře Scripts, nebo přímo do kořene Scripts:

@MyMod/
  Addons/
    MyMod_Scripts.pbo
      Scripts/
        Data/
          Credits.json       <-- Běžné umístění (COT, Expansion, DayZ Editor)
        Credits.json         <-- Také platné (DabsFramework, Colorful-UI)

Obě umístění fungují. Engine prohledává obsah PBO a hledá soubor pojmenovaný přesně Credits.json (na některých platformách záleží na velikosti písmen).

---

Struktura JSON

Soubor používá přímočarou strukturu JSON se třemi úrovněmi hierarchie:

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

Pole nejvyšší úrovně

Pole	Typ	Povinné	Popis
Header	string	Ne	Hlavní nadpis zobrazený na vrcholu titulků. Pokud je vynechán, žádný nadpis se nezobrazí.
Departments	array	Ano	Pole objektů oddělení

Objekt oddělení

Pole	Typ	Povinné	Popis
DepartmentName	string	Ano	Text záhlaví sekce. Může být prázdný "" pro vizuální seskupení bez záhlaví.
Sections	array	Ano	Pole objektů sekcí v rámci tohoto oddělení

Objekt sekce

V praxi existují dvě varianty pro výpis jmen. Engine podporuje obě.

Varianta 1: Pole Names (používá MyMod Core)

Pole	Typ	Povinné	Popis
SectionName	string	Ano	Podnadpis v rámci oddělení
Names	pole řetězců	Ano	Seznam jmen přispěvatelů

Varianta 2: Pole SectionLines (používají COT, Expansion, DabsFramework)

Pole	Typ	Povinné	Popis
SectionName	string	Ano	Podnadpis v rámci oddělení
SectionLines	pole řetězců	Ano	Seznam jmen přispěvatelů nebo textových řádků

Obě pole Names i SectionLines slouží ke stejnému účelu. Použijte to, které preferujete --- engine je vykresluje identicky.

---

Jak DayZ zobrazuje titulky

Zobrazení titulků sleduje tuto vizuální hierarchii:

╔══════════════════════════════════╗
║         MY MOD NAME              ║  <-- Header (velký, centrovaný)
║                                  ║
║     DEPARTMENT NAME              ║  <-- DepartmentName (střední, centrovaný)
║                                  ║
║     Section Name                 ║  <-- SectionName (malý, centrovaný)
║     Person 1                     ║  <-- Names/SectionLines (seznam)
║     Person 2                     ║
║     Person 3                     ║
║                                  ║
║     Another Section              ║
║     Person A                     ║
║     Person B                     ║
║                                  ║
║     ANOTHER DEPARTMENT           ║
║     ...                          ║
╚══════════════════════════════════╝

• Header se zobrazí jednou na vrcholu
• Každý DepartmentName funguje jako hlavní oddělovač sekcí
• Každý SectionName funguje jako podnadpis
• Jména se rolují vertikálně v zobrazení titulků

Prázdné řetězce pro odsazení

Expansion používá prázdné řetězce DepartmentName a SectionName plus záznamy obsahující pouze mezery v SectionLines k vytvoření vizuálního odsazení:

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

Toto je běžný trik pro ovládání vizuálního rozvržení v rolování titulků.

---

Použití lokalizovaných názvů sekcí

Názvy sekcí mohou odkazovat na klíče stringtable pomocí předpony #, stejně jako text v UI:

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

Když engine toto vykreslí, přeloží #STR_EXPANSION_CREDITS_SCRIPTERS na lokalizovaný text odpovídající jazyku hráče. To je užitečné, pokud váš mod podporuje více jazyků a chcete, aby byly záhlaví sekcí titulků přeloženy.

Názvy oddělení mohou také používat reference na stringtable:

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

---

Šablony

Samostatný vývojář

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

Malý tým

{
    "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)"
                    ]
                }
            ]
        }
    ]
}

Plná profesionální struktura

{
    "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"
                    ]
                }
            ]
        }
    ]
}

---

Reálné příklady

MyMod Core

Minimální, ale úplný soubor titulků používající variantu Names:

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

Community Online Tools (COT)

Používá variantu SectionLines s více sekcemi a poděkováními:

{
    "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"
                    ]
                }
            ]
        }
    ]
}

Pozoruhodné: COT zcela vynechává pole Header. Název modu pochází z jiných metadat (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 demonstruje nejsofistikovanější použití Credits.json, včetně:

• Lokalizovaných názvů sekcí přes reference na stringtable (#STR_EXPANSION_CREDITS_SCRIPTERS)
• Právních upozornění jako samostatného oddělení
• Prázdných názvů oddělení a sekcí pro vizuální odsazení
• Seznamu podporovatelů s desítkami jmen

---

Časté chyby

Neplatná syntaxe JSON

Nejčastější problém. JSON je přísný ohledně:

• Koncové čárky: ["a", "b",] je neplatný JSON (koncová čárka za "b")
• Jednoduché uvozovky: Používejte "dvojité uvozovky", ne 'jednoduché uvozovky'
• Klíče bez uvozovek: DepartmentName musí být "DepartmentName"

Před distribucí použijte validátor JSON.

Špatný název souboru

Soubor musí být pojmenován přesně Credits.json (velké C). Na souborových systémech citlivých na velikost písmen nebude credits.json ani CREDITS.JSON nalezen.

Míchání Names a SectionLines

V rámci jedné sekce použijte jedno nebo druhé:

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

Toto je nejednoznačné. Zvolte si jeden formát a používejte ho konzistentně v celém souboru.

Problémy s kódováním

Uložte soubor jako UTF-8. Znaky mimo ASCII (jména s diakritikou, znaky CJK) vyžadují kódování UTF-8, aby se ve hře zobrazovaly správně.

---

Osvědčené postupy

• Před zabalením do PBO ověřte svůj JSON externím nástrojem --- engine neposkytuje žádnou užitečnou chybovou zprávu pro nesprávně formátovaný JSON.
• Pro konzistenci používejte variantu SectionLines, protože je to formát používaný modly COT, Expansion a DabsFramework.
• Zahrňte oddělení "Legal Notices", pokud váš mod obsahuje assety třetích stran (fonty, ikony, zvuky) s požadavky na uvedení autora.
• Udržujte pole Header shodné s name vašeho modu v mod.cpp a config.cpp pro konzistentní identitu.
• Prázdné řetězce DepartmentName a SectionName používejte střídmě pro vizuální odsazení --- nadměrné použití způsobí fragmentovaný vzhled titulků.

---

Kompatibilita a dopad

• Více modů: Každý mod má svůj vlastní nezávislý Credits.json. Nehrozí žádné kolize --- engine čte soubor z PBO každého modu samostatně.
• Výkon: Titulky se načítají pouze tehdy, když hráč otevře obrazovku detailů modu. Velikost souboru nemá žádný dopad na herní výkon.