Player

The Player is a standalone desktop application that serves as your playground. It’s the easiest way to preview your UI and it also provides you with all the tools needed.

Running it

Running it is as simple as double-clicking the provided Player.bat on Windows or Player.sh on Mac. Alternatively, click the Player button in the Launcher.

Capabilities

Here’s a list of what the Player is capable of doing:

  • Dragging and dropping HTML files from your file system into the app will load them.
  • The Player will propagate mouse and keyboard input to the UI. Gamepad and touch input is propagated only on Windows.
  • It’s a great tool for profiling - run the app, hit F12 to open the dev tools and use the Performance panel to measure how fast your UI is.
  • It has a number of command-line arguments which you can use to control its behavior (e.g. what the initial page should be, where to read resources from, etc.). Run --help on the Player executable for a list of supported arguments.

Player Configurations

The Player comes with a config file, located at <package_root>/Player/Config.toml. All command line options can be provided through the config file - you can view some in the provided config file. The most useful arguments to provide through the Config.toml are fonts to register in advance, which you can do with the following syntax:

[register-font]
path = "path_to_font"
family = ""
sdf = "auto"
style = "auto"
weight = "auto"

To view all of the available values, run Player.exe register-font --help.

Keyboard shortcuts

  • F1 opens this page in your browser
  • F5 will reload the current scene
  • F11 toggles between 8 bit and 16 bit render target.
  • F12 will launch Prysm’s Dev tools which allow you to inspect, debug and profile your UI.
Player Overrides →