Installing Luna

This page outlines step-by-step instructions to be followed when installing Luna into a new or existing Unity project.

Requirements

Luna has the following system requirements:

  • Unity Personal or Pro 2018.2 or newer
  • MacOS or Windows
  • .NET 4.7 or later
  • .NET developer pack 4.7

Installation

Depending on your license agreement, you will get Luna in one of two flavours: as a Unity package or as a full source code distribution. The installation steps will vary depending on your specific type of package.

Installing via Package Manager (Unity 2018.3 or newer)

WARNING
Package Manager UI of Unity stores links to external packages using absolute paths. This is unportable and will break once the project is opened on another developer's machine.

Installing Luna in Unity 2018.3 or newer can be done using Package Manager UI. To get it installed into a project, please perform the following steps:

  1. Unzip Luna release file anywhere you like
  2. Open Package Manager UI by navigating to Window > Package Manager in main Unity menu:
set-up-install-luna-window-package-manager

  1. In Package Manager UI, hit "+" button located in lower left (or lower right, depending on your Unity version) part of the window, choose "Add package from disk" and select package.json from scripts folder within luna folder you unzipped Luna to in step 1:

You are done! Feel free to open Unity editor with your project and jump to initial setup.

Manual installation (Unity 2018.2 or newer)

In order to install Luna it is required to amend Packages/manifest.json file pointing Unity to a folder with Luna package manifest, so that Unity can discover and install Luna's editor extension. This can be done by following the below steps:

  1. Make sure Unity editor is shut down for the project
  2. Unzip Luna release file to any folder on your machine
    PRO TIP
    Best is to keep Luna folder somewhere next to your projects, so that you can always reference Luna folder relatively to a project folder.
  3. Open Packages/manifest.json file with any text editor
  4. Add a key "uk.lunalabs.luna" with the value of "file:RELATIVE_PATH_TO_LUNA_FOLDER/scripts/" under "dependencies" (root) key. Please mind the RELATIVE_PATH_TO_LUNA_FOLDER should be relative to Packages folder of your project. Your JSON file should look like the below:
set-up-install-luna-manifest-json

AN EXAMPLE

Let's imagine the following preconditions: < br/>

  • Your project sits at /Users/john/Work/MyUnityProject
  • You put Luna next to your project, at /Users/john/Work/Luna

This way, your manifest.json reference should contain an entry with file:../../Luna/scripts

You are done! Feel free to open Unity editor with your project and jump to initial setup.