Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.44 KB

Installation.md

File metadata and controls

62 lines (41 loc) · 2.44 KB
Raw

Installation

Install via OpenUPM

OpenUPM can automatically manage dependencies, it is recommended to use it to install the framework.

Requires nodejs's npm and openupm-cli, if not installed please install them first.

# Install openupm-cli,please ignore if it is already installed.
npm install -g openupm-cli 

#Go to the root directory of your project
cd F:/workspace/New Unity Project

#Install loxodon-framework
openupm add com.vovgou.loxodon-framework

Install via Packages/manifest.json (recommended)

Modify the Packages/manifest.json file in your project, add the third-party repository "package.openupm.com"'s configuration and add "com.vovgou.loxodon-framework" in the "dependencies" node.

The framework and all plugins have also been published to the npm repository. Users can install them using the npm repository at https://registry.npmjs.org/.You only need to change the URL in the configuration below from 'https://package.openupm.com' to 'https://registry.npmjs.org/'.

Installing the framework in this way does not require nodejs and openm-cli.

{
  "dependencies": {
    ...
    "com.unity.modules.xr": "1.0.0",
    "com.vovgou.loxodon-framework": "2.6.3",
  },
  "scopedRegistries": [
    {
      "name": "package.openupm.com",
      "url": "https://package.openupm.com",
      "scopes": [
        "com.vovgou"
      ]
    }
  ]
}

Install via git URL

After Unity 2019.3.4f1 that support path query parameter of git package. You can add https://github.com/vovgou/loxodon-framework.git?path=Loxodon.Framework/Assets/LoxodonFramework to Package Manager

Install via *.unitypackage file

Download Loxodon.Framework2.x.x.unitypackage and import it into your project.

Import the samples

  • Unity 2019 and later versions can import examples through Package Manager.

  • If the Editor is Unity 2018 version, please find Examples.unitypackage and Tutorials.unitypackage in the "Packages/Loxodon Framework/Package Resources/" folder, double-click to import into the project.