開発者用ドキュメント

開発者用ガイド

概要

Marutoolsにはアドオンシステムがあり、アドオンを開発することは簡単なステップを踏むだけで良いようになっています。

チュートリアル

これは、アドオンを作成するためのチュートリアルです。

はじめよう

まず、大きなアドオンか小さなアドオンのどちらを作成するか選びます。 大きなアドオンは フォルダー内にいくつものPythonスクリプトを作成し(Pythonパッケージと同じ)、それらによって一つのアドオンを構成します。 小さいアドオンは 単一のPythonスクリプトのみで構成されます。 後で変更することもできますが、移行作業はいばらの道かもしれません。

現在、MarutoolsにはMarueditorのみが入っています。そのため、Marueditor向けアドオンのみ

これが基本のコードです:

 1class Edit():
 2    name=""
 3    description=""
 4    file_types=[""]
 5    def __init__(self, api):
 6        self.api=api
 7    def save(self, file=None):
 8        pass
 9    def new(self):
10        pass
11    def close(self):
12        pass

addon_base.py

class Edit
name: str

アドオン名

description: str

アドオンの説明文

file_types: list[str]

["txt","py", ....] のように書くことができます。

__init__(api)

ファイルを開く際に呼び出されます。self は一つのファイルに対して共有されます。

パラメータ

api (libmarusoftware.addon.AddonAPI) -- アドオンAPI。これを使用することで、UIや設定などを操作することができます。 後々のためにこれをインスタンス内に保持することをおすすめします。

save(file=None)

ファイルの保存時に呼び出されます。

パラメータ

file (str or None) -- "save as..." を選んだ時、ここにはファイルの新しいパスが来ます。

new()

新規ファイル作成時に呼び出されます。

close()

ファイルを閉じる際に呼び出されます。

__init__ 関数が実行されるとき、api オブジェクトが引数として渡されます。apiオブジェクトは多くのAPIを持っています。詳細は、 アドオンAPIのリファレンス をご覧ください。

Pythonと同じように書くことができます。良いコーディングを！！