Crossplay Launcher Patch File Maker

Crossplay Launcher Patch File Maker creates patch files, which compare the latest version of the game full-client with the previous one, in Patch_Files_Folder.

    Item argument
    The previous version of game file’s path Click Select Path of Previous Version Path to select a path
    (Includes meta.json and game files)

    For more about meta.json file, see Be careful about game.
    The latest version of game file’s path Click Select Path of Current Version File Path to select a path
    (Includes meta.json and game file)

    For more about meta.json file, see Be careful about game.
    Patch file path Click Browse of Patch Folder Path to select a path
    Version settings Type into the Previous Version
    Appid settings Type into the Appid
    Environment DEV Select combobox from the Environment list
    TEST
    SANDBOX
    LIVE

Example of application

Generate a patch file by filling in the fields as shown below to upload version 2021.12.12.0002 of the game file when an appId is com.gcp2.stepbystep.windows.google.global.normal and the version 2021.12.12.0001 is already uploaded.

Crossplay Launcher Uploader

To users download a game file through Crossplay Launcher, the game development dept must upload a game file on server after completing QA test. Upload the game file by using Crossplay Launcher Uploader.

    Item argument
    The upload file path settings Click Browse of Upload Folder Path to select a path
    Patch file path Click Browse of Patch Folder Path to select a path
    (If not the first upload, click Not first time upload then select a path.)
    Upload environment DEV Select combobox from the Upload Environment list
    TEST
    SANDBOX
    LIVE
    Platform settings Select combobox from the Target Platform list
    Release settings

    Select combobox from the Is Release list

    The game version is divided into a release version and a patch version. If the changes between the latest version and the previous version are not significant, use the patch version if possible.

    • Release Version (Y): Both the original and patch files are uploaded to the server, and the latest release version of the game is downloaded during the first installation.
    • Patch Version (N): Only the patch files are uploaded to the server. The users who have installed the latest release version can patch the game using a later patch versions.
    Appid settings Type into the Appid
    Version settings Type into the Game Version

Upload procedure

Preparation before uploading

  1. Go to Hive Console > Crossplay Launcher > Game management > Manage Upload IP, choose the game and the AppID, and register the IP address of the PC for uploading the game.

  2. Regardless of the released version all the time when game files are uploaded, add the original game files in the folder selected in Upload Folder Path, and patch files in the folder selected in Patch Folder Path.
  3. Generate the meta.json file and add it in the folder selected in Upload Folder Path. The meta.json file should include the information about the path that is relative to a game shortcut icon file(.ico) and a game executables(.exe). You should pre-create a game shortcut file before developing a game. This file is used on Windows only, so that games for Mac can omit the icon field.
    e.g., {"launch":"game/game.exe", "icon":"game/icon.ico"} (field name: launch and icon)

Upload by tool

Expose Status Code : 201 on success.

Check after uploading

  1. After uploading the game, go to http://console.withhive.com/ and check if the game is uploaded as expected.
    • TEST environment: http://testconsole.withhive.com/
    • SANDBOX environment: http://sandboxconsole.withhive.com/
  2. You must check the list below in the review status; all steps below for the release version, and Register a review IP and Check the game update for the patch version.
    1. Register a review IP (if not registered)

      Select the game title and app id, then register a public IP(recommended) or a private IP.

    2. Check the game update (required on both the release version and patch version)
      • Install (or update) to the previous version, and update the game after changing the status of the newer version from standby to review.
      • Check if errors occur on Crossplay Launcher while updating the game.
      • Check the game runs as expected.
      • Compare the game full-client that is updated with a local Crossplay Launcher and the original full-client that belongs to the game development dept using a tool for data comparison, such as WinMerge. The files must be the same.
        게임 검수 설정
    3. Check the game installation (required on release version only)
      1. On Windows, remove the game in the Control Panel.
      2. Install the uploaded game.
        • Check if errors occur on Crossplay Launcher while updating the game.
        • Check if the icon is created in the desktop or Start menu.
        • Check the game runs as expected.
        • Compare the game full-client that is installed with a local Crossplay Launcher and the original full-client that belongs to the game development dept using a tool for data comparison, such as WinMerge. The files must be the same.
      3. In the review status, go to the Control Panel and remove the game. Check if the delete parameter that removes files additionally and the shortcut to the desktop and the start menu is removed as expected.
        For details about the delete parameter, see the Crossplay Launcher > Be careful about game > Deleting files guide.

Distribute

  1. Turning off the Review Settings, select the distribution date, and click SAVE DISTRIBUTION DATE.
  2. Check if the State changed to Distributing.
    • Before distribution
    • After distribution