﻿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
【タイトル】Tyrano KS Assistant
【Version 】1.00
【ファイル】TyranoKsAssistant.zip
【著 作 者】朋美姫（Lyrical Limited）
【連 絡 先】ホームページ
            https://lyricallimited.blog.jp/
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
《はじめに》

朋美姫のアプリ「Tyrano KS Assistant」をダウンロードしていただき、ありがとうございます！

本ツールは、ティラノスクリプトでゲームを作る方向けの、KSファイルの編集・制作補助アプリです。
KSファイルとは、ゲームの文章や命令（タグ）を書いた、拡張子「.ks」のファイルです。
文章の編集、タグの挿入、画像や音の確認、よく使う文章の登録、不要なタグの整理をお手伝いします。

このアプリでKSを編集・保存し、ティラノスタジオV6でゲームを動かして確認する使い方ができます。
初めての方は、同梱の「Manual.pdf」を見ながら、作品のコピーで操作を試してください。

《インストール方法》

1. 配布ZIP「TyranoKsAssistant.zip」を好きなフォルダーへ、すべて解凍してください。
2. 解凍したフォルダーの「TyranoKsAssistant.exe」をダブルクリックしてください。

次の5ファイルは、同じフォルダーに置いてください。
・TyranoKsAssistant.exe         アプリ本体
・TyranoKsAssistant.exe.config  アプリの動作に必要なファイル
・Readme.txt                    この説明書
・Manual.pdf                    操作マニュアル
・TagHelp.html                  タグのHTMLヘルプ

ZIPの中から直接起動せず、必ず解凍してからお使いください。
アプリ本体をゲームのdataフォルダーにコピーする必要はありません。
ティラノスタジオV6は同梱していません。併用する場合は別途用意してください。

《起動方法》

「TyranoKsAssistant.exe」をダブルクリックします。
「ファイル追加」または「フォルダ追加」で、編集したいKSファイルを登録します。
ファイルを画面へドラッグ＆ドロップして登録することもできます。
一覧の青いファイル名を1回クリックすると、そのファイルを読み込んだ編集画面が開きます。
「前回の編集を開く / エディタ」から、前回のファイルを開くこともできます。

■■■使い方 / How to Use■■■

<<日本語>>

《まずは文章を編集してみましょう》

1. 編集したいKSファイルを一覧へ追加します。
2. 青いファイル名をクリックして、編集画面を開きます。
3. ゲームの文章やタグを編集します。
4. 「保存」またはCtrl＋Sで保存します。
5. ティラノスタジオV6でゲームを再生して、変更したところを確認します。

タグは、[r]や[bg storage="背景.png"]のように、ゲームの動きを指定する命令です。
文章とタグを色分けして表示できるため、書いてある内容を見分けやすくなっています。
色分けは見た目だけの機能です。KSファイルに色や装飾のデータは書き込みません。

《テキストエディタの主な機能》

・新しいKSの作成、ファイルを開く、保存、名前を付けて保存
・文章の検索・置換、切り取り・コピー・貼り付け
・元に戻す／やり直す（最大100操作）
・タグ、コメント、ラベル・話者の色分け
・文字の大きさの変更、長い行の表示折り返し、行番号を指定した移動
・行の複製、行頭の「;」によるコメントの切り替え
・タグ一覧からの挿入、素材の選択、保存テンプレートの挿入
・編集中のKSを対象にしたタグ整理のプレビュー

表示折り返しは画面上だけのものです。ファイルに改行を追加する操作ではありません。
検索・置換は、大文字と小文字を区別する文字列一致です。正規表現には対応していません。
エディタの置換は、文章だけでなくタグの中の文字も対象になります。
同時に編集するファイルは1つです。別ファイルを開くときなどには、未保存の変更を確認します。
長いファイルでは色分けをオフにできます。200万文字を超える場合は色分けを省略します。

よく使うキー操作
Ctrl＋N：新規作成              Ctrl＋O：ファイルを開く
Ctrl＋S：保存                  Ctrl＋Shift＋S：名前を付けて保存
Ctrl＋F：検索                  Ctrl＋H：置換欄へ移動
F3：次を検索                   Ctrl＋G：行へ移動する欄へ移動
Ctrl＋Z：元に戻す              Ctrl＋Y：やり直す
Ctrl＋X／C／V：切り取り／コピー／貼り付け
Ctrl＋D：行を複製              Ctrl＋/：行コメントの切り替え
Ctrl＋Space：タグ検索           F1：タグの説明を開く
Ctrl＋Shift＋P：編集中のKSの整理結果を確認
F5：KSを保存してスタジオへ

《タグを一覧から挿入する》

エディタ右側の「タグを挿入」で、使いたいタグを選びます。
分類や検索で絞り込み、説明を読んで、「値を編集」の欄に素材名や時間などを入力します。
「カーソル位置へ挿入」を押すと、入力したタグが編集欄に入ります。
一覧のダブルクリックでも挿入できます。

背景、キャラクター、音声、文字の表示、場面の移動などのタグを用意しています。
一覧にはタグに加えてラベル・メモも含め、31種類の入力用ひな形があります。
ひな形の素材名・キャラクター名・ラベル名などは、自分の作品のものに変更してください。

通常のタグは、文章を選択している場合、その後ろへ挿入します。
linkとifは、選択した文章を開始タグと終了タグで囲みます。
挿入しただけではファイルは保存されません。確認してから「保存」を押してください。

《画像や音を確認して素材を選ぶ》

対応するタグで「素材ファイルを選ぶ」を押すと、素材を選ぶ画面が開きます。
画像を見たり、BGM・効果音を試聴したりしてから選択できます。

画像のプレビュー：PNG、JPEG、GIF（先頭の画像）、BMP
音声の試聴：WAV、MP3、OGG（Vorbis）

音は再生・停止でき、試聴の音量も変更できます。
試聴音量は、このアプリで聞くときの音量です。ゲーム用のタグのvolumeとは別です。
M4AとOGG/Opusの試聴には対応していません。

KSがゲームのdata/scenario内にあるときは、対応する素材フォルダーを基準に選択します。
この操作では素材ファイルをゲームのフォルダーへコピーしません。
ゲームに使う素材は、あらかじめ作品の適切なフォルダーへ入れてください。

《よく使う文章やタグをテンプレートにする》

同じキャラクターの表示タグなど、何度も使う内容はテンプレートとして登録できます。

1. 編集欄で登録したい部分を選択します。選択しない場合は現在の行を取り込みます。
2. テンプレート欄へ取り込み、わかりやすい名前を付けて保存します。
3. 次に使うときは、保存一覧から選んで「挿入」を押します。

複数行の文章やタグも登録できます。タグ一覧で入力した内容も取り込めます。
登録済みテンプレートは更新・削除できます。最大200個、1個あたり64,000文字まで保存できます。
テンプレート欄の書きかけは自動保存しません。「保存」または「更新」を押してください。

《ファイル名を変えて保存する》

編集画面には、編集中のファイル名と保存先フォルダーを表示します。
ファイル名欄を変更して保存すると、同じフォルダーの新しい名前で保存します。
拡張子を省略した場合は「.ks」を補います。元の名前のファイルは残ります。
すでに同名のファイルがある場合は、上書きを確認し、バックアップを作ります。
保存先のフォルダーも変更したいときは「名前を付けて保存」を使ってください。

別のKSから参照されているファイル名を変更した場合は、jumpやcallなどの参照も確認してください。
参照先のファイル名を自動で書き換える機能はありません。

《タグや文章をまとめて整理する》

1. 整理したいファイルを一覧に追加し、「設定」で処理内容を選びます。
2. 「③ このKSを確認」で、選択中のファイルの整理前と整理後を比べます。
3. 複数のファイルを対象にするときは「チェックした全部を確認」を使います。
4. 内容を確認してから「④ 確認した内容を保存」を押します。

主な処理
・空白と[r]だけの行から[r]を削除（空行そのものと、文章中の[r]は残します）
・[l]を、指定時間の[wait time=500]などへ変換
・同じ行で連続している[r]や[l]を1つに整理
・本文行末の余分な空白を整理
・指定した行間隔でタグを追加
・本文の文字列置換、タグ全体の完全一致置換
・出力する文字コードや改行形式の指定
・整理設定の保存・読み込み、変更行のCSV出力

最初は「別フォルダ出力」で、元のファイルを残して確認する使い方をおすすめします。
変更したファイルだけを日時付きフォルダーへ保存します。
ゲームへ反映するときは、出力したKSを作品側へコピーしてからテストしてください。
「元ファイルを上書き」では、バックアップを作ってから元のファイルへ保存します。
プレビューしただけでは、ファイルの内容は変わりません。

[l]は、本来はクリックを待つための有効なタグです。アプリが不具合を判定するわけではありません。
時間待ちに変えたいときだけ変換してください。初期設定では変換しません。
500ミリ秒は0.5秒です。待ち方が変わるため、ゲームで確認してください。

整理機能の「本文置換」はタグの属性内を変更しません。
タグ全体の置換は、空白や引用符も含めた完全一致です。
コメント、ラベル、話者行、@命令行、iscript/html/ignore/macroブロックは整理から保護します。
複数行タグなど、整理に対応していない書き方はエラーになる場合があります。
その場合は、一括整理ではなくエディタで内容を確認して編集してください。

《編集中のファイルを整理して確認する》

エディタの「このKSの整理結果を確認」は、まだ保存していない編集内容も対象にできます。
「整理結果を編集欄へ反映」で、確認した結果を編集欄へ取り込めます。Ctrl＋Zで戻せます。
反映後も、実際のファイルへ書き込むには保存が必要です。
整理設定はエディタを開いた時点のものを使います。設定を変えたときはエディタを開き直してください。
文章を編集した後は、整理結果の確認をやり直してください。

《ティラノスタジオV6と併用する》

1. ティラノスタジオV6で、制作中のプロジェクトを開きます。
2. このアプリの「スタジオEXEを選ぶ」で、スタジオの実行ファイルを一度指定します。
3. このアプリで、同じゲームのdata/scenario内のKSを編集します。
4. F5または「保存してスタジオへ」で保存して、スタジオを開く・切り替える操作を行います。
5. スタジオ側でゲーム再生やリロードを行い、変更したところを確認します。

F5は保存とスタジオへの切り替えまでです。
プロジェクトの選択、ゲーム再生、リロードはスタジオ側で操作してください。
画面が切り替わらない場合は、タスクバーからスタジオを選んでください。
「スタジオを開く」は、KSを保存せずにスタジオを開きます。

同じKSを2つのエディタで同時に編集しないでください。
外部で変更した場合は、このアプリの「ファイルを読み直す」で取り込んでください。
外部の変更を保存時に検出した場合は、上書きを止め、開き直しや別名保存を案内します。
シナリオの流れや初期化を変更した場合は、途中のセーブデータだけでなく最初からも確認してください。

《前回の作業と設定を自動保存する》

ファイル一覧、選択したファイル、整理設定、保存先、画面の位置・大きさなどを自動保存します。
エディタの前回のファイル、カーソル位置、文字サイズ、折り返し、スタジオの場所も覚えます。
次の起動時に作業状態を復元し、「前回の編集を開く / エディタ」で編集を再開できます。
整理のプレビューは、必要に応じて作り直してください。

重要：編集中の本文と、テンプレート欄の書きかけは自動保存しません。
本文は「保存」またはCtrl＋S、テンプレートは「保存」または「更新」で保存してください。

設定・作業履歴・保存ログ・テンプレートの保存場所
%LOCALAPPDATA%\TyranoKsAssistant

《保存とバックアップ》

KSを上書きするときは、保存先の横にバックアップを作ります。
保存場所：TyranoKS_Backups\日時_識別子\元のファイル名

元に戻すときは、現在のKSを別名で保管してから、バックアップを元の場所へコピーしてください。
バックアップは自動削除しません。不要になったものは、内容を確かめて整理してください。
大切な作品全体のバックアップも、別の場所へ定期的に保存してください。

エディタの保存では、元の文字コードとBOMを保持します。
新規ファイルはUTF-8（BOMなし）、改行はCRLFです。
文字化けする場合は「開く時の文字コード」を指定して開き直してください。
編集して保存すると、改行は元ファイルで最初に見つかった形式へ統一します。
ファイルは1個32MB、一括プレビューの入力合計は64MBまでです。
保存エラーが出た場合は、画面のメッセージやログを確認してください。

《マニュアル・HTMLヘルプ》

「使い方 PDF」で、操作を詳しく説明したManual.pdfを開きます。
「タグの説明 HTML」で、カテゴリ別にタグを説明したTagHelp.htmlを開きます。
HTMLヘルプはインターネットにつながっていなくても読めます。
検索やカテゴリのリンクからタグを選び、説明と記述例を確認してください。
F1や「このタグの説明」から、選択したタグの説明を開くこともできます。
直接その項目を開けない環境では、ヘルプのトップから検索してください。
「公式の説明を開く」は、ティラノスクリプト公式タグ一覧を開きます。
https://tyrano.jp/tag/

HTMLヘルプが開けない場合
・TagHelp.htmlが、TyranoKsAssistant.exeと同じフォルダーにあるか確認してください。
・TagHelp.htmlを直接ダブルクリックして、ブラウザーで開けるか確認してください。
・開けない場合は、HTMLファイルを開くアプリとしてEdgeやChromeなどを指定してください。
PDFが開けない場合も、Manual.pdfの配置と、PDFを開くアプリの設定を確認してください。

《アンインストール方法》

アプリを終了し、解凍したTyrano KS Assistantのフォルダーを削除してください。
設定・作業履歴・テンプレートなども削除する場合は、次のフォルダーを削除してください。
%LOCALAPPDATA%\TyranoKsAssistant

登録したテンプレートを残したい場合は、削除前にtemplates.xmlを別の場所へ保管してください。
アプリのフォルダーを削除しても、作品のKSや作品側のバックアップは削除されません。

《動作環境》

Windows 10 / 11の64ビット環境向け
.NET Framework 4.8
Microsoft Visual C++ v14 再頒布可能パッケージ（x64）

MSVCP140.dllなどの不足で起動できない場合は、Microsoft公式のx64版を導入してください。
動作確認環境や配布時の案内は、ホームページをご確認ください。
操作マニュアルの表示にはPDFを開くアプリ、HTMLヘルプの表示にはブラウザーが必要です。

《English / Quick Guide》

Tyrano KS Assistant is a free KS text editor and support tool for TyranoScript game creation.
Extract TyranoKsAssistant_Ver1.00.zip and run TyranoKsAssistant.exe.
Keep the executable, its .config file, Readme.txt, Manual.pdf and TagHelp.html together.
Add your KS files, then click a blue file name to open it in the editor.
Edit and save with Ctrl+S. You can insert tags, preview images and audio, and save reusable templates.
Preview cleanup changes before saving. Keep backups of your project.

To test your game, select the Tyrano Studio V6 executable and edit the KS files in the same project.
Press F5 to save and open or switch to Studio. Start or reload the game manually in Studio.
The app does not automatically select a project or start a game at the current KS file.
Settings and recent work information are saved automatically; unsaved text and template drafts are not.
Use Manual.pdf for instructions and TagHelp.html for categorized tag help.

《バージョンアップ履歴 / Version History》

1.00  初版
      KS編集、タグ挿入、画像・音声確認、保存テンプレート、タグ整理、
      作業設定の保存、ティラノスタジオV6との併用、PDF・HTMLヘルプを搭載。

《注意事項 / Notes》

本ツールはフリーソフトですが、著作権は朋美姫（Lyrical Limited）に帰属します。
再配布はご遠慮ください。リンクを共有する場合は公式HPをご利用ください。
バグ報告やご質問は、ホームページ（https://lyricallimited.blog.jp/）よりご連絡ください。
報告の際は、Ver1.00であること、操作手順、表示されたメッセージをお知らせください。
作品の本文や素材を含める場合は、公開してよい内容か確認してください。

ファイルの変更・置換・整理を行う前に、重要な作品データを必ずバックアップしてください。
本ツールは、すべてのタグの正しさ、参照先、シナリオの分岐や実際のゲーム動作を検証するものではありません。
整理結果にエラーがなくても、公開前は必ずゲーム本体で動作を確認してください。
本ソフトはTyranoScript公式製品ではない、独立した制作支援ツールです。

This is free software, but the copyright belongs to Tomomi Hime (Lyrical Limited).
Redistribution is prohibited. Please share the official website instead.
For bug reports or inquiries, contact us via https://lyricallimited.blog.jp/.
Back up important project files before editing or applying cleanup changes.
Always test the game itself before release.
This is an independent support tool and is not an official TyranoScript product.

《謝辞 / Acknowledgments》

本ツールをご利用いただくゲームクリエイターの皆様に感謝いたします。
音声の試聴には、miniaudio 0.11.23（David Reid）とstb_vorbis（Sean Barrett）を使用しています。
これらはパブリックドメインの条件を選択して使用しており、元のライセンス文はソースに含まれます。

Tyrano KS Assistant / Copyright © 朋美姫（Lyrical Limited）
