前提条件
アドオン SDK を使用して開発を行うには、以下が必要です。
-
Python 2.5、2.6 または 2.7。Python バージョン 3.0 と 3.1 はサポートされていません。環境変数 PATH に Python のパスを設定してください。
-
Firefox
-
SDK 本体。最新の安定したバージョンの SDK は、tarball または zip ファイル として入手できます。あるいは、最新の開発バージョンを GitHub リポジトリから入手することもできます。
Mac OS Xでの Homebrew を使ったインストール
アドオン SDK を Homebrew を用いてインストールするには、以下のコマンドを実行してください。
brew install mozilla-addon-sdk
Mac OS X / Linux でのインストール
shell や commnd prompt を用いて、任意の場所にアドオン SDK のファイルを展開し、SDK のルートディレクトリに移動してください。以下はコマンドの一例です。
tar -xf addon-sdk.tar.gz cd addon-sdk
次に、 Bash を使用している場合は以下を実行します。
source bin/activate
Bash 以外を使用している場合は、以下を実行します。
bash bin/activate
コマンドプロンプトの先頭に、SDK のルートディレクトリ名が追加されます。
(addon-sdk)~/mozilla/addon-sdk >
Windows でのインストール
shell や commnd prompt を用いて、任意の場所にアドオン SDK のファイルを展開し、SDK のルートディレクトリに移動してください。以下はコマンドの一例です。
7z.exe x addon-sdk.zip cd addon-sdk
次に、以下を実行します。
bin\activate
コマンドプロンプトの先頭に、SDK のルートディレクトリ名が追加されます。
(C:\Users\mozilla\sdk\addon-sdk) C:\Users\Work\sdk\addon-sdk>
SDK 仮想環境
上記のようにコマンドプロンプトが変更されていれば、シェルで仮想環境が起動し、アドオン SDK コマンドラインツールにアクセスできます。
仮想環境は deactivate
を実行していつでも終了することができます。
仮想環境は、そのコマンドプロンプトにおいてのみ有効です。コマンドプロンプトを閉じると仮想環境が終了するので、再び仮想環境を起動するには、新しいコマンドプロンプトを起動し source bin/activate
または bin¥activate
と入力する必要があります。新しいコマンドプロンプトを開くだけでは、SDK は起動されません。
ディスク上の異なる場所に SDK の複数のコピーを置き、切り替えて使用することもできます。さらには、別個のコマンドプロンプトで、それぞれのコピーを同時に起動することも可能です。
activate
永続化
activate
が行う処理は単に、最上位レベルの bin
ディレクトリにあるスクリプトを使用して、現在のコマンドプロンプトに関する複数の環境変数を設定することだけです。そこで、使用する環境でこれらの変数が永続化されるように設定すれば、新しくコマンドプロンプトを開くだけでそれらの変数が読み込まれ、仮想環境が常に使用できます。これにより、新しいコマンドプロンプトを開くたびに activate
と入力する必要がなくなります。
ただし、コマンドプロンプトに関する変数が、新しい SDK のリリース時に変更されることがあります。設定が必要な変数を特定するために SDK の起動スクリプトを参照するのが最良の方法です。 Bash 環境(Linux および Mac OS X)と Windows 環境では、起動に使用するスクリプトも、それによって設定される変数も異なります。
Windows
Windows では、 bin\activate
を実行すると activate.bat
が使用されます。SDK を常に有効にするには、コマンドラインから
setx
ツールを使用するか、コントロール パネルを使用します。
Linux/Mac OS X
Linux および Mac OS X では、 source bin/activate
により activate
Bash スクリプトが実行されます。SDK を常に有効にするには、Linuxの場合は ~/.bashrc
を、Mac OS Xの場合は ~/.bashprofile
を使用します。
あるいは、‾/bin
ディレクトリにある cfx
プログラムへのシンボリックリンクを作成する方法もあります。
ln -s PATH_TO_SDK/bin/cfx ~/bin/cfx
サニティチェック
シェルプロンプトで以下を実行します。
cfx
一行目には以下のように表示されるでしょう。それに続いて、多数の使用方法の情報が表示されます。
Usage: cfx [options] [command]
これが cfx
コマンドラインプログラム です。cfx
は、アドオン SDK の主要なインターフェイスで、Firefox の起動とアドオンのテスト、アドオンを配布するためのパッケージング、説明書の表示、および単体テストの実行に使用します。
問題が発生した場合
トラブルシューティング のページを参照してください。
次のステップ
cfx 入門のチュートリアルに目を通してください。cfx
ツールによってアドオンを作成する方法を説明します。