Skip to content

Commit bdf6465

Browse files
Merge pull request #70 from TriVR-TRPG/docs/update-overview-video-links
docs: update tool overview docs and intro video links
2 parents 2beab7e + 06fc266 commit bdf6465

4 files changed

Lines changed: 230 additions & 0 deletions

File tree

README.ja.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,12 @@ MIT
9090
- [ユドナリウム(Udonarium)](https://github.com/TK11235/udonarium#readme) - Webブラウザで動作するオンラインセッションツール
9191
- [ResoniteLink](https://github.com/Yellow-Dog-Man/ResoniteLink) - Resonite連携ツール
9292
- [tsrl](https://www.npmjs.com/package/@eth0fox/tsrl) - ResoniteLink接続に使用しているTypeScriptライブラリ
93+
94+
## MMC26 エントリー
95+
96+
このツールは Metaverse Maker Competition 2026 にエントリーした作品です。
97+
エントリー時点のバージョン: [v1.0.0-beta.4](https://github.com/TriVR-TRPG/udonarium-resonite-importer/releases/tag/v1.0.0-beta.4)
98+
99+
- イベント: [Metaverse Maker Competition 2026](https://youtu.be/MHxobH-TkKc)
100+
- カテゴリ: other tau
101+
- ワールド: [[MMC26] Udonarium Resonite Importer - Resonite](https://go.resonite.com/world/G-1Nc5BgekFJQ/R-b0e1dc28-fec9-48cb-8fee-58459f3f637a)

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,12 @@ MIT
9292
- [Udonarium](https://github.com/TK11235/udonarium) - Web-based virtual tabletop
9393
- [ResoniteLink](https://github.com/Yellow-Dog-Man/ResoniteLink) - Resonite integration tool
9494
- [tsrl](https://www.npmjs.com/package/@eth0fox/tsrl) - TypeScript library used for ResoniteLink connectivity
95+
96+
## MMC26 Entry
97+
98+
This tool was submitted to Metaverse Maker Competition 2026.
99+
Version at the time of entry: [v1.0.0-beta.4](https://github.com/TriVR-TRPG/udonarium-resonite-importer/releases/tag/v1.0.0-beta.4)
100+
101+
- Event: [Metaverse Maker Competition 2026](https://youtu.be/MHxobH-TkKc)
102+
- Category: other tau
103+
- World: [[MMC26] Udonarium Resonite Importer - Resonite](https://go.resonite.com/world/G-1Nc5BgekFJQ/R-b0e1dc28-fec9-48cb-8fee-58459f3f637a)

docs/tool-overview.ja.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Udonarium Resonite Importer
2+
3+
Resonite ユーザーが、ユドナリウムで配布されているセーブデータを取り込んで遊べるようにするツールです。
4+
5+
## 紹介動画
6+
7+
[![紹介動画(YouTube)](https://img.youtube.com/vi/3CHq_KOcIwQ/maxresdefault.jpg)](https://youtu.be/3CHq_KOcIwQ)
8+
9+
動画リンク: https://youtu.be/3CHq_KOcIwQ
10+
11+
## このツールで何ができる?
12+
13+
ユドナリウムのセーブ ZIP を Resonite にインポートし、盤面の見た目と配置をまとめて再現できます。
14+
キャラクター、カードと山札、ダイス、テーブル、地形、マップマスクに対応しています。
15+
16+
## ユドナリウムって何?
17+
18+
ユドナリウムは、Web ブラウザで動くオンラインセッション用ツール(Virtual Tabletop)です。
19+
主にボードゲーム、TTRPG、マーダーミステリーなどで使われています。
20+
21+
日本語圏では、ユドナリウム用のセーブデータ(ZIP)が多数配布されています。
22+
このツールは、それらのデータを Resonite に持ち込んで遊ぶことを目的にしています。
23+
24+
## どうやって使う?
25+
26+
### 1. アプリを入手
27+
28+
[Booth](https://trivr.booth.pm/items/8034445) または [GitHub Releases](https://github.com/TriVR-TRPG/udonarium-resonite-importer/releases/latest) から ZIP をダウンロードし、展開した `Udonarium Resonite Importer` を起動してください。
29+
30+
### 2. Resonite 側を準備
31+
32+
Resonite を起動し(未インストールの場合は Steam から導入)、新規ワールドを作成してください。
33+
ダッシュメニューのセッションタブで「ResoniteLinkを有効化」を実行し、「ResoniteLink がポート [数字] で動作中」と表示されたら準備完了です。
34+
35+
Steam: https://store.steampowered.com/app/2519830
36+
37+
### 3. インポート実行
38+
39+
アプリでユドナリウムのセーブ ZIP を選択し、手順 2 のポート番号を入力して「Resoniteにインポート」を押してください。
40+
41+
![GUI版の使用イメージ](images/gui.ja.png)
42+
43+
---
44+
45+
## もっと詳しく
46+
47+
### インポート時の挙動
48+
49+
- インポートしたオブジェクトは RootSlot 直下に生成されます。
50+
- ルートスロット名は `Udonarium Import - [ZIPファイル名]` です。
51+
- ルートには `udonarium-resonite-importer:root` タグが付きます。
52+
- RootSlot 直下に同タグを持つ既存スロットがある場合は、既存スロットを置き換えます。
53+
- 置き換え時は同じ Transform(位置・回転・大きさ)で再配置します。
54+
55+
### 高度なオプション
56+
57+
通常はデフォルトのまま使えます。必要な場合のみ変更してください。
58+
59+
- ルートにGrabbableを付ける(初期値: オフ)
60+
- 盤面全体を掴めるようにします。
61+
- ルートスケール(初期値: 1 (m))
62+
- ルートスケールを変更できます。
63+
- 既存の `udonarium-resonite-importer:root` タグ付きスロットがある場合、そのスケールが優先されます。
64+
- 初期状態では 1 マス = 1 m になるよう変換されます。
65+
- テーブルと固定された地形にコライダーを付ける(初期値: オフ)
66+
- CharacterCollider を付与し、乗れるようにしつつ壁のすり抜けを防げます。
67+
- 固定されていない地形には付与しません。
68+
- 半透明画像の描画方法(初期値: Cutout)
69+
- 半透明画像の BlendMode を一括で設定できます(個別設定はできません)。
70+
- `Cutout`: 透明度しきい値未満を描画しません(切り抜き向け)。
71+
- `Alpha`: 透明度に応じて描画します(重なり時に奥側の表示が欠ける場合あり)。
72+
- SimpleAvatarProtectionを付ける(初期値: オン)
73+
- 自分以外が保存できないようにできます。
74+
- 誰でも保存してよいものをインポートする場合のみオフにしてください。
75+
- ResoniteLinkホスト(初期値: localhost)
76+
- localhost 以外の ResoniteLink を使う場合に指定できます(未検証)。
77+
78+
### MMC26 エントリー
79+
80+
- イベント: [Metaverse Maker Competition 2026](https://youtu.be/MHxobH-TkKc)
81+
- カテゴリ: other tau
82+
- ワールド: [[MMC26] Udonarium Resonite Importer - Resonite](https://go.resonite.com/world/G-1Nc5BgekFJQ/R-b0e1dc28-fec9-48cb-8fee-58459f3f637a)
83+
84+
### クレジット
85+
86+
- 開発者: yoshi1123_
87+
- テスター: ankou, ifura, KTY, usaturn, Karabina
88+
- フィードバック: lill
89+
90+
使用アセット:
91+
92+
- ユドナリウム公式アセット: https://github.com/TK11235/udonarium
93+
94+
使用ツール:
95+
96+
- Vibe Coding & 翻訳: Claude Code, GitHub Copilot, ChatGPT/Codex
97+
- tsrl: ResoniteLink の TypeScript 実装ライブラリ https://www.npmjs.com/package/@eth0fox/tsrl
98+
- 動画編集: Davinci Resolve
99+
100+
動画内で使用しているアセット:
101+
102+
- BGM: [魔王魂](https://maou.audio/bgm_cyber13/) - CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
103+
- ユドナ用ルームデータ(テーブル数47) | ouma https://ouma.booth.pm/items/5499018
104+
- 【D&D5版】ダンジョン&ドラゴンズ第5版シナリオ「囚われの花嫁」 | しらたき置き場 https://nabenosoko.booth.pm/items/3694104
105+
106+
107+
108+

docs/tool-overview.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Udonarium Resonite Importer
2+
3+
A tool for Resonite users to import and play save data distributed for Udonarium.
4+
5+
## Intro Video
6+
7+
[![Intro Video (YouTube)](https://img.youtube.com/vi/3CHq_KOcIwQ/maxresdefault.jpg)](https://youtu.be/3CHq_KOcIwQ)
8+
9+
Video link: https://youtu.be/3CHq_KOcIwQ
10+
11+
## What Can This Tool Do?
12+
13+
You can import Udonarium save ZIP files into Resonite and recreate both the board visuals and object placement.
14+
It supports characters, cards/decks, dice, tables, terrain, and map masks.
15+
16+
## What Is Udonarium?
17+
18+
Udonarium is an online session tool (Virtual Tabletop) that runs in a web browser.
19+
It is mainly used for board games, TTRPGs, and murder mystery games.
20+
21+
In Japanese-speaking communities, many Udonarium save files (ZIP) are shared.
22+
This tool is built to bring those data sets into Resonite so you can play them there.
23+
24+
## How Do I Use It?
25+
26+
### 1. Get the App
27+
28+
Download the ZIP from [Booth](https://trivr.booth.pm/items/8034445) or [GitHub Releases](https://github.com/TriVR-TRPG/udonarium-resonite-importer/releases/latest), then launch `Udonarium Resonite Importer` from the extracted folder.
29+
30+
### 2. Prepare Resonite
31+
32+
Start Resonite (if not installed, install it from Steam), then create a new world.
33+
Open the Session tab in the dash menu, enable "ResoniteLink," and wait until you see "ResoniteLink is running on port [number]".
34+
35+
Steam: https://store.steampowered.com/app/2519830
36+
37+
### 3. Run Import
38+
39+
In the app, choose a Udonarium save ZIP, enter the port number from step 2, and click "Import to Resonite".
40+
41+
![GUI usage image](images/gui.en.png)
42+
43+
---
44+
45+
## More Details
46+
47+
### Import Behavior
48+
49+
- Imported objects are created directly under RootSlot.
50+
- The root slot name is `Udonarium Import - [ZIP filename]`.
51+
- The root gets the `udonarium-resonite-importer:root` tag.
52+
- If a slot with the same tag already exists under RootSlot, it is replaced.
53+
- During replacement, the new slot is placed with the same Transform (position, rotation, scale).
54+
55+
### Advanced Options
56+
57+
In most cases, default settings are fine. Change these only when needed.
58+
59+
- Add Grabbable to Root (default: Off)
60+
- Makes the whole imported board grabbable.
61+
- Root Scale (default: 1 (m))
62+
- Changes the root scale.
63+
- If an existing slot with `udonarium-resonite-importer:root` exists, that slot's scale takes priority.
64+
- By default, size is converted so that 1 tile = 1 meter.
65+
- Add colliders to table and fixed terrain (default: Off)
66+
- Adds CharacterCollider so players can stand on them and not pass through walls.
67+
- Not applied to non-fixed terrain.
68+
- Transparent image render mode (default: Cutout)
69+
- Sets BlendMode for all transparent images in bulk (no per-image setting).
70+
- `Cutout`: Pixels below alpha threshold are not rendered (good for cutout images).
71+
- `Alpha`: Renders by transparency (overlap may cause objects behind to appear broken).
72+
- Add SimpleAvatarProtection (default: On)
73+
- Prevents users other than you from saving.
74+
- Turn this off only when importing content that anyone is allowed to save.
75+
- ResoniteLink Host (default: localhost)
76+
- Lets you specify a non-localhost ResoniteLink host (not verified).
77+
78+
### MMC26 Entry
79+
80+
- Event: [Metaverse Maker Competition 2026](https://youtu.be/MHxobH-TkKc)
81+
- Category: other tau
82+
- World: [[MMC26] Udonarium Resonite Importer - Resonite](https://go.resonite.com/world/G-1Nc5BgekFJQ/R-b0e1dc28-fec9-48cb-8fee-58459f3f637a)
83+
84+
### Credits
85+
86+
- Developer: yoshi1123_
87+
- Testers: ankou, ifura, KTY, usaturn, Karabina
88+
- Feedback: lill
89+
90+
Assets used:
91+
92+
- Official Udonarium assets: https://github.com/TK11235/udonarium
93+
94+
Tools used:
95+
96+
- Vibe Coding & translation: Claude Code, GitHub Copilot, ChatGPT/Codex
97+
- tsrl: TypeScript implementation library for ResoniteLink https://www.npmjs.com/package/@eth0fox/tsrl
98+
- Video editing: Davinci Resolve
99+
100+
Assets used in the video:
101+
102+
- BGM: [MaouDamashii](https://maou.audio/bgm_cyber13/) - CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
103+
- Udonarium room data (47 tables) | ouma https://ouma.booth.pm/items/5499018
104+
- [D&D 5e] Scenario "Toraware no Hanayome" | Shirataki Okiba https://nabenosoko.booth.pm/items/3694104

0 commit comments

Comments
 (0)