Ronin Account
The documentation for the Ronin Account will be deprecated soon. For new integrations, refer to the Ronin Waypoint service.
Overview
Ronin Account is an OAuth 2.0 service that lets users sign in to your game or app with a passwordless flow, similar to other social login methods, for a seamless onboarding experience. It provides a single account for all games and apps in the Ronin ecosystem.
Features
- One account for all games and apps: while removing the burden of managing too many accounts, Ronin Account lets your users connect other entities, such as Ronin Wallet or Axie Infinity Marketplace.
- Improved onboarding experience: Ronin Account brings users to your apps faster by providing common social sign-in methods without having to go through complicated Web3 concepts at the early stage.
- Trusted sign-in provider: Ronin Account is already implemented as a sign-in provider in dApps and games within the Ronin ecosystem, such as Axie Infinity Origins, Axie Infinity Marketplace, or Mavis Hub.
Use cases
Sign-in with Ronin Account
Ronin Account allows users to sign in to your app conveniently with a passwordless flow, similar to other social login methods.
If you're a game studio that wants to publish a game on Mavis Hub, then you need to integrate with Ronin Account so that users can access your game on their desktop devices. If your game supports multiple platforms like iOS and Android, then the Ronin Waypoint Account Service provides you with the same user ID that the user used to play on Mavis Hub.
It might be the case that your game or app doesn't solely distribute on the Ronin publishing platform. With a Ronin Account, your user can sign in with the same account to inherit the same in-game progress, using the same user ID and information across different platforms and devices.
The following sections describe some scenarios where you can implement Ronin Account as a sign-in method for your users.
Sign-in on Mavis Hub
If you want to onboard your game to Mavis Hub, you must implement Ronin Account to allow your users to access the game on their desktop devices.
When your game is available on Mavis Hub, it receives a token from Mavis Hub. Using the token, the game can make a request to the Ronin Account server directly, and exclusively for this game. To access the game, the user only needs to sign in to Mavis Hub once.
If your game supports multiple operating systems such as iOS and Android, Ronin Account provides you with the same user ID that the player used to interact with the game on Mavis Hub.
Sign-in on the web or mobile
If your game is published as a standalone app or on mobile app stores, or, you can integrate Ronin Account as a sign-in method and authenticate users via an OpenID Connect (OIDC) flow.
Link user's Ronin Account with your own account system
If the user already has an account in your game, Ronin Account provides you with a flow to link the user's Ronin Account with their account in your game.
This use case offers two implementation scenarios described in the following sections.
Link through Mavis Hub
Your app can retrieve a user ID when the user has signed in to your game. This ID represents the unique user ID of the Ronin Account. The third-party backend account system can automatically and implicitly create a user account without needing the user to sign in with any other method.
Link in-game
Ronin Account supports the OpenID 2.0 specification so that games can allow users to safely sign in to their account from within the game and retrieve their user ID by opening a web browser.
The following diagram illustrates the flow of linking a user's Ronin Account:
Next steps
Follow the steps in the Get started guide to prepare your game or dApp for Ronin Account integration.