Skip to content

Commit

Permalink
不足分を追記
Browse files Browse the repository at this point in the history
  • Loading branch information
o-tr committed Aug 15, 2024
1 parent 5b0cc02 commit bd7daac
Show file tree
Hide file tree
Showing 7 changed files with 98 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/ImageGimmicksPack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ImageGimmicksPack
パッケージを分割したため、`v0.1.0` 以前の `ImageTab` に相当するものとしてリリースしたパッケージです
[ImageTab](/docs/ImageTab/)[ImageSlide](/docs/ImageScreen/)[ImageDeviceController](/docs/ImageDeviceController/)[ImageScreen](/docs/ImageScreen/)と、それを用いたサンプルワールドが含まれています
3 changes: 3 additions & 0 deletions docs/ImageScreen/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ImageScreen
画像を投影するための画面です
[ImageTab](/docs/ImageTab)[ImageSlide](/docs/ImageSlide/) を用いて画像を投影することを想定しています
2 changes: 2 additions & 0 deletions docs/ImageScreen/creator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# ワールド制作者向け
[ImageDeviceController](/docs/ImageDeviceController/) の管理下に追加し、他の端末から画像を投影することを想定しています
4 changes: 4 additions & 0 deletions docs/TextZip/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# TextZip
[ImageDeviceController](/docs/ImageDeviceController/) で読み込むことができるフォーマットです
機能に応じていくつかのバージョンが存在します

37 changes: 37 additions & 0 deletions docs/TextZip/v0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# TextZip v0
v0.0.2 以降のすべての `ImageDeviceController` で読み込むことができるフォーマットです

## 定義
```typescript
type Rect = {
width: number;
height: number;
}

type ManifestItem = {
path: string;
rect: Rect
}

type Manifest = ManifestItem[];
```

## サンプルデータ
```json
[
{
"path": "0.rawimage",
"rect": {
"width": 612,
"height": 792
}
},
{
"path": "1.rawimage",
"rect": {
"width": 612,
"height": 792
}
}
]
```
46 changes: 46 additions & 0 deletions docs/TextZip/v1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# TextZip v1
v0.1.0 以降の `ImageDeviceController` で読み込むことができるフォーマットです

## 定義
```typescript
type Rect = {
width: number;
height: number;
}

type ManifestItem = {
path: string;
format: string; //データのフォーマット
rect: Rect;
extensions?: {[ext_name: string]: string} //各機能ごとにKV形式でデータを格納する/extensionに何も指定がない場合は定義しなくても良い
}

type Manifest = {
files: ManifestItem;
manifestVersion: number; //マニフェストの仕様版
requiredFeatures: string[]; //フォーマットの読み込み機能など必須要件
extensions: string[]; //読み込み自体には支障がないが、あった方が良い要件
}
```
## サンプルデータ
```json
{
"files": [
{
"path": "<path-to-image>",
"format": "<texture-format>",
"rect": {
"width": 256,
"height": 256
},
"ext":{
"note": "<content-string>",
}
}
],
"requiredVersion": 1,
"requiredFeatures": ["rgb24"],
"extension": ["note"],
}
```
3 changes: 3 additions & 0 deletions docs/WeatherWidget/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# WeatherWidget
GeoLocation を用いた天気予報ギミックです
利用するには `Comfort & Safety` > `Allow Untrusted URLs` を許可している必要があります

0 comments on commit bd7daac

Please sign in to comment.