dno-client

About

Helper tools for building and deploying Unity applications for your desired platforms.

Installation

Install tools by running npm i dno-client in the root of your game project. Once this is done you should be able to use the tools by running npx dno-client.

      _                                  _   _                  _
   __| |  _ __     ___             ___  | | (_)   ___   _ __   | |_
  / _` | | '_ \   / _ \   _____   / __| | | | |  / _ \ | '_ \  | __|
 | (_| | | | | | | (_) | |_____| | (__  | | | | |  __/ | | | | | |_
  \__,_| |_| |_|  \___/           \___| |_| |_|  \___| |_| |_|  \__|

Usage: dno-client [options] [command]

Options:
  -V, --version                                                output the version number
  -h, --help                                                   display help for command

Commands:
  unity:android:build [env] [debug] [version] [versionCode]    perform Android build
  unity:android:publish [env] [debug] [version] [buildNumber]  perform Android build and then publish
  unity:config:write [env]                                     copy SDK config file to Unity project
  unity:osx:build [env] [debug] [version] [buildNumber]        perform Standalone OSX build
  unity:osx:publish [env] [debug] [version] [buildNumber]      perform Standalone OSX build and then publish to
                                                               GDrive
  unity:webGL:publish [env] [dist] [debug]                     build Unity project for WebGL. (dist defaults to
                                                               false)
  unity:windows:build [env] [debug] [version] [buildNumber]    perform Standalone Windows64 build
  unity:windows:publish [env] [debug] [version] [buildNumber]  perform Standalone Windows64 build and then publish
                                                               to GDrive
  help [command]                                               display help for command

Usage

There are some external dependencies that need to be satisfied for the tools to work;

• /sdk-config/settings.json - this file contains project specific values that dno-client expects.

  {
      "netlifySiteId": "xxxxxx-xxxxx-xxxxx-xxxxxx-xxxxxx",
      "projectName": "ProjectName",
      "unityProjectPath": "client/unity",
      "unityBuildClass": "com.Example.AppBuilder",
      "version": "1.0.0"
  }

  • netlifySiteId - the Netlify site ID for the project. This can be found in the Netlify dashboard.
  • projectName - the name of the project. This is used to name the build artifacts.
  • unityProjectPath - the path to the Unity project. This is used to run Unity builds.
  • unityBuildClass - the name of the class that is used to run Unity builds. This is used to run Unity builds; expected endpoints are Build_Android(), Build_StandaloneOSX(), Build_StandaloneWindows64() and Build_WebGL() where applicable.
  • version - the version of the project. This is used to name the build artifacts.

• firebase-tools - we use Firebase CLI tools for Mobile app distribution. This is expected to be installed globally.

• DNO_CLIENT_GOOGLE_CREDENTIAL_PATH - environment variable pointing at the path of a service account file used to deploy Windows and Mac builds to Google Drive. This service account file can be found in our Password Manager.

Mac Publishing Variables

If you are looking to publish to the Mac OSX then you'll also require the following environment variables;

• MAC_APPLE_ID - the Apple ID used to create the app-specific password used in the Notorization process.
• MAC_APP_PWD - the app-specific password for the notorization process.
• MAC_TEAM_ID - the Team ID can be found in the Apple Developer portal for the app.
• MAC_SIGNING_IDENTITY - the name of the credentials found in Keychain Access to code sign the published .app

As well as the above environmental variables; the code signing process requires an entitlements file at /sdk-config/<env>/<projectName>.entitlements. The contents of this plist file varies depending on the platform you are deploying to.