Generate an archive and installer

The deploy.bat script from the scripts/win directory generates a Launcher build archive for automatic update delivery to the users.

You can launch deploy.bat by:

  • double-clicking the script file — this will place the build in the cloned project folder > target subfolder;
  • from the command line prompt, using an additional --out <directory> key, where <directory> is your desired build installation path.

Example

Copy
Full screen
Small screen
deploy.bat --out C:/Target

To generate a Launcher installer and get a link to deliver it to users:

  1. In Publisher Account go to Launcher > General settings and click Generate link to installer for Windows.
  2. In the window that appears, upload a ZIP Launcher build archive and an ICO installer icon. Click Generate.
  3. Wait for the installer to be generated, signed with an Xsolla certificate, and uploaded to the Xsolla CDN.
  4. Copy the link to the web installer to distribute it to your users. To get a link to the stand-alone installer, select Get link to stand-alone installer from the drop-down menu.

Note
A web installer takes less disk space than a stand-alone one but requires an internet connection. A stand-alone installer can be used offline.
Notice
We recommend you deliver Launcher to your users only via the Xsolla CDN. To use other CDNs for delivering Launcher, contact your Account Manager.

The deploy.sh script from the scripts/macOS/ directory generates:

  • A Launcher installer that you can send to new users.
  • A Launcher build archive for automatic update delivery to the users.
  • An APP file.

For the security system of macOS to identify your Launcher build as a safe one, you need to:

  1. Sign the build with the developer certificate.
  2. Notarize your build by Apple.
Signing and notarizing are done automatically after running the deploy.sh script. Follow the instructions below to prepare for signing the build and run the script.

Preparation steps

To sign and verify the app, you must have:

Generating an app-Specific password

  1. Go to Apple ID.
  2. Pass the two-factor authentication.
  3. Go to the Security section.
  4. Click Generate Password.

  1. Type a label for the password and click Create.

Getting the certificate signature

  1. Open the Keychain Access app.
    1. Go to Keychain Access > Certificate Assistant and select Request a Certificate From a Certificate Authority.

    1. Enter your data in the window that appears, select Save to disk, and click Continue.
  1. Specify the path to the folder where you want to save the certificate and click Save.
  2. Go to Apple Developer and log in.
    1. Go to Certificates, Identifiers & Profiles, open the Certificates tab, and add a new certificate.

    1. Set the certificate type to Developer ID Application and click Continue.
    2. Select the file with the generated certificate and click Continue.
    3. Click Download to download the developer certificate.
  1. Open the downloaded file and install the certificate.
  2. Open the terminal and run the security find-identity -p basic -v command.

Registering a bundle ID

  1. Go to Apple Developer.
    1. Go to Certificates, Identifiers & Profiles, open the Identifiers tab, and add a new identifier.

    1. Select the App IDs type and click Continue.
    2. Set the app type to App and click Continue.

    1. Insert the Bundle ID. Example: com.template.launcher. Click Continue.
  1. Make the following edits in the Info.plist config-file:
    1. Set the CFBundleIdentifier parameter value to your bundle ID.
    2. Set values of the CFBundleVersion and CFBundleShortVersionString parameters to the app version number.

Example

Copy
Full screen
Small screen
<key>CFBundleIdentifier</key>
<string>com.template.launcher</string>
<key>CFBundleVersion</key>
<string>102</string>
<key>CFBundleShortVersionString</key>
<string>1.0.102</string>

Running a script

When you have completed all the preparation steps, run the following commands:

Copy
Full screen
Small screen
chmod +x deploy.sh
./deploy.sh --username <username> --password <password> --signature <signature> --teamid <teamid> --apppath <apppath> --appname <appname> --outpath <outpath>

Command-line arguments:
  • apppath — a path to the Launcher build you want to sign. Required. Default is ../../launcher/macos.
  • username — a name of the Apple developer account user. Required. Example: j.smith@email.com.
  • password — an app-specific password. Required.
  • appname — a Launcher build name. Optional. Default is launcher.
  • signature — a certificate signature. Required. Example: Developer ID Application: John Smith (JWZ3331234).
  • teamid — an ID of the team. Required. To get it, run the xcrun altool --list-providers -u "AC_USERNAME" -p "AC_PASSWORD" command.
  • bundleid — an application ID, or a Bundle ID. Optional. Default is com.template.launcher.
  • outpath — a path to the directory to place the signed APP file, archive, and the DMG Launcher installation file. Optional. Default is $apppath/../../target/macos.
If the signing and notarization processes went without errors, the terminal will display this message:

If you get the altool cannot be found error, run the xcrun altool command. In case it returns another error, run the xcode-select -r command.

Was this article helpful?
Thank you!
Is there anything we can improve? Message
We're sorry to hear that
Please explain why this article wasn't helpful to you. Message
Thank you for your feedback!
We'll review your message and use it to help us improve your experience.

Continue reading