Pulse Online

Pulse Online is the online layer of the Pulse plugins: users and login, sessions, parties, friends, invites, presence, achievements, stats and leaderboards, matchmaking with skill ratings, a server browser with server administration, reconnect, text chat, safety tools and voice chat. It works on top of a backend (Online Subsystem v1, Online Services v2 or an in-memory Mock backend for tests), so the game code is the same for every online service. Every online operation is a request object with its own logic that runs in the queue of the subsystem it belongs to.

  • Users and login: one user per local player, online or local login, login methods as instanced structs (EOS account portal, dev auth tool, …), privileges, “press any key” helpers.
  • Sessions: host (listen server or dedicated server), find, join, quick play, leave; reservation beacons for whole parties.
  • Party / lobby: players stay together in the menu, find a match together, follow the leader into it and return together. Member data, party data, leader change, kick and promote; party messages through a party beacon; game servers know the party and the leader of each player (to keep parties together).
  • Friends and invites: friends list with presence, session and party invites with accept, decline and timeout.
  • Presence: rich presence with session state, custom statuses and properties.
  • Avatars: pictures of users with an in-memory cache, downloads of avatar URLs and initials as fallback.
  • Platform service: a second platform under the main backend (Steam under EOS) for the login ticket, friends, presence, avatars and overlay invites; a simulated platform in the Mock backend.
  • Achievements: local users unlock their own, a trusted server unlocks for any player; progress through stats.
  • Stats and leaderboards: read and write stats, batched writes, top / around the player / friends; trusted writes by the server for any player.
  • Matchmaking: queues as data assets, rules that open up over time, hosting when nothing fits, whole parties; optional skill rating (Weng-Lin / OpenSkill) with placement, seasons, rank tiers and more, written only by servers; simulation of a queue in the editor.
  • Servers: server browser (filters, favourites, history, passwords), start parameters, bans, whitelist, admin commands, server messages, heartbeat.
  • Connection and reconnect: ping, packet loss and NAT type; rejoin the last game after a crash or a lost connection.
  • Text chat and safety: session, team, party and whisper chat without a chat backend; block list, player reports, sanctions and text filters (EOS Reports and Sanctions through PulseOnlineEOS).
  • Cloud storage: title files (news, remote config with offline cache) and user files with time, version and hash and write conditions (IfMissing, IfVersion, Conflict); cloud saves of PulseSave slots through the bridge PulseOnlineSaveBridge, kept in step by the mirror of PulseSave.
  • User content: list, subscribe, download and upload mods and maps (Mock: folders on the disk).
  • Anti-cheat: a place for an anti-cheat service: PreLogin check, watched clients, messages, kick on a violation.
  • Service providers: serve single services (stats, cloud files, matchmaking, …) from a Blueprint or C++ class of the game while the backend keeps the rest.
  • Entitlements and store: DLC ownership by product tag, offers with prices, purchases through the platform overlay.
  • Voice chat: party voice and match voice with proximity (PulseOnlineVoice, EOS backend in PulseOnlineEOS).
  • UI: MVVM view models for the party, its members and leaderboards; default widgets in the Pulse UI theme (login status, friends, party, server browser, invite dialog); invites and connection hints through the UI host (the Pulse HUD by default) with the bridge PulseOnlineHUDBridge.
  • Debugging: cheats, snapshots in the Pulse Debugger, timeline events and message bus events.

Documentation map

  1. Getting Started: enable the plugin, pick modules, log in, host a first session.
  2. Users and Login: users, login methods, privileges, events.
  3. Backends: OSS and Mock (OSSv2 with an add-on), services, their order, own backends and extensions.
  4. Service Providers: single services from a Blueprint or C++ class of the game.
  5. Platform Service: platforms under the main backend (Steam under EOS), the Mock platform.
  6. Requests: lifecycle, queues, sub-requests, the async node, own requests.
  7. Setting Values: FPulseOnlineSetting and the session key helpers.
  8. Sessions: hosting, searching, joining, reservation beacons.
  9. Party: the party/lobby system, member data, messages, matchmaking, the party of each player on game servers.
  10. Friends and Invites: friends list, invites, overlay joins.
  11. Presence: rich presence.
  12. Avatars: pictures of users, cache, fallback, avatar services.
  13. Achievements: local and server achievements, stat progress.
  14. Stats and Leaderboards: stats, batched writes, leaderboards, server writes.
  15. Matchmaking: queues, rules, skill rating, rating features, dedicated servers, simulation.
  16. Server Browser and Administration: server lists, favourites, start parameters, access checks, admin commands.
  17. Anti-Cheat: the anti-cheat service on the server, messages, violations.
  18. Connection and Reconnect: connection status, NAT type, rejoining the last game.
  19. Chat and Safety: text chat, block list, reports, sanctions, text filters.
  20. Cloud Storage: title files, remote config, user files, file info and write conditions.
  21. User Content: mods and maps: list, subscribe, download, upload.
  22. Cloud Saves: PulseSave slots in the cloud (bridge PulseOnlineSaveBridge).
  23. Entitlements and Store: DLC ownership, products, offers, purchases.
  24. Voice Chat: party voice, match voice, proximity, own voice backends.
  25. UI (MVVM): party and leaderboard view models.
  26. UI Widgets: default widgets, HUD integration (bridge PulseOnlineHUDBridge).
  27. Settings: all project settings.
  28. Debugging: cheats, snapshots, the Online page of the Pulse Debugger, logs.
  29. Console: console commands, cheats and log categories.

At a glance

Step In this plugin
Set Up 0 required, 8 optional
Create 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, Online Anti-Cheat Provider
Test Example map LV_PulseOnline_Example, cheat PulseOnlineGrant
Check Pulse window, Check All, -run=PulseCheck

In more detail:

  1. Enable PulseOnline (it brings PulseFoundation). For EOS, also enable PulseOnlineEOS.
  2. Log the player in on the start screen with Login Pulse Online User.
  3. Host with a host session request, find and join with a find sessions request and a join request (or Quick Play).
  4. Keep players together with the party requests; invite friends with UPulseOnlineSocialSubsystem.

Modules

Module Type Content
PulseOnline Runtime Core: requests and queues, users and login, service interfaces, backend choice, service providers (adapters), types (FPulseOnlineResult, UPulseOnlineSessionResult), setting values.
PulseOnlineBackendOSS Runtime Backend on Online Subsystem v1.
PulseOnlineBackendMock Runtime In-memory backend for specs and PIE.
PulseOnlineSession Runtime Session requests and subsystem, reservation beacons, connection status and reconnect.
PulseOnlineParty Runtime Party requests and subsystem, party beacon.
PulseOnlineSocial Runtime Friends, invites, presence, recent players.
PulseOnlineAchievements Runtime Local and server achievements.
PulseOnlineStats Runtime Stats and leaderboards.
PulseOnlineMatchmaking Runtime Queues, matchmaking rules, skill rating, simulation.
PulseOnlineServer Runtime Server browser and server administration.
PulseOnlineSafety Runtime Block list, player reports, sanctions, text filters.
PulseOnlineChat Runtime Text chat.
PulseOnlineStorage Runtime Title and user files, remote config, user content.
PulseOnlineCommerce Runtime Entitlements, products, store offers, purchases.
PulseOnlineVoice Runtime Voice chat.
PulseOnlineMVVM Runtime Party and leaderboard view models.
PulseOnlineUI Runtime Default widgets in the Pulse UI theme.
PulseOnlineDebug Runtime Cheats.
PulseOnlineTests DeveloperTool Specs against the Mock backend.
PulseOnlineUncooked, PulseOnlineEditor UncookedOnly, Editor Create Pulse Online Request node, editor customizations.

Add-ons and bridges

Plugin Adds
PulseOnlineOSSv2 Add-on: the backend on Online Services v2 (Backends).
PulseOnlineEOS EOS login methods, lobby promotion, EOS voice, server achievements, server stats, NAT type, reports and sanctions.
PulseAchievementOnlineBridge Writes PulseAchievement achievements and stats to online achievements.
PulseOnlineSaveBridge Makes the user storage the second storage of PulseSave: the slots of the game and the profiles in the cloud (Cloud Saves).
PulseOnlineHUDBridge Invites, connection hints, removals, login errors and purchases through the UI host, by default the Pulse HUD (UI Widgets).

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