2019年9月26日

サクラエディタをPapyrusに対応させる辞書ファイル配布

私はサクラエディタのファンです。何より名前が好きです。
Papyrusもずっとサクラエディタで書いていて、補助的な機能もいくつか使っています。

そこで今回は、色分けや入力補完、ポップアップヘルプ等の機能を使うための辞書ファイルを配布します。
サクラエディタのファンの方も、今から使おうと思っていた方も、ダウンロードしてご自由にお使いください。またマニアックなものを…とか思われそうですが気にしない。

※2019/09/26 version 0.3 に更新。一部のキーワードヘルプが表示されない点を修正しました。

目次

  1. ダウンロード
  2. サクラエディタのインストール
  3. Papyrus辞書の導入
  4. 各機能の使い方
  5. 補記
  6. 対応ツールおよびMOD
  7. 更新履歴

1. ダウンロード (uploader.jp)

SakuraEditor-PapyrusForSkyrim_0-30.zip

zipの中には以下のファイルが入っています。

  • "Papyrus" フォルダ
    • Papyrus.ini … 導入時に指定する設定ファイル
    • Papyrus_Color-Dark.col … カラー（ダーク）
    • Papyrus_Color-Light.col … カラー（ライト）
    • Papyrus_Help.khp … キーワードヘルプ
    • Papyrus_Outline.txt … アウトライン解析
    • Papyrus_Supplement.txt … 入力補完機能
    • Papyrus_Supplement-Base.txt … 入力補完機能（バニラ・SKSE限定）
    • Papyrus1.kwd … 強調キーワード1
    • Papyrus2.kwd … 強調キーワード2
  • readme.txt

2. サクラエディタのインストール

2-1. ダウンロード

サクラエディタは以下のウェブサイトからダウンロードできます。

ダウンロードファイルが複数あるので、おすすめを書いておきます。
最初にインストーラパッケージでインストールして、exeを最新版に上書きする方法です（LE版スカイリムの日本語化みたい）。

まずトップページから 簡易ダウンロード > インストーラパッケージダウンロード へ移動します。

パッケージダウンロード > V2(Unicode版) > 最新版ダウンロード sakura_install2-2-0-1.exe (2.2.0.1) からインストーラパッケージをダウンロードします。

トップページに戻り、詳細ダウンロード > GitHub Sakura Editor Releases へ移動します。

Ver2.3.2.0 (Unicode版) > sakura2-3-2-0.zip から最新版のexeをダウンロードします。

2-2. インストール

まずインストーラパッケージを使って通常通りの方法でインストールします。設定がいくつか出てきますが、デフォルトのままで構いません。
そして "sakura2-3-2-0.zip" から "sakura.exe" を取り出し、"C:\Program Files (x86)\sakura\sakura.exe" に上書きします。
これでインストールは完了です。

目次に戻る

3. Papyrus辞書の導入

3-1. "Papyrus" フォルダのコピー

配布したzipを解凍し、"Papyrus" フォルダを "sakura.exe" と同じ階層にコピーします。
通常は "C:\Program Files (x86)\sakura\Papyrus" となります。

3-2. 設定のインポート

サクラエディタを起動し、設定 > タイプ別設定一覧 (Ctrl + 4) を開きます。Papyrus用のタイプを新規作成するために「追加」ボタンを押します。

一番下に新しいタイプが作成されますので、「設定変更」から名前を「Papyrus」に変更します。

OKを押すと設定画面が閉じるので、もう一度タイプ別設定一覧 (Ctrl + 4) を開きます。作成したPapyrusタイプに、設定項目をインポートします。
「インポート」ボタンを押して "Papyrus\Papyrus.ini" を選択してください。

確認メッセージが出ますので、読込先を「Papyrus」にして「OK」ボタンを押します。

これで 導入完了 です。

必要な設定はすべてやっておきましたので、サクラエディタでpscファイルを開けば自動的に適用されます。簡単ですね！

フォントは初期設定でメイリオを指定してあります。等幅フォントなどに変更したい場合は、タイプ別設定 (Ctrl + 5) > スクリーン タブから行ってください。

3-3. 更新作業

辞書を新しいバージョンへ更新するときは、以下の手順で行ってください。

  1. 最新版のzipを解凍し、"Papyrus" フォルダを既存のものに上書きする。
  2. 設定 > 共通設定 (Ctrl + 6) > 強調キーワード で「Papyrus2」を表示し、インポート から "Papyrus2.kwd" を指定する。

目次に戻る

4. 各機能の使い方

4-1. 入力補完機能

先頭文字をいくつか入力して「Ctrl + Space」を押すと補完候補が出ますので、「↑」「↓」で選択して「Enter」を押せば補完されます。後述のキーワードヘルプも脇に表示されます。
入力文字を増やせば候補が絞られていきますし、初めから候補が1つの場合は即時補完されます。

特殊な補完候補として、以下の7種のスクリプトはそれに続く関数も含めて候補が出ます。

Debug. / Game. / Input. / Math. / SKSE. / StringUtil. / Utility.

これらのスクリプトで関数も含めて補完する際は、ドット「.」を入力する前までの文字列で候補を選んでください。
例えば「game」と打つとGame関数一覧が出ますが、「game.」とドットまで入れると、関数の候補は出なくなります。

これは、サクラエディタの入力補完機能が記号を区切りと認識する仕様のためです。関数のみでも候補は出るようにしてありますので、状況に応じて使い分けてください。

それから、候補には「編集中のファイルにある文字列」も出るように設定してあります。プロパティ名や変数名を繰り返し用いる際、スペルミスを防ぐためにご利用ください。

SKSEプラグインMODの補完候補は、初期設定ではすべて出るようになっています。
バニラおよびSKSEの補完候補のみに限定したいときは、タイプ別設定 (Ctrl + 5) を開いて、支援 タブの 単語ファイル で「(1)」ボタンから "Papyrus_Supplement-Base.txt" を指定してください。候補数が7割弱に絞られます。

4-2. キーワードヘルプ

関数を選択状態にする（ダブルクリックで可）と、引数と属性がポップアップ表示されます。引数の数や規定値などを確かめることができます。
SKSEやプラグインMODで追加される関数の場合には、それも併記されます。

4-3. アウトライン解析

「F11」キーを押すと「State」や「If」等の位置を解析して一覧表示します。

一覧から行をダブルクリックするか「ジャンプ」ボタンを押すことで、その行に移動できます。

解析は文字列で判定していますので、階層構造を上手く再現できないことがあります。例えば If の入れ子は再現できません。

4-4. カラーの変更

デフォルトではライトカラー（白背景）になっていますが、ダークカラー（黒背景）も用意しておきました。

変更したい場合は、タイプ別設定（Ctrl + 5）を開き、カラー タブの「インポート」ボタンから "Papyrus_Color-Dark.col" を指定してください。
ライトカラーに戻したい時は "Papyrus_Color-Light.col" を指定してください。

4-5. スクリプトのコンパイル

スクリプトはCKでコンパイルしても良いのですが、以下のようにすれば、サクラエディタから行うことが可能です。

まず "steamapps\common\Skyrim\Papyrus Compiler" フォルダ内に、以下の内容を書いたバッチファイル "SakuraCompile.bat" を作成します。

cd %~dp0
"PapyrusCompiler.exe" %1 -f="TESV_Papyrus_Flags.flg" -i="..\Data\scripts\source" -o="..\Data\scripts"

あとはコンパイルしたいpscファイルを開き、ツール > 外部コマンド実行（Ctrl + F5）で以下の文字列を入力して実行してください。

"$e..\..\..\Papyrus Compiler\SakuraCompile.bat" "$F"

すると別ウィンドウに見慣れた実行結果が表示されます。

ちなみにCKでスクリプトをダブルクリックした時の動作は、File > Preferences の Scripts タブで指定できます。これを「Edit externally」にした上で拡張子を関連付けておけば、サクラエディタで直接開くことができます。

4-6. おすすめ共通設定

あとは好みの問題ですが、入力補完機能とキーワードヘルプに関するおすすめの共通設定を挙げておきます。
設定 > 共通設定 の 支援 タブで変更できます。

  • 入力補完機能の候補決定キーから「→」を外す。
  • キーワードヘルプのフォントを見やすいものに変更する。

目次に戻る

5. 補記

配布する辞書ファイル類は、サクラエディタ様、ベセスダ様、SKSEチーム様、および各MODの作者様にご迷惑をお掛けするような形でない限り、ご自由にお使いください。

もしコードの過不足や間違いを見つけたら、ぜひ教えてください。全力で作業した思い入れのあるファイルなので、大事にしていきたいと思っています。

色分けに関しては、多彩すぎる分け方や強い色使いが好みではないので比較的おとなしい感じになっています。より多彩に色分けしたい場合は "Papyrus2.kwd" の中身を複数に分ければできますが…その予定はありません。

私は普段スクリプトを書く時、ライトカラー（白背景）で書いています。サクラエディタのデフォルトカラーを少し変えた程度のもので、目がこの色使いに慣れています。
ダークカラー作成は初の試みです。パステルカラーを基調にして目に優しい感じを目指しましたが、視認性と疲れにくさの調整はなかなか難しいですね。

配布したものが、サクラエディタでPapyrusを書く方の助けに少しでもなれば幸いです。

6. 対応ツールおよびMOD

7. 更新履歴

7-1. 履歴
  • 2019/09/26 version 0.3 ; 一部のキーワードヘルプが表示されない点を修正。
  • 2019/08/23 version 0.21 ; 入力補完と強調キーワードで、SkyUIの関数が抜けていたのを修正。
  • 2019/08/19 version 0.2 ; 対応MODを8つ追加。既存項目の修正。
  • 2018/07/15 version 0.1 ; 公開。バニラのスクリプトとSKSEに対応。
7-2. 旧版ダウンロード

カテゴリ:

0 件のコメント:

コメントを投稿

注: コメントを投稿できるのは、このブログのメンバーだけです。

登録: コメントの投稿 (Atom)