rocktakey / opensiv3d-linux-template

Template for OpenSiv3D project on Linux

LinuxにおけるOpenSiv3Dプロジェクトのテンプレート

このレポジトリは、OpenSiv3Dを利用したプログラムを、 Linuxでそのままビルドできるようにしておくためのテンプレートプロジェクトです。

• Siv3D: v0.6.5

使い方

GitHubレポジトリの作成

1. 「Use this template」を押下
2. 「Repository name」と「Descipion」(任意)を入力
3. 「Public」「Private」を選択
4. 「Create repository from template」を押下

Linuxでビルドする

1. 自分のプロジェクトをクローン(<username>と<your-project>は適宜自分のものに変えてください)

git clone https://github.com/<username>/<your-project>

2. 公式サイトを参考にSiv3D本体をビルド、インストール
3. エンジン(Linux/App/resources/engine/)をこのプロジェクトにコピーする
   1. OpenSiv3Dをクローン

   git clone https://github.com/Siv3D/OpenSiv3D /tmp/OpenSiv3D --depth=1

   2. エンジンをコピー(/path/to/project/は適宜自分のプロジェクトのクローン場所に変更)

   cd /path/to/project/
   mkdir resources
   cp -r /tmp/OpenSiv3D/Linux/App/resources/engine ./resources/engine

4. 自分のプロジェクトをビルドする
   1. プロジェクトのディレクトリに移る

   cd /path/to/project/

   2. ビルドの準備をする(ninjaでなくmakeを使うのであれば-GNinjaは不要)

   mkdir build && cd build
   cmake -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo ..

   3. ビルドする

   cmake --build build

5. 実行する(実行ファイル名は最初に変更した通りに変更)

./Siv3DExampleProject

CMakeLists.txtの書き換え

この項は必ずしも行う必要はないですが、公開するときにプロジェクトや実行ファイルの名前が独自のもののほうがかっこいいです。 また、複数ファイルにまたがる大きなプロジェクトとなるときには、対象を追加するために必要になります。

プロジェクト名の変更

• CMakeLists.txtの2行目のOpenSiv3D_Linux_Appという語を任意の名前に変更する。

実行ファイルの名前の変更

• CMakeLists.txtの全てのSiv3DExampleProjectという単語を任意の名前に置換する。

cppファイルの追加

• CMakeLists.txtの# Add cpp files here以降にcppファイルを追加する

トラブルシューティング

エディタや言語サーバーがSiv3Dをみつけられず、エラーを大量に表示してしまう

buildディレクトリで、以下のコードを実行してください

cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .. && cp compile_commands.json ../

これにより、ルートディレクトリにcompile_commands.jsonが生成されます。 このファイルはコンパイルに必要な情報を全て含むため、ライブラリやヘッダファイルの場所を エディタや言語サーバーに知らせることができます。