Prepare app files

Prepare app files¶

To distribute an app with the Crossplay Launcher, you need to prepare the necessary files running app on a PC. These include the app icon, app execution file, app configuration file, and others, as shown in the example below:

ROOT_FOLDER
│  meta.json
└─ APP_FOLDER
    │  app.ico
    │  app.exe
    │  app.ini
    │  ...
    └─ resources
    └─ data
    └─ packages
    └─ ...

ROOT_FOLDER¶

ROOT_FOLDER is the top-level directory containing all the data necessary to distribute an app with the Crossplay Launcher. ROOT_FOLDER should contain APP_FOLDER and meta.json. The folder name ROOT_FOLDER can be specified by the app developer. After specifying the name, it should be entered in the Hive Console under Crossplay Launcher > App Management > Download Setting > Game Installation Option > Folder Name.

APP_FOLDER¶

APP_FOLDER is the folder containing files necessary for app execution. Prepare and place the app execution file, icon file, resources, data, and other necessary files in this folder. The folder name APP_FOLDER can be specified by the app developer. However, the folder name should not contain "#" or ";" characters, and it should not contain empty subfolders.

META.JSON¶

In meta.json, there are the relative paths of the app execution file (app.exe), icon file (app.ico), which are placed in the APP_FOLDER, and the paths or registry paths to be deleted along with the app upon uninstallation. The relative paths of the app execution file and icon file are relative to the location of the meta.json file. meta.json must be located in the same location as the APP_FOLDER.

Write the meta.json file following the example format below.

{
    "launch": "APP_FOLDER/app.exe",
    "icon": "APP_FOLDER/app.ico",
    "delete": [
        {
        "type": "CSIDL",
        "path": "0x1c/myGameLocalRes"
        },
        {
        "type": "general",
        "path": "C:/myGameGlobalRes"
        },
        {
        "type": "registrykey",
        "root": "0x80000001",
        "path": "SOFTWAREMyGame"
        }
    ]
}

The following is a guide for the delete array:

The following is an example of configuring meta.json when a certain game app files are prepared as shown below:

In the above situation, write meta.json file as follows:

{
    "launch": "game/game.exe",
    "icon": "game/icon.ico",
    "delete": [
        {
        "type": "CSIDL",
        "path": "0x1c/myGameLocalRes"
        },
        {
        "type": "general",
        "path": "C:/myGameGlobalRes"
        },
        {
        "type": "registrykey",
        "root": "0x80000001",
        "path": "SOFTWAREMyGame"
        }
    ]
}