CIRCA - CREW-Brussels/EXP GitHub Wiki
CIRCA
CIRCA (Crew InteRaCtive Archive) is an implementation for Unreal Engine aimed at recording Location Based experiences and performances (LBX) into Unreal, baking them into a standalone application for playback with or without VR headset.
Requirements:
- Unreal Engine 5.3
- Download the plugin's folder in the Plugins folder of your project here or if your project is on git, add this command in the Plugins folder of your project:
git add submodule https://github.com/CREW-Brussels/CIRCA.git
CIRCA (Crew InteRaCtive Archive) is an implementation for Unreal Engine aimed at recording Location Based experiences and performances (LBX) into Unreal, baking them into a standalone application for playback with or without VR headset.
CIRCA is currently in active development, in particular regarding the UI/UX to replay in VR.
How to use CIRCA in a project?
REQUIREMENTS
- Unreal Engine 5.3
- Download CIRCA Plugin (Link coming) and install it to your project's PlugIn folders.
- Make sure it's actvated in the Plugin's menu.
RECORD
In your scene that will be recorded:
-
Change the Game Mode Class of your scene in World Overridde
-
Change it to BP_CIRCA_Record_GameMode -> In UE, the Game Mode acts as the blueprint for the overall gameplay logic, determining aspects such as player characters. Here, changing the Gamemode to the BP_CIRCA_Record_GameMode will allow us to use CIRCA's recording tools.
Additional note: If you are using VR, and our CREW XR Template (link coming), you should follow the next steps. It allows using VR Players, at the same time as using settings to record our performance with CIRCA.
- Create a new Game Mode in World Overridde, inherited from GameModeBase
- Edit it
- Go to: File > Reparent Blueprint > BP_CIRCA_Record_GameMode
- Player State Class: BP_XR_PlayerState
- Default Pawn Class: create new blueprint class pawn, reparented from BP_XR_Player. Here we're naming it BP_XR_CIRCA_Player.
- Change Net Mode as: Play as listen server
- For every movable element that needs to be recorded:
Edit them, and add the component CIRCA_Recorded
In the case you have a VR Player, also add the component in BP_XR_CIRCA_Player created earlier.
- Use key R to Record the scene and E to End the Recording in the editor of the server, while the level is being played.
REPLAY
Perform the following steps after having made a recording:
-
Duplicate the level and open it. We will use this second level to replay the recordings.
-
Change the Game Mode World Overridde, to BP_CIRCA_Replay_GameMode
-
Open the Sequencer and drop the scene Level Sequence in the scene. You should find the Level Sequence asset of your recording in Cinematics > Takes > Date > Scene_1_01
-
Drag and drop it in your scene
In details -> add Tag: CIRCA
- For every XR player recorded you should:
- open the recording of the level
- double click on the sequencer of the player
- mute the last transform (see screenshot)
Package the project into an app
- In Editor -> Project Settings -> Maps & Modes
Change the default map to the CIRCA Player map you last created:
- Package your project for Windows, no additional settings have to be modified
-> You should now have a working app. If it was a multiplayer experience, it is also possible
About
CIRCA, a submodule of EXP, is being developed by CREW as part of EMIL, the European Media and Immersion Lab, an Innovation Action funded by the European Union and co-funded by Innovate UK.
Funding
This project has received funding from the European Union's Horizon Europe Research and Innovation Programme under Grant Agreement No 101070533 EMIL.