Getting Started

Like every Pulse plugin, Pulse Online is used in four steps: Set Up, Create, Test and Check. The Pulse window (Tools > Pulse > Pulse) walks through them, and its Guide shows each step in the editor. The list at the start of each section comes from the plugin itself; the text after it goes into the details.

To see it working before you set anything up, start with Test: the plugin brings an example map, and a cheat logs you in with the Mock backend, without an account.

Pulse Online needs the free Pulse base plugin PulseFoundation (1.0 or newer); it is enabled with it. It does not need Epic’s CommonUser plugin.

Set Up

The Pulse window (Tools > Pulse > Pulse, tab Workflow, step Set Up) checks each of these and fixes it with a click:

  • Optional: Choose the online service. The OSS backend uses the platform service of the online subsystem (DefaultPlatformService in [OnlineSubsystem] of DefaultEngine.ini, e.g. EOS or Steam with their own settings). Without one, or when it does not start, it uses the Null subsystem: local play and LAN only; the game logs a warning at start (bWarnWithoutOnlineService). For tests without accounts start the editor with -PulseOnlineBackend=Mock or use PulseOnlineGrant.
  • Optional: Let the Asset Manager scan PulseOnlineQueue assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Connect with OnlineSubsystemEOS: PulseOnlineEOS. EOS login methods (account portal, persistent auth, exchange code, Steam through External Auth), the EOS setup steps, lobby promotion, EOS voice, server achievements and stats, NAT type, reports and sanctions.
  • Optional: Connect with PulseSave: PulseOnlineSaveBridge. Cloud saves: the PulseSave slots synced with the user storage of the player.
  • Optional: Connect with PulseGameplay: PulseOnlineHUDBridge. Invites, reconnects, connection messages and notifications through the UI host (the Pulse HUD by default).
  • Optional: Connect with PulseQuest: PulseQuestOnlineBridge. Party quests: the players of one party share a quest host on the server.
  • Optional: Connect with PulseAchievement: PulseAchievementOnlineBridge. Achievements and stats of PulseAchievement as online achievements.
  • Optional: Connect with PulseBuild: PulseBuildOnlineBridge. Party rights for Pulse Build: the members of a player’s party build in its claims and change its pieces.

Modules

Enable the plugin and keep the modules you use (all are enabled by default):

Module Content
PulseOnline Core: requests, users and login, services, backend choice, types. Always needed.
PulseOnlineBackendOSS, PulseOnlineBackendMock The backends, see Backends; Online Services v2 with the add-on PulseOnlineOSSv2.
PulseOnlineSession Sessions: host, find, join, quick play, leave, reservation beacons. See Sessions.
PulseOnlineParty Parties and the party beacon. See Party.
PulseOnlineSocial Friends, invites, presence. See Friends and Invites and Presence.
PulseOnlineAchievements Achievements. See Achievements.
PulseOnlineStats Stats and leaderboards. See Stats and Leaderboards.
PulseOnlineMatchmaking Queues and skill based matchmaking. See Matchmaking.
PulseOnlineServer Server browser and administration. See Server Browser and Administration.
PulseOnlineSafety, PulseOnlineChat Block list, reports, sanctions, text filters; text chat. See Chat and Safety.
PulseOnlineUI Default widgets: login status, friends, party, server browser, invite dialog. See UI Widgets.
PulseOnlineCommerce DLC ownership, store offers and purchases. See Entitlements and Store.
PulseOnlineStorage Title files, remote config and user files. See Cloud Storage; cloud saves come with the bridge PulseOnlineSaveBridge (Cloud Saves).
PulseOnlineVoice Voice chat (needs the VoiceChat plugin and a voice backend). See Voice Chat.
PulseOnlineMVVM Party view models (needs ModelViewViewModel). See UI (MVVM).
PulseOnlineDebug Cheats. See Debugging.

Optional bridge plugin PulseOnlineEOS: EOS login methods, lobby promotion, EOS voice, server achievements.

Online service

Configure the online subsystem of the project as usual (e.g. DefaultPlatformService=EOS with the EOS settings). The OSS backend picks it up; without a platform service, or when the configured one does not start, it uses the Null subsystem (local play and LAN). Set Up shows which service runs in the editor, and the game logs one warning at start when no online service runs (see Backends).

For PIE tests without accounts, start the editor with -PulseOnlineBackend=Mock: two PIE instances can host and join each other through the Mock backend.

Beacon net driver

Reservation beacons and the party beacon use the BeaconNetDriver definition. For EOS, use the EOS net driver so the beacon runs over EOS P2P with relay (no open ports needed on the party leader). The engine takes the first definition of a name, and BaseEngine.ini already defines BeaconNetDriver with the IP net driver: remove that one with a - line, otherwise the beacons keep running over IP. PulseOnlineEOS has this as a setup step with a fix.

[/Script/Engine.Engine]
-NetDriverDefinitions=(DefName="BeaconNetDriver",DriverClassName="/Script/OnlineSubsystemUtils.IpNetDriver",DriverClassNameFallback="/Script/OnlineSubsystemUtils.IpNetDriver")
+NetDriverDefinitions=(DefName="BeaconNetDriver",DriverClassName="/Script/SocketSubsystemEOS.NetDriverEOS",DriverClassNameFallback="/Script/OnlineSubsystemUtils.IpNetDriver")

On a dedicated server NetDriverEOS reports itself unavailable and the IP fallback is used.

If Iris replication is enabled, verify that beacons work with it; otherwise disable Iris for the beacon net driver.

Subsystems

All of them are created automatically:

Subsystem Owner Module Purpose
UPulseOnlineBackendSubsystem Game instance PulseOnline Creates and switches the backend.
UPulseOnlineUserSubsystem Game instance PulseOnline Users, login, privileges.
UPulseOnlineLocalPlayerSubsystem Local player PulseOnline Request queue per local player.
UPulseOnlineSessionSubsystem Game instance PulseOnlineSession Session queue, reservation beacons, travel.
UPulseOnlinePartySubsystem Game instance PulseOnlineParty Party queue, party state, party beacon.
UPulseOnlineSocialSubsystem Local player PulseOnlineSocial Friends, invites, overlay joins.
UPulseOnlinePresenceSubsystem Game instance PulseOnlineSocial Rich presence.
UPulseOnlineLocalAchievementSubsystem, UPulseOnlineServerAchievementSubsystem Game instance PulseOnlineAchievements Achievements (each behind a setting).
UPulseOnlineStatsSubsystem Game instance PulseOnlineStats Stats and leaderboards.
UPulseOnlineMatchmakingSubsystem Game instance PulseOnlineMatchmaking Matchmaking tickets, ratings, queues.
UPulseOnlineConnectionSubsystem Game instance PulseOnlineSession Connection status, last session, rejoin.
UPulseOnlineServerBrowserSubsystem, UPulseOnlineServerSubsystem Game instance PulseOnlineServer Server browser; server administration and server messages.
UPulseOnlineSafetySubsystem Game instance PulseOnlineSafety Block list, reports, sanctions, text filters.
UPulseOnlineChatSubsystem Game instance PulseOnlineChat Text chat.
UPulseOnlineVoiceSubsystem Local player PulseOnlineVoice Voice channels, transmit mode, proximity.
UPulseOnlineGameVoiceServerSubsystem Game instance PulseOnlineVoice Match voice channel on servers.
UPulseOnlinePartyViewModelSubsystem Local player PulseOnlineMVVM The party view model.

Settings

Every module has its own page under Project Settings > Pulse (Online, Online Sessions, Online Party, Online Social, Online Achievements, Online Stats, Online Matchmaking, Online Server, Online Safety, Online Chat, Online Voice, Online View Models). All values are listed on Settings.

Create

New assets come from Add > Pulse > Online in the content browser or New in the Pulse window:

  • Host Session Request (Blueprint of UPulseOnlineHostSessionRequest, the main asset): Hosts a game session with your map, player count and settings and travels to it; listen server or dedicated server.
  • Find Sessions Request (Blueprint of UPulseOnlineFindSessionsRequest): Searches joinable sessions with your filters; its Results feed a join session request.
  • Join Session Request (Blueprint of UPulseOnlineJoinSessionRequest): Joins a session (search result, invite, party), reserves slots for the party and travels to the server.
  • Quick Play Request (Blueprint of UPulseOnlineQuickPlayRequest): Joins the session with the best ping, or hosts one with its host request when none is found.
  • Login Request (Blueprint of UPulseOnlineLoginRequest): Logs a local player in with a login method of its own (credentials, device id, EOS account portal) and checks privileges.
  • Matchmaking Queue (UPulseOnlineQueueDefinition): One matchmaking queue: game mode, teams, matchmaking rules, rating model and rating features (placement, ranks, seasons, fairness).
  • Online Stats Provider (Blueprint of UPulseOnlineStatsProvider): Serves the stats of players from a service of your game (web API, own backend) while the online service keeps login and sessions; set it in ServiceOverrides.
  • Online User Storage Provider (Blueprint of UPulseOnlineUserStorageProvider): Keeps the cloud files of players (cloud saves) in a storage of your game, with versions and write conditions; set it in ServiceOverrides.
  • Online Matchmaking Provider (Blueprint of UPulseOnlineMatchmakingProvider): Matchmaking tickets at a service of your game (FlexMatch, your own matchmaker) instead of the session search; set it in ServiceOverrides.
  • Online Achievement Provider (Blueprint of UPulseOnlineAchievementProvider): Serves the achievements of players from a service of your game; set it in ServiceOverrides.
  • Online Server Achievement Provider (Blueprint of UPulseOnlineServerAchievementProvider): Achievements a trusted server unlocks for any player, at a service of your game; set it in ServiceOverrides.
  • Online Server Stats Provider (Blueprint of UPulseOnlineServerStatsProvider): Stats a trusted server writes for any player, at a service of your game; set it in ServiceOverrides.
  • Online Leaderboard Provider (Blueprint of UPulseOnlineLeaderboardProvider): Reads leaderboards from a service of your game; set it in ServiceOverrides.
  • Online Title Storage Provider (Blueprint of UPulseOnlineTitleStorageProvider): Serves the files every player reads (remote config, news) from a storage of your game; set it in ServiceOverrides.
  • Online Moderation Provider (Blueprint of UPulseOnlineModerationProvider): Sends player reports to a service of your game and reads the sanctions of players; set it in ServiceOverrides.
  • Online User Content Provider (Blueprint of UPulseOnlineUserContentProvider): User made content (mods, levels) from a service of your game: query, subscribe, download, upload; set it in ServiceOverrides.
  • Online Anti-Cheat Provider (Blueprint of UPulseOnlineAntiCheatProvider): An anti-cheat of your game: decides who may join, watches the clients and reports violations; set it in ServiceOverrides.

Every online operation is a request. A Blueprint of a request class keeps the values of your game in one place (map, player count, session settings, login method), so menus and servers run the same request; Create Pulse Online Request also creates them at runtime. See Requests and Sessions.

Log in, host and join

  1. Login. On the start screen, call Login Pulse Online User with the owning player (bOnline true). On Failed, offer to play offline (bOnline false). See Users and Login.
  2. Host. Create a host session request (Create Pulse Online Request with UPulseOnlineHostSessionRequest, set the map and the max players) and run it with Execute Request. The listen server travels to the map.
  3. Join. On another instance, run a find sessions request and then a join session request with one of its Results, or use a quick play request. See Sessions.

Matchmaking queues

A Matchmaking Queue (UPulseOnlineQueueDefinition) describes one queue: game mode, teams, matchmaking rules, a rating model and rating features. See Matchmaking.

Test

  • Play Example in the Pulse window opens /PulseOnline/Examples/LV_PulseOnline_Example and starts Play in Editor.
  • Then the cheat PulseOnlineGrant gives the player what the plugin needs.
  • The Pulse Debugger opens on its page PulseOnline.Online.
  • PulseOnlineGrant switches to the Mock backend, logs the player in and shows the default widgets (login status, friends, party, server browser). PulseOnlineStatus prints backend, users and sessions, the Online page of the Pulse Debugger shows the requests. Hosting and joining between two standalone PIE instances: see Sessions in the docs.

The example map

The plugin brings an example map, /PulseOnline/Examples/LV_PulseOnline_Example (enable Show Plugin Content in the content browser). Play Example for Online in the Pulse window opens it, starts Play in Editor and runs PulseOnlineGrant: it switches the game instance to the Mock backend, logs the player in and shows the default widgets (login status, friends, party, server browser), so you can try the plugin without an account. PulseOnlineGrant OSS keeps the online subsystem (e.g. EOS) instead, PulseOnlineGrant Current the active backend. The Online page of the Pulse Debugger shows users, backend, sessions, party and every request with its result and duration; PulseOnlineStatus prints the same in the console (see Console).

Sessions and parties need two game instances: start the editor with -PulseOnlineBackend=Mock and play with two standalone instances (Play > Net Mode Play Standalone, two players); one hosts, the other finds and joins it.

Check

  • Check in the Pulse window, Check All there (console Pulse.Check) or the commandlet -run=PulseCheck -Plugins=PulseOnline checks the setup and validates every Host Session Request, Find Sessions Request, Join Session Request, Quick Play Request, Login Request, Matchmaking Queue, Online Stats Provider, Online User Storage Provider, Online Matchmaking Provider, Online Achievement Provider, Online Server Achievement Provider, Online Server Stats Provider, Online Leaderboard Provider, Online Title Storage Provider, Online Moderation Provider, Online User Content Provider and Online Anti-Cheat Provider in the project.
  • The plugin also runs checks of its own over the project.

Matchmaking queues validate themselves when they are saved (rules, rating model, teams); Check does it for every queue of the project, together with the setup.

Diagnostics

  • The Online page of the Pulse Debugger and PulseOnlineStatus.
  • PulseOnlineFailNext makes the next call of an operation fail with the Mock backend, to test error paths.
  • Log categories and all cheats: Console; snapshots and the timeline: Debugging.

This site uses Just the Docs, a documentation theme for Jekyll.