-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from EndoHizumi/develop
0.2.6
- Loading branch information
Showing
6 changed files
with
212 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# WebTaleKit プロジェクト作成マニュアル | ||
|
||
## 前提条件 | ||
|
||
- Node.js 20以降がインストールされていること | ||
- HTML、CSS、JavaScriptの基本的な知識があること | ||
|
||
## プロジェクトの作成 | ||
|
||
1. 新しいディレクトリを作成し、そこにWebTaleKitのディレクトリ構造を設定します。 | ||
|
||
```bash | ||
├─src | ||
│ ├─scene | ||
│ | └─title.scene | ||
| ├─ screen | ||
│ | ├─title.html | ||
│ | ├─title.css | ||
│ | └─title.js | ||
│ ├─resource | ||
│ │ ├─audio | ||
│ │ ├─background | ||
│ │ ├─chara | ||
│ │ ├─key | ||
│ │ ├─se | ||
│ │ ├─config.js | ||
│ │ └─voice | ||
├─tsconfig.json | ||
├─webpack.config.js | ||
|
||
``` | ||
|
||
## シーンの作成 | ||
|
||
1. `src/scene`ディレクトリに新しいシーンファイル(例:`title.scene`)を作成します。 | ||
|
||
2. シーンファイルには、`<scenario>`セクションと`<logic>`セクションがあります。 | ||
- `<scenario>`セクションでは、WebTaleScript(WTS)を使ってゲームの進行を制御します。 | ||
- `<logic>`セクションでは、JavaScriptを使ってシーンで使う処理や背景のデータ、変数の定義を記述します。 | ||
|
||
3. WTSを使って、テキストの表示、キャラクターの表示、選択肢の表示などを行います。 | ||
例: | ||
|
||
```html | ||
<scenario> | ||
<say name="燈火">「先輩、別れてください」</say> | ||
<say name="智樹">「え、ごめん。今・・・なんて」</say> | ||
<choice prompt="プロローグをスキップしますか?"> | ||
<item label="はい"> | ||
<jump index="1"></jump> | ||
</item> | ||
<item label="いいえ"></item> | ||
</choice> | ||
</scenario> | ||
``` | ||
|
||
- 利用できるWTSタグ | ||
- text(テキストの表示) | ||
- choice(選択肢の表示) | ||
- show(画像の表示) | ||
- hide(画像の日表示) | ||
- newpage(画面のクリア) | ||
- jump(シナリオの行移動) | ||
- sound(音楽の再生) | ||
- say(名前付きテキストの表示・ボイス再生) | ||
- if(処理分岐) | ||
- call(JSメソッドの呼び出し) | ||
- moveTo(画像の水平・平行移動) | ||
- route(シーンの移動) | ||
|
||
4. `<logic>`セクションで、シーンの設定や変数の定義を行います。 | ||
前のシーンの設定を引継ぐ場合は、その項目は入力を省略できます。 | ||
|
||
例: | ||
|
||
```html | ||
<logic> | ||
const sceneConfig = { | ||
background: '屋上.jpg' | ||
} | ||
</logic> | ||
``` | ||
|
||
- 利用できる設定 | ||
- template(シーンのUIのHTML) | ||
- name (シーンの名前) | ||
- background(シーンの背景) | ||
- bgm(シーンのBGM) | ||
|
||
## UIの作成 | ||
|
||
1. `src/screen`ディレクトリにシーンごとのUIファイル(HTML、CSS、JavaScript)を作成します。 | ||
|
||
2. HTMLファイルでUIの構造を定義し、CSSファイルでスタイルを設定します。 | ||
|
||
3. JavaScriptファイルでUIの動作を制御します。 | ||
|
||
## ビルドとデプロイ | ||
|
||
1. WebPackやViteを使ってプロジェクトをビルドします。 | ||
|
||
2. ビルド時に、シーンファイル(`.scene`)がJavaScriptに変換され、UIファイル(HTML、CSS、JavaScript)がインライン化されます。 | ||
|
||
3. ビルドされたファイルを`dist`ディレクトリに出力します。 | ||
|
||
4. `dist`ディレクトリの内容をWebサーバーにデプロイすることで、ゲームを公開できます。 | ||
|
||
以上がWebTaleKitを使ってビジュアルノベルゲームを作成するための基本的な流れです。 | ||
タグの詳細については、[WebTaleKit仕様](documents/spec.md)を参照してください。 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.