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
Getting Started: enable the plugin, pick modules, log in, host a first session.
Enable PulseOnline (it brings PulseFoundation). For EOS, also enable PulseOnlineEOS.
Log the player in on the start screen with Login Pulse Online User.
Host with a host session request, find and join with a find sessions request and a join request (or Quick Play).
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.