@mflrevan/ucp 0.1.1 → 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 +30 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @mflrevan/ucp
|
|
2
2
|
|
|
3
|
-
|
|
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`.
|
|
4
6
|
|
|
5
7
|
## Install
|
|
6
8
|
|
|
@@ -8,31 +10,39 @@ CLI for programmatic control of Unity Editor over WebSocket. Enables AI agents,
|
|
|
8
10
|
npm install -g @mflrevan/ucp
|
|
9
11
|
```
|
|
10
12
|
|
|
11
|
-
|
|
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
|
|
12
26
|
|
|
13
27
|
## Usage
|
|
14
28
|
|
|
15
29
|
```bash
|
|
16
30
|
cd /path/to/MyUnityProject
|
|
17
|
-
ucp
|
|
18
|
-
ucp
|
|
19
|
-
ucp
|
|
20
|
-
ucp
|
|
21
|
-
ucp
|
|
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
|
|
22
37
|
```
|
|
23
38
|
|
|
24
|
-
##
|
|
25
|
-
|
|
26
|
-
- Unity project with the UCP bridge package installed
|
|
27
|
-
- Supported platforms: macOS (x64, ARM64), Linux (x64), Windows (x64)
|
|
28
|
-
|
|
29
|
-
### Install the Bridge
|
|
39
|
+
## Bridge install
|
|
30
40
|
|
|
31
41
|
```bash
|
|
32
42
|
ucp install
|
|
33
43
|
```
|
|
34
44
|
|
|
35
|
-
Or add to `Packages/manifest.json`:
|
|
45
|
+
Or add this to `Packages/manifest.json`:
|
|
36
46
|
|
|
37
47
|
```json
|
|
38
48
|
{
|
|
@@ -42,35 +52,18 @@ Or add to `Packages/manifest.json`:
|
|
|
42
52
|
}
|
|
43
53
|
```
|
|
44
54
|
|
|
45
|
-
##
|
|
46
|
-
|
|
47
|
-
| Command | Description |
|
|
48
|
-
|---|---|
|
|
49
|
-
| `ucp connect` | Verify connection to Unity bridge |
|
|
50
|
-
| `ucp doctor` | Run health checks |
|
|
51
|
-
| `ucp compile` | Trigger recompilation |
|
|
52
|
-
| `ucp play` / `stop` / `pause` | Play mode control |
|
|
53
|
-
| `ucp scene list\|active\|load` | Scene management |
|
|
54
|
-
| `ucp snapshot` | Capture scene hierarchy |
|
|
55
|
-
| `ucp screenshot` | Capture screenshot |
|
|
56
|
-
| `ucp logs` | Stream console logs |
|
|
57
|
-
| `ucp run-tests` | Run edit/play mode tests |
|
|
58
|
-
| `ucp read-file` / `write-file` / `patch-file` | File operations |
|
|
59
|
-
| `ucp exec list\|run` | Run automation scripts |
|
|
60
|
-
| `ucp vcs *` | Version control (Plastic SCM) |
|
|
55
|
+
## Release asset source
|
|
61
56
|
|
|
62
|
-
|
|
57
|
+
The installer downloads from:
|
|
63
58
|
|
|
64
|
-
|
|
59
|
+
`https://github.com/mflRevan/unity-control-protocol/releases/download/v<version>/...`
|
|
65
60
|
|
|
66
|
-
|
|
67
|
-
- **Binary:** [GitHub Releases](https://github.com/mflRevan/unity-control-protocol/releases)
|
|
68
|
-
- **Source:** `git clone` + `cargo build --release`
|
|
61
|
+
That means npm publish depends on the matching GitHub release artifacts existing for the same tag.
|
|
69
62
|
|
|
70
63
|
## Links
|
|
71
64
|
|
|
72
|
-
-
|
|
73
|
-
-
|
|
65
|
+
- Repository: https://github.com/mflRevan/unity-control-protocol
|
|
66
|
+
- Releases: https://github.com/mflRevan/unity-control-protocol/releases
|
|
74
67
|
|
|
75
68
|
## License
|
|
76
69
|
|