Metadata

Dokumenkan setiap medan wajib dan pilihan dalam fail metadata.json presence Nowly.

Medan Wajib

Setiap presence memerlukan:

Medan	Jenis	Penerangan	Lalai
`name*`	string	Nama paparan perkhidmatan atau platform.	-
`author*`	object	Pengarang utama yang dipaparkan pertama dalam pustaka dan imej OG.	-
`description*`	object	Penerangan tempatan pendek dikunci mengikut locale.	-
`url*`	string[]	Domain atau corak URL disokong untuk memadankan halaman.	-
`color*`	string	Warna jenama dalam format hex, digunakan oleh UI dan embed.	-
`category*`	string	Salah satu daripada streaming, music, video, social, gaming, tools, ai, learning, creator, atau other.	-

Contoh

{
  "name": "YouTube",
  "author": {
    "name": "Nowly Developer",
    "github": "example"
  },
  "url": ["youtube.com", "www.youtube.com"],
  "color": "#FF0033",
  "category": "streaming",
  "description": {
    "en-US": "Watch and share videos on YouTube."
  }
}

Pengarang dan Penyumbang

author - Penyelenggara utama, dipaparkan pertama dalam pustaka dan imej OG.
contributors - Individu tambahan yang membantu dengan presence tersebut.

Nama pengguna GitHub (kunci github) digunakan untuk menyelesaikan avatar.

Penerangan dan Ciri

description - Teks marketplace pendek, dikunci mengikut locale.
longDescription - Penerangan lanjut untuk halaman butiran.
features - Senarai tempatan tingkah laku yang disokong (contohnya sokongan butang, kekunci media).

Sokongan native Discord

Sesetengah platform sudah muncul di Discord apabila pengguna memautkan akaun mereka (Spotify ialah contoh biasa). Tetapkan bendera pilihan ini supaya pustaka boleh menerangkan bahawa Nowly masih berguna tanpa pautan itu.

Medan	Jenis	Penerangan	Lalai
`discordNative`	boolean	True apabila Discord sudah menunjukkan platform ini jika pengguna memautkan akaun mereka. Pilihan. Lalai kepada false.	-

{
  "name": "Spotify",
  "discordNative": true
}

Ini hanya memaparkan nota maklumat pada halaman pustaka dan dalam sambungan (butiran kedai dan presence yang dipasang). Ia tidak menyekat pemasangan.

Pemadanan URL

url - Domain atau corak URL disokong untuk memadankan halaman.
regExp - Pemadanan berasaskan regex untuk corak URL yang kompleks.

Gunakan regExp hanya apabila pemadanan url biasa tidak mencukupi. Utamakan senarai domain eksplisit.

Konteks Pelaksanaan

Dua medan pilihan mengawal bagaimana dan bila skrip presence anda berjalan dalam pelayar.

Medan	Jenis	Penerangan	Lalai
`world`	"main" \| "isolated"	Dunia pelaksanaan. Lalai kepada isolated.	-
`runAt`	"document_start" \| "document_end" \| "document_idle"	Bila skrip disuntik. Lalai kepada document_idle.	-

Secara lalai, presence berjalan dalam dunia isolated: ia berkongsi DOM halaman tetapi bukan konteks JavaScript halaman. Ini adalah lalai selamat dan berfungsi untuk hampir semua presence.

Tetapkan "world": "main" apabila presence anda memerlukan konteks halaman, khususnya untuk:

membaca global halaman (contohnya objek pemain yang laman dedahkan pada window);
membuat fetch disahkan sumber sama yang perlu membawa kuki sesi pengguna (contohnya API metadata dalaman laman).

{
  "name": "Netflix",
  "url": ["netflix.com", "www.netflix.com"],
  "world": "main",
  "color": "#E50914",
  "category": "streaming",
  "description": {
    "en-US": "Watch movies and series on Netflix."
  }
}

fetch daripada dunia isolated tidak dianggap sebagai permintaan pihak pertama, jadi panggilan yang disahkan gagal secara senyap. Jika presence anda bergantung pada API log masuk laman, anda mesti menetapkan "world": "main".

Pengisytiharan ini sepenuhnya berada dalam metadata.json - sambungan membacanya semasa pendaftaran. Tiada perubahan pada sambungan diperlukan untuk menambah presence konteks halaman baharu.

Kategori

Kategori yang dibenarkan ialah streaming, music, video, social, gaming, tools, ai, learning, creator, dan other.

Edit di GitHub

Command Palette