-
-
Notifications
You must be signed in to change notification settings - Fork 1
Using Plugins JP
このページは、MoleditPy プラグインを インストールして使う ユーザー向けのページです。プラグインを 開発 したい場合は、メイン app リポジトリの docs/PLUGIN_DEVELOPMENT_MANUAL_V4.md を参照してください — このページではプラグイン開発 API はあえて重複させていません。
MoleditPy のプラグインは、あなたの個人用プラグインフォルダに置かれる 1 つの Python ファイル(または小さなフォルダ/zip パッケージ)です。読み込まれると MoleditPy はそれを実行し、プラグインがどのエントリポイントを定義しているかに応じて、メニュー項目、エクスポート/解析アクション、新しい拡張子のファイルオープナー、3D 描画スタイル、ツールバーボタンを追加したり、起動時に自動実行されたりします。プラグインは実行中のアプリケーション(現在の分子、2D シーン、3D ビューア)に完全にアクセスできます — サンドボックス化はされていないため、信頼できる提供元のプラグインのみをインストールしてください(プラグインが問題を起こした場合の復旧方法は下記の セーフモード を参照)。
プラグインフォルダは以下の場所です:
-
Windows:
C:\Users\<あなた>\.moleditpy\plugins\ -
macOS/Linux:
~/.moleditpy/plugins/
(plugins/plugin_manager.py:self.plugin_dir = os.path.join(os.path.expanduser("~"), ".moleditpy", "plugins")。)このフォルダは必要になった時点で自動的に作成されます。各プラグインは以下のいずれかです:
-
plugins/直下に置かれた単一の.pyファイル、または -
__init__.pyを含むサブフォルダ(「パッケージ」プラグイン — 大型の公式プラグインのいくつか、例えば ORCA Result Analyzer はこの形式です)、または - インストール時にサブフォルダへ展開される
.zip。
すべてのプラグイン操作はメインウィンドウの Plugin メニューから始まります。Plugin ▸ Plugin Manager... を開くと、検出されたすべてのプラグインが表形式で一覧表示されます:Status、Name、Version、Author、Location(プラグインフォルダからの相対パス)、Description。
-
Status は色分けされています:緑色の Loaded(正常動作)、灰色の No Entry Point(ファイルに
initialize()/run()/autorun()のいずれも定義されておらず、何も起きなかった)、赤色の Error (Init): ... / Error (Autorun): ...(起動時にプラグインが例外を投げた。メッセージはその表のセルにそのまま表示され、同じ例外はログにも記録されます — 詳細を探す場所は Troubleshooting を参照)。 - Reload Plugins — プラグインフォルダを再スキャンし、すべてを最初から再実行します。MoleditPy を再起動せずに済みます。プラグインファイルを手動で編集/追加した後に使用します。
-
Open Plugin Folder — OS のファイルブラウザで
~/.moleditpy/plugins/を開きます。 - Remove Plugin — 行を選択してクリックすると、確認プロンプトの後にそのプラグインのファイル(パッケージプラグインの場合はフォルダ全体)を削除します。これは元に戻せません。
-
Explore Plugins Online — ブラウザで公式の Plugin Explorer を開きます。ここで全カタログを閲覧し、
.py/.zipをダウンロードして手動でインストールできます。 - 行をダブルクリックすると、そのプラグインの完全なメタデータ(名前/バージョン/作者/ステータス/場所/説明)がメッセージボックスで表示されます。
プラグインマネージャーのウィンドウ自体がドラッグ&ドロップに対応しています:.py ファイル、.zip アーカイブ、フォルダ(またはその __init__.py)をウィンドウにドロップし、表示される名前/作者/バージョン/説明/SHA-256 を確認すれば、プラグインフォルダにコピーされ、次回のリロードで読み込まれます。
GUI をまったく開かずに、コマンドラインからプラグインをインストールすることもできます:
moleditpy --install-plugin path/to/plugin.py
moleditpy --install-plugin path/to/plugin.zip
moleditpy --install-plugin path/to/plugin_folder/同じ名前/作者/バージョン/説明/SHA-256 のサマリーを表示し、ファイルを ~/.moleditpy/plugins/ にコピーする前にターミナルで y の確認を求めます。フラグの完全なリファレンスは Command-Line Options を参照してください。
プラグインが起動時に MoleditPy をクラッシュさせる場合や、デバッグのためにプラグインの有無を切り分けたい場合は、以下で起動します:
moleditpy --safeこれによりプラグイン検出そのものがスキップされます — plugin_manager は None のままになり、プラグインファイルは1つも読み取られません。このモードで Plugin ▸ Plugin Manager... を開いても、プラグイン一覧の代わりに「Plugins are disabled (safe mode)」という情報メッセージが表示されるだけです。問題のあるプラグインを特定して削除/修正したら、通常どおり起動し直してください。
個別の「無効化」トグルはありません — プラグインはプラグインフォルダに存在すれば(そして読み込まれ)、存在しなければそれまでです。削除するには:
- プラグインマネージャーの Remove Plugin を使う(ファイル/フォルダを代わりに削除してくれます)、または
-
~/.moleditpy/plugins/から.pyファイルやフォルダを手動で削除し、Reload Plugins をクリック(または MoleditPy を再起動)します。
MoleditPy の公式プラグインは、別リポジトリ moleditpy-plugins にあります。その REGISTRY/plugins.json ファイルが、Plugin Explorer と Plugin Installer プラグインの両方が参照する権威あるインデックスです。各レジストリエントリには、プラグインの id、表示名、現行バージョン、作者、一行説明、タグ、Python パッケージの依存関係、downloadUrl(moleditpy-plugins リポジトリ内の生ファイル、または大型プラグインの場合はプラグイン独自のスタンドアロンリポジトリのリリースアセット)、supported_python_version、supported_os が記録されています。
このコレクションからプラグインを入手する方法は 2 通りあります:
-
Plugin Explorer(ブラウザ) — https://hiroyokoyama.github.io/moleditpy-plugins/explorer/。プラグインマネージャーの Explore Plugins Online ボタンから直接アクセスできます。タグ/説明で閲覧し、
.py/.zipをダウンロードして、プラグインマネージャーのウィンドウにドラッグするか--install-pluginを使ってください。 -
Plugin Installer プラグイン — これ自体が公式プラグインの1つです(Official Plugins 参照)。インストールすると、
Plugin ▸ Plugin Installer...から、アプリを離れることなく MoleditPy の中から 更新確認とプラグインのインストール/更新ができます。同じplugins.jsonレジストリを取得し、インストール済みバージョンと比較し、インストール前に各ダウンロードの SHA-256 をレジストリと照合します(不一致の場合はインストールを強制的にブロックします)。取得は常にhttp/https経由のみです。
公式プラグインの全リスト(それぞれが何をするか、メニューのどこに現れるか、必要条件)については Official Plugins を参照してください。
プラグインは MoleditPy 自体と同じ権限で動作し、サンドボックス化はされていません — プラグインはファイルの読み書きやネットワークリクエストを行うことができ、(Python Console プラグインのような極端な例では)あなたが入力した任意のコードを実行することさえできます。信頼できるプラグインのみをインストールしてください:上記の公式コレクション、または独自に信頼性を確認したプラグインリポジトリ/作者のものです。問題の診断中にプラグインの関与を切り分けたい場合、--safe モード(§5)が問題がプラグイン関連かどうかを確認する最も速い方法です。
- Official Plugins — すべての公式プラグインの全カタログ
-
Command-Line Options —
--safeと--install-pluginの詳細 - Troubleshooting Common Issues — 読み込みに失敗したプラグインの診断
-
docs/PLUGIN_DEVELOPMENT_MANUAL_V4.md(メイン app リポジトリ)— プラグイン開発者向け