Quick starts

Switch between Standalone, Pixel Streaming and Kiosk

Show the same product with an on-screen UI, in a browser through Pixel Streaming, or on a big screen controlled from a tablet, and switch between them without touching the product.

The Output setting decides where the configurator's UI is drawn and where it is controlled from. The product, its zones and cameras do not change between outputs. All three send the same commands.

OutputUnreal drawsThe visitor usesNeeds
Standalone (on-screen UI)The product and the UMG panelMouse, touch or a touchscreen on the same machineBAKR only
Pixel Streaming (web UI)The product only; the video goes to a browserThe BAKR player page, served by Unreal, or a page of your ownEpic's Pixel Streaming 2 plugin enabled + a signalling server (the editor's own is enough to test)
Kiosk (phone/tablet UI)The product only, full screenA tablet or phone on the same networkNothing extra; no internet or cloud

How switching works

Two things decide the output:

  1. The Output setting: Project Settings → Plugins → BAKR → Output. It is saved in DefaultGame.ini and survives packaging. A launch argument overrides it for one run:

    -BAKROutput=Standalone
    -BAKROutput=PixelStreaming
    -BAKROutput=Kiosk
    
  2. The player controller in your game mode. Standalone works with the plain BAKRPlayerController (the default in BAKRGameMode). Pixel Streaming needs BAKRStreamingController. Kiosk needs BAKRWebSocketController.

BAKR project settings Output field set to Standalone on-screen UI
Choose where the configurator is displayed and controlled for the project.

The kiosk controller is a normal BAKR controller plus the socket, and it only opens a port when the Output is Kiosk. So a game mode with BAKRWebSocketController covers both Standalone and Kiosk, and you switch between them with -BAKROutput alone.

One build, every output Make one game mode per output (for example GM_Standalone, GM_Kiosk, GM_Streaming) and pick one per launch with Unreal's standard map option, for example Showroom?game=/Game/BAKR/GM_Kiosk.GM_Kiosk_C, together with the matching -BAKROutput=. Or use the shortcut above and ship one GM_Kiosk for both Standalone and Kiosk.

Standalone (the default)

Nothing to set up. Use configurator game mode in this level (step 06) selects BAKRGameMode, and the Output defaults to Standalone. The panel is the generated UMG HUD; see Customize the UI. To turn the HUD off for one controller, untick Create UI on a BAKRPlayerController Blueprint.

Kiosk mode

Unreal fills a big screen with the product. A tablet on the venue's Wi-Fi opens a web page that Unreal serves itself and holds every control: zones, swatches, variants, categories, styles, cameras, sequences and reset. Materials and variants are on tabs of their own, as in the on-screen panel; the tabs appear only when a product has both. No internet, cloud service, account or signalling server is needed.

  1. Create a Blueprint child of BAKRGameMode, for example GM_Kiosk, and set Player Controller Class to BAKRWebSocketController.
  2. Select GM_Kiosk as the level's GameMode Override in World Settings.
  3. Set Project Settings → Plugins → BAKR → Output to Kiosk (phone/tablet UI), or launch with -BAKROutput=Kiosk.
  4. Launch the game. The log prints the address to open, for example http://192.168.1.20:8080/.
  5. Open that address on a tablet on the same network.

Settings live in Project Settings → Plugins → BAKR Kiosk:

SettingDefaultMeaning
Port8080One port serves the page over HTTP and the WebSocket.
Bind addressemptyEmpty binds only this machine's main LAN address. 0.0.0.0 listens on every network interface and logs a warning.
Served directoryemptyEmpty serves the page shipped with the plugin. Point it at your own folder to brand the page.
Idle reset seconds0 (off)Seconds without a command before every product returns to its defaults and the start camera.
Idle warning seconds10How long before the reset every tablet shows a countdown that anyone can cancel.
Hide the cursor on the big screenOnThe big screen shows the product, not a pointer.

How it behaves in a room:

  • Many tablets, one state. Everyone who opens the address sees and drives the same configuration. Every change reaches every tablet.
  • Sleep and reconnect. A tablet that sleeps or loses Wi-Fi reconnects and catches up by itself. A disconnect never interrupts a transition or leaves the product busy.
  • Late joiners receive the full catalog with the current state the moment they connect.

Security The kiosk listener is for a local network only. It holds no credentials and has no pairing, so every device on that network shares the session. On a network that is open to the public, put the kiosk on its own network.

To restyle the tablet page, copy the Web/Kiosk folder inside the BAKR plugin folder to your own folder, edit it, and point Served directory at it. The page builds itself from the catalog, so new options appear on the tablet without code changes.

Pixel Streaming

The application streams its picture to a browser. BAKR ships a ready player page: the stream full screen, with the BAKR panel, camera bar and product switcher drawn over it in HTML. Unreal serves the page itself and opens it when you press Play.

Quick start: three steps

  1. Enable Pixel Streaming 2. BAKR's Pixel Streaming support is built in, but Epic's Pixel Streaming 2 plugin is not switched on for you. Enable it in Edit → Plugins and restart the editor.
  2. Pick the controller and the output. Create a Blueprint child of BAKRGameMode, for example GM_Streaming, set Player Controller Class to BAKRStreamingController, and select it as the level's GameMode Override. Set Output to Pixel Streaming (web UI), or launch with -BAKROutput=PixelStreaming.
  3. Press Play with streaming on. Start the editor's signalling server (Pixel Streaming → Stream Level Editor) and press Play. Once the streamer connects, your browser opens http://127.0.0.1:8090 with the configurator over the stream.

If a viewer is already connected, for example the tab from your last Play, which reconnects by itself, no second tab opens. The log line BAKR player page: serving … at http://127.0.0.1:8090/ and http://<LAN address>:8090/ gives the address for a tablet or a second PC on the same network. A Shipping build serves the page but never opens a browser.

The page is only served while the Output is Pixel Streaming. With Standalone, the on-screen HUD is already in the video, so open Epic's own player on the signalling server's viewer port instead.

Settings

Project Settings → Plugins → BAKR Pixel Streaming:

SettingDefaultMeaning
Serve the player pageOnOff leaves the browser side to you: Epic's stock player or your own page.
Port8090The page's HTTP port. Keep it apart from the streamer port (8888) and the viewer port (80).
Open in browser on PlayOnEditor and development builds only.
Signalling URL for browsersemptyThe signalling server's viewer address. Empty uses the editor's own viewer port, or port 80 on the page's host. Set it for a separate signalling server, for example ws://192.168.1.20:8080.
Served directoryemptyServe your own build of the page instead of the one in the plugin.

Two ports, two roles Unreal connects to the signalling server's streamer port (8888). Browsers connect to its viewer port (80). A browser pointed at 8888 is filed as a second streamer and never receives video. The player page always uses the viewer port.

A packaged build or Epic's infrastructure

Run a signalling server from Epic's Pixel Streaming Infrastructure for your engine version and launch with -PixelStreamingURL=ws://127.0.0.1:8888. The player page is still served on port 8090. Without the editor it assumes the viewer port is 80 on its own host, so set Signalling URL for browsers when yours differs. For a custom streamer, set Streamer Id on the controller and call Connect Streamer once that streamer exists.

Change the player page

The page's source is in Source/ThirdParty/BAKRPlayer inside the BAKR plugin folder (React, Tailwind and Epic's Pixel Streaming frontend library). Its Player folder is the build Unreal serves, so using the page needs no Node.

cd <BAKR plugin folder>/Source/ThirdParty/BAKRPlayer
npm install
npm run dev        # http://localhost:5173/?mock: the whole UI against a fake catalog, no Unreal needed
npm run build      # rebuilds Player/

Against a running editor, open http://localhost:5173/?ss=ws://127.0.0.1. To keep your version out of the plugin, build into a folder of your own and point Served directory at it. To host the page elsewhere, add ?ss=wss://your-signalling-host to its address or build with VITE_SIGNALLING_URL. The page builds itself from the catalog, so new options, categories, cameras and products appear without changing it.

Your own page

To write a page from scratch, use bakr-client.js. It has setup steps in the Web API reference:

const bakr = attachBAKRConfig(pixelStreaming, (message) => {
  if (message.type === "catalog") buildUI(message);
  if (message.type === "state") showSelection(message.configuration);
  if (message.type === "error") showError(message.message);
});
bakr.send("catalog");
bakr.send("material", { zone: "body_paint", id: "Red" });
bakr.send("poi", { id: "Wheel" });

All viewers of one streamer share one product state. Independent shoppers need separate instances. Hosting, TURN, TLS and GPU allocation are part of the Pixel Streaming deployment, not of BAKR.

The panel side

Panel on right on the BAKR Player Controller is the one setting for which side the panel sits on. The HUD, a browser front end and the camera framing all follow it.

Next: every command and response is in the Web API, and every setting in Project settings and launch options.