@mflrevan/ucp 0.1.0 → 0.1.1
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 +77 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# @mflrevan/ucp
|
|
2
|
+
|
|
3
|
+
CLI for programmatic control of Unity Editor over WebSocket. Enables AI agents, CI/CD pipelines, and automation tools to interact with Unity projects.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @mflrevan/ucp
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
The package automatically downloads the correct prebuilt binary for your platform (macOS, Linux, Windows).
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
cd /path/to/MyUnityProject
|
|
17
|
+
ucp connect # verify connection to Unity bridge
|
|
18
|
+
ucp snapshot # capture full scene hierarchy
|
|
19
|
+
ucp compile # trigger recompilation
|
|
20
|
+
ucp play # enter play mode
|
|
21
|
+
ucp write-file Assets/Scripts/MyScript.cs --content "..."
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Requirements
|
|
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
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
ucp install
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Or add to `Packages/manifest.json`:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"com.ucp.bridge": "https://github.com/mflRevan/unity-control-protocol.git?path=unity-package/com.ucp.bridge"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Commands
|
|
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) |
|
|
61
|
+
|
|
62
|
+
All commands support `--json` for structured output.
|
|
63
|
+
|
|
64
|
+
## Alternative Install Methods
|
|
65
|
+
|
|
66
|
+
- **cargo:** `cargo install --git https://github.com/mflRevan/unity-control-protocol --path cli`
|
|
67
|
+
- **Binary:** [GitHub Releases](https://github.com/mflRevan/unity-control-protocol/releases)
|
|
68
|
+
- **Source:** `git clone` + `cargo build --release`
|
|
69
|
+
|
|
70
|
+
## Links
|
|
71
|
+
|
|
72
|
+
- [Full documentation](https://github.com/mflRevan/unity-control-protocol)
|
|
73
|
+
- [GitHub Releases](https://github.com/mflRevan/unity-control-protocol/releases)
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
MIT
|