Additional Guides

This section contains additional guides associated with now.gg Cloud to help you configure our services and APIs conveniently.

Available Additional Guides

The following guides are available:




Cloud Storage Setup for Saving User State

Games typically save user’s progress locally on device files to maintain continuity across gaming sessions. now.gg provides this feature on the Cloud, ensuring seamless gaming experiences for users.

This section focuses on setting up the now.gg Cloud storage to save and restore the user’s game progress data by defining the save file path(s) and excluded file path(s).

Defining the ‘Save’ and ‘Excluded’ file path(s) is an essential practice that reduces the game’s loading time to enhance the user experience and ensure optimal usage of now.gg Cloud storage.

To set up the cloud storage, you should specify the following:

  • Save file path(s)
    Indicates the location of files or folders which should be saved on the cloud. Typically, the save files are stored in /data/data/<package_name>/<file_name>.
  • Excluded file path(s)
    Indicates the location of files and folders which you do not want to save on the cloud.

Configuring File Paths

You can configure this setting for any new app you release now.gg Cloud. In case your app is already released, you will need to release a new version of your app.

To configure the file paths:

  • Log in to the nowStudio.
  • You can either:
  • On the ‘App Contents’ tab:
    • Provide the Save File Path(s) and the Excluded File Path(s):
    • Click on Save.
  • Click on Release on the left navigation.

Note:

  • If you have multiple file paths, separate each of them with a new line instead of spaces or commas.
  • For save file paths, only the files and folders you specify will be saved and restored for the next user session.
  • For excluded file paths (Optional), the files and folders you specify will not be saved on the cloud.

Important Information

  • The game’s loading time depends on the size of the game data to be restored for the user session.
    • For a seamless app experience, we recommend an ideal save file(s) size of up to 5 MB. However, save file(s) of up to 10 MB are also acceptable.
      • The file size recommendation applies to a single file or the combined size of multiple files.
    • Including larger file(s) may impact the game’s loading time.
  • We recommend avoiding the usage of any Android identifiers, such as Android id, within the app, for a better experience.



Preparing App Files

Using this guide, you can prepare your app files to upload on nowStudio.

To create a release with nowStudio, you need to prepare your app files. We accept either a standalone APK or an APK and Assets Zip file.

You can prepare either of the following:

  • Standalone APK File
    • You can provide a full APK containing all Assets.
  • APK and Assets Zip Archive
    • Games typically download necessary assets at launch, causing delays in gameplay. With now.gg, you can provide a Zip containing the APK and Assets to significantly reduce the game loading time and enable instant gameplay for the user.

1. Prepare an APK File

This section provides instructions to prepare an APK file to upload on nowStudio.

Prepare an APK file that adheres to the following requirements:

  • A 64-bit Android app for ARM.
  • A full APK containing all Assets.

After you have prepared your APK, you can continue to add your app on nowStudio.


2. Prepare an APK and Assets Zip Archive

This section provides instructions to prepare the APK and Assets Zip archive for your app/game on nowStudio.

Games typically download necessary assets at launch, causing delays in gameplay. With now.gg, you can provide a Zip containing the APK and Assets to significantly reduce the game loading time and enable instant gameplay for the user.

Process

1. Create the Bundle (Zip Archive)

You should follow the specified format and contents below to create the zip archive of your App and Assets:

  • APK file
  • metadata.json
  • Assets directory
    • Asset1
    • Asset2
    • OtherAssets (file or directory)
  • Obb directory
    • main.<package version code>.<package name>.obb
    • patch.<package version code>.<package name>.obb
For your reference, here is a sample representation of the Game APK + Assets Bundle:

Important Information

  • The Assets folder in your App bundle can have multiple objects.
    • These can include any files or directories.
  • We recommend that you provide us with either Assets or Obb or both, depending on your preference. However, either one of these is mandatory to successfully process your upload.

2. Create Manifest File

The following sample JSON illustrates the required format for the manifest file metadata.json:

{
    "assets": [
        {    
            "name": "asset1.xyz",
            "location": "/data/media/0/Android/data/<packageName>/files"
        },
        {
            "name": "asset2.unity3d",
            "location": "/data/media/0/Android/data/<packageName>/files"
        },
        {
            "name": "OtherAssets",
            "location": "/data/data/<packageName>/files"
        }
    ]
}

3. Add Your App

After you have prepared the APK and Assets Zip archive, you can continue to add your app on nowStudio.




Add and Configure Custom Domain

This guide details the process of adding a custom domain for your apps if you want to host them on domains other than now.gg.

In addition to now.gg Cloud, you can also host your apps on other domains by adding a custom domain for your apps on nowStudio.

The following scenarios are explained:

  • Add a custom domain for a new app.
  • Add a custom domain for a published app.

1. Add a Custom Domain for a New App

This section explains the steps to add a custom domain for a new app.

To do so:

  • After you have added a new app.
  • Select your app from the All Apps section.
    • Click on View Details in front of your app name.
  • Within the Production section, click on Information.
  • Enter the custom domain address in the given field, as shown below:

    Note: Make sure you own the domain that you wish to add.
  • Please ensure you fill out the other required details.
  • Click on Save.
    • Our team will verify the domain details you have provided. Once the domain details have been verified, you can continue mapping your domain.
  • After you have provided all the required app information, you can continue to create a release for your app.
  • After receiving the mapping details, you can view them by clicking on ‘Mapping details’ within the ‘Information‘ tab, as shown below:
  • The domain mapping details are provided, as shown below:
  • You can configure your DNS provider using the provided details.
  • After you perform the provided configuration with your DNS provider, your game will be available on your domain.


2. Add a Custom Domain for a Published App

This section explains the steps to add a custom domain for an already published app.

To do so:

  • Select your app from the All Apps section.
    • Click on View Details in front of your app name.
  • Within the Production section on the left sidebar, click on Information.
  • Click on the Edit button in the bottom right.
    (This will enable you to edit the provided fields)
  • Enter the custom domain address in the given field, as shown below:

    Note: Make sure you own the domain that you wish to add.
  • Click on Save.
  • A confirmation will be displayed on-screen, as shown below:
  • Our team will verify the domain details you have provided. Once the domain details have been verified, you can continue mapping your domain.
  • After receiving the mapping details, you can view them by clicking on ‘Mapping details’ within the ‘Information‘ tab, as shown below:
  • The domain mapping details are provided, as shown below:
  • You can configure your DNS provider using the provided details.
  • After you perform the provided configuration with your DNS provider, your game will be available on your domain.



Upload App using Nowgg CLI

nowgg CLI is a command-line tool that lets you easily upload your app builds to nowStudio. This guide details this functionality.

Prerequisites

  • App ID
    • Used to identify the App on nowStudio.
    • Your App ID can be found under the App Details section of nowStudio.
  • Publisher Token
    • Used to identify the publisher company.
    • Your Publisher token is available under the Account Information section of nowStudio.

Using nowgg CLI

Open any terminal on macOS or Windows.

1. Install nowgg CLI tool

  pip install nowgg

2. Initialize nowgg CLI

  nowgg init --token "<your_publisherToken_from_nowStudio>"

3. Upload App to nowStudio

  nowgg upload --app_id <your_app_id> --file_path "/directory/sample.apk" --apk_version <app_version_name> --version_code <app_version_code>

Note: Your app will be uploaded to the App Library within nowStudio.

4. Help

  nowgg -h
   nowgg init -h
   nowgg upload -h

Important Information

  • While running the nowgg command, If you receive a ‘command not recognized’ error, consider adding <python directory>\<Scripts> to your PATH.
  • if you receive any ‘permission-related errors’, you should run the commands as an Administrator.



×

Table of Contents

Additional Guides

Table of Contents

Document Rev. 1.0

Text copied to clipboard
Link copied to clipbord
Questions? Please reach out to us at dev-support@now.gg