Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ ws://127.0.0.1:8765/ws
### 目次
- [🏓 Ping-Pong(接続テスト)](#-ping-pong接続テスト)
- [🌲 Tree(シーン構造)](#-treeシーン構造)
- [📦 Item(アイテムカタログ)](#-itemアイテムカタログ)
- [グループ一覧取得](#グループ一覧取得)
- [グループ内カテゴリ取得](#グループ内カテゴリ取得)
- [カテゴリ内アイテム取得](#カテゴリ内アイテム取得)
- [🔄 Update(オブジェクト変更)](#-updateオブジェクト変更)
- [Transform更新](#transform更新)
- [アイテム色変更](#アイテム色変更)
Expand Down Expand Up @@ -144,6 +148,127 @@ ws://127.0.0.1:8765/ws
]
```

### 📦 Item(アイテムカタログ)

シーンに追加可能なすべてのアイテムの情報を取得します。アイテムは階層構造で整理されています:グループ → カテゴリ → アイテム。

#### グループ一覧取得

すべてのアイテムグループの一覧を取得:

**リクエスト:**
```json
{
"type": "item",
"command": "list-groups"
}
```

**レスポンス:**
```json
{
"type": "success",
"command": "list-groups",
"data": [
{
"id": 0,
"name": "アイテム",
"categoryCount": 15
},
{
"id": 1,
"name": "ライト",
"categoryCount": 3
}
]
}
```

#### グループ内カテゴリ取得

指定したグループ内のカテゴリを取得:

**リクエスト:**
```json
{
"type": "item",
"command": "list-group",
"groupId": 0
}
```

**レスポンス:**
```json
{
"type": "success",
"command": "list-group",
"groupId": 0,
"data": {
"id": 0,
"name": "アイテム",
"categories": [
{
"id": 0,
"name": "図形",
"itemCount": 25
},
{
"id": 1,
"name": "家具",
"itemCount": 42
}
]
}
}
```

#### カテゴリ内アイテム取得

指定したカテゴリ内のすべてのアイテムを取得:

**リクエスト:**
```json
{
"type": "item",
"command": "list-category",
"groupId": 0,
"categoryId": 0
}
```

**レスポンス:**
```json
{
"type": "success",
"command": "list-category",
"groupId": 0,
"categoryId": 0,
"data": {
"id": 0,
"name": "図形",
"groupId": 0,
"items": [
{
"id": 0,
"name": "スフィア(通常)",
"properties": {
"isAnime": false,
"isScale": true,
"hasColor": true,
"colorSlots": 3,
"hasPattern": false,
"patternSlots": 0,
"isEmission": false,
"isGlass": false,
"bones": 0,
"childRoot": ""
}
}
]
}
}
```

### 📝 Update(オブジェクト変更)

#### Transform更新
Expand Down
125 changes: 125 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ All commands and responses use JSON format.
### Table of Contents
- [🏓 Ping-Pong (Connection Test)](#-ping-pong-connection-test)
- [🌲 Tree (Scene Structure)](#-tree-scene-structure)
- [📦 Item (Item Catalog)](#-item-item-catalog)
- [List Groups](#list-groups)
- [List Group Categories](#list-group-categories)
- [List Category Items](#list-category-items)
- [🔄 Update (Object Properties)](#-update-object-properties)
- [Update Transform](#update-transform)
- [Update Item Color](#update-item-color)
Expand Down Expand Up @@ -148,6 +152,127 @@ Retrieve the complete scene object hierarchy:
]
```

### 📦 Item (Item Catalog)

Retrieve information about all available items that can be added to the scene. Items are organized in a hierarchical structure: Groups → Categories → Items.

#### List Groups

Get a list of all item groups:

**Request:**
```json
{
"type": "item",
"command": "list-groups"
}
```

**Response:**
```json
{
"type": "success",
"command": "list-groups",
"data": [
{
"id": 0,
"name": "Items",
"categoryCount": 15
},
{
"id": 1,
"name": "Lights",
"categoryCount": 3
}
]
}
```

#### List Group Categories

Get categories within a specific group:

**Request:**
```json
{
"type": "item",
"command": "list-group",
"groupId": 0
}
```

**Response:**
```json
{
"type": "success",
"command": "list-group",
"groupId": 0,
"data": {
"id": 0,
"name": "Items",
"categories": [
{
"id": 0,
"name": "Shapes",
"itemCount": 25
},
{
"id": 1,
"name": "Furniture",
"itemCount": 42
}
]
}
}
```

#### List Category Items

Get all items within a specific category:

**Request:**
```json
{
"type": "item",
"command": "list-category",
"groupId": 0,
"categoryId": 0
}
```

**Response:**
```json
{
"type": "success",
"command": "list-category",
"groupId": 0,
"categoryId": 0,
"data": {
"id": 0,
"name": "Shapes",
"groupId": 0,
"items": [
{
"id": 0,
"name": "Sphere (Normal)",
"properties": {
"isAnime": false,
"isScale": true,
"hasColor": true,
"colorSlots": 3,
"hasPattern": false,
"patternSlots": 0,
"isEmission": false,
"isGlass": false,
"bones": 0,
"childRoot": ""
}
}
]
}
}
```

### 📝 Update (Modify Objects)

#### Update Transform
Expand Down
Loading