BeamFarm Demo¶
This demo showcases how you can use the Beamable Unreal SDK in a mobile game project. Particularly it focuses on the Mobile Link Account Flows in Multiple providers like Google and Apple.
Introduction¶
Aside from our BeamableCore Plugin, here's what the sample contains:
BEAMPROJ_BeamFarmUnreal Plugin.: Contains the UE implementation for the sample client. Key locations in the project are:Plugins/BEAMPROJ_BeamFarm/Source/BEAMPROJ_BeamFarm/Public: Public headers for runtime systems, including sign-in interfaces.Plugins/BEAMPROJ_BeamFarm/Source/BEAMPROJ_BeamFarm/Private: C++ implementations for runtime systems.Plugins/BEAMPROJ_BeamFarm/Source/BEAMPROJ_BeamFarm/Public/GameCenterSignIn.handPrivate/GameCenterSignIn.cpp: Apple Game Center sign-in flow.Plugins/BEAMPROJ_BeamFarm/Source/BEAMPROJ_BeamFarm/Public/GoogleSignIn.handPrivate/GoogleSignIn.cpp: Google sign-in flow.Plugins/BEAMPROJ_BeamFarm/Content/UI_BPs: Blueprint assets used by the sample UI flow.
Microservice/BeamfarmMsMicroservice: Microservice containing code that's used by the sample for various matchmaking and stats stuff.
To set up this sample you'll need a Beamable Account and a Realm. To configure the repo for the sample run dotnet beam unreal select-sample BEAMPROJ_Beamfarm.
Setting up the Project¶
To set up an organization and realm to run this sample, follow the steps below.
- Go to the Beamable Portal and create a new Beamable realm called
Beamfarm - Compile and open the
BeamableUnrealeditor project. - Sign into your Beamable account and go to the
Beamfarmrealm.- Optionally you can hit
Apply to Buildafter the realm change is done.
- Optionally you can hit
Running the Sample in Editor¶
Leveraging the new Beamable PIE Settings, you can run the sample in editor through two entry points: The Main Menu or the Gameplay scene.
Running the Sample¶
- Open the Unreal editor.
- Open the
L_Beamfarm_MainScreenLevel if it's not opened yet.- You can find it inside the
BEAMPROJ_Beamfarm Contentfolder. - If you can't see plugin content in your content browser, you can change the settings of the UE
Content Browserto display it.
- You can find it inside the
- Go to the
Beamable -> Microservicewindow.- You should see the
BeamfarmMSservice there. Select it. - Click
Runand wait until you see theService ready for trafficlog line (and the running icon in the Microservice's card to change). - After you're done with the sample, don't forget to come here and stop the service.
- You should see the
- You don't need to select any Play Preset, as the
Beamfarm_MainScreenlevel is the common entry point for the sample. So leave the Play Preset selector toNone. - Play the
L_Beamfarm_MainScreenin the Editor.
Can I use it as a Template?¶
This sample is not meant to be used as a template directly; however, its components are free for you to copy and use in your own project. Here's what these are:
- The
BeamfarmMSMicroservice : located inside Microservice/BeamfarmMS - Beamable code and blueprints inside BEAMPROJ_Beamfarm plugin