Deep links

How it works

Deep links allow users to open a launcher, or specific tab or page of the launcher from a browser. Some deep links enable you to transfer data from a browser to the game.

Note
Deep links have the following prerequisites:
  • The launcher is installed on the user’s computer.
  • The launcher has been opened by the user at least once.

How to get it

To open the launcher from a browser or external application, place one of the following links in the href attribute on the external resource, as indicated in the table below. In the links, <launcher-id>, <game-id>, and <tab-id> are identifiers of the launcher, game, and tab. To find their values:

  1. Open your project in Publisher Account.
  2. Click Launcher in the side menu.
  3. Find the launcher on the dashboard and click Edit launcher.
  4. Go to the Content section.
  5. Click Tabs.
  6. In the drop-down list to the right of the tab, click Edit.
  7. Copy the values from the URI of the tab editing page: https://publisher.xsolla.com/&amp;lt;merchant-id&amp;gt;/projects/<<project-id>/new-launcher/<launcher-id>/game/<game-id>/tabs/<tab-id>.

Note
If an invalid path is specified in the deep link, the deep link will either open the launcher or focus its window if the launcher is already open.
LinkDescription
xl-<launcher-id>://openOpens the launcher or focuses its window if the launcher is already open.
xl-<launcher-id>://game/Opens the main game page.
Supports data transfer from the browser to the game.
xl-<launcher-id>://game//newsOpens the game news tab or the main game page if the news page is unavailable.
Supports data transfer from the browser to the game.
xl-<launcher-id>://game//storeOpens the game store tab or the main game page if the store is unavailable.
Supports data transfer from the browser to the game.
xl-<launcher-id>://game//tab/Opens a custom tab on the game page or the main game page if the custom tab is unavailable.
Supports data transfer from the browser to the game.
xl-<launcher-id>://settingsOpens the launcher settings page.
xl-<launcher-id>://tab/Opens a custom tab in the launcher or the main game page if the custom tab is unavailable.
Example:
Copy
Full screen
Small screen
 <a href="xl-2484://settings">Open launcher-settings</a>
Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.
Last updated: January 22, 2024

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!