add book

.github/workflows/gh-pages.yml

@@ -0,0 +1,33 @@
+name: github pages
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 23
+
+    - name: Build
+      env: 
+        TZ: "Asia/Tokyo"
+      run: |
+        cd ./book
+        npm i
+        npx honkit build
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./book/_book
+        publish_branch: gh-pages
+        user_name: 'ai[bot]'
+        user_email: '138105980+yui-syui-ai[bot]@users.noreply.github.com'

.gitignore

@@ -9,3 +9,6 @@
 /scpt/*.jpeg
 /scpt/*.png
 config
+book/_book
+book/node_modules
+book/desktop.ini

book/CNAME

@@ -0,0 +1 @@
+ue-book.syui.ai

book/README.md

@@ -0,0 +1,5 @@
+![](cover.jpg)
+
+# Unreal Engine 5 Guide Book
+
+<a href="/book.pdf" target=”_blank”>download</a> | <a href="https://ue-book.syui.ai" target="_blank">web</a>

book/SUMMARY.md

@@ -0,0 +1,29 @@
+# Summary
+
+* [Unreal Engine 5 Guild Book](README.md)
+* [default](default/README.md)
+ * [asset/plugin](default/00_asset.md)
+ * [start](default/01_start.md)
+ * [install](default/02_install.md)
+ * [tips](default/03_tips.md)
+* [game animation sample](gas/README.md)
+ * [キャラクターを追加する](gas/01_character.md)
+ * [飛びつける高さを増やす](gas/02_jump.md)
+ * [キャラクターの見た目を変える](gas/03_vrm.md)
+ * [モーションキャプチャで動かす](gas/04_vmc.md)
+ * [揺れものを設定する](gas/05_kawaii.md)
+ * [カメラワークの設定する](gas/06_camera.md)
+ * [アニメーションを作成する](gas/07_anim.md)
+* [control rig sample](crs/README.md)
+ * [CRでキャラクターを動かす](crs/01_character.md)
+* [city sample](city/README.md)
+ * [惑星形式のmapを作る](city/01_remove.md)
+* [json blueprint utilities](json/README.md)
+ * [apiから情報を取得する](json/01_varest.md)
+* [pixel streaming](pixel/README.md)
+ * [基本事項](pixel/01_server.md)
+* [有料アセット](plan/README.md)
+ * [superhero fligth animations](plan/01_flying.md)
+ * [ultra dynamic sky](plan/02_uds.md)
+ * [ocean waves](plan/03_ocean.md)
+* [end](end/README.md)

book/city/01_remove.md

@@ -0,0 +1,33 @@
+# 惑星形式のmapを作る
+
+## 海の境界を消す
+
+海には境界があってそれが惑星システム(planet system)を構築する際に邪魔になるので消します。
+
+## ocean wavesで惑星の海を作る
+
+必要なものを`/Content/OceanWaves/Levels/EarthSizedOceanPlanet`からcopyして持ってきましょう。
+
+- `BP_EarthSizedSphericalMesh`
+- `BP_EarthSizedOcean`
+- `WaterVolume`
+
+`BP_EarthSizedSphericalMesh`の`transform-location-z:-63600000`にします。`Sphere Radius:63600000`にします。`SphereEdge Length:16000000`になるはずです。
+
+次に海上の影問題を修正するため`Material Overrides`, `Material Outer/Inner`をすべて変更します。私は`/Vefects/Water/VFX/WaterMaterials`を使用しました。
+
+次に`BP_EarthSizedOcean`の`Volume Maaterials`で`WaterVolume`をセットします。`Above/Underwater`を`/Vefects/Water/VFX/UnderWater`に変更します。`height:0`にします。これは海に入って出たときに海中を適用する高さを設定します。
+
+## ultra dynamic skyで天候と惑星を作る
+
+1. `/Content/UltraDynamicSky/Blueprints/Ultra_Dynamic_Sky`を開きます。
+2. そこに地球と月と太陽のBPを入れます。各自が用意してください。なお、地球は`SkyAtmosphere`の下に置いてください。
+> 名前は 地球(BP_Earth), 月(BP_Moon), 太陽(BP_Sun) としておきます。
+3. `BP_Earth`は詳細から`transform-location-z:-636000000`, `transform-scale:6360000`にします。
+4. `Sky_Sphere_Mesh`の`transform-scale:50000`にします。
+5. 関数の`Current Star Color(pure)`にて高度を取得できるため、各componentの表示と非表示(visibility)を切り替えます。
+
+<iframe src="https://blueprintue.com/render/k3xgicx_/1" scrolling="no" allowfullscreen style="width:100%;height:400px"></iframe>
+
+- `BP_Earth`: `transform-location-z:-636000000`, `transform-scale:6360000`
+- `Sky_Sphere_Mesh`: `transform-scale:50000`

book/city/README.md

@@ -0,0 +1,4 @@
+# city sample
+
+[city sample](https://www.unrealengine.com/marketplace/ja/product/city-sample)
+

book/crs/01_character.md

@@ -0,0 +1,21 @@
+# CRでキャラクターを動かす
+
+`control rig`は`CR_xxx`というファイル名がつけられています。
+
+## dragon
+
+例えば、ABPで`head_global_ctrl`の値を更新します。
+
+<iframe src="https://blueprintue.com/render/o3glwh72/1" scrolling="no" allowfullscreen style="width:100%;height:400px"></iframe>
+
+## mech
+
+1. `/Content/ControlRig/Characters/Mech/Meshes/SKM_Mech`からABP, BP, SM(StaticMesh)を作成します。
+2. ABPから`Control Rig`で`cannon_ctrl`などを動かせます。
+
+```sh
+- /Content/ControlRig/Characters/Mech/BP_Mech
+- /Content/ControlRig/Characters/Mech/ABP_Mech
+- /Content/ControlRig/Characters/Mech/Meshes/SM_Mech
+```
+

book/crs/README.md

@@ -0,0 +1,4 @@
+# control rig sample
+
+[control rig sample](https://www.fab.com/ja/listings/2ce3fe44-9ee6-4fa7-99fc-b9424a402386)
+

book/default/00_asset.md

@@ -0,0 +1,42 @@
+# asset/plugin
+
+現在使用しているplugin(プラグイン)やasset(アセット)の`version(バージョン)`を記述します。
+
+ゲームは無料のassetだけでも作れます。しかし、時間やクオリティを向上させたい場合は有料のassetを使いましょう。
+
+本書の一部では有料assetの使い方を解説します。
+
+## asset
+
+|name|latest|body|
+|---|---|---|
+|[game animation sample](https://dev.epicgames.com/documentation/en-us/unreal-engine/game-animation-sample-project-in-unreal-engine)|5.5|キャラクターをパルクールアクション|
+|[city sample](https://www.unrealengine.com/marketplace/ja/product/city-sample)|5.5|大規模な都市を構築|
+|[control rig sample](https://www.fab.com/ja/listings/2ce3fe44-9ee6-4fa7-99fc-b9424a402386)|5.5|人間以外のキャラクター|
+
+## plugin
+
+|name|latest|body|
+|---|---|---|
+|[pixel streaming](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/master/Docs/pixel-streaming-2-migration-guide.md)|2|ゲームをserverにdeployしてwebからプレイ|
+|[twinmotion](https://www.twinmotion.com/ja)|20250101p|建造物をインポート|
+|[vrm4u](https://github.com/ruyo/VRM4U/releases/tag/20250103)|20250103|vrmモデルを動かす|
+|[kawaiiphysics](https://github.com/pafuhana1213/KawaiiPhysics)|20241201|揺れものを設定|
+|[varest](https://github.com/ufna/VaRest)|20240828|curlのようなもの。supportが終了しているのでbuildが必要|
+
+## 有料
+
+|name|latest|
+|---|---|
+|[superhero flight animations](https://www.fab.com/ja/listings/41185c19-5191-4153-8293-8cc9901efa95)|20241217|空を飛ぶ|
+|[ultra dynamic sky](https://docs.google.com/document/d/1xAr0Hd3mY7Mp0g0waKLUvJaddUPaVxEeRoEEFXctCE0/)|20250203|空や天候を自動化|
+|[ocean waves](https://www.unrealengine.com/marketplace/ja/product/ocean-waves)|20240923|惑星の海を作る|
+|[magicalanimset](https://www.fab.com/ja/listings/a63386b8-7cad-42cd-8b81-a9de147e1f08)|20241222|少女の戦闘アニメーション|
+
+## link 
+
+こちらで最新情報を取り扱っています。
+
+- https://git.syui.ai/ai/ue/
+- https://blueprintue.com/profile/ai/
+- https://dev.epicgames.com/community/profile/organization/gdkg/ai/

book/default/01_start.md

@@ -0,0 +1,58 @@
+# start
+
+## ueとは
+
+`Unreal Engine`は`epic games`という会社が作っているゲームエンジンです。よく`ue`と略されます。
+
+最新バージョン(latest version)は`5`なので、`ue5`となります。
+
+`ue`の他には`unity`, `godto`が有名です。`DirectX`というものがあり、例えば、`DX12`からGPUに命令を送ることができます。ゲームエンジンの多くは`DX11`, `DX12`を使用します。
+
+|name|url|
+|---|---|
+|unreal engine|https://unrealengine.com/|
+|github|https://github.com/EpicGames/UnrealEngine|
+
+ソース(source)からビルド(build)して使うこともできます。一部でbuildしないと使えない機能があります。private repoなので[こちら](https://www.unrealengine.com/ja/ue-on-github)からアクセス権をもらいます。
+
+## ueの特徴と注意
+
+`c++`か`blueprint`で書きます。
+
+ueの特徴はグラフィックが綺麗なことです。と言ってもきれいなグラフィックはunityなどでも実現可能です。しかし、ueは初期設定でもそれが実現できるので、主にグラフィック用途で使用されています。
+
+ueはバグ(bug)が多く基本的に動きません。これはアップデート(update)が速く、3Dを扱うソフトウェア(software)なので仕方ありません。複雑なのです。
+
+ueを長く使っているとわかることですが、ゲーム制作にはあまり向きません。unityのほうがおすすめです。ueはきれいな画像やシーンを作る用途におすすめです。
+
+「ueはバグが多く基本的に壊れている」このことを最初に理解しておかないと「おかしいなあ」と時間を無駄にしてしまいます。また、保存せず長時間コードを書き続けるのは危険です。クラッシュ(crash)すると消えてしまいます。プロジェクト(project)そのものが壊れることもよくあります。注意しましょう。
+
+## 用語の解説
+
+|title|short|body|
+|---|---|---|
+|unrealengine|ue|アンリアルエンジン|
+|version|ver|バージョン|
+|code||コード、プログラミング言語で書かれた文章|
+|build||ビルド、osで実行できる形式にすること。windowsなら`.exe`|
+|compile||コンパイル、コンピュータで実行できる形式にすること。buildと同じ意味で使われる|
+|source|src|ソース、主にソースコードの略|
+|server||サーバー、リクエストに応じるコンピュータ|
+|deploy||serverに実行ファイルを置くこと|
+|example|ex|例、uriではexample.comが有名|
+|install||インストール、アプリをインストールすること|
+|application|app|アプリ、ソフトウェア(software)のこと|
+|library|lib|ライブラリ、softwareを構築するための部品|
+|package|pkg|パッケージ、appだったり、libだったり色々。基本的にpkg managerでinstallできるものを指す|
+|update|up|アップデート、5.5の`x.5`の部分を言う ex: 5.4 -> 5.5|
+|upgrade||アップグレード、5.5の`5.x`の部分を言う ex: 4.0 -> 5.0|
+|asset||アセット、ueでは購入できるlibやexampleを指す|
+|plugin|plug|プラグイン、エンジンに直接入れる追加機能。新たなblueprintなどを使えるようになる|
+|crash||クラッシュ、アプリやosが落ちること|
+|cache||キャッシュ、一時ファイルのこと。tmpなども使われる|
+|repository|repo|リポジトリ、主にsrc codeの一式が置いてある場所|
+|project||プロジェクト、ueでは主に新しいゲームを作った時のフォルダ一式|
+|blueprint|bp|ブループリント、ueのノードベースで書く形式。anim blueprintはabp、character blueprintはcbpと略される事が多く、ファイル名は`BP_XXX`, `ABP_XXX`, `CBP_XXX`となる。基本大文字が使われる|
+|variable|var|変数、一時的な値の保存場所|
+
+基本的に英語で書けるものは英語で書きます。ueのmenuは英語にするのがおすすめです。様々な単語に慣れておきましょう。

book/default/02_install.md

@@ -0,0 +1,53 @@
+# install
+
+srcからbuildしない場合は`epicgames launcher`からinstallします。
+
+https://www.unrealengine.com/download
+
+また、[vsinstaller](https://visualstudio.microsoft.com/ja/downloads/)を使用して必要なpackageを入れてください。
+
+![](../img/0001.png)
+
+[vscode](https://github.com/microsoft/vscode)でbuildするには`.uproject`を右クリックして`.sln`を作ります。
+
+## package build
+
+まずは新しいprojectを作り、package buildできるかを試してみましょう。
+
+ueではbuildが通らないことがよくあります。長い時間をかけて作り上げたもののbuildが通らない事態は避けましょう。
+
+なお、`mac`, `linux`は、ほとんどうまくいきません。package化に成功してもappが正常に起動しないことがあります。使用するpluginやassetなども影響します。
+
+```sh
+# corss compile tool : https://dev.epicgames.com/documentation/ja-jp/unreal-engine/linux-development-requirements-for-unreal-engine
+# ubuntu(xorg + nvidia)
+
+$ sudo apt-get install xorg xvfb
+Xvfb :99 &
+export DISPLAY=:99
+
+$ sudo apt-get install vulkan-tools
+$ sudo apt-get install mesa-vulkan-drivers
+```
+
+## engineとproject
+
+installする場所は自分で決められます。参考の場所を紹介します。
+
+```sh
+# engine
+C:\Program Files\Epic\UE_5.5\Engine\Binaries\Win64\UnrealEditor.exe
+
+# project
+C:\Users\$USER\Documents\Unreal Projects\MyProject\MyProject.uproject
+```
+
+## windows tool
+
+|name|url|
+|---|---|
+|pwsh|https://github.com/PowerShell/PowerShell|
+|windows terminal|https://github.com/microsoft/terminal|
+|openssh|https://github.com/PowerShell/Win32-OpenSSH|
+|vscode|https://github.com/microsoft/vscode|
+

book/default/03_tips.md

@@ -0,0 +1,91 @@
+# tips
+
+この章は読み飛ばしてください。まとめやすいように重要項目を上にしています。
+
+最初はわからないかもしれませんが、最後まで読んでまた来ると、わかるようになっているかもしれません。
+
+## variable(var)
+
+まずは変数の紹介です。変数はローカル変数(local)、グローバル変数(global)があります。最初はprojectで読み込むところに作ります。
+
+1. フォルダの`/Content/Blueprints/`で右クリックして、ブループリントクラス、`GameInstance`を作ります。例えば、`GM_xxx`にします。(名前はなんでもいいです)
+2. `設定 -> プロジェクト設定 -> マップ&モード`の`Game Instance:GameInstance Class`に`GM_xxx`を読み込みます。
+
+なお、名前に`Default`, `Test`, `Config`などを使う場合は予約されていることがあります。注意してください。
+
+これを開いて、変数のところで`UserTest`という名前で`string`型の変数を作ります。コンパイル(compile)してください。デフォルト値は`World`とでも入れておきましょう。
+
+次に、`/Content/Blueprints/CBP_SandboxCharacter`を開いて、EventGraphで右クリックし、`Cast To GM_xxx`を選択します。
+
+インプット(input)のpin(ピン)にあるObjectには`Get Game Instance`をつなぎます。そして、アウトプット(output)の青線は`Get UserTest`と検索し、それを`Print String`につなぎます。
+
+さて、ここにkeyを設定して再生すると`World`と表示されるはずです。
+
+特に重要なのが`変数の型`です。種類もそうですが、変数の型の右側にある色アイコンをクリックしてみると、たくさんの形式があることがわかります。
+
+- 単一
+- 配列
+- 設定
+- マップ
+
+配列を使ってみましょう。`UserTestList`という名前で`string`の配列を作成します。
+
+ここで、デフォルト値に追加できることに気づくはずです。
+
+例えば、単語を3つ追加してみます。
+
+- [0]ai
+- [1]burst
+- [2]can
+
+`Cast To GM_xxx`から`Get UserTestList`を引っ張り出し、`Length`につなげます。それをprintしてみると、`2`と表示されるはずです。
+
+`length(len)`はその配列に追加された数を知ることができます。
+
+では、全部の値を取り出すため`for`を書きましょう。`UserTestList`から`For Each Loop`を伸ばして`Loop Body`からprintにつなぎます。値は`Array Element`から取ります。
+
+もし文字列をつなぎたいなら`Append`が使えます。
+
+変数にはObjectをいれることもできます。たくさんのObjectを入れておき、`Find`で検索して取り出すこともできます。
+
+では、characterを全部まとめて検索できる変数を作ってみます。
+
+名前は`UserCharacterObj`でstringを選択し、マップを選択します。右側のマップは`オブジェクト(object)`と検索し、object参照を選択します。
+
+```sh
+str obj
+--- ---
+```
+
+`cbp character`と検索し、characterのcbpを入れていきます。名前はわかりやすいものにしてください。例えば、`manny`, `quinn`など。
+
+では繋いでいきます。
+
+```sh
+[Get Game Instance] --> [Cast To GM_Defaultconfig] --> [UserCharacterObj]
+
+--> [Find(manny)] --> [Get Object Name] --> [Print String]
+```
+
+<iframe src="https://blueprintue.com/render/_q-q_ffz/" scrolling="no" allowfullscreen style="width:100%;height:400px"></iframe>
+
+基本的にこれを利用して、他のBPと値をやり取りすることになります。例えば、`ABP_SandboxCharacter`で条件を満たしたとき実行してほしいアニメーション(anim)があったとします。
+
+この場合、まず`GM_xxx`の変数で`UserCharacterAnim`をboolean型で作り、実行してほしいタイミングで`CBP_SandboxCharacter`に書いた`Cast To GM_Defaultconfig`から`UserCharacterAnim`を`true`に変更します。`Set UserCharacterAnim`で検索してください。そして、ABPには`UserCharacterAnim`がtrueならanimを再生する処理を書きます。
+
+## function(func)
+
+次は関数です。関数は簡単で、何度も繰り返す部分を再利用可能な形で残します。それが関数です。
+
+新しい関数を作ってみましょう。左バーの関数(+)を押せば作成されます。名前は`FuncTest`にします。
+
+関数を表す紫色のボックス(box)を選択した状態でinputとoutputの見てもらって、inputにboolという名前でboolean型を作ります。outputにはstrという名前でstring型を作ります。
+
+処理の内容はboolがtrueなら`[yes]`というstringを出力し、falseなら`[no]`にします。
+
+<iframe src="https://blueprintue.com/render/pvn4lao9/2" scrolling="no" allowfullscreen style="width:100%;height:400px"></iframe>
+
+確認してみましょう。`[9]`を押すと`[yes][no]`が表示されます。
+
+<iframe src="https://blueprintue.com/render/pvn4lao9/1" scrolling="no" allowfullscreen style="width:100%;height:400px"></iframe>
+