AviUtl MarkdownEX

aviutl_browser を使って AviUtl で Markdown を表示するスクリプト。

aviutl_browser 同梱の Markdown.anm を元に機能拡張を行ったものです。

主な機能

Markdownの表示
数式の表示
絵文字の表示

導入方法

aviutl_browser をまだ導入していない場合は先に導入してください。
Releases から最新版のZIPファイルをダウンロードしてください。
ZIPファイルを展開し、script フォルダを拡張編集の script フォルダと統合してください。

使い方

Markdownの表示

script/browser/MarkdownEX.exa を拡張編集タイムラインに D&D するか、カスタムオブジェクト MarkdownEX.obj に設定ダイアログから Markdown を記述したファイルのパスを指定してください。ファイルを指定して表示する場合は UTF-8 で保存されたファイルを指定してください。

MarkdownEX.exa を exedit.auf と同じフォルダか、同じフォルダに作ったフォルダ内に移動させておくとタイムラインの右クリックから利用できます。

トラックバーの幅と高さからはページの幅と高さ、拡大率からはページの拡大率(style.zoom)を設定できます。

設定ダイアログの Markdown からは Markdown の表示に使用するスタイルを指定できます。 contents/MarkdownEX/css/markdown フォルダ内にある CSS ファイルから使用したいファイルを選択してください。

設定ダイアログのハイライトからはコードブロックのハイライトに使用するスタイルを指定できます。 contents/MarkdownEX/css/hljs フォルダ内にある CSS ファイルから使用したいファイルを選択してください。

数式の表示

MathJax を使用して数式を描画することができます。

インライン形式の例

$a + b$ あるいは \\(a + b\\)

ブロック形式の例

$$
a + b
$$
または
\\[
a + b
\\]

絵文字の表示

aviutl_browser は Chromium でレンダリングした HTML ページを AviUtl で表示します。そのため 🍤 の様に実体参照で書けば絵文字を表示(この場合🍤)することができます。ファイルを指定して表示する場合は、ファイルに直接絵文字が書いてあっても表示できます。これらの入力方法で表示される絵文字は使用するフォントに組み込まれているものです。

また、 :fried_shrimp: の様にキーワードをコロンで囲むことでも絵文字を表示することができます。この場合はキーワードに対応する画像を表示します。デフォルトでは contents/MarkdownEX/img/default フォルダ内にある画像を表示します。キーワードと画像の対応は default フォルダ内にある setting.json 内で "キーワード": "画像ファイル名" という形で定義されています。画像を追加したい場合はこのフォルダ内に画像を追加し、 setting.json にキーワードを追記してください。キーワードとして使用できる文字は半角英数字と記号 -+_ です。また、 img フォルダ内に新しく作ったフォルダ内に画像ファイルと setting.json を保存することで別の絵文字セットを作ることもできます。使用する絵文字セットを変更する際は、設定ダイアログの絵文字から使用したい絵文字セットのフォルダ名を指定してください。

補助モジュール

シーンオブジェクトで参照している先のシーンと現在のシーンにおいて MarkdownEX が同じレイヤーにあると処理が少し重くなります (例えば Root と Scene 1 それぞれのLayer 1 に MarkdownEX が置いてあり、 Root から Scene 1 を参照する場合)。これは rikky 氏の rikky_module を導入してあれば軽減することができます。必須ではありませんが複数のシーンで本スクリプトを使用する場合は rikky_module を導入しておくことをおすすめします。

更新履歴

更新履歴は CHANGELOG を参照してください。

ライセンス

このソフトウェアは MIT ライセンスのもとで公開されます。詳細は LICENSE を参照してください。

クレジット

使用したライブラリ等については CREDITS を参照してください。

karoterra / aviutl-markdownex Goto Github PK