OpenSiv3D | ライブラリの自前ビルド

2 min read読了の目安(約2100字

OpenSiv3D の自前ビルド

OpenSiv3D リポジトリのソースコードからライブラリを自前ビルドすると、以下のようなメリットがあります。

  • 未リリースのバージョンの最新機能を試すことができる
  • 内部コードを改造してライブラリをビルドできる
  • コンパイルオプションを変更してライブラリをビルドできる

一方で、自前ビルドにおいては以下の点に注意が必要です

  • リリース版でないバージョンのコードには未実装個所や不具合が残っている可能性が高い
  • 開発中のバージョンのコードにはプロジェクトテンプレートが付属しないため、Siv3D アプリケーションのプロジェクトに必要な engine 関連のファイルに差分がある場合、自前でファイルをコピーするなどして解消する必要がある

自前ビルドの手順

ソースコードのダウンロード

OpenSiv3D の公式 GitHub リポジトリ にアクセスします。最新の安定リリース版のソースコードは master ブランチに、最新の開発版 (v0.6) のソースコードは v6_winmac_develop (不安定) または v6_master (安定)ブランチにあります。

GitHub 上にある緑色の「Code」というボタンを押して、ZIP 形式でダウンロードするか、リポジトリのクローンを行い、使用しているコンピュータにソースコードを展開します。

Boost ライブラリの追加

OpenSiv3D の公式リポジトリからソースコードをダウンロードしただけでは、ビルドに必要ないくつかのライブラリが不足しています。現在のバージョンでは Boost ライブラリを OpenSiv3D/Dependencies/ フォルダに追加する必要があります。

v0.4.3 は Boost 1.72.0 を、v0.6 では Boost 1.73.0 を、一旦別の場所にダウンロードして展開します(コンピュータが対応している場合、7z 形式を選択すると ZIP 形式よりも高速です)。

そして、展開された boost_1_7x_0/ フォルダ内にある boost/ フォルダだけを、OpenSiv3D/Dependencies/boost_1_7x_0/boost/ という配置になるように、OpenSiv3D のプロジェクトにコピーします。これで準備は完了です。

ビルド

Windows の場合は OpenSiv3D/WindowsDesktop/OpenSiv3D.sln を、macOS の場合は OpenSiv3D/macOS/OpenSiv3D.xcodeproj を開くと、OpenSiv3D をビルドするプロジェクトが立ち上がります。あとは特に変更をせずビルドを実行するだけです。

ビルドしたライブラリを使ってアプリケーションのサンプルプログラムを動かしたい場合の手順は簡単です。Siv3D-Test というプロジェクトが同梱されており、そこに Main.cpp が含まれているので、それを書き換えるだけです。

既存の SDK ファイルを上書きする

ここからは、自前ビルドしたライブラリを既存・新規プロジェクトから利用したい場合の手順です。(注意: v0.4.3 を独自に改造した新しい v0.4.3 ライブラリファイルを既存の v0.4.3 プロジェクトで使いたいケースです。v0.4.3 を v0.6 で上書きすることはできません)

OpenSiv3D を自前ビルドすると、Windows の場合は Siv3D.lib (Release ビルド) および Siv3D_d.lib (Debug ビルド) が、macOS の場合は Siv3D.a が生成されます。これらの静的ライブラリファイルと、ビルドに使ったヘッダ (Siv3D/include/ フォルダ) を、すでにインストール済みの OpenSiv3D SDK 内のファイルの場所へ上書きすると、それを既存・新規プロジェクトから利用できます。

Windows の場合、インストールした OpenSiv3D SDK はインストール時に指定したフォルダ(デフォルトではドキュメントフォルダ)に展開されています。

この記事に贈られたバッジ