GShare is a solution that helps game developers earn revenue from the users who do not make in-game purchases. Users install a desktop app that utilizes the resources of their PCs to earn rewards toward their in-game balance, from which they can pay for in-game purchases. Main features:

• Support of Microsoft Windows 10 and higher
• App customization according to your brand’s needs
• UI localization into 20 languages. Default languages are EN and RU. To add more, please contact your Account Manager
• Configuration options for better optimization of resources (CPU and/or GPU)
• Minimum reward amount setup
• Direct payouts to the user’s in-game balance

Integration Flow

There are two types of GShare integration:

• Customized app
• Standard app

Customized App

Select this integration type if you want to customize the standard GShare app according to your game’s needs. You can place the link to this GShare build:

• on the Xsolla landing page
• on your own landing page
• on a banner in the payment UI
• in the user’s game account

Prerequisites

If you want to place the link to your GShare build on the Xsolla landing page, on your own landing page, or in the user’s game account, you will need to apply the following settings first:

1. Go to Pay Station settings and enable user verification via a public user ID. It is the unique user identifier for the game and for authorization in GShare (e.g. user email or nickname).
2. Set up the User search webhook.

Preparing the Customized Build

Contact your Account Manager or send an email am@xsolla.com with the following information:

• Minimum reward amount (identical to the price of one unit of your virtual currency specified in the Virtual Currency module settings in Publisher Account).
• UIStyle.json with customized styles for the app.
• UI texts you want to change.
• App icon in the ICO format. Size: 32x32 px and 128x128 px.
• Loading screen image in the SVG format.

Example of a standard UIStyle.json:

{
    "common": {
        "background_color": "#121217",
        "card_background_color": "#1b1b24",
        "prime_color": "#0096d1",
        "text_color": "#ffffff",
        "input_color": "#2e2e3a"
    }
}

Field descriptions:

• background_color — app background color
• card_background_color — blocks and dialog boxes background color
• prime_color — accent color for various UI elements (e.g. Call-to-Action buttons)
• text_color — text color
• input_color — input fields color

Placing the Link on the Xsolla Landing Page

Provide your Account Manager with the following information:

• Landing page texts you want to change. See the standard Xsolla landing page.
• URL for your own domain name (optional). By default, the landing page is published on the Xsolla domain and has a URL in the <landing_name>.xsollasitebuilder.com format. For the correct display of the landing page at your URL, add a CNAME record with <landing_name>.xsollasitebuilder.com in DNS settings.

Placing the Link on Your Own Landing Page

Add the following script to your landing page:

<script>
function downloadGShare() {
let partnerId = 1;
let userId = 'some_user_id';
let link =  'https://api-generator.xsolla.com/gshare-dists?partner_id=' + partnerId + '&user_login=' + userId;
window.open(link, "_top");
}
</script>
<input value="Download GShare" onclick="downloadGShare()" type="button">

You will need to pass your partner ID from the GShare database in the partner_id parameter. To get the value for partner_id, please contact your Account Manager.

You can also pass user ID (v1) in the user_login parameter. If you decide not to pass any value, users will have to enter their public user ID to download the app.

Placing the Link on a Banner in the Payment UI

To display the GShare banner in the payment UI and redirect users to your landing page, please contact your Account Manager or email am@xsolla.com. Users will see the banner on the payment status page.

Placing the Link in the User’s Game Account

Add the following script to the user’s game account:

<script>
function downloadGShare() {
let partnerId = 1;
let userId = 'some_user_id';
let link =  'https://api-generator.xsolla.com/gshare-dists?partner_id=' + partnerId + '&user_login=' + userId;
window.open(link, "_top");
}
</script>
<input value="Download GShare" onclick="downloadGShare()" type="button">

You will need to pass your partner ID from the GShare database in the partner_id parameter. To get the value for partner_id, please contact your Account Manager.

You can also pass user ID (v1) in the user_login parameter. If you decide not to pass any value, users will have to enter their public user ID to download the app.

Standard App

Select this integration type if you want to use the standard GShare app with default settings. You can place the link to this GShare build only on a banner in the payment UI.

The banner will appear on the payment status page. Clicking on the banner will redirect the user to the landing page with the link for downloading the standard GShare app. When users download the app, they get an Xsolla number — their unique identifier. It is generated upon downloading and enables the support of various builds with the ability to select a particular build for a particular game. The user will select the build after the app is installed and run. See an example.

To display the GShare banner in the payment UI, contact your Account Manager or email am@xsolla.com. In your message, please also mention the minimum reward amount (identical to the price of one unit of your virtual currency specified in the Virtual Currency module settings in Publisher Account).