Home

Foundation Library

Foundation Library is a free open source product that contains lots of useful APIs, Utilities and Extension methods. We do not provide any articles or tutorials for these plugins. But we do try to keep every public API documented and self-explanatory.

API Reference

Quick links to explore the library:

• Utilities. The collection of various utility methods.
• Editor Utilities.The collection of utility methods for the Unity Editor.
• Extensions. Extension methods for default C# and Unity Objects.
• Patterns. Implementation of well-known design patterns like Singleton, Factory, Pool, etc.
• UI Toolkit. Helper methods, extensions, utilities for the new Unity UI Toolkit framework.

Install from NPM

• Navigate to the Packages directory of your project.
• Adjust the project manifest file manifest.json in a text editor.
• Ensure https://registry.npmjs.org/ is part of scopedRegistries.
  • Ensure com.stansassets is part of scopes.
  • Add com.stansassets.foundation to the dependencies, stating the latest version.

A minimal example ends up looking like this. Please note that the version X.Y.Z stated here is to be replaced with the latest released version which is currently .

{
  "scopedRegistries": [
    {
      "name": "npmjs",
      "url": "https://registry.npmjs.org/",
      "scopes": [
        "com.stansassets"
      ]
    }
  ],
  "dependencies": {
    "com.stansassets.foundation": "X.Y.Z",
    ...
  }
}

• Switch back to the Unity software and wait for it to finish importing the added package.

Install from OpenUPM

• Install openupm-cli npm install -g openupm-cli or yarn global add openupm-cli
• Enter your unity project folder cd <YOUR_UNITY_PROJECT_FOLDER>
• Install package openupm add com.stansassets.foundation

Install from a Git URL

Yoy can also install this package via Git URL. To load a package from a Git URL:

• Open Unity Package Manager window.
• Click the add + button in the status bar.
• The options for adding packages appear.
• Select Add package from git URL from the add menu. A text box and an Add button appear.
• Enter the https://github.com/StansAssets/com.stansassets.foundation.git Git URL in the text box and click Add.
• You may also install a specific package version by using the URL with the specified version.
  • https://github.com/StansAssets/com.stansassets.foundation.git#X.Y.X
  • Please note that the version X.Y.Z stated here is to be replaced with the version you would like to get.
  • You can find all the available releases here.
  • The latest available release version is

Referencing packages from private repositories by SSH

Unity Package Manager supports referencing packages from private repositories by SSH, see an example: "com.company.app": "ssh://[email protected]/Company/app.git#X.Y.Z". But easy to stumble if doing it the first time because Unity Package Manager requires the only SSH key without a passphrase. A quick guide to starting with:

• Start Git Bash and generate SSH key without a passphrase if you don't have one already. (Git SSH Guide)
• Add SSH key to an ssh-agent. Reboot PC.
• Create some temporary directory on a PC and go there by executing command cd C:\Repositories\SSHTestRepository. Clone repository that going to be referenced as a package with git clone [email protected]/Company/app.git, agree with adding to a hosts list.
• Done! Feel free to delete previously cloned repository.

For more information about what protocols Unity supports, see Git URLs.