5.3. fejezet: Credits.json

Főoldal | << Előző: inputs.xml | Credits.json | Következő: ImageSet formátum >>

---

Összefoglalás: A Credits.json fájl határozza meg azokat a stáblistát, amelyet a DayZ megjelenít a modod számára a játék mod menüjében. Felsorolja a csapattagokat, közreműködőket és köszönetnyilvánításokat részlegek és szekciók szerint rendezve. Bár tisztán dekoratív, ez a szabványos módja annak, hogy elismerd a fejlesztőcsapatod munkáját.

---

Tartalomjegyzék

• Áttekintés
• Fájl helye
• JSON struktúra
• Hogyan jeleníti meg a DayZ a stáblistát
• Lokalizált szekciók használata
• Sablonok
• Valós példák
• Gyakori hibák

---

Áttekintés

Amikor egy játékos kiválasztja a mododat a DayZ launcherben vagy a játékon belüli mod menüben, a motor egy Credits.json fájlt keres a mod PBO-jában. Ha megtalálja, a stáblista egy görgethető nézetben jelenik meg, részlegekre és szekciókra bontva --- hasonlóan a filmek stáblistájához.

A fájl opcionális. Ha hiányzik, nem jelenik meg stáblista szekció a mododhoz. De beletenni jó gyakorlat: elismeri a csapatod munkáját és professzionális megjelenést kölcsönöz a mododnak.

---

Fájl helye

Helyezd a Credits.json fájlt a Scripts könyvtárad Data almappájába, vagy közvetlenül a Scripts gyökerébe:

@MyMod/
  Addons/
    MyMod_Scripts.pbo
      Scripts/
        Data/
          Credits.json       <-- Gyakori hely (COT, Expansion, DayZ Editor)
        Credits.json         <-- Szintén érvényes (DabsFramework, Colorful-UI)

Mindkét hely működik. A motor átvizsgálja a PBO tartalmát egy Credits.json nevű fájl után (egyes platformokon kis-nagybetű érzékeny).

---

JSON struktúra

A fájl egyszerű JSON struktúrát használ három szintű hierarchiával:

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

Felső szintű mezők

Mező	Típus	Kötelező	Leírás
Header	string	Nem	A stáblista tetején megjelenő fő cím. Ha nincs megadva, nem jelenik meg fejléc.
Departments	array	Igen	Részleg objektumok tömbje

Részleg objektum

Mező	Típus	Kötelező	Leírás
DepartmentName	string	Igen	Szekció fejléc szöveg. Lehet üres "" vizuális csoportosításhoz fejléc nélkül.
Sections	array	Igen	A részlegen belüli szekció objektumok tömbje

Szekció objektum

Két változat létezik a nevek felsorolására. A motor mindkettőt támogatja.

1. változat: Names tömb (MyFramework használja)

Mező	Típus	Kötelező	Leírás
SectionName	string	Igen	Al-fejléc a részlegen belül
Names	string tömb	Igen	Közreműködők neveinek listája

2. változat: SectionLines tömb (COT, Expansion, DabsFramework használja)

Mező	Típus	Kötelező	Leírás
SectionName	string	Igen	Al-fejléc a részlegen belül
SectionLines	string tömb	Igen	Közreműködők nevei vagy szöveges sorok listája

Mind a Names, mind a SectionLines ugyanazt a célt szolgálja. Használd azt, amelyiket preferálod --- a motor azonosan jeleníti meg őket.

---

Hogyan jeleníti meg a DayZ a stáblistát

A stáblista megjelenítése ezt a vizuális hierarchiát követi:

╔══════════════════════════════════╗
║         MY MOD NAME              ║  <-- Header (nagy, középre igazított)
║                                  ║
║     DEPARTMENT NAME              ║  <-- DepartmentName (közepes, középre igazított)
║                                  ║
║     Section Name                 ║  <-- SectionName (kicsi, középre igazított)
║     Person 1                     ║  <-- Names/SectionLines (lista)
║     Person 2                     ║
║     Person 3                     ║
║                                  ║
║     Another Section              ║
║     Person A                     ║
║     Person B                     ║
║                                  ║
║     ANOTHER DEPARTMENT           ║
║     ...                          ║
╚══════════════════════════════════╝

• A Header egyszer jelenik meg a tetején
• Minden DepartmentName fő szekcióelválasztóként működik
• Minden SectionName al-címsorként működik
• A nevek függőlegesen görgethetők a stáblista nézetben

Üres sztringek térközként

Az Expansion üres DepartmentName és SectionName sztringeket, valamint csak szóközökből álló bejegyzéseket használ a SectionLines-ban vizuális térköz létrehozásához:

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

Ez egy gyakori trükk a vizuális elrendezés szabályozására a stáblista görgetésben.

---

Lokalizált szekciók használata

A szekció nevek hivatkozhatnak stringtable kulcsokra a # előtaggal, ugyanúgy mint az UI szövegek:

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

Amikor a motor megjeleníti ezt, a #STR_EXPANSION_CREDITS_SCRIPTERS kulcsot a játékos nyelvének megfelelő lokalizált szövegre oldja fel. Ez hasznos, ha a modod több nyelvet támogat és szeretnéd, hogy a stáblista szekció fejlécek is le legyenek fordítva.

A részleg nevek szintén használhatnak stringtable hivatkozásokat:

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

---

Sablonok

Egyedüli fejlesztő

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

Kis csapat

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

Teljes professzionális struktúra

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

---

Valós példák

MyFramework

Minimális de teljes stáblista fájl a Names változattal:

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

Community Online Tools (COT)

A SectionLines változatot használja több szekcióval és köszönetnyilvánításokkal:

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

Megjegyzés: a COT teljesen kihagyja a Header mezőt. A mod neve más metaadatokból származik (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

Az Expansion mutatja be a Credits.json legkifinomultabb használatát, beleértve:

• Lokalizált szekció neveket stringtable hivatkozásokkal (#STR_EXPANSION_CREDITS_SCRIPTERS)
• Jogi nyilatkozatokat külön részlegként
• Üres részleg és szekció neveket vizuális térközként
• Támogatók listáját tucatnyi névvel

---

Gyakori hibák

Érvénytelen JSON szintaxis

A leggyakoribb probléma. A JSON szigorú a következőkkel kapcsolatban:

• Záró vesszők: a ["a", "b",] érvénytelen JSON (a záró vessző a "b" után)
• Szimpla idézőjelek: Használj "dupla idézőjeleket", ne 'szimpla idézőjeleket'
• Idézőjel nélküli kulcsok: a DepartmentName formátumnak "DepartmentName" kell lennie

Használj JSON validátort a kiadás előtt.

Hibás fájlnév

A fájl nevének pontosan Credits.json-nak kell lennie (nagy C-vel). Kis-nagybetű érzékeny fájlrendszereken a credits.json vagy CREDITS.JSON nem lesz megtalálva.

Names és SectionLines keverése

Egy szekción belül használj egyet vagy másikat:

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

Ez kétértelmű. Válassz egy formátumot és használd következetesen az egész fájlban.

Kódolási problémák

Mentsd a fájlt UTF-8 kódolással. A nem-ASCII karakterek (ékezetes nevek, CJK karakterek) UTF-8 kódolást igényelnek a helyes játékon belüli megjelenítéshez.