Blenderアドオン開発|bl_infoの書き方ガイド:絶対守るべきルール

Blenderでアドオン開発を始めたばかりの人が、必ず最初に出会うコード。 それが bl_info です。

この記事では、bl_info の正しい理解と、「これだけは外せない」というポイントを分かりやすくまとめます。


1. bl_info は“なくても動く”が、“書かないと困る”

結論から言うと、Pythonファイルに register()unregister() 関数さえ定義されていれば、Blenderはスクリプトとして読み込み、実行することができます。

つまり、bl_info がなくても

  • アドオンとして「インストール」はできる
  • ボタンを押せば「内部処理」は走る
  • 「パネルやボタン」も正常に表示される

一見、動作に問題はありません。しかし、実際に「ツール」として公開したり、数カ月後の自分がメンテナンスしたりするとなると、話は別です。


bl_info が無いと発生する「実害」

bl_info を記述しない、あるいは適当に済ませると以下のような致命的な問題が発生します。

  1. 管理不能
    アドオン一覧で名前が “Unknown” 表示になり、どれが自分の作ったものか分からなくなる。
  2. 信頼性の喪失
    作者情報が出ないため、ユーザーは「誰が作ったか不明な怪しいツール」として警戒する。
  3. 検索にヒットしない
    設定画面の検索窓に引っかからず、有効化すら困難になる。
  4. 互換性トラブル
    blender バージョン指定がないと、古いAPIで書かれたコードが最新版で暴走しても警告が出ない。
  5. 配布不可
    BOOTHなどで公開しても、バージョン管理ができないため「未完成品(品質不足)」として扱われる。

3. 初心者がまず覚えるべき bl_info のポイント

① “必須ではないが、公開するなら絶対必須”

「自分のPCで1回動かすだけ」なら不要ですが、誰かに渡す、あるいは将来の自分に渡すなら、これは「アドオンの戸籍」です。書かない選択肢はありません。

② 最小限の「黄金セット」を知る

まずは以下のテンプレートをコピペして書き換えることから始めましょう。

bl_info = {
    "name": "ツール名(日本語可)",
    "author": "あなたの名前(アドオン作成者)",
    "version": (1, 0, 0),
    "blender": (5, 0, 0),  # 最小動作保証バージョン(これ未満だと警告が出る)
    "location": "View3D > Sidebar > MyTab", # UIの場所を明記!
    "description": "何をするツールか一言で",
    "warning": "", # 開発中やバグなど、注意点があれば記述
    "doc_url": "https://...", # 👈 使い方マニュアルへのリンク
    "tracker_url": "https://...", # 👈 バグ報告先(GitHub等)へのリンク
    "category": "Object",
}

【早見表】各項目の役割と設定のコツ

項目名指す内容書き方のコツ・注意点
nameアドオンの正式名称設定画面で一番大きく表示されます。日本語もOK。
author作成者の名前誰が作ったかを示します。SNS名やGitHub名が一般的。
versionアドオンのVer.(1, 0, 0)形式。機能追加で数字を上げて管理します。
blender対応Blender Ver.必須。 指定未満のVer.で使うと警告(!)が出ます。
locationUIが表示される場所ユーザーが「どこにボタンがあるか」を知るための道標。
description機能の短い説明設定画面の一覧に表示されます。検索対象にもなります。
warning注意喚起・警告未完成(Beta版)や外部連携が必要な際などに使用。
doc_url公式マニュアルURL「Webサイト」ボタンとして設定画面に表示されます。
tracker_urlバグ報告用URL「バグを報告」ボタンとして表示されます。GitHub等が推奨。
category検索用カテゴリMesh, Object, Systemなど、既存の分類に従います。

③ “location” は「ユーザーへの地図」

初心者からの質問で最も多いのが、**「インストールしたけど、どこにボタンがありますか?」**です。 location 項目は単なるメモではなく、Blenderの設定画面でユーザーに表示される「公式ガイド」になります。

よく使う場所の記述テンプレ

  • 右側のサイドバー(Nパネル) "location": "View3D > Sidebar > [タブ名]"
  • オブジェクトの右クリックメニュー "location": "View3D > Object Context Menu"
  • プロパティパネル(モディファイア等) "location": "Properties > Modifier"
  • 上部メニュー(ファイルや編集など) "location": "TopBar > Edit > [項目名]"

④ バージョン表記のルール

(1, 0, 0) のように3つの数字で書きましょう。

  • 1つ目:メジャー(大規模更新・互換性なし)
  • 2つ目:マイナー(新機能の追加)
  • 3つ目:パッチ(バグ修正のみ)

⑤ 複数ファイル(フォルダ形式)のルール

アドオンが大きくなり、複数の .py ファイルをフォルダにまとめる場合は、フォルダ直下の __init__.py の冒頭に bl_info を記述します。Blenderはこのファイルを「アドオンの入り口」として真っ先に探しに行きます。


4. 「bl_info」の豆知識

  • blender 項目のヒミツ
    実は3つ目の数字はあまり厳密ではありません。例えば (4, 0, 0) と書けば「4.0.x 以上のBlenderならOK」という意味になります。
  • サポートの手間を減らすコツ
    doc_urltracker_url を設定しておくと、アドオン設定画面に「ドキュメント」と「報告」ボタンが自動で出ます。これだけで、DMやメールでの質問を減らすことができます。

まとめ

Blenderアドオンは bl_info が無くても動きますが、ユーザー管理・検索・バージョン管理のために実用上は必須です。「アドオンのプロフィールカード」を正しく書くことが、一流の開発者への第一歩です。

>KOJI REPORTへようこそ

KOJI REPORTへようこそ

当ブログでは日々起きた出来事や料理系の記事を面白可笑しく記載しています。日記がてら「Magic book diary(魔導書日記)」と称してるカテゴリも用意していますので是非みてくださいね♪では、当ブログを心行くままお過ごしください★

CTR IMG