Skip to content

Commit

Permalink
-> update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ethan Cheung committed Nov 22, 2020
1 parent 182c7fe commit a977acc
Showing 1 changed file with 44 additions and 18 deletions.
62 changes: 44 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,51 @@
> ### FIGHT4DREAM Locomotors MoveInPlace Unity
> Activate and swing the controllers to move.
# Introduction

It depends on [SpeedChecker].

[SpeedChecker]: https://github.com/fight4dream/Fight4Dream.Zinnia.SpeedChecker.Unity
Activate and swing the controllers to move.

## Setup

1. Add the following to your manifest.json
```
"scopedRegistries": [ { "name": "npmjs", "url": "https://registry.npmjs.org/", "scopes": [ "io.extendreality" ] } ],
```

2. In the package manager, Add package from git URL...
```
https://github.com/fight4dream/Fight4Dream.Zinnia.SpeedChecker.Unity.git
```
and
```
https://github.com/fight4dream/Fight4Dream.Locomotors.MoveInPlace.Unity.git
```
### Adding the package to the Unity project manifest

* Navigate to the `Packages` directory of your project.
* Adjust the [project manifest file][Project-Manifest] `manifest.json` in a text editor.
* Ensure `https://registry.npmjs.org/` is part of `scopedRegistries`.
* Ensure `io.extendreality` is part of `scopes`.
* Ensure `com.fight4dream` is part of `scopes`.
* Add `com.fight4dream.locomotors.moveinplace.unity` to `dependencies`, stating the latest version.

A minimal example ends up looking like this. Please note that the version `X.Y.Z` stated here is to be replaced with [the latest released version][Latest-Release] which is currently [![Release][Version-Release]][Releases].
```json
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"io.extendreality",
"com.fight4dream"
]
}
],
"dependencies": {
"com.fight4dream.locomotors.moveinplace.unity": "X.Y.Z",
...
}
}
```
* Switch back to the Unity software and wait for it to finish importing the added package.

### Done

The `FIGHT4DREAM Locomotors MoveInPlace Unity` package will now be available in your Unity project `Packages` directory ready for use in your project.

The package will now also show up in the Unity Package Manager UI. From then on the package can be updated by selecting the package in the Unity Package Manager and clicking on the `Update` button or using the version selection UI.

[Unity]: https://unity3d.com/
[Unity Package Manager]: https://docs.unity3d.com/Manual/upm-ui.html
[Project-Manifest]: https://docs.unity3d.com/Manual/upm-manifestPrj.html
[Version-Release]: https://img.shields.io/github/package-json/v/fight4dream/Fight4Dream.Locomotors.MoveInPlace.Unity?label=release
[Releases]: ../../releases
[Latest-Release]: ../../releases/latest

## Tutorial

Expand Down

0 comments on commit a977acc

Please sign in to comment.