Publishing to OPPO Mini Games

Starting with v2.0.5, Cocos Creator officially supports the release of games to the OPPO Mini Games. It takes just a single click with Cocos Creator to publish to the OPPO Mini Game. This document is currently written on the basis of v2.0.6, which is the lowest recommended version to use. If you are using v2.0.5, it is recommended to upgrade to v2.0.6.

Environment Configuration

  • Download OPPO Mini Game Debugger and install it on your Android device (Android Phone 6.0 or above is recommended)

  • Install nodejs-8.1.4 or above, globally

  • Determine whether you need to install Debugging Tools according to your own development needs.

Release Process

  1. Use Cocos Creator to open the project that needs to be released. Select OPPO Mini Game in the Platform dropdown of the Build... panel.

Required parameter items: Filled in according to the user's requirements and the prompt information in the parameter input box. Including Game Package Name, Game Name, Desktop Icon, Game Version Name, Game Version Number, Platform Version Number.

Optional parameter items: Includes Small Packet Mode, Small Packet Mode Server Path and Custom npm folder path (New in v2.0.9).

For the Keystore and two signature files (certificate.pem path and private.pem path), need to select the Keystore or fill in two paths according to user requirements.

The specific filling rules for the relevant parameter configuration are as follows:

  • Game Package Name

    Game Package Name is required and is filled in according to the user's needs.

  • Game Name

    Game Name is required. Is the name of the OPPO Mini Game. And the Title at the top of the Build panel does not participate in the OPPO mini game packaging process.

  • Desktop Icon

    Desktop Icon is required. Click the ... button at the back of the input box to select the icon you want. When building, the Desktop Icon will be built into the OPPO Mini Game project. Desktop Icon suggest using PNG pictures.

  • Game Version Name

    This item is required. Game Version Name is the real version, such as: 1.0.0.

  • Game Version Number

    This item is required. 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. Note: The Game Version Number must be a positive integer.

  • Supported Minimum Platform Version Number

    This item is required. According to the requirements of OPPO Mini Games, this value must be greater than or equal to 1031 at present.

  • Small Packet Mode and Small Packet Mode Server Path

    This item is optional. The in-package volume of the mini-game contains code and resources that cannot exceed 10M, and resources can be loaded via network requests. Small Packet Mode is to help users keep the script files in the small game package, other resources are uploaded to the remote server, and downloaded from the remote server as needed. And the download, cache and version management of remote resources, Cocos Creator has already helped the user. What the user needs to do is the following two steps:

    1. When building, check the Small Packet Mode and fill in the Small Packet Mode Server Path. Then click on Build.

    2. After the build is complete, click the Open button after the Publish Path to upload the /quickgame/res directory under the release path to the packet mode server. For example, if the default publishing path is build, you need to upload the /build/quickgame/res directory.

    At this point, the res directory will no longer be included in the built-up rpk, and the resources in the res directory will be downloaded from the filled Small Packet Mode Server Path through the network request.

  • Keystore

    When you check the Keystore, the default is to build the rpk package with a certificate that comes with Creator, which is used only for debugging. Note: When the rpk package is to be used to submit an audit, do not check the Keystore to build it.

    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 user can configure two signature files by using the ... button to the right of the input box. Note: These two signature files are not recommended to be placed in the build/quickgame directory of the publish package, otherwise the build directory will be emptied each time when it is built, resulting in file loss.

    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 user needs to generate the signature file private.pem, certificate.pem through tools such as openssl.

      # 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 opened directly in the terminal in Linux or Mac environment, and in the Windows environment you need to install openssl and configure system environment variables.

  • Custom npm folder path

    This item is optional. Starting with v2.0.10, the global npm of the operating system can be automatically obtained and without manual setting. The way to obtain npm is:

    • Windows: Gets the path in the environment variable from the system.
    • Mac: Gets the path in the environment variable from the configuration file of Shell.

    If not, make sure the npm is properly installed and can be started directly in the command line environment. The obtained npm is used to provide an environment for building rpk. If the npm folder path cannot be found at building, Cocos Creator will only export the game project directory and will not generate the rpk package.

    The npm filling rules below v2.0.10 are as follows:

    • If you do not fill out this item, the Creator will read the npm path in the environment variable by default on the Windows system, and the npm in the /usr/bin/local directory is read by default on the Mac system to build the exported mini game rpk package that can be run.
    • If your PC environment does not have npm installed or cannot read the npm path in the system, you will need to fill out the Custom npm folder path to build and exported rpk package. Fill in the rules as follows:

      • Windows system

        # Get local npm folder path
        where npm
        # If the output is
        C:\Program Files\nodejs\npm
        # Then the local npm folder path is filled in as:
        C:\Program Files\nodejs
        
      • Mac system

        # Get local npm folder path
        which npm
        # If the output is
        /Users/yourname/.nvm/versions/node/v8.1.4/bin/npm
        # Then the local npm folder path is filled in as:
        /Users/yourname/.nvm/versions/node/v8.1.4/bin
        

2. Build

Build release After the relevant parameters of the panel are set, click Build. After the build is complete, click the Open button behind the Publish Path to open the build release package. You can see that the quickgame directory is generated under the default release path build directory, which is the exported OPPO Mini Game. The game project directory and rpk, rpk package are in the /build/quickgame/dist directory.

3. Run the built rpk to the phone

Copy the generated mini-game rpk file (located in the dist directory of the OPPO minigame project's quickgame directory) to the /sdcard/games/ directory on your phone's SD card. Then open the Mini Game Debugger that has been installed before on the Android device, click the OPPO Mini Game section, and then find the icon corresponding to the game name. If not found, click on the upper right corner. More button - refresh button to refresh.

4. Subpackage rpk

Subpackage loading, that is, splitting the game content into several packages according to certain rules, only downloading the necessary packages when starting up for the first time. This necessary package is called main package, and the developer can trigger in the main package. Download other sub-packages, which can effectively reduce the time spent on the first boot. To use this function, you need to set Subpackage Configuration in Cocos Creator, and the package will be automatically subpackaged when the setting is completed.

After the build is complete, the subpackage directory is in the /build/quickgame/dist directory.
In this case, you need to create a new subPkg directory in the sdcard directory of the Android device, and then copy the .rpk file in the /build/quickgame/dist directory to the subPkg directory.

Then switch to the Package Load section of Mini Game Debugger, click Refresh at the top right to see the game name of the subpackage, click Second Open to use the same as the normal packaged rpk .

Note: Subpackage rpk needs to be copied to the /sdcard/subPkg/ directory of Android devices, and non-subpackage rpk needs to be copied to the /sdcard/games/ directory of Android devices, both of which cannot be mixed.

results matching ""

    No results matching ""