開発環境の構築
必要な環境
OpenXOPSの開発には、「Visual Studio」(Visual C++、詳細は後述)と「DirectX SDK」の2つが両方とも必要です。工夫次第で、他の環境やライブラリで代用可能な場合もありますが、このページでは Visual Studio と DirectX SDK を揃えることを中心に説明します。
番外ながら「BorlandC++ Compiler」と「DirectX SDK」を組み合せて利用する方法も説明しますが、基本的には Visual Studio の使用を推奨します。
後述の通りソフトウェアのインストールを要するため、管理者権限でインストールできるPCである必要があります。また、後述の無料版を利用する場合でも、Microsoftへのアカウント登録が必要なため、メールアドレスが必須です。
(一部 大学や専門学校では、授業で使用するためにインストール・環境構築済みのPCがあるかもしれません。)
「開発・技術資料」ページで解説している通り、OpenXOPSは以下の環境で開発しています。
OS : Windows10 Pro (64ビット)
開発環境 : Microsoft Visual Studio 2019
使用SDK : Microsoft DirectX SDK (June 2010)
基本的には、上記の環境と同じ環境を用意すれば、OpenXOPSをコンパイル可能です。それ以外のゲームエンジンや処理ライブラリは、基本的に必要ありません。
※上記環境以外での開発・コンパイルが不可能なわけではありません。
このページでは、以下を組み合せて利用する方法を紹介します。
・Visual C++ 2010 と DirectX SDK (June 2010)
・Visual Studio 2019 と DirectX SDK (June 2010)
・BorlandC++ Compiler 5.5 と DirectX SDK
ただし、具体的なインストール手順や詳細な利用方法に関する説明は省略します。他の文献を当たってください。
また直接コンパイルとは関係ないものの、Doxygenの構築についても簡単に解説します。
各ソフトウェア・パッケージの概要
Visual Studio (Visual C++)
Visual Studioは、Microsoftが開発している総合開発環境です。プログラミング環境と解釈しても間違いではありません。
Visual Studioは、数年ごとにバージョンアップされており、同一年のバージョンでもエディション(種類)があります。殆どのエディションは有料ですが、「Express Edition」「Community」ならば無料で使用できます。OpenXOPSをコンパイルするには無料版の Express Edition / Community で十分です。ただし、30日以上使用する場合は別途アカウント登録が必要です。(無料)
本来Visual Studioは多数のプログラミング言語に対応していますが、Express Edition に限り、プログラミング言語ごとに個別に配布されています。Visual Studio Express Editionの C++ 版は「Visual C++ Express Edition」と呼ばれています。
なお、ご自身が学生で個人での非商用目的でのみ利用する場合、Microsoftの「Microsoft Imagine」(旧:DreamSpark)が利用できる場合があります。一般には有料で提供・販売されている一部エディションが(学生に限り)無料で入手できる制度ですが、詳細は割愛します。
このページでは、無料版の Express Edition / Community を利用する前提で「Visual C++ XXXX」「Visual Studio XXXX」(XXXXはバージョン・開発年)と呼称します。
BorlandC++ Compiler
BorlandC++ Compilerは、ボーランドが開発していたC++用コンパイラです。
2000年3月から個人利用に限り、バージョン 5.5 が無料で公開されています。ダウンロード時にユーザー登録が必要な上、ダウンロードしたファイルを解凍するためのパスワードをメールアドレスで受信する必要があります。
このページでは、無料で公開されている「BorlandC++ Compiler 5.5」のみを解説対象とします。
DirectX SDK
DirectX SDKとは、同じくMicrosoftが無料で公開しているSDK(ソフトウェア開発キット)の1つで、DirectXプログラムを作成するために必要なライブラリなどを含んでいます。
DirectX SDKも、過去には数ヵ月ごとにバージョンアップされており、各バージョンは「February 2007」のように年月で表されています。2022年10月時点で、最新版は2010年6月に公開された「June 2010」です。
構築方法の比較
●Visual C++ 2010 と DirectX SDK (June 2010)
利点:
Windows8.1を正式にサポートしている。
欠点:
発表が比較的古く、開発環境自体も最新ではない。
Microsoftは「予告なく削除(=公開終了)する場合がある」とアナウンスしている。
コンパイルするごとに、数十MB〜100MBほどの巨大なファイルが自動生成される。
作成した実行ファイルが、Windows2000で動作せずWindowsXP以降が必要になる。
開発環境が多機能・複雑で、使い方を覚え操作に慣れるのが大変。
●Visual Studio 2019 と DirectX SDK (June 2010)
利点:
三択の中では、最も新しい組み合わせ。
OpenXOPS開発のメインに使用しており、動作が確実。
2022年現在で公式に入手可能。
Windows8.1/10/11を正式にサポートしている。
欠点:
古いRevのOpenXOPSを使用する場合、エラーでコンパイルできない場合がある。(R290以下)
コンパイルするごとに、数百MBほどの巨大なファイルが自動生成される。
作成した実行ファイルが、Windows2000で動作せずWindowsXP以降が必要になる。
開発環境が多機能・複雑で、使い方を覚え操作に慣れるのが大変。
●BorlandC++ Compiler 5.5 と DirectX SDK
利点:
必要な物を全てインストールしても、全容量が少なく軽い。
氏名・住所・メールアドレス 程度の情報を入力するだけで使用できる。(アカウント作成は不要)
BCC Developer(後述)は、シンプルで使いやすい。
欠点:
ライセンス上、個人利用に限られている。
開発元が一切のサポートを提供してくれない。
2000年3月に公開され、開発環境が非常に古い。
Visual C++に対して、動作にわずかな差が発生する。
Visual C++と比べ、高度なデバック(開発)機能がない。
【方法:その1】 Visual C++ 2010 と DirectX SDK (June 2010)
本節では、Visual C++ 2010 と DirectX SDK (June 2010) を入手し構築する方法について解説します。
前で触れた通り、OpenXOPSの開発には Visual Studio 2019 と DirectX SDK (June 2010) を使用していますが、既に Visual C++ 2010 をお持ちの方は、OpenXOPSを Visual C++ 2010 でコンパイルすることもできます。
Visual C++ 2010でコンパイルしたプログラムは Windows 2000 で動作させることができず、動作に Windows XP 以降の環境が必要になります。
Windows 2000 も動作対象に含める場合は、Visual C++ 2008 を使ってください。
Visual C++ 2010
無料版のVisual C++ 2010 Express Editionは、以下の公式サイトから入手してください。
・Visual Studio のダウンロード
・Webインストール版 直リンク
・オフライン(DVD)インストール版 直リンク
DirectX SDK (June 2010)
DirectX SDK (June 2010) は、以下の公式サイトから無料で入手できます。
・DirectX Software Development Kit(英語)
DirectX SDK (June 2010) のインストーラーには不具合があり、インストール時に既に新しい「Visual C++ 2010 再頒布可能パッケージ」(Visual C++ 2010 Redistributable Package)が入っていると、エラー:S1023でSDKのインストールに失敗します。
VC++2010をインストールする前に先に DirectX SDK (June 2010) をインストールするか、あるいは一度新しいVisual C++ 2010 再頒布可能パッケージを削除してから DirectX SDK (June 2010) をインストールし、後からVisual C++ 2010 再頒布可能パッケージの最新版を再度インストールするしかありません。
プロジェクトファイルの設定
Visual C++ 2010上でプロジェクトファイルを作成してください。
作成後、プロジェクトファイルが生成されたディレクトリに、OpenXOPSのソースファイル群を全て移動してください。
次に、Visual C++ 2010画面内(ソリューションエクスプローラー)にファイルを追加します。「ソース ファイル」に全ての.cppファイル、「ヘッダー ファイル」に全ての.hファイル、「リソース ファイル」にresource.rcを追加してください。 なお icon.icoファイル は同じディレクトリに置いてあれば十分であり、Visual C++ 2010上に追加する必要はありません。
メニュー[プロジェクト]→[プロパティ]を開き、プロジェクトファイルの一部設定項目を変更する必要があります。
Debug | Release | |
---|---|---|
文字セット | マルチバイト文字セット | マルチバイト文字セット |
ランタイム ライブラリ | マルチスレッド デバック(/MTd) | マルチスレッド(/MT) |
加えて、同プロパティ内で DirectX SDK を使用するための設定も行ってください。
※DirectX SDKはインストールが完了しただけでは利用できません。
・インクルード ディレクトリ:「$(DXSDK_DIR)include;」を追加
・ライブラリ ディレクトリ:「$(DXSDK_DIR)lib\x86;」を追加
64bit-OSをお使いの場合でも DirectX SDK のLibファイルはx86(32bit)を使用してください。x64を指定するとエラーになります。
使用方法
Visual C++ 2010 のファイルの編集方法やコンパイル方法などは、各自で確認してください。Visual C++ 2010の詳細な使い方まで解説するのは、本ページの内容から大きく外れるので割愛します。使い方を解説した専門書や情報サイトもあるので、不明な点は他の文献を当たってください。
DebugモードとReleaseモードを切り替えて使用することを強くお勧めします。詳しい使い分けの解説は省略します。
DirectX SDKには様々なサンプルや開発用ツールが入っていますが、OpenXOPSをコンパイルする上では(SDKを)直接触る必要はありません。
【方法:その2】 Visual Studio 2019 と DirectX SDK (June 2010)
本節では、Visual Studio 2019 と DirectX SDK (June 2010) を入手し構築する方法について解説します。
Visual Studio 2019
無料版のVisual Studio Community 2019は、以下の公式サイトから入手してください。
・Visual Studio Toolsのダウンロード
・Visual Studio 2019 リリースノート
インストール時には「C++によるデスクトップ開発」と「C++によるゲーム開発」を有効にする必要があります。
DirectX SDK (June 2010)
DirectX SDK (June 2010) は、以下の公式サイトから無料で入手できます。
・DirectX Software Development Kit(英語)
プロジェクトファイルの設定
Visual Studio 2019上でプロジェクトファイルを作成してください。テンプレートは「Windowsデスクトップウィザード」を選択し、アプリケーションの種類では「デスクトップアプリケーション(.exe)」、かつ「空のプロジェクト」にチェックマークを入れます。
作成後、プロジェクトファイルが生成されたディレクトリに、OpenXOPSのソースファイル群を全て移動してください。
次に、Visual Studio 2019画面内(ソリューションエクスプローラー)にファイルを追加します。全ての.cppファイルと.hファイル、resource.rcを追加してください。
メニュー[プロジェクト]→[プロパティ]を開き、プロジェクトファイルの一部設定項目を変更する必要があります。
Debug | Release | |
---|---|---|
文字セット | マルチバイト文字セット | マルチバイト文字セット |
ランタイム ライブラリ | マルチスレッド デバック(/MTd) | マルチスレッド(/MT) |
加えて、同プロパティ内で DirectX SDK を使用するための設定も行ってください。
※DirectX SDKはインストールが完了しただけでは利用できません。
・インクルード ディレクトリ:「$(DXSDK_DIR)include;」を追加
・ライブラリ ディレクトリ:「$(DXSDK_DIR)lib\x86;」を追加
64bit-OSをお使いの場合でも DirectX SDK のLibファイルはx86(32bit)を使用してください。x64を指定するとエラーになります。
Releaseモードにおいては、デバック情報の生成 を「いいえ」に設定することを推奨します。
使用方法
Visual Studio 2019 の使用方法は、各自で調べてください。使い方を解説した専門書や情報サイトもあります。
【方法:その3】 BorlandC++ Compiler 5.5 と DirectX SDK
OpenXOPSでは、Microsoftの Visual C++ を使用した開発を推奨しますが、一応 BorlandC++ Compiler を用いて開発することもできます。
本節では、BorlandC++ Compiler と DirectX SDK を入手し構築する方法について解説します。
BorlandC++ Compiler 5.5
ボーランド(現:エンバカデロ)が開発した BorlandC++ Compiler 5.5 は、以下のサイトから無料で入手できます。
ただし、ダウンロード時にユーザー登録を行う必要があり、ファイル群の解凍に必要なパスワードをメールアドレスで受信する必要があります。
・BorlandC++ Compiler 5.5
ページ内の「C++コンパイラの入手方法」の手順に従ってください。
BorlandC++ Compiler 5.5 はコンパイラ単体であり、Visual C++ のようなエディタは付属していません。BorlandC++ Compiler 5.5 に対応した開発環境として Jm(三浦淳)氏が開発した「BCC Developer」を利用します。
なお、BorlandC++ Compiler 5.5 単体でも利用できます。コンソール環境でコンパイルを行う場合は、BCC Developer は不要です。
BCC Developer は、以下のサイトから無料で入手できます。
・BCC Developer
ページ内の「Download」にある「BCC Developer 1.2.21 (2004/7/3) - bccdev1221.lzh (1095KB)」です。
BorlandC++ Compiler 5.5 はインストーラーですが、BCC Developer はファイルを解凍するだけでインストール完了です。
DirectX SDK (February 2007)
DirectX SDK (February 2007) は、以下の公式サイトから無料で入手できます。
・DirectX Software Development Kit(英語)
Microsoftから提供されている DirectX SDK は、Visual Studio(Visual C++)用に提供されているパッケージであるため、そのまま BorlandC++ Compiler では使用できません。
DirectX SDK を BorlandC++ Compiler で読み込めるよう自前で書き換え・変換することもできるようですが、Alexey Barkovoy氏が作られた「DirectX libraries for C++Builder」を利用する手段を紹介します。
・C++Builder resources(英語)
ページ内の「DirectX libraries for C++Builder」にある「CBuilder_DX92_libs.zip」です。
設定ファイルの作成
インストールを経て、上記のファイル群が以下のディレクトリに配置・作成された前提で解説します。お使いの環境と異なる場合、適宜読み替えてください。
対象 | ディレクトリ |
---|---|
BorlandC++ Compiler 5.5 | C:\borland\bcc55 |
BCC Developer | ディスクトップ |
DirectX SDK (February 2007) | C:\Program Files\Microsoft DirectX SDK (February 2007) |
DirectX libraries for C++Builder | C:\CBuilder_DX92_libs |
BorlandC++ Compiler 5.5 には、別途設定ファイル(テキストデータ)を作成し、インクルードファイルなどのディレクトリを指定する必要があります。
以下のようなファイルを「C:\borland\bcc55\Bin」に作成します。
-I"c:\borland\bcc55\Include" -I"C:\Program Files\Microsoft DirectX SDK (February 2007)\Include" -L"c:\borland\bcc55\Lib;c:\borland\bcc55\Lib\PSDK" -L"C:\CBuilder_DX92_libs" |
-L"c:\borland\bcc55\Lib;c:\borland\bcc55\Lib\PSDK" -L"C:\CBuilder_DX92_libs" |
使用方法
BCC Developer を用いて開発できます。BCC Developer の詳しい使い方は、書籍や情報サイトを参考にしてください。
以下、間違えやすい要点だけ解説します。
初回起動時に「環境設定」ダイアログが表示されます。コンパイラには BorlandC++ Compiler 5.5 をインストールしたディレクトリにある \Bin\bcc32.exe を指定します。
プロジェクトを作成した後、OpenXOPSの全ての .cppファイル と .hファイル を追加してください。ただし resource.rc ファイルは取り込めません。出力する実行ファイルやウインドウにアイコンを設定するには、メニュー[プロジェクト]→[リソーススクリプトファイル]を選び新規作成し、resource.rcファイルの内容を手動でコピー・ペーストしてください。
メニュー[プロジェクト]→[プロジェクト設定]を開き、(最初に表示されている)アプリケーションタブのターゲットで、「Windowsアプリケーション (-W)」が選択されていないとコンパイルエラーになります。
【参考】 Doxygenの構築
Doxygen(ドキシジェン)は、ソースコード内の記述を元にドキュメントを生成する ドキュメンテーション・システム です。OpenXOPSのソースコードに記述されているプログラムを元に、ブラウザで観覧可能なドキュメントを自動で生成します。
開発者に対してプログラムの可読性を確保するために使用する物で、OpenXOPSのコンパイルには直接関係ありません。Doxygenを利用しなくても、開発することは可能です。しかし、関数の引数や戻り値などをブラウザ上で確認できるなど、構築する利点はそれなりにあると思います。
基本的な使用方法 (入手・設定など)
Doxygenの最新版は、以下の公式サイトから無料で入手できます。
・doxygen Downloads(英語)
ページ内の「A binary distribution for Windows」から入手してください。
OpenXOPSで使用しているのは 1.8.9.1 ですが、(全く同一のバージョンでなくても)近いバージョンであれば問題なく動作すると思われます。
いくつかのドキュメント生成方法があります。
今回はVisual C++を設定し、コンパイル時に毎回自動的にドキュメントを出力する方法を紹介します。
上記でダウンロードしたDoxygen(本体)を、プロジェクトファイルのあるディレクトリに配置します。
次に、Doxygenの設定ファイルを用意します。SourceForge.JPのプロジェクトページから入手する(doxygen.conf)か、各自で用意してください。設定ファイルもプロジェクトファイルのあるディレクトリに配置します。以下、設定ファイル名が「doxygen.conf」である前提で説明します。
Visual C++で、メニュー[プロジェクト]→[プロパティ]を開き、「ビルドイベント」のビルド後に実行するコマンドラインを以下のように設定します。
doxygen doxygen.conf |
ファイルの配置やプロジェクトファイルの設定を誤っていなければ、Visual C++でコンパイルを実施するたびに、常に最新のドキュメントが生成されます。
SourceForge.JPのプロジェクトページから入手した設定ファイルを使っている場合、プロジェクトファイルのディレクトリ内にある /doc/html/ に生成されます。同フォルダ内にある index.html をWEBブラウザで開いてください。(どこかにショートカットを作っておいても良いかもしれません。)
応用方法
別途Graphvizを入手して組み合わせれば、クラスの継承関係の図も生成できます。
Doxygenの詳しい使用方法は、公式ドキュメントや解説サイトをご覧ください。