manifest.json dla widgetów Livedeck: pola, uprawnienia i kody błędów

Każde pole, uprawnienie i typ ustawienia w manifest.json oraz znaczenie każdego kodu błędu.

8 min czytania Zaktualizowano 4 lis 2026

manifest.json opisuje twój widget. Livedeck odczytuje go przy wgrywaniu, buduje z niego ustawienia w edytorze i daje widgetowi tylko wymienione w nim uprawnienia. Nieznane pola to błąd, więc literówki nigdy się nie ukryją.

json
{
  "manifestVersion": 1,
  "name": "Gift Goal",
  "version": "1.0.0",
  "sdk": "1",
  "entry": "index.html",
  "description": "A bar that fills up with gifts.",
  "formats": ["9:16", "16:9"],
  "size": { "default": [600, 160], "min": [300, 80], "max": [1080, 400] },
  "permissions": ["events.gift", "media.play"],
  "settings": [
    { "key": "goal", "type": "number", "label": { "de": "Ziel", "en": "Goal" }, "default": 100, "min": 1 },
    { "key": "giftId", "type": "gift", "label": { "de": "Nur dieses Geschenk", "en": "Only this gift" } },
    { "key": "accent", "type": "color", "label": { "de": "Farbe", "en": "Colour" }, "default": "#22c55e" },
    { "key": "doneSound", "type": "media", "label": { "de": "Ton bei Ziel", "en": "Goal sound" }, "accept": "audio" }
  ],
  "locales": ["de", "en"]
}

Pola

manifestVersion

Pole wymagane: tak

Znaczenie: Zawsze 1

name

Pole wymagane: tak

Znaczenie: Nazwa widgetu, maks. 60 znaków

version

Pole wymagane: tak

Znaczenie: Numer wersji x.y.z, np. 1.2.0

sdk

Pole wymagane: tak

Znaczenie: Wersja SDK, obecnie "1"

entry

Pole wymagane: nie

Znaczenie: Plik startowy, domyślnie index.html. Musi kończyć się na .html.

description

Pole wymagane: nie

Znaczenie: Krótki opis, maks. 300 znaków

formats

Pole wymagane: nie

Znaczenie: ["9:16"], ["16:9"] lub oba (domyślnie: oba)

size

Pole wymagane: tak

Znaczenie: Rozmiar w pikselach na płótnie overlayu: default, min i max jako [szerokość, wysokość]

permissions

Pole wymagane: nie

Znaczenie: Jakie dane dostaje widget (patrz niżej)

settings

Pole wymagane: nie

Znaczenie: Ustawienia, które użytkownicy zmieniają w edytorze (maks. 40)

locales

Pole wymagane: nie

Znaczenie: Języki obsługiwane przez widget, np. ["de", "en"]

Płótno ma 1080 × 1920 pikseli w 9:16 i 1920 × 1080 w 16:9. Rozmiary wynoszą od 16 do 3840 pikseli. min i max to limity, gdy użytkownicy zmieniają rozmiar widgetu w edytorze. Bez nich obowiązuje default. Buduj widget w stałych pikselach dla default: gdy użytkownik zmienia rozmiar, Livedeck skaluje całą stronę razem z ramką (tekst, obrazy i odstępy rosną razem). Jeśli ramka ma inny kształt niż default, strona dostaje dodatkowe miejsce w tym kierunku, więc tam, gdzie ma wypełniać, używaj szerokości/wysokości 100%, flexboxa lub grida. livedeck.context.size to rozmiar strony w pikselach CSS, a livedeck.context.scale to powiększenie.

Uprawnienia

Kupujący widzą tę listę przed zakupem, a edytor pokazuje ją w sekcji „Ma dostęp do”. Proś tylko o to, czego naprawdę potrzebujesz.

events.gift

Prezenty (zdarzenie gift)

events.chat

Wiadomości z czatu (chat)

events.like

Polubienia, zbiorczo (like)

events.follow

Nowi obserwujący (follow)

events.share

Udostępnienia LIVE (share)

events.join

Widz dołącza do LIVE (join)

events.fanclub

Dołączenia do fanklubu (fanclub)

events.viewers

Liczba widzów (viewers)

stream.status

Na żywo, offline lub w trakcie sprawdzania (stream)

media.play

Może odtwarzać dźwięki z ustawień mediów przez Livedeck

host.profile

Nazwa i zdjęcie profilowe streamera (livedeck.host)

Ustawienia

Każde ustawienie ma key, type i label. Klucz zaczyna się małą literą, po której są litery, cyfry lub _ (maks. 32 znaki). Label to tekst albo obiekt z językami, np. {"de": "Farbe", "en": "Colour"}, maks. 80 znaków. Widget odczytuje wartości z livedeck.settings.

text

Pola: default, maxLength (maks. 200)

Wartość w widgecie: Tekst

number

Pola: default, min, max, step (wszystkie opcjonalne)

Wartość w widgecie: Liczba

range

Pola: default, min i max (wymagane), step

Wartość w widgecie: Liczba, w edytorze jako suwak

boolean

Pola: default

Wartość w widgecie: true lub false

color

Pola: default jako #rrggbb

Wartość w widgecie: Kolor jako #rrggbb

select

Pola: options (od 1 do 50, każda z value i label), default

Wartość w widgecie: value wybranej opcji

gift

Pola: default (ID prezentu lub null)

Wartość w widgecie: ID prezentu jako liczba lub null

media

Pola: accept: audio, image lub video. Bez default.

Wartość w widgecie: true, gdy użytkownik wybrał własny plik, w przeciwnym razie false

Uwaga: Ustawienia multimediów nigdy nie przekazują widgetowi adresu pliku. Dźwięki odtwarzasz przez livedeck.media.play(key), a obrazy i klipy pobierasz przez livedeck.media.url(key).

Gdy brakuje wartości albo jest nieprawidłowa, widget dostaje wartość domyślną. Dzięki temu aktualizacje z nowymi ustawieniami działają u wszystkich, którzy już używają twojego widgetu.

Błędy w manifest.json

Gdy sprawdzanie kończy się błędem „manifest.json is invalid”, pod nim widać kod i miejsce błędu, np. settings[2].default.

manifest_not_object

Plik nie jest obiektem JSON.

manifest_too_large

Plik jest większy niż 64 KB.

manifest_invalid_json

Nieprawidłowy JSON (często o jeden przecinek za dużo lub za mało).

unknown_field

To pole nie istnieje. Zwykle to literówka.

required

Brakuje wymaganego pola.

wrong_type

Zły typ, np. tekst zamiast listy.

unsupported_manifest_version

manifestVersion nie wynosi 1.

unsupported_sdk

sdk nie jest równe „1”.

invalid_name

Nazwa jest pusta, dłuższa niż 60 znaków lub zawiera niewidoczne znaki sterujące.

invalid_text

Tekst jest pusty, za długi lub zawiera niewidoczne znaki sterujące.

invalid_version

Wersja nie ma formatu x.y.z (np. 1.0.0).

invalid_entry

entry nie jest ścieżką względną do pliku .html.

invalid_format

Format nie jest „9:16” ani „16:9”.

duplicate

Zduplikowany wpis.

invalid_size

Rozmiar spoza zakresu 16–3840 pikseli lub default nie mieści się między min a max.

unknown_permission

To uprawnienie nie istnieje.

too_many_settings

Więcej niż 40 ustawień.

invalid_setting_key

key nie pasuje do wzorca (patrz wyżej).

unknown_setting_type

Ten typ ustawienia nie istnieje.

invalid_default

default nie pasuje do typu lub wykracza poza zakres.

invalid_bounds

min, max, step lub maxLength jest nieprawidłowe.

invalid_options

Brak options, lista jest pusta, ma ponad 50 pozycji albo któraś opcja nie ma value.

invalid_media_kind

accept nie jest audio, image ani video.

invalid_locale

Ten język nie istnieje. Dozwolone: en, de, tr, fr, es, it, ru, ar, zh-CN, ja, he, pt, nl, pl, uk, ko, hi, id, vi, th.

Czy ten artykuł był pomocny?