True friendship isn't about being there when it's convenient,
it's about being there when it's not.

---

---

unity-path

A simple and robust way to determine where Unity3D is installed in the current environment.

I'm provided as a Typescript-compatible Node.js module, but also as a standalone command line utility. Under the hood I'm not that complex - just an environment variable wrapped in friendly glitter.

Help Topics

• Installation
• Usage
• Contributing
• License

Installation

For shell installations: npm

npm install -g unity-path

For node project installations: npm

npm i unity-path --save-dev

Usage

For most use cases (involving default install locations), all you need to use is either:

Javascript:

var unityPath = require('unity-path').unityPath
 
unityPath().then(function(path) {
  console.log('Unity is located at:', path);
})

Shell:

echo "Unity is located at: $(unity-path)"

Output:

Unity is located at: /Applications/Unity/Unity.app/Contents/MacOS/Unity

or

Unable to locate Unity installation, tried all of these paths: "/opt/Unity/Editor/Unity", "/Applications/Unity/Unity.app/Contents/MacOS/Unity", "C:\Program Files\Unity\Editor\Unity.exe", "C:\Program Files (x86)\Unity\Editor\Unity.exe". Try setting env 'UNITY_PATH' or supplying a path to check as first argument.

Both of these methods will set the environment variable UNITY_PATH on the first invocation. Any further invocations will simply read from this cached location. If you have installed Unity in a special location, you can set this from your equivalent of .profile or .bash_profile by running either:

Javascript:

var unityPath = require('unity-path').unityPath
 
unityPath('/path/to/unity')
// or: unityPath(['/path/to/unity1', '/path/to/unity2'])

Shell:

unity-path "/path/to/unity"

Any further invocations on the system, even from deep within build tooling, will return this path instead. Variations of these scripts are included in the ./examples directory of this source package.

Contributing

For features, please raise an issue suggesting the feature. If the feature request is given the green light, we will accept pull requests.

For bugs, please raise an issue notifying us of the bug. If you have a fix, you may raise a pull request immediately for code review, however you must ensure that good test coverage and high code quality is maintained.

Please also see our contributing CODE_OF_CONDUCT.

License

Licensed under the MIT License, see LICENSE for more information.