Documentation
Browse documentation

DocumentationGet started

Reference widgets

The built-in widgets of PlayerVox OverCrow are ordinary widgets written with the public SDK, packaged by overcrow-widget and published in the signed catalog like yours. Their sources live in widgets/ of the public repository, under the MIT license: read them, copy them, and use them as a starting point.

WidgetDescriptionIDPermissionsSource
ClockShows the local time of day and, optionally, the date, in a 24-hour format.com.playervox.overcrow.clocknonewidgets/clock/
FPSShows the game’s presented frame rate, when the host has a frame rate source.com.playervox.overcrow.fpsfps.readwidgets/fps/
MediaThe track your music player is playing, with its cover, and previous, play/pause and next buttons in Interactive mode.com.playervox.overcrow.mediamedia.read, media.controlwidgets/media/
NotesYour notes and checklists over the game: up to eight notes, each with free text and a checklist, the same for every game. Read them in Passive mode; in Interactive mode choose, create, delete and edit them in the widget, and tick entries off. They stay on this computer.com.playervox.overcrow.notesnotes.read, notes.writewidgets/notes/
PerformanceGame CPU and memory, plus the temperatures this computer exposes.com.playervox.overcrow.performancetelemetry.read, fps.readwidgets/performance/
Session journalThe finished play sessions of your game, newest first: date, start time and duration, five per page. Recorded on your device without an account, merged with your PlayerVox journal when you sync. Delete a session after confirmation.com.playervox.overcrow.playervox.journaljournal.read, journal.deletewidgets/playervox-journal/
My ratingYour own PlayerVox rating of the Steam game you play: its grade and score, and in Interactive mode three criteria and an optional review to publish or update. Needs your PlayerVox account.com.playervox.overcrow.playervox.ratingplayervox.rating.read, playervox.rating.writewidgets/playervox-rating/
Player reviewsWhat PlayerVox players think of the game you play: three reviews per page with each player's grade and score, in your language when a translation exists. Limit them to the players you follow from the widget's menu. Needs your PlayerVox account.com.playervox.overcrow.playervox.reviewsplayervox.reviews.readwidgets/playervox-reviews/
PlayerVox scoreThe PlayerVox community grade of your Steam game, with its score, rating count and three criteria. No account needed; the badge is always shown.com.playervox.overcrow.playervox.scoreplayervox.score.readwidgets/playervox-score/
SessionShows how long the current game session has lasted.com.playervox.overcrow.sessionsession.readwidgets/session/
Manual stopwatchA stopwatch to the hundredth of a second, started, paused and reset with its buttons or the host’s shortcuts.com.playervox.overcrow.stopwatchstopwatch.read, stopwatch.controlwidgets/stopwatch/
Twitch chatRead and send messages in a public Twitch chat you choose: your favorite channels, the scrolling history with emotes and replies in Interactive mode, the last messages fading out in Passive mode. Needs your Twitch account.com.playervox.overcrow.twitch.chattwitch.chat.read, twitch.chat.composewidgets/twitch-chat/
Warframe MarketSearches public PC items from a cached catalog, shows an item’s online sellers and buyers in two tabs, and copies a trade whisper when you click.com.playervox.overcrow.warframe.marketnetwork, storage, clipboardWritewidgets/warframe-market/

What a widget directory holds

  • the package sources: manifest.json, view.ocml, style.ocss, logic.ts, locales/, LICENSE;
  • listing.json, its marketplace text;
  • assets/preview.png, its marketplace preview: the image of its preview scenario, framed and staged by node scripts/compose-previews.mjs;
  • tests/: unit tests of the logic, and scenarios with reference images in both themes, both languages and two scales, played by overcrow-widget test in PlayerVox OverCrow's headless runtime;
  • README.md: what it shows, its menu, its permissions, how it works and what it costs.

What each one shows

To see how to…Read
tick at each minute or second of local time, follow a menu optionClock
subscribe to a service and show a missing valueFPS, Session
lay out a list of values in a grid, hide a menu row the machine cannot servePerformance
show an image handed by OverCrow, retry a subscription that endedMedia
command a service on a user action, let OverCrow advance a durationManual stopwatch
edit text through a form bound to a write intent, keep draftsNotes, My rating
draw on a canvasPlayerVox score, My rating
page through a service and react to a revisionPlayer reviews, Session journal
keep a long scrolling list at its end, send a messageTwitch chat
call an HTTP API, cache it in storage, copy to the clipboardWarframe Market

Warframe Market is not a built-in: a PlayerVox widget of the catalog, installed on request, it shows network routes with a declared response bound, storage for a cached catalog and a clipboard copy on a click.

Work on one

From a checkout of the repository, link the SDK of that revision into the widgets, then check one, package it and run its unit tests:

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 needs the SDK built first (npm ci then npm run build in sdk/). The four templates of overcrow-widget init are in templates/, and two complete examples written for these pages in docs/content/examples/: weather calls an HTTP API and countdown uses a timer, a canvas, a context menu and storage.