久しぶりの記事投稿です。OBSのプラグイン開発に興味が出たので、備忘録的に導入手順をまとめます。
二番煎じ感もありますが、ピンポイントでこの環境の事が知りたいどなたかの参考になれば。
前提
Windows環境で、VisualStudioを使った例を紹介します。
VisualStudioにはあらかじめCMake拡張が入れている物とします。
また、OSBはインストール済みである事が前提です。
準備
まずはプラグイン開発環境の準備からです。
基本的にはVisualstudioがCmakeListsを元にほぼ自動でセットアップしてくれます。
公式からテンプレートのダウンロード
- こちらから取得できます。Cloneするなりzipで取得、展開します。
https://github.com/obsproject/obs-plugintemplate/tree/master
Visual Studio 2022の起動
-
[ローカルフォルダを開く]を選択
-
ダウンロードしたテンプレートのフォルダを選択
-
自動で必要な物がダウンロードされ、ビルド環境が整う
最初のビルド
準備が出来たのでビルドできるか確認してみましょう。
- F7または、ビルド→すべてビルドでビルドが出来ることを確認。
- obs-plugintemplate-master\build_x64\RelWithDebInfoにplugintemplate-for-obs.dllが生成されている事を確認する。
動作確認
出来上がったdllをOBSのインストールされたフォルダにコピーします。
必要に応じて、ビルド後自動でコピーされるように設定するようにしましょう。
-
出来上がったdllを↓にコピーしてOBSを再起動
C:\Program Files\obs-studio\obs-plugins\64bit -
ヘルプ→ログファイル→現在のログを表示でログの中に
obs_module_load関数内で、モジュール読み込み時に出しているログが無事出力されているか確認する。
無事コンパイルしてからOBSで動くまでの確認が出来ました。
あともうひと手間
無事動きましたが、このままではテンプレートをコピーした感が満載です。
名称などを自分の物に設定しましょう。
buildspec.jsonの編集
- ファイルの一番下にあるname以下のパラメータを適切自分のプラグインの名称に変更
- CmakeListsの更新
-
c++20の明示的な有効化
OBSのサンプルや解説では、c++20以降でしか使えない構造体の初期化がされている物が多くあります。
Visualstudio環境＋CMakeではデフォルトで使えない場合もあるので、以下で明示的に指定します。
- CMakeLists.txtに↓を追加する。
set(CMAKE_CXX_STANDARD 20)
まとめ
今回は簡単に導入部分だけに絞って解説を行いました。
時間があればグラフィックスに関わる部分も書こうと思います。