Installation

Installing Genesis

Import Package

Using this library in your project can be done in three ways:

Install via OpenUPM

The package is available on the openupm registry. It's recommended to install it via openupm-cli.

openupm add com.jeffcampbellmakesgames.Genesis

Install via GIT URL

Using the native Unity Package Manager introduced in 2017.2, you can add this library as a package by modifying your manifest.json file found at /ProjectName/Packages/manifest.json to include it as a dependency. See the example below on how to reference it.

{
	"dependencies": {
		...
		"com.jeffcampbellmakesgames.genesis" : "https://github.com/jeffcampbellmakesgames/genesis.git#release/stable",
		...
	}
}

You will need to have Git installed and available in your system's PATH.

Install via classic .UnityPackage

The latest release can be found here as a UnityPackage file that can be downloaded and imported directly into your project's Assets folder.

Extract Genesis.CLI

In order to run code-generation, the Genesis.CLI command-line executable should be extracted from the included zip file. It can be easily found and selected by running the menu item Tools -> JCMG -> Genesis -> Select Genesis.CLI ZIP.

Extract the contents of the folder to a location outside of the Assets folder.

Configure Genesis Project Settings

In order for Unity to find the Genesis.CLI CLI executable for code-generation, we need to configure the Genesis project settings. Open up the project settings at Edit -> Project Settings. Set the Installation Folder to the path of the extracted Genesis.CLI executable.

Next Steps

To continue with Genesis usage, see here.