Log inGet started
Package

ridgeRun.package

Newest version

This package holds more than this page lists. See all of its files in its world.

README.md

RunFrameMeter

Measures the frame rate a player actually gets on a Ridge Run run, on that player's own machine (desktop app, browser tab or phone), segment by segment between checkpoints, and files a small report in the world's shared store (runtime_data.world) under perf/<courseId>/<platform>/<player id>/<run start>.

  • Put it on any entity of the scene that holds a RidgeRunCourse; it reads the local player's RidgeRunner (state and checkpoints reached). Nothing else is needed.
  • A report is filed at every checkpoint and when the run ends (finish or fall), so a run cut short still counts. A player keeps their last keepRuns (default 5).
  • Each report holds the platform (native, browser, android), viewport and raster size, resolution scale, quality tier, the engine's own CPU/GPU time per frame (profiler.frameCost), and for the whole run and each segment: frames, fps (frames over wall time), median fps, 95th/99th percentile and worst frame in ms, and the share of frames slower than 33.4 ms and 50 ms.
  • Nothing is drawn and nothing is synced: every peer measures only itself. Turn it off with measure = false.

Reading the reports: runtime_data.world.list("perf/ridgeRun/browser/").