Skip to main content

Quickstart

The Genies CLI (command line interface) is the primary tool used to create new Unity projects with the Genies SDK imported.

Download the CLI​

Once you have created your Genies account, download the appropriate Genies CLI from here: https://workshop.genies.com/welcome

CLI Download

Install the Genies CLI​

Open the File​

Once you download the CLI, double click the file to open the installation app.

Install File

caution

Installing the CLI currently will warn users that it is from an unrecognizable developer.

Checkout the Common Issues section if there are any problems with installing the CLI.

Click the Install Button​

A dialogue box should appear, click the Install button.

Install Button

Overwrite Smart Fox​

A terminal may appear asking to overwrite Smart Fox installation. Type y and then press Enter to continue.

Install SmartFox

Complete the Setup​

Click through the options until you see a Finish button which completes the installation.

Install Finish

Running the Genies CLI​

Once the CLI is installed, it can be ran with the command line to generate a new Unity Project for you to build your Experience with the Genies SDK. Before that, you will need to register a new Experience.

Register a new Experience​

You will need five tokens before creating an experience. These tokens can be obtained after you've registered your Experience in the Workshop Portal.

Tokens

Open the Command Line​

The Genies CLI needs to be used in a command line interface to create an Experience, which is an app that has different names for Mac and Windows.

Mac Terminal​

On a Mac, open the Terminal app which can be found under Applications > Utilities in the Finder.

Windows Command Prompt​

On Windows, find the Command Prompt app by typing command prompt in Window's Search. Right click the app and select Run as administrator.

Creating a new Experience​

To create a new Experience, start by running the command:

geniescli create <projectpath> -e

CLI Creation

note

Depending on your computer, creating a new Experience may take several minutes.

caution

A common issue when creating an Experience is an error indicating that Access is denied. Read below for a possible solution.

Open the Project​

Once the setup is complete, this will create a new Unity project with the Genies SDK assets at the given project path.

tip

Check out the Example Starter Scene page to see a demo of how open the project.

Common Issues​

Unity Access Denied​

When using the geniescli create command, there may be an error after inputting the four tokens that looks like this:

An error occurred trying to start process 'C:\Unity\' with working directory 'C:\Unity\'. Access is denied.

This is usually because it is not able to find the directory to the correct Unity version installation. This can be solved by the following steps:

  1. Clear the CLI settings using the geniescli settings command.
  2. With Unity Hub open, find the directory to the correct Unity installation (see below).
  3. Try the geniescli create <path> -e command again.
  4. It will ask for a custom Unity directory. Use the directory from Step 2.

Directory

Unrecognized App​

When double clicking the installation app file, Windows may present a warning that the file is an "unrecognized app". Click the More info button and then click the Run anyway button.

Unrecognized App

Unidentified Developer​

When double clicking the installation app file, Mac may present a warning that it cannot be opened because it is from an unidentified developer.

Unidentified Developer

To solve this, follow these instructions:

  • Click the "?" at the top right of that warning.
  • Click the "Privacy & Settings" in the sidebar.
  • Scroll at the way down and select App Store and indentified developers option.
  • Then click the Open Anyway button below.

Open Anyway