Documentation
Parcourir la documentation

DocumentationCommencer

Widgets de référence

Les widgets intégrés de PlayerVox OverCrow sont des widgets ordinaires, écrits avec le SDK public, empaquetés par overcrow-widget et publiés dans le catalogue signé comme les vôtres. Leurs sources se trouvent dans widgets/, dans le dépôt public, sous licence MIT : lisez-les, copiez-les et servez-vous-en comme point de départ.

WidgetDescriptionIDPermissionsSources
HorlogeAffiche l’heure locale et, en option, la date, au format 24 heures.com.playervox.overcrow.clockaucunewidgets/clock/
FPSAffiche la fréquence d’images présentée par le jeu, quand l’hôte dispose d’une source.com.playervox.overcrow.fpsfps.readwidgets/fps/
MédiaLe morceau que joue votre lecteur de musique, avec sa pochette, et les boutons précédent, lecture/pause et suivant en mode interactif.com.playervox.overcrow.mediamedia.read, media.controlwidgets/media/
NotesVos notes et listes de tâches par-dessus le jeu : jusqu’à huit notes, chacune avec un texte libre et une liste de tâches, les mêmes pour tous les jeux. Lisez-les en mode passif ; en mode interactif, choisissez, créez, supprimez et modifiez-les dans le widget, et cochez les éléments. Elles restent sur cet ordinateur.com.playervox.overcrow.notesnotes.read, notes.writewidgets/notes/
PerformancesCPU et mémoire du jeu, et les températures que cet ordinateur expose.com.playervox.overcrow.performancetelemetry.read, fps.readwidgets/performance/
Journal de sessionsLes sessions de jeu terminées de votre jeu, de la plus récente à la plus ancienne : date, heure de début et durée, cinq par page. Enregistrées sur votre appareil sans compte, fusionnées avec votre journal PlayerVox si vous synchronisez. Supprimez une session après confirmation.com.playervox.overcrow.playervox.journaljournal.read, journal.deletewidgets/playervox-journal/
Ma noteVotre note PlayerVox du jeu Steam auquel vous jouez : son grade et son score, et en mode interactif trois critères et un avis facultatif à publier ou mettre à jour. Nécessite votre compte PlayerVox.com.playervox.overcrow.playervox.ratingplayervox.rating.read, playervox.rating.writewidgets/playervox-rating/
Avis des joueursCe que les joueurs de PlayerVox pensent du jeu auquel vous jouez : trois avis par page avec la note et le score de chaque joueur, dans votre langue quand une traduction existe. Limitez-les aux joueurs que vous suivez depuis le menu du widget. Nécessite votre compte PlayerVox.com.playervox.overcrow.playervox.reviewsplayervox.reviews.readwidgets/playervox-reviews/
Note PlayerVoxLa note de la communauté PlayerVox pour votre jeu Steam, avec son score, son nombre de votes et trois critères. Sans compte ; le badge reste toujours visible.com.playervox.overcrow.playervox.scoreplayervox.score.readwidgets/playervox-score/
SessionAffiche la durée de la session de jeu en cours.com.playervox.overcrow.sessionsession.readwidgets/session/
ChronomètreUn chronomètre au centième de seconde, démarré, mis en pause et réinitialisé par ses boutons ou les raccourcis de l’hôte.com.playervox.overcrow.stopwatchstopwatch.read, stopwatch.controlwidgets/stopwatch/
Chat TwitchLisez et envoyez des messages dans le chat Twitch public de votre choix : vos chaînes favorites, l’historique défilant avec emotes et réponses en mode interactif, les derniers messages qui s’effacent en mode passif. Nécessite votre compte Twitch.com.playervox.overcrow.twitch.chattwitch.chat.read, twitch.chat.composewidgets/twitch-chat/
Marché WarframeRecherche les objets PC publics dans un catalogue en cache, affiche les vendeurs et acheteurs en ligne d’un objet dans deux onglets et copie un message d’échange sur un clic.com.playervox.overcrow.warframe.marketnetwork, storage, clipboardWritewidgets/warframe-market/

Ce que contient le dossier d’un widget

  • les sources du paquet : manifest.json, view.ocml, style.ocss, logic.ts, locales/, LICENSE ;
  • listing.json, son texte pour la marketplace ;
  • assets/preview.png, son aperçu dans la marketplace : l’image de son scénario preview, cadrée et mise en scène par node scripts/compose-previews.mjs ;
  • tests/ : les tests unitaires de la logique, et des scénarios avec leurs images de référence dans les deux thèmes, les deux langues et deux échelles, joués par overcrow-widget test dans le runtime headless de PlayerVox OverCrow ;
  • README.md : ce qu’il affiche, son menu, ses permissions, son fonctionnement et son coût.

Ce que chacun montre

Pour voir comment…Lisez
se déclencher à chaque minute ou seconde de l’heure locale, suivre une option du menuHorloge
s’abonner à un service et afficher une valeur manquanteFPS, Session
disposer une liste de valeurs en grille, masquer une ligne du menu que la machine ne peut pas alimenterPerformances
afficher une image fournie par OverCrow, relancer un abonnement qui s’est terminéMédia
commander un service sur une action de l’utilisateur, laisser OverCrow faire avancer une duréeChronomètre
modifier du texte avec un formulaire lié à un intent d’écriture, conserver des brouillonsNotes, Ma note
dessiner sur un canvasNote PlayerVox, Ma note
parcourir un service page par page et réagir à une révisionAvis des joueurs, Journal de sessions
maintenir une longue liste défilante sur sa fin, envoyer un messageChat Twitch
appeler une API HTTP, la mettre en cache dans le stockage, copier dans le presse-papiersMarché Warframe

Marché Warframe n’est pas un widget intégré : widget PlayerVox du catalogue, installé à la demande, il montre des routes réseau avec une limite de réponse déclarée, le stockage pour un catalogue en cache et une copie dans le presse-papiers sur un clic.

Travailler sur l’un d’eux

Depuis une copie de travail du dépôt, liez aux widgets le SDK de cette révision, puis vérifiez l’un d’eux, empaquetez-le et lancez ses tests unitaires :

SH
node scripts/prepare-widgets.mjs
overcrow-widget check widgets/clock
overcrow-widget package widgets/clock
node --test widgets/clock/tests/logic.test.mjs

prepare-widgets.mjs demande que le SDK soit construit d’abord (npm ci puis npm run build dans sdk/). Les quatre templates d’overcrow-widget init se trouvent dans templates/, et deux exemples complets, écrits pour ces pages, dans docs/content/examples/ : weather appelle une API HTTP et countdown utilise un minuteur, un canvas, un menu contextuel et le stockage.