みずー工房

気ままライフを綴るブログです

【BlenderAPI】開発環境を用意しよう - Mac編

BlenderAPIの開発のために、VScodeを使った開発環境を用意しましょう!
Blender自身にエディタは付属していますが、日本語が入力できないなどの問題があるので導入をお勧めします。


Big Surについて
最新版のmacOS「Big Sur」では、今回導入する「pyenv」が通常通りに利用できないようです。
それらの回避方法について追記予定です。少々お待ちを...。
Windowsを利用している方
Windows編はこちらです。参考にどうぞ!



Blender用の開発環境を作ってみよう!

どうして開発環境が必要なの?

Blenderにはテキストが入力できるエリアがあります。
基本的には、そこで入力したPythonコードを実行する形になります。


けれども、ここで入力をするにはいくつかの問題があります。 1つは簡単に日本語が打てません。
プログラムする上で日本語を入力する機会はあまりありませんが、コメントできないのは不便です。
どうしても入力したい時は、メモ帳などで打ち込んだ内容をコピペするしかなさそうです。


他にも、別のエディタで使える便利なモジュール(例えばminimapとか)を追加したりはできないので、
Blender内部のエディタではなく、別のエディダで一度書いてからコピペするのをおすすめします。


導入の方針

Pythonの導入から行おうと思います。基本的にはこれらの流れで行います。
もしすでに環境が整っている場合は、適度にスキップしてください。
紹介する方法以外にも、別の環境や別のエディタで構成できると思います。臨機応変におねがいしますね!

  • パッケージ管理ツール「Homebrew」を導入する
  • Homebrew」を使って「vscode」と「pyenv」をインストールする
  • Python環境管理ツール「pyenv」を使って「Python」をインストールする
  • Pythonモジュール導入ツール「pip」を使って「fake-bpy-module」を導入する


もしかしたら「?」と思われているかもしれませんが、順を追って説明していくので大丈夫です。
図にするとこんな感じですね。

f:id:exe_3Z1K:20201224210403p:plain


「pyenv」と言う文字を見て「conda」の方が良いと思われる方もいるかもしれませんが、
私は安定して使えているので、今回はこれで導入させてください。condaでもできると思います。


Homebrewを導入する

Homebrewは、 既存ソフトをコマンドラインで導入できるパッケージ管理ソフトです。
通常は、Pythonインストーラーで導入することが普通かなと思うのですが、
いくつも環境を作ったりするとパスを通すのが面倒だったりするので、今回はこれを使います。


黒い画面に白い文字が苦手だ...というのはわかります。けど、絶対に便利なのでこっちに慣れましょー。
なお、個人使用の無償利用の場合は機能が制限されているようですが、全く問題ないです。


まずは、 「ターミナル」を開始します。

f:id:exe_3Z1K:20201224210428p:plain


次に「Homebrew」のページに行きます。
Homebrew (外部ページ)


利用規約等の内容も読みつつ、 コマンドをコピーします。
このコマンドをターミナルで実行します。コピペをしてEnterを押すとインストールを開始します。

f:id:exe_3Z1K:20201224210502p:plain


執筆時点ではこんな感じ。少し時間がかかるかもしれません。

Terminal
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"


エラー等が表示されていなければ、Homebrewの導入完了です。


Homebrew で vscode と pyenv-win を導入する

vscode」とは「Visual Studio Code」というテキストエディタ です。メモ帳の超拡張版と思ってください。
「pyenv」とは「Python」を管理してくれるソフト です。いろいろ便利なのでこちらを導入します。
後に pyenv を使って Python を導入します。


まずはHomebrewのアップデートを行います。
以下のコマンドを実行してみてください。

Terminal
$ brew update


次に、Visual Studio Codeをインストールしましょう。

Terminal
$ brew cask install visual-studio-code


次に、Visual Studio Codeをインストールしましょう。

Terminal
$ brew install --cask visual-studio-code


さらに、pyenvをインストールしましょう。

Terminal
$ brew install pyenv


pyenv で Python を導入する

pyenvでPythonを導入しましょう。まず、どのバージョンのPythonを導入するか選択します。
Blenderに付属しているPythonと同じバージョンを選ぶと良いと思います。
Pythonコンソールにバージョンが書かれてます。

f:id:exe_3Z1K:20201224210526p:plain


私のBlenderは「3.7.4」だったので、このバージョンのPythonを導入しようと思います。
さきほどのPowerShellから、以下のコマンドを実行します。導入したいバージョンは適宜変更してください。

Terminal
$ pyenv install 3.7.4


インストールが完了すれば、以下のコマンドからどのバージョンのPythonが入っているかを確認できます。

Terminal
$ pyenv versions


今の方法を使えば、別のバージョンのPythonも同時にインストールしておくことができます。
同じバージョンのPythonを共存させることはできませんので、注意を。


pyenvでバージョンを切り替えるコマンドは以下です。

Terminal
$ pyenv global 3.7.4


どのPythonを利用しているかを確認するコマンドは以下です。

Terminal
$ pyenv version


vscode で fake-bpy-module を利用する

「fake-bpy-module」を導入します。
現在導入したPythonは、BlenderPythonとは一切関係がありません。
Blender専用で提供されている bpy などをプログラムに記述すると「存在しません」とエラーが出ます。


「fake-bpy-module」は、Fakeを読み込んで存在しないエラーを出ないようにしてくれます。
なお Fake (嘘)なので、実行まではできません。


まずpip自体のアップグレードを行います。PowerShellで以下を実行してみましょう。

Terminal
$ pip install --upgrade pip


そして以下のコマンドを実行することで、導入することができます。
Blenderバージョンに合わせて、数字を変えてください。

Terminal
$ pip install fake-bpy-module-2.82


以上で全てが完了しました。



おわりに

お疲れ様でした。これでAPI開発がやりやすくなると思います。
書いたスクリプトを実行するには、vscodeからコピーしてBlenderに貼り付けてくださいねー


おすすめ記事