From a6bf4dadc9861c20f0f508649eaa50c57515a7f6 Mon Sep 17 00:00:00 2001 From: JLChnToZ Date: Tue, 14 May 2024 14:00:45 +0800 Subject: [PATCH] Update manuals --- Packages/idv.jlchntoz.vvmw/README.md | 3 ++- Packages/idv.jlchntoz.vvmw/README_JA.md | 26 ++++++++++++++----------- Packages/idv.jlchntoz.vvmw/README_ZH.md | 18 ++++++++++------- 3 files changed, 28 insertions(+), 19 deletions(-) diff --git a/Packages/idv.jlchntoz.vvmw/README.md b/Packages/idv.jlchntoz.vvmw/README.md index 0551544..0cf69eb 100644 --- a/Packages/idv.jlchntoz.vvmw/README.md +++ b/Packages/idv.jlchntoz.vvmw/README.md @@ -7,7 +7,7 @@ Welcome! VizVid is a general-purpose video player frontend for use in VRChat. It aims to cover many use cases, from watch-together video/live stream player in lounges, to large event venue for music performances, or even booths for exhibitions or showcases. Due to its target customers, it has a flexible architecture, just like a factory made electronic but with a easy to open back lid, make it easier to let users mess them around for their needs. > [!NOTE] -> This documentation is for V1.0.34 or later, some guidelines are different to older versions. +> This documentation is for V1.0.37 or later, some guidelines are different to older versions. ## Table of Contents * [How to install?](#how-to-install) @@ -237,6 +237,7 @@ This is an optional component that manages the queue of the playback. You can pr - **History Size**: How many recent user entered URL entries will be recorded. If this value is greater than `0`, a "Playback History" entry beside queue list and playlists will appeared. When the player plays a user-input URL, the URL and who entered will append here, allowing it to be quickly re-queued afterwards. Setting this value to `0` will entirely disable this feature. + (URLs selected in playlists will not recorded) - **Edit Playlists...**: Edit the Playlists defined in this component. The options below are in the Playlist editor window now: - **Reload**: Discard any changes to the playlist and reload to inspector. diff --git a/Packages/idv.jlchntoz.vvmw/README_JA.md b/Packages/idv.jlchntoz.vvmw/README_JA.md index 16b5daf..1c5e600 100644 --- a/Packages/idv.jlchntoz.vvmw/README_JA.md +++ b/Packages/idv.jlchntoz.vvmw/README_JA.md @@ -7,7 +7,7 @@ VizVidの使用をご検討いただき、誠にありがとうございます VizVidはVRChatに向けて開発し、汎用的な動画プレイヤーのフロントエンドです。ラウンジで皆で楽しんでいただける動画/ライブ配信プレイヤーだけではなく、大規模イベント、さらに展示会やショーケース・ブースでも対応する、汎用性が満載の動画プレイヤーになります。柔軟な構築されたガジェットのように、裏蓋を開けたら様々な形を簡単に調整され、ユーザーの皆様に多様な場合を対応されます。 > [!NOTE] -> このマニュアルは v1.0.34 以降に対応しており、一部の内容は古いバージョンと異なります。 +> このマニュアルは v1.0.37 以降に対応しており、一部の内容は古いバージョンと異なります。 ## 目次 - [導入方法](#導入方法) @@ -24,7 +24,7 @@ VizVidはVRChatに向けて開発し、汎用的な動画プレイヤーのフ - [Text Mesh Proへの移行](#Text-Mesh-Proへの移行) - [バンドルの仕組み](#バンドルの仕組み) - [VVMW (Game Object)](#VVMW-Game-Object) - - [Builtin Module / AVPro Module](#Builtin-Module--AVPro-Module) + - [Builtin Module / AVPro Module / Image Module](#Builtin-Module--AVPro-Module--Image-Module) - [Playlist Queue Handler](#Playlist-Queue-Handler) - [Locale](#Locale) - [Default Screen / Screen](#Default-Screen-Screen) @@ -191,10 +191,10 @@ Unityハイアラーキにあるプレハブは、以下の通りになります * **Targets**:カスタムスクリプトの統合に対応するため、ここでアサインされたUdon (sharp) に、イベントデータを出力します。(統合したい方は、各自ソースコードを読んでおいてください。ソースコードに関する記事は提供していませんので、予めご了承ください。) * **Realtime GI Update Interval**:リアルタイムGIを更新する間隔。無効化するには、0に設定しておけばOKです。Light Probe・Realtime GIなど、ワールドと画面レンダラーに設定することで、この機能の使用ができます。 -### Builtin Module / AVPro Module -動画再生用のプレイヤーモジュールです。バックエンドの動画プレイヤーをVizVidのフロントエンドに接続するゲームオブジェクトです。調整可能なオプションはこちらになります: -* **Player Name**:UIに表示するプレイヤーの名前です。名前を変更するか、またlang.jsonファイルを改変して、ローカライズを行えます。 -* **Materials**, **Texture Property Name**:基本的にこの設定を調整する必要はありません。これはバックエンドのプレイヤーから、映像を取得するものです。 +### Builtin Module / AVPro Module / Image Module +動画再生 / 画像表示用モジュールです。バックエンドの動画プレイヤー / 画像ビューアをVizVidのフロントエンドに接続するゲームオブジェクトです。調整可能なオプションはこちらになります: +* **Player Name**:UIに表示するプレイヤー / ビューアの名前です。名前を変更するか、またlang.jsonファイルを改変して、ローカライズを行えます。 +* **Materials**, **Texture Property Name**:基本的にこの設定を調整する必要はありません。これはバックエンドのプレイヤー / ビューアから、画面を取得するものです。 * **Maximum Resolution**:動画解像度の選択が可能の場合、設定値の高さの映像データを読み込みます。デフォルト値は1080です。 * (※AVPro限定オプション) Use Low Latency:ライブ配信を視聴する場合、低遅延モードの有効化を設定します。 * **Primary Audio Source**:音声データをオーディオソースに優先送信する設定です。Builtin Playerの場合、これは唯一の出力源になります。Audio Linkを設定している場合、オーディオソースから流れた音をAudio Linkに送信します。 @@ -205,7 +205,11 @@ Unityハイアラーキにあるプレハブは、以下の通りになります ### Playlist Queue Handler 再生キューを管理する、オプショナルコンポーネントです。プレイリストの管理と再生キューの有効化の設定ができます。 * **Core**:VVMWに接続用コンポーネントです。設定されていない場合、「Find」をクリックして設定を行います。 -* **Enable Queue List**:有効化にすると、動画再生の間に追加したURLは、キューリストに入れます。ある程度再生マナーを入れたい方にお勧めします。 +* **Enable Queue List**:有効化にすると、動画再生の間に追加したURLは、キューリストに入れます。ある程度再生マナーを持ちたい方におすすめします。 +* **History Size**:再生履歴の数を設定します。 + 0より大きい値に設定すると、キューリストの側に、再生履歴が表示します。VizVidに入力したURLと入力者が再生履歴に記録され、再生履歴からURLを選択すると、素早く再キューイングすることができます。 + 値を0に設定すると無効化にされます。 + (事前に組み込まれたプレイリストは記録されません。) * **Edit Playlists…**:事前に入れるプレイリスト編集用コンポーネントです。 \ 調整可能な項目は以下になります: * **Reload**:編集内容を破棄し、インスペクターにリロードします。 @@ -213,12 +217,12 @@ Unityハイアラーキにあるプレハブは、以下の通りになります * **Export All**:すべてのプレイリストをJSON形式で書き出します。 * **Export Selected**:選択したプレイリストをJSON形式で書き出します。 * **Import from JSON**:前回保存したプレイリストのJSONファイルをインポートします。インポートする時点で、追加・上書きを選択するプロンプトウィンドウが表示されます。 - * **Playlists**:事前に入れたプレイリストです。追加・消去・並べ替え・名前変更ができます。 + * **Playlists**:事前に組み込まれたプレイリストです。追加・消去・並べ替え・名前変更ができます。 * **<プレイリスト名>**:プレイリストを選択すると、以下の編集ができます: * **Title**:プレイヤーに表示するタイトルです。 - * **URL (PC)**:動画のリンク、YouTube・Twitch・SoundCloud・RTSP・RTMPなどの対応ができます。 - * **URL (Quest)**:Quest / Android ユーザー向けリンクです。RTSPTなど、Androidプラットフォームに対応しないリンクに対して、代用のリンクを入れます。(入れない場合は、PC用URLを流用します。) - * **<Builtin / AVPro Player>**:再生するプレイヤーモジュールを事前に指定します。ライブ配信やSoundCloudなど、AVProが必須の場合に指定することができます。 + * **URL (PC)**:動画のURL、YouTube・Twitch・SoundCloud・RTSP・RTMPなどの対応ができます。 + * **URL (Quest)**:Quest / Android ユーザー向けURLです。RTSPTなど、Androidプラットフォームに対応しないURLに対して、代用のURLを入れます。(入れない場合は、PC用URLを流用します。) + * **<Builtin / AVPro Player / Image Viewer>**:再生/表示するモジュールを事前に指定します。ライブ配信やSoundCloudなど、AVProが必須の場合に指定することができます。 * **Load Playlist from YouTube**:YouTubeプレイリストを入力することで、選択するプレイリストに追加されます。 * **Fetch Titles**:動画タイトルを取得します。現時点はYouTubeのみ対応します。 * **Default Playlist**:ユーザーがJoinする時、デフォルト選択するプレイリストです。 diff --git a/Packages/idv.jlchntoz.vvmw/README_ZH.md b/Packages/idv.jlchntoz.vvmw/README_ZH.md index ab8f05d..fda6379 100644 --- a/Packages/idv.jlchntoz.vvmw/README_ZH.md +++ b/Packages/idv.jlchntoz.vvmw/README_ZH.md @@ -5,7 +5,7 @@ 嗨!VizVid 是一款為了 VRChat 所設計的多功能媒體播放器前端。它的用途廣泛,除了在地圖與朋友一起觀看影片或直播用的播放器、大型音樂表演的活動場地,甚至在展覽會或展示攤位都能使用。針對各式各樣的需求,VizVid 有著前所未有的靈活性。猶如電子零件廠販賣的電子用品般,只要打開後蓋,就能依各自所需,自由地進行調整。 > [!NOTE] -> 本說明文件內容,涵蓋了 v1.0.34 或往後更新的版本,一部分的說明與舊版會有所不同。 +> 本說明文件內容,涵蓋了 v1.0.37 或往後更新的版本,一部分的說明與舊版會有所不同。 ## 目錄 * [安裝方法](#安裝方法) @@ -22,7 +22,7 @@ * [遷移至 Text Mesh Pro](#遷移至-Text-Mesh-Pro) * [VizVid 的構造](#VizVid-的構造) * [VVMW (Game Object)](#VVMW-Game-Object) - * [Builtin Module / AVPro Module](#Builtin-Module--AVPro-Module) + * [Builtin Module / AVPro Module / Image Module](#Builtin-Module--AVPro-Module--Image-Module) * [Playlist Queue Handler](#Playlist-Queue-Handler) * [Locale](#Locale) * [Default Screen / Screen](#Default-Screen--Screen) @@ -210,12 +210,12 @@ VizVid 於 Hierarchy 中的 Prefab 構造如下: - **Realtime GI Update Interval**:即時全域光照的更新間隔。設定 0 即為停用。 需要設定場景中的 Light Probe 和 Realtime GI 與螢幕渲染器,才能使用此功能。 -### Builtin Module / AVPro Module -播放影片時使用的播放器模組。負責將後端的影片播放器,連接至 VizVid 核心的遊戲物件。 +### Builtin Module / AVPro Module / Image Module +播放影片 / 圖片時使用的播放器 / 檢視器模組。負責將後端的影片播放器 / 圖片檢視器,連接至 VizVid 核心的遊戲物件。 以下是可以調整的設定: -- **Player Name**:顯示於 UI 上的播放器名稱。可以直接更改名稱,或是更改 **lang.json** 進行在地化翻譯。 -- **Materials**, **Texture Property Name**:通常不用更改設定。這裡是負責從播放器後端取得影片的畫面。 +- **Player Name**:顯示於 UI 上的播放器 / 檢視器名稱。可以直接更改名稱,或是更改 **lang.json** 進行在地化翻譯。 +- **Materials**, **Texture Property Name**:通常不用更改設定。這裡是負責從播放器 / 檢視器後端取得影片的畫面。 - **Maximum Resolution**:載入影片的最高解析度 (如果可選)。數值是影片的高度。預設值為`1080`。 - **Use Low Latency**:AVPro 限定選項。若要觀賞串流內容。此選項可降低觀看延遲。 - **Primary Audio Source**:聲音會優先輸出的 Audio Source。 @@ -233,6 +233,10 @@ VizVid 於 Hierarchy 中的 Prefab 構造如下: - **Core**:將元件指向至 VizVid 核心。若為留空,按「Find」即可解決。 - **Enable Queue List**:若為啟用,影片播放期間,當其他使用者新增網址,將會加入播放佇列中。 建議啟用,讓大家當個有禮貌的乖寶寶。 +- **History Size**:設定播放記錄的數量。 + 若設定比 0 大的數值,在播放佇列旁,會顯示播放記錄。當使用者輸入網址時,網址和輸入者的名字會加入此處,以便快速重新點播。 + 設定 0 即為停用 + (播放清單的點播不會加入播放記錄) - **Edit Playlists...**:編輯播放清單的元件。 播放清單編輯視窗內,可做出以下調整: - **Reload**:取消變更,並將播放清單載回至 Inspector。 @@ -245,7 +249,7 @@ VizVid 於 Hierarchy 中的 Prefab 構造如下: - **Title**:要顯示的影片標題。 - **URL (PC)**:影片連結。支援 YouTube、Twitch、SoundCloud、RTMP、RTSP 等等連結。 - **URL (Quest)**:對於 RTSPT / RTMP 等等 Quest / Android 平台不支援的連結,提供可用連結的替代方案 (留空即會沿用 PC 的連結)。 - - **<Builtin / AVPro Player>**:選擇播放連結的模組。 + - **<Builtin / AVPro Player / Image Viewer>**:選擇播放 / 檢視連結的模組。 若播放連結為串流或 SoundCloud,請選擇 AVPro 模組。 - **Load Playlist from YouTube**:將 YouTube 播放清單匯入至選擇的播放清單。 - **Fetch Titles**:若 Title 欄為空,則可自動取得並匯入影片標題,目前僅支援 YouTube。