はじめに
この記事はVR法人HIKKY Advent Calendar 2023の21日目の記事です。
前日は @IwahanaFuku さんによる 基礎から始めるVket Cloudワールド作成でした。VketCloudSDKに関するより深い理解のためには、前日の記事も併せてご一読いただくことをおすすめいたします。
VketCloudSDK / VketCloudSDKマニュアルとは
メタバース開発エンジンであるVket Cloudを利用してメタバース / ワールドを作る方法はいくつか用意されています。
最もカジュアルな方法としてはMy Vketにてゲームライクに家具や小道具を配置するマイルームがあります。
また、ビジネス向けにはVket Cloudのビジネスプラン以上の有料ライセンスを取得すると利用できるテンプレートワールドがあります。
そして、最も拡張性や実装の自由度の高いワールド作りの方法としては、Unityエディタを拡張したVketCloudSDKが用意されています。
VketCloudSDK公式マニュアルは、SDKの利用に関する情報を補完する目的で作成・維持されているウェブサイトです。
なぜSDKマニュアルが必要なのか
VketCloudSDKは厳密にはひとつのツールを指すものではなく、ビルド用のセットアップツール、デバッグコンソール、Vket Cloud仕様にパーティクルを作成するエディター、アニメーションコンバーターなど、様々なツール / モジュールの複合によって構成されています。
これらツールの使い方に限らず、独自のプログラミング言語であるHeliScriptの書き方、SDK独自のコンポーネントを使用したギミックの実装方法など、総じてSDKを使用したワールド作りのために必要な知識の集約を目的として編集が進められています。
一方で、開発陣のみならずSDKユーザーからもSDKの利用を通じたノウハウを集約させる場が必要であり、本記事の主題のようにSDKマニュアルへの知識のコントリビューションを広く募集するに至りました。
もしVketCloudSDKを使用して面白いものができた・知見が得られた際はお気軽にマニュアルへの追記を検討いただければと思います。
SDKマニュアルの執筆に参加する方法
GitHubのアカウントを取得した上で、VketCloudSDK公式マニュアルレポジトリにアクセスしてください。
https://github.com/VRHIKKY/VketCloudSDK_Documents
なお、公式マニュアルのローカル環境の構築のためには、Python3.11以降が必要です。
必要な環境のクローンを完了した上で、レポジトリのREADMEにて紹介しているwindows_mkdocs.bat (Mac環境ではmac_mkdocs.sh)の起動か、クローンしたレポジトリのルートにて以下のコマンドを実行するとドキュメントのローカルビルドができます。
python -m venv .venv
call .\.venv\Scripts\activate
pip install -r requirements.txt
mkdocs serve
ローカルビルドがなされている状態でhttp://127.0.0.1:8000/ にアクセスすると、手元のドキュメントの編集や変更を確認することができます。
おわりに
ここまでお読みいただきありがとうございました。本記事を読んでいただいてVketCloudSDK / SDKマニュアルを触れてみようと思っていただいたのであれば幸いです。
また、アドベントカレンダーとして大遅刻したにも関わらず、快く掲載いただいた主宰スタッフ及び関係各位に感謝申し上げます。
明日のアドベントカレンダーは @Usui_KKYL さんによるVirtual Market 2023 WinterにおけるJIRA導入とタスク管理です。