VSCodeでopenframeworksの開発環境構築

2024/05/28に公開

やること

  • openframeworksのダウンロード
  • 拡張機能インストール
  • フォーマッターの設定
  • テンプレートの修正

oFダウンロード

screenshot
公式サイトからopenframeworksをダウンロード

ダウンロードしたzipファイルを解凍し、適当な場所に配置します。

この記事では書類フォルダ直下に配置して進めます。

screenshot

OFのパスを設定

プロジェクトジェネレータを開いてみましょう。
screenshot

すると、以下のようなエラーメッセージが出るので、修正します。

エラーメッセージ全文

ACTION NEEDED: Running on macOS for the first time?

Please close the ProjectGenerator.app, move it up a level (or anywhere on HD) and then back into the projectGenerator/ folder.

If the OF path is not the root of the unzipped OF folder please set the OF path to this folder (ie, the folder which has "addons", "libs", in it)

screenshot

of_v0.12.0_osx_releaseフォルダをVSCodeで開きます。

screenshot

of_v0.12.0_osx_release/projectGenerator/projectGenerator.app/Contents/Resources/app/settings.jsonを修正する必要があるようです。

以下のように変更しましょう。

{
	"advancedMode": true, // trueに変更
	"defaultOfPath": "/Users/kanaru/Documents/of_v0.12.0_osx_release", // ofフォルダへの絶対パス
	"defaultPlatform": "osx",
	"defaultRelativeProjectPath": "apps/myApps",
	"showConsole": false,
	"showDeveloperTools": false,
	"useDictionaryNameGenerator": true
}

新規プロジェクトを作ってみる

これでとりあえず動く状態にはなりました。試しに新規プロジェクトを作ってみましょう。

TemplateにVisual Studio Codeを指定してGenerateをクリック。

screenshot

of_v0.12.0_osx_release/apps/myApps/mySketchが作られたら成功です。

mySketchフォルダをVSCodeで開いてみましょう。

右上のメニューから新規ターミナルを開いて、

screenshot

make Debug

でソースコードのビルド。

make RunDebug

でビルド結果の実行が出来ます。

グレーのウィンドウが表示されれば成功。

screenshot

拡張機能インストール

拡張機能タブに移動し、ms-vscode.cpptoolsで検索。

Installをクリック。

screenshot

VSCodeのエラーを解消

以下のようなエラーが出るので、解消。

screenshot

コンパイラパスを修正

mySketch/.vscode/c_cpp_properties.jsonの、"name": "Mac"と同じ階層にある"compilerPath"を実際のコンパイラのパスに修正します。

screenshot

includeの修正

"includePath""${workspaceRoot}/../../../libs/cairo/include/cairo"を追加

screenshot

フォーマッターの設定

VSCodeの設定を開き、Editor: Format On Saveにチェックを入れる。

screenshot

デフォルトのフォーマットルールでもいいですが、.clang-formatを作成し、独自のルールを定義することも出来ます。

参考 : Clang-Format Style Options

私の場合はGoogleのスタイルガイドをそのまま使っています。

screenshot

テンプレートの修正

これらの修正をプロジェクトを作るたびに行うのは手間なので、テンプレートを修正しましょう。

of_v0.12.0_osx_release/scripts/templates/vscodeを複製し、of_v0.12.0_osx_release/scripts/templates/customという名前にします。

custom/.vscode/c_cpp_properties.jsonに先程の修正を加えてください。

必要であればcustom/配下に.gitignore.clang-formatも作成出来ます。

また、scripts/templates/osx/srccustom/配下にコピーし、フォーマットしておくと、新規プロジェクト作成時にフォーマット済みのコードに出来ます。

Discussion