@cubelife/sdk 0.2.0 → 0.2.2
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 +15 -8
- package/package.json +11 -4
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @cubelife/sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Give your AI agent a living pixel-art character. Characters mirror agent state in real time, live in rooms, and have emotions.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -15,16 +15,23 @@ import { CubeLifeClient } from '@cubelife/sdk';
|
|
|
15
15
|
|
|
16
16
|
const client = new CubeLifeClient({ apiKey: 'your-agent-api-key' });
|
|
17
17
|
|
|
18
|
-
// Report what your agent is doing
|
|
19
18
|
await client.report('coding', { detail: 'Building the login page', sentiment: 'positive' });
|
|
20
|
-
|
|
21
|
-
// Update progress
|
|
22
19
|
await client.report('coding', { detail: 'Building the login page', progress: 0.5 });
|
|
23
|
-
|
|
24
|
-
// Mark complete
|
|
25
20
|
await client.report('complete', { detail: 'Login page shipped' });
|
|
26
21
|
```
|
|
27
22
|
|
|
23
|
+
Your character appears at [life.cubeworld.co.za](https://life.cubeworld.co.za), in the desktop companion, or embedded in your own app via `<iframe>`.
|
|
24
|
+
|
|
25
|
+
## MCP Server
|
|
26
|
+
|
|
27
|
+
If you use Claude Code, Cursor, Windsurf, or any MCP-compatible tool, you can skip the SDK and use the CLI's built-in MCP server instead:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npx cubelife setup claude-code # auto-configures MCP
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The MCP server exposes `cubelife_report`, `cubelife_complete`, `cubelife_error`, and `cubelife_status` tools. See the [cubelife CLI](https://www.npmjs.com/package/cubelife) package.
|
|
34
|
+
|
|
28
35
|
## API
|
|
29
36
|
|
|
30
37
|
### `CubeLifeClient`
|
|
@@ -37,8 +44,8 @@ const client = new CubeLifeClient({ apiKey: 'your-key' });
|
|
|
37
44
|
|
|
38
45
|
**Methods:**
|
|
39
46
|
|
|
40
|
-
- `report(state, options?)` - Report agent state
|
|
41
|
-
- `getState()` - Get current agent state
|
|
47
|
+
- `report(state, options?)` - Report agent state
|
|
48
|
+
- `getState()` - Get current agent state (returns sleeping status)
|
|
42
49
|
- `navigate(destination)` - Move agent to a different room
|
|
43
50
|
- `customise(options)` - Update character appearance (outfit, skin tone, accessories)
|
|
44
51
|
- `setCreature(type)` - Switch agent to a creature form
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cubelife/sdk",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "SDK for CubeLife — give your AI agent a living pixel-art character",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -20,16 +20,23 @@
|
|
|
20
20
|
"agent",
|
|
21
21
|
"pixel-art",
|
|
22
22
|
"character",
|
|
23
|
-
"visualization"
|
|
23
|
+
"visualization",
|
|
24
|
+
"mcp",
|
|
25
|
+
"mcp-server",
|
|
26
|
+
"developer-tools",
|
|
27
|
+
"companion",
|
|
28
|
+
"claude",
|
|
29
|
+
"cursor",
|
|
30
|
+
"copilot"
|
|
24
31
|
],
|
|
25
32
|
"license": "MIT",
|
|
26
33
|
"repository": {
|
|
27
34
|
"type": "git",
|
|
28
|
-
"url": "https://github.com/
|
|
35
|
+
"url": "https://github.com/Ivy-Innovation/cubelife.git",
|
|
29
36
|
"directory": "sdk"
|
|
30
37
|
},
|
|
31
38
|
"homepage": "https://life.cubeworld.co.za",
|
|
32
|
-
"bugs": "https://github.com/
|
|
39
|
+
"bugs": "https://github.com/Ivy-Innovation/cubelife/issues",
|
|
33
40
|
"devDependencies": {
|
|
34
41
|
"@vitest/coverage-v8": "^4.0.18",
|
|
35
42
|
"typescript": "^5.7.0",
|