Skip to content

Latest commit

 

History

History
134 lines (81 loc) · 9.43 KB

publish-vivo-mini-game.md

File metadata and controls

134 lines (81 loc) · 9.43 KB
Raw

Publish to vivo Mini Games

Note: some platforms only have Chinese documentation available when visiting the platforms website. It may be necessary to use Google Translate in-order to review the documentation.

Environment Configuration

  • Download the Quick App & vivo Mini Game Debugger and vivo Mini Game Engine and install it on your Android device (recommended Android Phone 6.0 or above)

  • Install nodejs-8.9.0 or above, globally:

    Note: after installing nodejs, you need to note whether the npm source address is https://registry.npmjs.org/

    # View current npm source address
npm config get registry

# If not, reset the npm source address
npm config set registry https://registry.npmjs.org/

  • Install vivo-minigame/cli globally:

    npm install -g @vivo-minigame/cli

    If vivo-minigame/cli installation fails, it may be caused by too low version of nodejs. Please check the version of node and upgrade.

Build Options

For some general build options of platforms, please refer to the General Build Options documentation for details.

Name Optional Default value Description Field name
Start Scene Asset Bundle Optional false If set, the start scene and its related dependent resources are built into the built-in Asset Bundle — start-scene to speed up the resource loading of the start scene. startSceneAssetBundle
Remote server address Optional Empty This option is optional and used to fill in the address of the remote server where the resources are stored.If this option is left blank, the build/quickgame/remote folder in the release package directory will be packaged into the rpk package.Refer to the Resource Management section for more details. remoteServerAddress
Game Package Name required (Project Name) such as com.example.demo package
Desktop Icon required (Cocos Logo) Click the search icon button at the back of the input box to select the icon you want. When building, the Desktop Icon will be built into the vivo Mini Game project. It is suggested to use PNG images for the Desktop Icon.
Game Version Name required (Cocos version) Game Version Name is the real version, such as: 1.0.0. versionName
Game Version Number required 1201 Game Version Number is different from the Game Version Name, and the Game Version Number is mainly used to distinguish the version update. Each time when you submit audit, the game version number is at least 1 higher than the value of the last submitted audit. It must not be equal to or less than the value of the last submitted audit, and it is recommended that the Game Version Number be recursively incremented by 1 each time when the audit is submitted. versionCode
Supported Minimum Platform Version Number required 1035 Please refer to Official Documentation to check the latest version number of vivo engine. minPlatformVersion
Orientation - landscape Device direction, it will be written in manifest.json. deviceOrientation
Use debug keystore - true When you check Use Debug Keystore, it means that the rpk package built with the certificate that comes with Creator is used by default, and it is only used for debugging. when the rpk package is to be used to submit an audit, do not check the Use Debug Keystore to build it. useDebugKey
Key certification path - - The key store certificate, the quick game on the Huawei App Market, must be signed with the release version certificate, and the certificate fingerprint must be configured in the background of the Huawei Developers Alliance. For details, please refer to the following [Generate Signature File](###Generate Signature File) privatePemPath、certificatePemPath

Generate signature file

If you don't check the Keystore, you need to configure the signature files certificate.pem path and private.pem path, where you build a rpk package that you can publish directly. The developer can configure two signature files by using the search icon button to the right of the input box.

There are two ways to generate a signature files:

  • Generated by the New button after the certificate.pem path in the Build panel.

  • Generated by the command line.

    The developer needs to generate the signature file **private.pem**, **certificate.pem** through tools such as **openssl**.

```bash
# Generate a signature file with the openssl command tool
openssl req -newkey rsa:2048 -nodes -keyout private.pem   -x509 -days 3650 -out certificate.pem
```

> **Note**: **openssl** can be used directly in the terminal in Linux or Mac environment, and in the Windows environment you need to install `openssl` and configure system environment variables. Restart Creator after the configuration is complete.

Run the rpk

There are three ways to run rpk on your phone:

  • Method One

    Click the Run button at the bottom right of the vivo-mini-game build task in the Build panel and wait for the QR Code interface to be generated:

    Then open the Quick App & vivo Mini Game Debugger that was installed before on your Android device. Click the Scan code install button to scan the QR Code to open the rpk.

  • Method Two

    Copy the generated mini game rpk file (located in the dist directory) to the sdcard directory of the mobile phone.

    Open the Quick App & vivo Mini Game Debugger that has been installed before on your Android device, click Local Install, then find the rpk file from the sdcard directory of your mobile phone and select Open.

  • Method Three

    Specify to the editor installation directory resources/tools/vivo-pack-tools in the command line, and execute the command npm run server to generate URL and QR code using the vivo Mini Game Packer Commands.

    # Specify to the editor installation directory.
cd F:/CocosCreator/resources/tools/vivo-pack-tools

# Generate URL and QR code
npm run server

    Then open the Quick App & vivo Mini Game Debugger that was installed before on your Android device.

    Finally, click the Scan code install button to copy the URL generated in the first step to the browser, and then directly scan the QR code on the web page to open the rpk.

Subpackage Loading

In the construction of vivo mini games, the configuration of Asset Bundle will also be automatically generated into the vivo mini game release package vivo-mini-game/src directory according to the rules The manifest.jsonconfiguration file.

Note: quick App & vivo Mini Game DebuggerStarting from the 1051version, the sub-package loading of vivo mini games is supported. Although the version lower than 1051 does not support sub-package loading, it is also compatible. If sub-package is used, it will not affect the normal operation of the game. For details, please refer to [vivo subpackage loading-runtime compatibility](https://minigame.vivo.com.cn/documents/#/lesson/base/subpackage?id=%e8%bf%90%e8%a1%8c %e6%97%b6%e5%85%bc%e5%ae%b9).

Sub-package loading package size limit

At present, the subpackage size of vivo mini games has the following restrictions:

-The size of all sub-packages and the main package of the entire mini game does not exceed 8M(the entire compressed package after packaging does not exceed 16Mincluding the entire package. For details, please refer to vivo sub-package loading-compile-time compatibility) -The size of a single sub-package/main package cannot exceed 4M

For details, please refer to vivo mini game subpackage loading official document.

vivo Mini Game Environment Resource Management

The part of vivo mini games that exceed the package size limit must be downloaded through the network.

Cocos Creator has helped developers to download, cache and manage remote resources. For details, please refer to Resource Management.

Reference documentation

Note: some platforms only have Chinese documentation available when visiting the platforms website. It may be necessary to use Google Translate in-order to review the documentation.