Reference

Project settings, game mode and launch options

Project-wide settings, the game mode and controller classes, and the command-line arguments that override them.

Project Settings → Plugins → BAKR

SettingDefaultMeaning
OutputStandalone (on-screen UI)Standalone, Pixel Streaming (web UI) or Kiosk (phone/tablet UI). Pixel Streaming and Kiosk create no widget. Saved in DefaultGame.ini.
BAKR output selection in Unreal Project Settings
The project-wide output setting selects the interface used to present the configurator.

Project Settings → Plugins → BAKR Kiosk

Settings for kiosk mode.

SettingDefaultMeaning
Port8080Serves the control page over HTTP and the WebSocket.
Bind addressemptyEmpty binds this machine's primary LAN address only. 0.0.0.0 binds every interface and logs a warning.
Served directoryemptyEmpty serves the page shipped in the plugin.
Idle reset seconds0Seconds without a command before every product resets. 0 disables it.
Idle warning seconds10Countdown shown on every tablet before the reset. 0 resets without warning.
Hide the cursor on the big screenOn

Project Settings → Plugins → BAKR Pixel Streaming

Settings for Pixel Streaming. The player page is only served while Output is Pixel Streaming.

SettingDefaultMeaning
Serve the player pageOnServe the BAKR player page: the stream with the BAKR UI drawn over it.
Port8090HTTP port of the page. Keep it apart from the streamer (8888) and viewer (80) ports.
Open in browser on PlayOnOpens the page once the streamer connects, unless a viewer is already connected. Never in Shipping.
Signalling URL for browsersemptyThe signalling server's viewer address. Empty uses the editor's viewer port, or port 80 on the page's host.
Served directoryemptyEmpty serves the page shipped in the plugin (Source/ThirdParty/BAKRPlayer/Player).

Launch arguments

ArgumentEffect
-BAKROutput=StandaloneOverrides Output for one run.
-BAKROutput=PixelStreamingAlso accepts Web.
-BAKROutput=Kiosk
-BAKRProduct=<Id>Start on this product, before the game mode's Startup Product Id.
-PixelStreamingURL=ws://host:8888Epic's argument for the signalling server (Pixel Streaming only).

Game mode: BAKRGameMode

PropertyDefaultMeaning
Startup Product IdNoneProduct to start on when there are several. None uses the first in the switcher.
Spawn Demo When EmptyOnSpawn the sample product in a level without any configurator.
Player Controller ClassBAKRPlayerControllerUse BAKRWebSocketController for Kiosk and BAKRStreamingController for Pixel Streaming.
Default Pawn ClassBAKRCameraPawnReplace with your own Blueprint child to add effects.

Use configurator game mode in this level (step 06) sets the level's GameMode Override to BAKRGameMode. For your own game mode Blueprint, select it in World Settings instead.

Controllers

BAKRPlayerController

PropertyDefaultMeaning
HUD Widget ClassBAKRDesignerHUDWidgetDefault HUD for every product without its own UI Widget Class.
Create UIOnOff creates no HUD for this controller. The camera then frames the product centered, with no panel offset.
Panel on rightOnPanel side for the HUD, browser front ends and camera framing.

BAKRWebSocketController (kiosk)

A BAKRPlayerController with the kiosk socket. The listener starts only with the Kiosk output.

PropertyDefaultMeaning
Serve in every outputOffAlso open the socket in Standalone or Pixel Streaming, for a mixed setup.

BAKRStreamingController (Pixel Streaming)

PropertyDefaultMeaning
Streamer IdemptyCustom streamer to bind. Empty uses Epic's default streamer. Call Connect Streamer after a custom streamer exists.

Blueprint: Get Player Page URL and Get Player Page LAN URL return the player page's addresses (empty when it is not served), and Open Player Page opens it in this machine's browser.