Get Started With Cross Play

This feature is no longer available for new submissions. This documentation is intended solely for developers with existing games.

Other documentation for Cross Play:

Identify the Path

To enable cross play between Instant Games and native (iOS/Android) games, the first step is to identify the path to take, which depends on the current setup of your Instant Games and/or native (iOS/Android) games with respect to their Facebook integrations.

  • If you have a native game title, and planning to launch a new Instant Game version, use Path A
  • If you have a Instant Game title, and planning to launch a new native game version, use Path B
  • If you have both Instant Game and native game version (with Facebook Login) of same title:
  • If the user base of Instant Game is significantly larger, use Path C
  • If the user base of native games is significantly larger, use Path D
  • None of above applied to your situation? Please reach out to us to get support.

A. Launching A New Instant Game

  1. Using same Application ID on developer.facebook.com, add Instant Game product to it.
  2. Set up your new Instant Game with necessary configurations, follow the documentation to get started with Instant Game.
  3. Your Instant Game and native games are now cross play enabled, which means:
    • You can account link user between Instant Game and native games, follow instructions in Cross Play documentation.
    • You can leverage the new APIs we are introducing for cross play enabled games to enhance gameplay and social experiences, check out Cross Play documentation for more details.

B. Launching A New Native Game

  1. Using same Application ID on developer.facebook.com (http://developer.facebook.com/), add Facebook Login for Gaming to it.
  2. Integrate Facebook Login for Gaming for native games, follow instructions in Appendix 1. Integrating with Facebook Login for Gaming for more details.
  3. Your Instant Game and native games are now cross play enabled, which means:
    • You can account link user between Instant Game and native games, follow instructions in Cross Play documentation.
    • You can leverage the new APIs we are introducing for cross play enabled games to enhance gameplay and social experiences, check out Cross Play documentation for more details.

C. Migrating the Native Game to New App ID

To enable cross play, Instant Game and native game needs to be hosted using the same Application ID. Given that the user base of your Instant Game is significantly larger than native game, migrating the native game to use the Application ID of Instant Game will cause minimal friction in player experience.

  1. Using the Application ID of your Instant Game on developer.facebook.com, add Facebook Login for Gaming to it.
  2. Integrate Facebook Login for Gaming for native games, follow instructions in Appendix. Integrating with Facebook Login for Gaming for more details. This integration should replace your current integration with Facebook Login using the Application ID of native game.
  3. Launch the native game with new Application ID.
  4. Request and complete the App Review for user_friends permission.
  5. Your Instant Game and native games are now cross play enabled, which means:
    • Native game players will need to reconnect their account using Facebook Login for Gaming.
    • Instant Game players will not experience anything different during this process.
    • You can account link user between Instant Game and native games, follow instructions in Cross Play documentation.
    • There is a chance that the same user has two copies of progress on both Instant Game and native game before when you account link them, you should prepare your game to handle this situation.
    • You can leverage the new APIs we are introducing for cross play enabled games to enhance gameplay and social experiences, check out Cross Play documentation for more details.

D. Migrating the Instant Game to New App ID

To enable cross play, Instant Game and native game needs to be hosted using the same Application ID. Given that the user base of your native game is significantly larger than Instant Game, migrating the Instant Game to use the Application ID of native game will cause minimal friction in player experience.

  1. Using the Application ID of your native game on developer.facebook.com, add Instant Game to it.
  2. Set up your new Instant Game with necessary configurations, follow the documentation to get started with Instant Game.
  3. Navigate to your original Instant Game, go to Instant Game > Cross Play in menu, set the cross play destination to be the Application ID of your native game. After this, you can check your native game’s Instant Game > Cross Play to see that the apps are correctly linked.
  4. Launch the Instant Game with new Application ID.
  5. Request and complete the App Review for user_friends permission.
  6. Your Instant Game and native game are now cross play enabled, which means:
    • Native game players will not experience anything different during this process.
    • Instant Game players will automatically be redirected to the new Instant Game you have set up in Step 3. These users will need to accept Terms of Services to enter the game. Certain social features, such as context ID, tournament might be broken during that transition period, but recover after user starts new game play sessions on the new Instant Game.
    • You can account link user between Instant Game and native games, follow instructions in Cross Play documentation.
    • There is a chance that the same user has two copies of progress on both Instant Game and native game before you account link them, you should prepare your game to handle this situation.
    • You can leverage the new APIs we are introducing for cross play enabled games to enhance gameplay and social experiences, check out Cross Play documentation for more details.

Appendix . Integrating with Facebook Login for Gaming

If your native games have a live integration with Facebook Login:

  1. Contact us with your native app ID, we can enable Facebook Login for Gaming Test Mode on your application, which will give Facebook Login for Gaming experiences to admin, developer and tester of the app, while other users will continue to receive classic Facebook Login. With Demo Mode, you can quickly assess whether Facebook Login for Gaming is fully compatible with your app.
  2. If your SDK is below version v6.4, it is strongly recommended to upgrade it to latest version (v9.0) to ensure Facebook Login for Gaming works seamlessly with your app.
  3. After Test Mode is enabled, you will see its status on the settings panel for Facebook Login for Gaming.
  1. Follow documentation to integrate with Facebook Login for Gaming and Gaming Graph Domain (graph.fb.gg):

  2. Test all the user scenarios related to Facebook integration in your game, such as reading information of current user, query user’s friends etc.

  3. Once all testing are done, you can enable it on your production Application ID. You should release the version that fully support Facebook Login for Gaming first, and after most of users have updated, contact Facebook support team to enable it for your production application.

If your native games do not have a Facebook Login integration:

  1. Create a new application on developer.facebook.com (http://developer.facebook.com/), and select Gaming as category. You should see Facebook Login for Gaming in the list of products after application is created.
  2. If you do not see Facebook Login for Gaming in the list of products, contact Facebook support team to enable it for your application.
  3. Follow documentation to integrate with Facebook Login for Gaming and Gaming Graph Domain (graph.fb.gg):

  4. Test all the user scenarios related to Facebook integration in your game, such as reading information of current user, query user’s friends etc.

  5. Once all testing are done, you can release it by change your application to Live status.