unicial

Unicial CLI

This CLI provides tooling/commands to assist you in the scenes development process. Some of the commands will help you scaffold a new scene project, locally start and visualize the scene in order to test it and deploy it to a content server to be incorporated in your Unicial parcel.

Usage

To install the latest version of unicial (Unicial CLI), run this command:

npm install -g unicial

To learn what you can do with the CLI run the following command:

unicial --help

See more details at Unicial docs.

Documentation

For details on how to use Unicial developer tools, check our documentation site

Contributing

• Fork this repository to your own GitHub account and then clone it to your local device.
• Install dependencies with npm install.
• Build the project by running npm run build.
• Link the CLI with: npm link. The unicial command should now be available.
• You can run tests with npm test

NOTE: you can set the environment variable DEBUG=true to see all debugging info

Releasing

Just update the version on the package.json file and merge to master.

Configuration

unicial can be configured in several ways to adapt it to another environment other than the default one. To do this you have to either set environment variables or change your ~/.unicialinfo file:

Variable name	Enviroment variable	~/.unicialinfo
Provider	RPC_URL	-
MANA Token Contract	MANA_TOKEN	MANAToken
LAND Registry Contract	LAND_REGISTRY	LANDRegistry
Estate Registry Contract	ESTATE_REGISTRY	EstateRegistry
Content Server URL	CONTENT_URL	contentUrl
Segment API key	SEGMENT_KEY	segmentKey

Copyright info

This repository is protected with a standard Apache 2 license. See the terms and conditions in the LICENSE file.