Get started
Installation
Install the precompiled plugin, open the example level, and switch on Pixel Streaming when you need it. No compiling, no Visual Studio.
BAKR ships as a precompiled plugin. You install it from Fab, enable it in your project, and it runs straight away. You don't need a C++ project, Visual Studio or a rebuild, and it works in Blueprint-only projects.
Requirements
- Unreal Engine 5.5, 5.6, 5.7 or 5.8 on Windows. Use the build made for your engine version: a plugin built for one version does not load in another.
- Any project, Blueprint-only or C++.
- Epic's Movie Render Pipeline plugin, which BAKR enables for you. It is used by the final-quality batch render.
- Epic's Geometry Cache plugin, also enabled for you, so Alembic Geometry Caches can carry materials.
- Epic's WebSocket Networking plugin, also enabled for you. The kiosk and the Pixel Streaming player page serve their pages with it.
Install the plugin
- Get BAKR from its Fab listing.
- In the Epic Games Launcher, open Unreal Engine → Library and scroll to Fab Library. Search for BAKR.
- Click Install to Engine and pick your engine version. Fab puts the plugin in
<Engine>/Engine/Plugins/Marketplace/BAKR, so every project on that engine can use it. - Open your project.
- In Edit → Plugins → Product Configuration, enable BAKR - The Configurator Toolkit and restart the editor. The plugin is off until you enable it, so installing it alone changes nothing in your projects.
Keep the plugin with the project
To version BAKR with your project, or to hand the project to someone who doesn't own the engine install, copy the BAKR folder from the engine's Plugins/Marketplace folder to <YourProject>/Plugins/BAKR. Close the editor first.
Everything is in that one plugin: the configurator, the editor tools, the generated UI, the kiosk and the Pixel Streaming support.
Check that it runs
The quickest check is the example level that comes with the plugin:
- In the Content Browser, open Settings and turn on Show Plugin Content.
- Open BAKR Content → Maps → BAKR_Example.
- Press Play.
If you can pick swatches, orbit with left-drag and zoom with the scroll wheel, the install works.
The example level
BAKR_Example is a complete product, set up exactly the way you set up your own, so it is also a good place to look around:
- BAKR Example Product in the Outliner is the configurator. Select it to see its zones (a finish and a shape for the top and the bottom object), their options, its styles and its sequences in the Details panel.
- The meshes, the two pivots they hang from, and the three cameras with their orbit pivots are in the BAKR Example folder of the Outliner.
- The styles and the two Level Sequences are assets in BAKR Content → Example.
- All shape options sit in the same spot, so in the editor they overlap. Click Show default variants, or Isolate one variant option..., on the configurator's Details panel to see one at a time. In Play only the chosen shape shows.
To try your own changes, duplicate the level and its Example folder into your project first. Files inside the plugin folder are replaced when you update BAKR.
The built-in demo
You can also check without the example level:
- Create an empty level.
- In World Settings, set GameMode Override to BAKRGameMode.
- Press Play.
When a level has no configurator in it, the game mode spawns a small demo product with sample lighting, cameras, styles and an animation. If you can pick swatches, orbit with left-drag and zoom with the scroll wheel, the install works. The demo appears only in an empty level. Once you place your own BAKR Configurator, the demo stays away.
Tip On a real product you rarely set the game mode by hand. The configurator's 06 - Validate and play step has a Use configurator game mode in this level button that does it for you.
Kiosk and Pixel Streaming
Both are part of BAKR; there is nothing extra to install.
| Output | What to enable |
|---|---|
| Kiosk (phone/tablet UI) | Nothing. It only opens a port when the Output is Kiosk. |
| Pixel Streaming | Epic's Pixel Streaming 2 plugin, in Edit → Plugins, then restart. BAKR does not switch it on for you, so projects that don't stream never load it. |
Packaging
Reference your product's Data Assets and Blueprints from a cooked map, or add a Primary Asset Label with a cook rule. Two things are not cooked automatically:
- A streamed variant level that is not a sublevel of the persistent level. Add it to Project Settings → Packaging → List of maps to include.
- A custom kiosk page folder. Make sure it is copied next to the build.
Play in Editor and standalone -game launches need no cook.