Getting started

はじめかた

Obsidian プラグインを入れて、Gemini API キーを設定し、はじめての掛け合いを見るまでの手順です。10 分ほどで終わります。

必要なもの

  • Obsidian 1.8.7 以降(Windows / macOS / Linux / iOS / Android)。API キーを Obsidian のシークレットストレージに保存するには 1.11.4 以降が必要です。
  • Google アカウント(Gemini API キーを作るため)。

Angel & Devil は、まだ Obsidian のコミュニティプラグイン一覧には載っていません。そのため、Obsidian の設定から名前で検索しても出てきません。下のどちらかの方法で入れてください。

インストール

おすすめ

方法 1: BRAT を使う

BRAT は、ベータ版のプラグインを GitHub から入れて自動で更新してくれるコミュニティプラグインです。Windows・macOS・Linux・iOS・Android のどれでも、Obsidian の中だけで完結します。

  1. Obsidian の 設定 → コミュニティプラグイン を開きます。制限モードがオンなら、オフにします。
  2. 閲覧 を押し、「BRAT」で検索してインストールし、有効化 します。
  3. 設定 → BRAT → Add Beta plugin を開きます。
  4. リポジトリに koooyooo/angel-and-devil-obsidian と入力して追加します(バージョンは最新のままで構いません)。
  5. 設定 → コミュニティプラグイン で Angel & Devil をオンにします。

以後の更新は BRAT が自動で行います。

BRAT を使わない場合

方法 2: 手動で入れる

ほかのプラグイン(BRAT)を入れたくない人向けです。パソコン(Windows / macOS / Linux)で行います。更新はリリースのたびに同じ手順でやり直します。

  1. 最新のリリースから angel-and-devil.zip をダウンロードします。
  2. zip を展開します。
    • Windows: zip を右クリック → すべて展開
    • macOS: zip をダブルクリック
    angel-and-devil というフォルダができ、その中に main.js・manifest.json・styles.css の 3 つが入っていれば OK です。
  3. Obsidian の 設定 → コミュニティプラグイン を開き、「インストール済みプラグイン」の横にあるフォルダのアイコンを押します。プラグインのフォルダ(<Vault>/.obsidian/plugins/)が開きます。
  4. そこへ angel-and-devil フォルダごと移します。次の形になれば正しい置き場所です。
    <Vault>/.obsidian/plugins/angel-and-devil/main.js
    <Vault>/.obsidian/plugins/angel-and-devil/manifest.json
    <Vault>/.obsidian/plugins/angel-and-devil/styles.css
  5. Obsidian に戻り、「インストール済みプラグイン」の横の再読み込みのアイコンを押してから、Angel & Devil をオンにします(制限モードがオンならオフにします)。

フォルダが見つからないとき: .obsidian は名前が「.」で始まるため、macOS の Finder では隠れています。Finder で Cmd + Shift + . を押すと表示されます。Windows のエクスプローラーでは通常どおり見えます。plugins フォルダがまだなければ、自分で作って構いません。

方法 3: インストールスクリプト(macOS / Linux、開発者向け)

ターミナルに慣れている人向けです。最新のリリースから 3 つのファイルを Vault に直接ダウンロードします。設定(data.json)は更新しても残ります。Windows では動きません(方法 1 か 2 を使ってください)。

curl -fsSL https://raw.githubusercontent.com/koooyooo/angel-and-devil-obsidian/main/install.sh \
  | sh -s -- /path/to/your/vault

バージョンを指定するときは、2 つめの引数に渡します(例: … | sh -s -- /path/to/your/vault 0.2.2)。実行したあと、設定 → コミュニティプラグイン で Angel & Devil をオンにします。

Gemini API キーを用意する

掛け合いは、あなた自身の Gemini API キーで Google の Gemini API を呼び出して作ります。作者のサーバーは通りません。

  1. Google AI Studio の API キーのページを開き、Google アカウントでログインして Create API key を押します。
  2. Obsidian の 設定 → Angel & Devil を開き、Gemini API キーにキーを貼り付けて 保存 を押します。
  3. キーを確認 を押し、「キーを確認できました。」と出れば準備完了です。

キーを安全に使うためにおすすめの設定

キーの保存場所や、ほかのプラグインから読めるかどうかは免責事項とプライバシーにまとめています。

はじめての掛け合い

  1. 掛け合わせたいノートを開きます。日記でも、読書メモでも構いません。
  2. ノートの右上(ヘッダー)にある 😇😈 ボタンを押します。左のリボンのアイコンや、コマンドパレットの「Angel & Devil: 掛け合いを開始」からも始められます。
  3. クリック・タップ・Space キーで 1 セリフずつ進みます。スキップ で全部表示、もう一度 で作り直し、ノート末尾に保存する でノートに残せます。

テキストを選んでから始めると、選んだ部分だけを読ませられます。掛け合いのあとには、下の欄からひとこと返すこともできます。

うまくいかないとき

コミュニティプラグインの一覧に Angel & Devil が出てこない

  • フォルダが 1 段深くなっていないか確認してください(plugins/angel-and-devil/angel-and-devil/main.js になっていると読み込まれません)。
  • フォルダの中に manifest.json があるか確認し、「インストール済みプラグイン」の再読み込みアイコンを押すか、Obsidian を再起動してください。
  • 別の Vault のフォルダに入れていないか確認してください(Vault ごとに .obsidian があります)。

😇😈 ボタンが見当たらない

  • Markdown のノートを開いているか確認してください。プラグインがオンになっていれば、リボンのアイコンやコマンドパレットからも始められます。

「API キーが正しくないようです」と出る

  • キーの前後に余計な空白が入っていないか確認し、貼り付け直して 保存 → キーを確認 を押してください。
  • キーの使い道を絞っている場合は、Generative Language API が許可されているか確認してください。

「利用の上限に達しました」と出る

  • 無料枠の回数制限か、設定した利用上限に達しています。少し待つか、Google AI Studio → Usage で状況を確認してください。

スマートフォンで入れたい

  • モバイルでは手動のインストールはほぼできません。方法 1(BRAT)を使ってください。

解決しないときは、GitHub の Issues で教えてください(API キーは貼らないでください)。

更新と削除

  • BRAT で入れた場合: 自動で更新されます。
  • 手動で入れた場合: 新しいリリースの 3 つのファイルで上書きし、プラグインを一度オフにしてからオンにします。設定(data.json)はそのまま残ります。
  • 削除: 設定 → コミュニティプラグイン で アンインストール を押します。API キーも消したいときは、先に 設定 → Angel & Devil で 削除 を押してください。記憶をオンにしていた場合、記憶のフォルダ(初期値 _angel_and_devil/)は普通のノートとして Vault に残るので、不要なら手で消します。