@mflrevan/ucp 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# @mflrevan/ucp
|
|
2
|
+
|
|
3
|
+
Version `0.2.0` of the Unity Control Protocol CLI.
|
|
4
|
+
|
|
5
|
+
This package installs the `ucp` command and downloads the matching published binary for your platform during `postinstall`.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @mflrevan/ucp
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### pnpm
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pnpm add -g @mflrevan/ucp
|
|
17
|
+
pnpm approve-builds
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Supported platforms
|
|
21
|
+
|
|
22
|
+
- Windows x64
|
|
23
|
+
- macOS x64
|
|
24
|
+
- macOS arm64
|
|
25
|
+
- Linux x64
|
|
26
|
+
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
cd /path/to/MyUnityProject
|
|
31
|
+
ucp doctor
|
|
32
|
+
ucp connect
|
|
33
|
+
ucp snapshot
|
|
34
|
+
ucp object get-fields --id 46894 --component Transform
|
|
35
|
+
ucp asset search -t Material
|
|
36
|
+
ucp build targets
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Bridge install
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
ucp install
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Or add this to `Packages/manifest.json`:
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"dependencies": {
|
|
50
|
+
"com.ucp.bridge": "https://github.com/mflRevan/unity-control-protocol.git?path=unity-package/com.ucp.bridge"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Release asset source
|
|
56
|
+
|
|
57
|
+
The installer downloads from:
|
|
58
|
+
|
|
59
|
+
`https://github.com/mflRevan/unity-control-protocol/releases/download/v<version>/...`
|
|
60
|
+
|
|
61
|
+
That means npm publish depends on the matching GitHub release artifacts existing for the same tag.
|
|
62
|
+
|
|
63
|
+
## Links
|
|
64
|
+
|
|
65
|
+
- Repository: https://github.com/mflRevan/unity-control-protocol
|
|
66
|
+
- Releases: https://github.com/mflRevan/unity-control-protocol/releases
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
MIT
|