gmh5225 / get-unity

🕹 Command line tool for getting the download URL for the latest or specific version of Unity.

🕹 Command line tool for getting the download URL for the latest or specific version of Unity.

Install

$ npm install -g get-unity

Usage

Get the download URL of the latest major release of Unity.

$ get-unity

Get the download URL of the latest minor release of Unity.

$ get-unity 2019.x

Get the download URL of the latest patch release of Unity.

$ get-unity 2019.2.x

Get the download URL of the version found in ProjectSettings/ProjectVersion.txt

$ get-unity --file=ProjectSettings/ProjectVersion.txt

Exporting URL to an enviroment variable.

$ UNITY_URL=$(get-unity --file=ProjectSettings/ProjectVersion.txt)
$ echo $UNITY_URL

Help

  Command line tool for getting the download URL for the latest or specific version of Unity.

  Usage
    $ get-unity <version> [options]

  Options
  --file, -f       Search file for Unity version number.
  --force, -r      Force update to local cache of editor versions.
  --offline, -o    Prevent request to update local cache of editor versions.
  --help, -h       Display this help message.
  --version, -v    Display the current installed version.

API

getUnityUrls(string filter [, string filePath])

const { getUnityUrls } = require('get-unity');

getUnityUrls('2019', './data/editor-installers.json').then(urls =>
  console.log(urls)
);

Output:

{
  "linux": "https://download.unity3d.com/download_unity/5f859a4cfee5/LinuxEditorInstaller/Unity.tar.xz",
  "mac": "https://download.unity3d.com/download_unity/5f859a4cfee5/MacEditorInstaller/Unity-2019.2.11f1.pkg",
  "win64": "https://download.unity3d.com/download_unity/5f859a4cfee5/Windows64EditorInstaller/UnitySetup64-2019.2.11f1.exe"
}

parseVersionFromString(string contents)

const { parsers } = require('get-unity');

console.log(
  parsers.parseVersionFromString(`m_EditorVersion: 2019.2.9f1
m_EditorVersionWithRevision: 2019.2.9f1 (ebce4d76e6e8)`)
);

Output:

2019.2.9f1

updateEditorInstallers([string filePath, int ttl])

const { updateEditorInstallers } = require('get-unity');

updateEditorInstallers('./data/editor-installers.json', 3600000).then(() =>
  console.log('Done')
);