DOCSEARCHbyAlgolia
Submit Docs

brainCloud Documentation

website·Indexed 32 days ago

https://docs.braincloudservers.com

Technical documentation for the brainCloud backend-as-a-service, featuring API references for game development services including authentication, gamification, leaderboards, matchmaking (asyncmatch), item catalogs, and Cloud Code. Provides implementation examples across multiple languages such as C#, Java, JavaScript, Dart, GDScript, and Roblox.

Tokens
335.1K
Snippets
1.8K
Records
2.5K
Agent score
60%

What's inside brainCloud

  1. Overview of Global File V3 Service

    The Global File V3 API provides a system for managing files that are global to an application. Key features include the ability to organize files into sub-directories and the ability to upload global files from Client Libraries by migrating an uploaded User File. V3 files are stored separately from legacy global files and are not supported by the current Design Portal. For files uploaded via the Custom Config | Files section of the portal, the legacy S3 Handling service must be used instead.

  2. Overview of the Push Notification service

    The Push Notification service manages the registration of device tokens and the delivery of push notifications to users. Before sending notifications, you must configure settings in the brainCloud portal's Notification Settings page. Templated or 'normalized' push notifications (pre-defined messages with substitutions and localization) are configured on the Notification Templates page. Note that while users can send notifications to themselves, the sender is excluded from group push notification deliveries.

  3. Overview of RoomServer service capabilities

    The RoomServer service allows developers to launch hosted servers directly, bypassing the brainCloud lobby matchmaking process. All 'Sys' prefixed APIs are available to both client and Server-to-Server (S2S) integrations.

  4. Overview of brainCloud Gamification features

    The Gamification service provides server-side support for common metagame elements:

    • XP Levels: Manages experience points (starting at 0) and levels. XP is incremented via Player Statistics services.
    • Achievements: Can be triggered manually via AwardAchievements or automatically as player rewards.
    • Milestones: Define conditions for delivering rewards. They must be unlocked before they can be completed and awarded.
    • Quests: Compound Milestones where completion is derived from the status of embedded Tasks (Milestones).
    • Player Rewards: A system to reward players for leveling up, completing milestones, or finishing quests. Rewards can include achievements, XP, currencies, or statistics.

  5. Overview of the User service

    The User service (introduced in version 4.3) provides administrative tools for managing user accounts, including creating, retrieving, and deleting users, as well as paging through the user list and managing password resets.

    Critical Constraint: This service is only accessible via Cloud Code.

  6. Overview of brainCloud Logging Service

    The logging service is available exclusively in Cloud Code. It allows developers to record info, warning, and error messages to the app's Exception Logs, which are viewable on the Global Monitoring - Recent Errors page of the brainCloud portal. Debug-level log messages are also supported but only display in the activity pane of the Cloud Code Editor and API Explorers; they are not persisted to the logging database and are only available via the bridge.

  7. Overview of One-Way Offline Multiplayer

    One-Way Offline Multiplayer is designed for games where an active Attacker attacks the settlement of an offline Defender. The Defender's settlement behaves based on previous configurations. The typical workflow involves: 1. Finding an opponent via MatchMaking or Friends API. 2. Managing the match lifecycle using StartMatch(), CompleteMatch(), and CancelMatch(). 3. Recording attack events via the PlaybackStream API. 4. Updating opponent data (leaderboards, currency) via custom cloud code scripts.

  8. Overview of Group Files

    Group Files allow groups to own files associated with a specific group. They support a folder structure and ACL permissions (owner, member, or other) at both the folder and file levels. Key capabilities include creating, moving, and deleting folders and files, as well as moving user files into group space. Note that group files are not migrated to downstream apps during deployment.

  9. Overview of BrainCloud Campaign LiveOps service

    The Campaign service is a LiveOps tool for no-code A/B testing and feature flagging. It allows game operators to create time-bounded campaigns that modify game behavior for targeted player segments without requiring new code deployments.

    Available administrative operations include:

    • SysTriggerCampaignForUser: Manually trigger a scenario for a player (player must be flagged as a tester).
    • SysRemoveCampaignForUser: Remove a player from a specific campaign.
    • SysRemoveAllCampaignsForUser: Remove a player from all campaigns.
    • SysUpdateCampaignJson: Update the global campaignJson payload.
    • SysUpdateScenarioJson: Update a specific scenario's scenarioJson payload.

  10. Overview of PlaybackStreamService

    The PlaybackStreamService enables the creation and replay of a series of events. It is specifically used by One-Way Matches to track events. The service provides a set of 'Sys' APIs available to both clients and Server-to-Server (S2S) integrations.

  11. Overview of brainCloud Gamification features

    The Gamification service provides server-side support for common metagame elements, building upon Statistics APIs and Player Rewards. Key features include:

    • Experience Points (XP) and Levels
    • Achievements
    • Milestones
    • Quests
    • Stats Events

    Management APIs for Milestones and Quests (those starting with "Sys") are available via Cloud Code and S2S.

  12. Overview of Lobby Service APIs

    The Lobby Service provides a suite of APIs divided into three main functional areas: Online Matchmaking (finding and creating lobbies), Lobby Experience (interacting with joined lobbies), and Room Service Integration (APIs for room server providers).