X?-Rのページ

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。
====== StoryLib 1.1.0 ソースコード配布版 - リファレンス ======

----

Godot3系で動作することを確認済みですが、HTML5版にエクスポートした際に、Godotのバージョンによっては特定のブラウザ（Chromeなど）でセーブ機能がうまく動作しない場合があります。

===== StoryLibとは =====

Godotゲームエンジンで利用可能な、テキスト主体の簡易演出用フレームワークです。
これ1つでサウンドノベル風のストーリーや会話イベントなどを手軽に作成することができます。

**特徴①**

作家やデザイナーの方にも幅広くご利用いただけるよう、シンプルで扱いやすい設計にしました。

**特徴②**

テキストや画像の表示、音楽の再生、選択肢の分岐処理など、様々な命令を.txtファイルから制御でき、リアルタイムで迅速なデバッグが可能です。

**特徴③**

本フレームワークはオープンソースで完全無料！
どうぞご活用ください。

※チュートリアルで使用している3枚のキャラクター画像（chara1.png, chara2.png, chara3.png）にのみ、X?-Rの著作権がございます。

===== セットアップ方法 =====

解凍したStoryLibフォルダ内の、readme.txtを除く全てのファイル/フォルダをGodotのプロジェクトフォルダにコピーします。そしてGodotを起動して当該プロジェクトを開き、以下のステップに従ってセットアップを行ってください。

**①画像や音楽ファイルを用意します**

画像はImagesフォルダ、音楽はSoundsフォルダの任意の場所にそれぞれインポートします。
※SEでループ処理の必要のないものは、エンジンから当該ファイルを選択して、インポートタブのLoopのチェックを外します。

**②上記のアセットをテキストファイルで呼び出し可能にするために、Data.gdに登録します**

  - 記号付きリストpreload用変数を作り、アセットのアドレスをpreload内にコピーします（アセットをドラッグ＆ドロップすると早いです）。
  - 1をget_imageおよびget_bgmおよびget_seのうちの、目的にあった関数内に追記します。""で囲っているのが呼び出しに使う名前です。
  - ブロジェクト >プロジェクト設定 >自動読み込みにData.gdを指定

**③Splash.tscn、Start.tscn、Story.tscnのレイアウトを必要に応じて編集します**

※レイアウトの編集方法については割愛させていただきます。
※ノードの順番はアニメーションの再生に影響する場合があるため、デフォルトの状態を保つようにしてください。

**④StoryLib.gd内の、プロジェクト毎に個別設定をする項目を必要に応じて変更します**

補足: エクスポートに.txtファイルを含む設定
プロジェクト >エクスポート >リソース >リソース以外のファイル/フォルダをエクスポートするためのフィルタ
に、*.txt を記述する。

===== ストーリー用テキストファイルの編集 =====

デバッグを開始してチュートリアルを確認してください。
以下のファイルからも確認できます。

文法サンプル: Stories/opening.txt
コマンド: Scripts/Story.gd

===== その他の機能 =====

・セーブデータ管理
　セーブデータのコピー、移行、削除ができます

・デバッグモード
　StoryLib.gdのis_story_debug_modeをtrueにすることで利用可能です。
　画面下部のバーから.txt内でジャンプしたい行数を入力して更新ボタンを押すと、その行に処理を移行できます。