Skip to content

Upload patch version to server

If you have previously distributed a PC version app using Crossplay Launcher in either the Sandbox or Live environment, you need to upload the patch version to the Hive Console Sandbox or Production server for updating this app.

 

There are two main ways to upload the patch version:

  1. Uploading only the patch file
  2. Uploading the patch file along with the entire app files


Uploading only the patch file means users update the app only with the patch file. This method can be used when the patch file size is not large. However, this method can cause an issue when there are many intermediate versions between the initial version and the latest version (e.g., 1.0.0.0, 1.0.0.1, 1.0.0.2, ..., 1.1.0.0). As the Crossplay Launcher updates the version sequentially through intermediate versions (e.g., 1.0.0.0 → 1.0.0.1 → 1.0.0.2 → ... → 1.1.0.0), continuously updating the app with only patch files can take a long time for the users who installs the app for the first time or reinstalls the app.

Uploading the patch file along with the entire app files means users reinstall the app to update it. This method can be used when the entire app size is not excessively large and when there are many intermediate versions. In this case, the time it takes for users to update the app may be shorter than updating the app with only patch files.

In the end, whether to choose one of the methods depends on considerations such as the total size of the app files, the number of intermediate versions, and the size of the app patch files. The app developers should select one after checking the time required for app installation and updates.


Creating patch files

For both methods, you need to create patch files first. Use the patch maker to analyze the differences between the app's current version and the new version and generate patch files. Then, upload the patch files to the Hive Server using an uploader. The total size of the files of new version app must be less than 30GB based on disk allocation size, and the size of each file of new version app must be less than 4GB.

Both the patch maker and the uploader come in two types: GUI and CUI. Choose one of the two methods depending on your development environment. Below, we'll guide you through how to use GUI or CUI patch maker in a situation where you're updating a game app version.


Scenario

  • AppID: com.gcp2.stepbystep.windows.google.global.normal
  • Hive Console server to upload to: LIVE
  • Previous app version: 1.0.0.0
  • Location of the previous version app: D:\myGame_v1_0_0_0
  • Latest app version: 1.0.0.1
  • Location of the latest version app: D:\myGame_v1_0_0_1
  • Location to generate patch files: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1
Note

When using an antivirus program, its real-time protection (or monitoring) feature, which detects program installations and file changes, may cause errors during the creation of patch files. If errors persist while creating patch files, consider registering the patch maker as a trusted program in the antivirus software, or try again after closing the antivirus program.


Option 1: create patch file using GUI

The GUI patch maker creates patch files through a GUI interface.

 

  1. Download the Crossplay Launcher tool from here and extract it, then run GUI/patch_maker/CrossplayLauncherPatchFileMaker.exe.
  2. In the patch maker interface, enter the following and press Start:
    • Previous Version Path: D:\myGame_v1_0_0_0
    • Current Version Path: D:\myGame_v1_0_0_1
    • Patch File Path: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1
    • Environment: Use SANDBOX for sandbox environment, LIVE(REAL) for live environment
    • APP ID: com.gcp2.stepbystep.windows.google.global.normal
    • Previous Version: 1.0.0.0

Option 2: Generating patch files using CUI

  1. Download the Crossplay Launcher tool and extract it from here.
  2. Create Pre_Version_Folder and Cur_Version_Folder folders in the same directory where CUI/patch_maker/cpflPtc.exe is located, and copy the files from D:\myGame_v1_0_0_0 and D:\myGame_v1_0_0_1 into these folders, respectively.

  3. Run CUI/patch_maker/cpflPtc.exe in the Windows terminal or PowerShell with the following command-line arguments:

    • ‐‐prePath: D:\myGame_v1_0_0_0, default is Pre_Version_Foler
    • ‐‐nextPath: D:\myGame_v1_0_0_1, default is Cur_Version_Foler
    • ‐‐patchPath: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1, default is Patch_Files_Folder
    • -envi: Sandbox environment is SANDBOX, Live environment is LIVE (must be the same as the environment where version 1.0.0.0 app files were uploaded)
    • ‐‐appid: com.gcp2.stepbystep.windows.google.global.normal
    • ‐‐version: Enter the previous version, 1.0.0.0
    • -runbatch: y (whether to skip the question prompt during the patching process)
    
cpflPtc.exe \
‐‐prePath="D:\myGame_v1_0_0_0" \
‐‐nextPath="D:\myGame_v1_0_0_1" \
‐‐patchPath="D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1" \
-envi="LIVE" \
-appid="com.gcp2.stepbystep.windows.google.global.normal" \
-version="1.0.0.0" \
-runbatch="y"

Verify the generated patch files

Check the patch files generated by the GUI or CUI patch maker in the Patch_Files_Folder. If the file data differs even though the file paths are the same between the previous and new versions, a patch file is generated. If a file is added in the new version that was not present in the previous version, a file will be created at the corresponding file path in Patch_Files_Folder.

Option 1: uploading patch files only

Upload the generated patch files to either the Hive Console Sandbox server or the Hive Console Live server. There are two types of uploaders available: GUI and CUI. Depending on your development environment, choose one of these methods to upload the patch files.


Option 1: uploading patch files using GUI

The GUI uploader uploads through a graphical interface.

 

  1. From the Hive Sandbox console or Hive Live console, navigate to Crossplay Launcher > App Management > Upload IP and select the game and AppID. Register the IP address of the PC where the app files will be uploaded as the representative IP (Rep IP).
  2. Download the Crossplay Launcher tool and extract it from here.
  3. Execute GUI/uploader/CrossplayLauncherFileUploader.exe.
  4. On the uploader screen, input the following and click Start:
    • Upload Folder Path: D:\myGame_v1_0_0_1
    • Patch Folder Path: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1 (path where the patch files generated by the patch maker are located)
    • Not first time upload: Checked
    • Enviorment: Sandbox environment is SANDBOX, Live environment is LIVE(REAL) (must match the environment where version 1.0.0.0 app files were uploaded)
    • Platform: Windows
    • Is Release: N
    • APP ID: com.gcp2.stepbystep.windows.google.global.normal
    • App Version: 1.0.0.1
  5. If the upload is successful, the Processing window will display status code 201.

Option 2: Uploading patch files using CUI

  1. From the Sandbox console or Live console, navigate to Crossplay Launcher > App Management > Upload IP and select the game and AppID. Register the IP address of the PC where the app files will be uploaded as the representative IP (Rep IP).
  2. Download the Crossplay Launcher tool and extract it from here.

  3. Execute CUI/uploader/cpflupl.exe in Windows terminal or PowerShell with the following command-line arguments:

    • -envi: Sandbox environment is SANDBOX, Live environment is LIVE (must match the environment where version 1.0.0.0 app files were uploaded)
    • ‐‐platform: w
    • ‐‐release: n
    • -notfirstupload: Applicable (only when uploading patch files, not uploading a new app)
    • ‐‐appid: com.gcp2.stepbystep.windows.google.global.normal
    • ‐‐version: 1.0.0.1
    • ‐‐filepath: D:\myGame_v1_0_0_1
    • ‐‐filepatchpath: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1, default is toUploadPatchFiles
    • -runbatch: Applicable
    
cpflupl.exe \
‐‐appid="com.gcp2.stepbystep.windows.google.global.normal" \
‐‐platform="w" \
--version="1.0.0.1" \
-envi="LIVE" \
‐‐filepath="D:\myGame_v1_0_0_1" \
‐‐filepatchpath="D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1" \
-runbatch ‐‐notfirstupload ‐‐release="n"
  4. If the upload is successful, you will see status code 201 in the terminal or shell.
Note

When uploading patch files, if the version you are about to upload matches the version of the previously distributed version (called App Version in GUI and ‐‐version in CUI), the upload process will not be executed.


Option 2: uploading patch files and the entire app files together

Upload the created patch files and full app files to either the Hive Console Sandbox Server or the Hive Console Live Server. There are two types of uploaders: GUI and CUI. Choose one of these methods depending on your development environment to upload the patch files and the entire app files.

Option 1: uploading patch files and full app files using GUI

The GUI uploader uploads through GUI screen.

  1. Select the game and AppID at Sandbox console or Live console under Crossplay Launcher > App Management > Upload IP, and register the IP address of the PC where the app files will be uploaded as the representative IP (Rep IP).
  2. Download and extract the Crossplay Launcher tool from here.
  3. Run GUI/uploader/CrossplayLauncherFileUploader.exe.
  4. On the uploader screen, input the following details and click Start:
    • Upload Folder Path: D:\myGame_v1_0_0_1
    • Patch Folder Path: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1 (the directory where the * patch files generated by the patch maker are located)
    • Not first time upload: Checked
    • Environment: SANDBOX for Sandbox environment, LIVE(REAL) for Live environment (should match the environment where version 1.0.0.0 app files were uploaded)
    • Platform: Windows
    • Is Release: Y
    • APP ID: com.gcp2.stepbystep.windows.google.global.normal
    • App Version: 1.0.0.1
  5. If the upload is successful, the Processing window will display status code 201.


Option 2: Uploading patch files and full app files using CUI

  1. Select the game and AppID at Sandbox console or Live console under Crossplay Launcher > App Management > Upload IP, and register the IP address of the PC where the app files will be uploaded as the representative IP (Rep IP).
  2. Download and extract the Crossplay Launcher tool from here.

  3. Execute CUI/uploader/cpflupl.exe with the following command-line arguments in Windows terminal or PowerShell:

    • -envi: Sandbox environment is SANDBOX, Live environment is LIVE (must match the environment where version 1.0.0.0 app files were uploaded)
    • ‐‐platform: w
    • ‐‐release: y
    • -notfirstupload: Applicable (only when uploading patch files, not uploading a new app)
    • ‐‐appid: com.gcp2.stepbystep.windows.google.global.normal
    • ‐‐version: 1.0.0.1
    • ‐‐filepath: D:\myGame_v1_0_0_1
    • ‐‐filepatchpath: D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1, default is toUploadPatchFiles
    • -runbatch: Applicable
    
cpflupl.exe \
‐‐appid="com.gcp2.stepbystep.windows.google.global.normal" \
‐‐platform="w" \
--version="1.0.0.1" \
-envi="LIVE" \
‐‐filepath="D:\myGame_v1_0_0_1" \
‐‐filepatchpath="D:\PATCH_myGame_v1_0_0_0_myGame_v1_0_0_1" \
-runbatch ‐‐notfirstupload ‐‐release="n"
  4. If the upload is successful, you will see status code 201 in the terminal or shell.
Note

When uploading patch files, if the version you are about to upload matches the version of the previously distributed version (called App Version in GUI and ‐‐version in CUI), the upload process will not be executed.


Check upload result

After the upload is completed, go to Hive Console > Crossplay Launcher > App Management > Download Setting to verify that the app has been successfully uploaded.