Crossplay Launcher Patch File Maker

Crossplay Launcher Patch File Maker creates the patch files which contain the changes from the previous to the latest version of the game client under the Patch_Files_Folder. (This default folder is not used when you run it by setting the path with the command line interface.)

Configuration Items ARGUMENT
environment (-e or -envi) DEV -e=DEV
TEST -e=TEST
SANDBOX -e=SANDBOX
LIVE None
the file path of the older version game -prePath=… (Pre_Version_Folder will be used when this argument is not set.)
the file path of the latest version game -nextPath=… (Cur_Version_Folder will be used when this argument is not set.)
the path that the patch files are created -patchPath=… (Patch_Files_Folder will be used when this argument is not set.)
appid configuration -appid=…
version configuration -version=…
skip “y/n?” -runbatch

Example

This example is explained upon the case where the app id is com.gcp2.stepbystep.windows.google.global.normal, the older version of the game, which was already uploaded, is 1.0.0.1. This example will show how to upload 1.0.0.2.

  1. Run cpflptc.exe.
    If you need both a test server and a sandbox server, add envi=TEST or envi=SANDBOX as an argument for the program execution in Terminal, CMD, PowerShell, or, etc.
  2. Copy the game files.
    Put the 1.0.0.1 version game files (including meta.json and game files) in Pre_Version_Folder and put the 1.0.0.2 version game files (including meta.json and game files) in Cur_Version_Folder. On the CLI window type y and press Enter.
    For details about the meta.json file, please refer to crossplay launcher > caution > Precautions regarding the game
  3. After type in the game appid, press Enter.
  4. Please enter the previous version.
  5. When asked whether to proceed with the patch file creation (“Start to process? (y/n)”), press Enter after typing y.
  6. Wait until the patch file creation is completed.
  7. Check if the patch files have been created in Patch_Files_Folder as follows.
    • [file name]_patch If the contents of game files of 2 different game versions, located in the same path for each version, are different from each other, [file name]_patch file is created.
    • [file name] The files that are not in 1.0.0.1 but are new in 1.0.0.2 are created in Patch_Files_Folder.

Crossplay Launcher Uploader

The game development part needs to upload the game files to the server after completing the game development and QA so that users can download the game files through the Crossplay Launcher. You can upload game files using Crossplay Launcher Uploader. (Do not enter the items when setting and running with the command line.)

Configuration Items Argument Notes
environment (-e or -envi) DEV -e=DEV -e or -envi
TEST -e=TEST
SANDBOX -e=SANDBOX
LIVE None
Help -h or –help or -?
release –release

If omitted, it operates as the patch file upload mode.

Must be set when uploading for the first time.

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 ‐‐appid=…
version -v=… or ‐‐version=…
the indicator of the initial upload ‐‐notfirstupload Must be set when uploading after the first upload
platform -p=w or ‐‐platform=w If omitted, set to the environment of the currently running platform
upload file path ‐‐filepath=… If not set, the toUploadFiles folder is used
patch file path ‐‐filepatchpath=… If not set, toUploadPatchFiles folder is used
the path that the meta data is created ‐‐metadatapath=… If not set, metadatas folder is used

 

Example

This example explains how to upload the game files of the version 1.0.0.2 upon the case where the app id is com.gcp2.stepbystep.windows.google.global.normal.

  1. Copy the game files.

    Put the game files in toUploadFiles, and put the patch files created with Crossplay Launcher Patch File Maker in toUploadPatchFiles. (For the initial upload, there is no patch file, so you don’t need to put any file in toUploadPatchFiles.)

  2. Execute cpflupl.exe with the configuration items and their arguments shown in the table above.
  3. If the arguments are entered without issues, the upload to the console server will proceed automatically.
  4. When the game uploading is completed, go to http://console.withhive.com/ and check if the game upload was successful.
    • Sandbox Environment: http://sandboxconsole.withhive.com/
  5. 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.
        Game Review Settings
    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.
  6. 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.
  7. Set Review Settings to OFF status, specify the Distribution Date in the Distribution Settings window, and click Save Distribution Date.
  8. Check the State item has been changed to Distributing.
    • before distribution
    • after distribution