Improve design documents (#128)

* docs: add some design contents

* docs: プレイヤーの動きに関するStateについて情報整理

* chore: 起動できるようにebitengineを更新

* fix: 内部Stateの扱いを改善しつつ、上昇と下降時の不具合を修正

* chore: WebAssembly関連の文書や処理、ファイルを更新・改善

* chore: CIでの設定も更新

* chore: golangci-lintの指摘対応

* fix: 先の変更によりプレイ画面でキー入力を受け付けなくなっていたのを修正

* chore: デバッグのための設定を追加

* fix: テキスト表示の仕組み変更に伴って位置ズレが生じていたのを修正

Author: kemokemo

.github/workflows/gh-pages.yml

@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Setup Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version: '1.20.1'
+          go-version: '1.24.4'
 
       - name: Checkout
         uses: actions/checkout@v4
@@ -26,10 +26,10 @@ jobs:
           GOOS=js GOARCH=wasm go build -ldflags="-X 'main.Revision=$(git rev-parse --short HEAD)'" -o ./public/kuronan-dash.wasm
 
       - name: Copy wasm exec
-        run: cp $(go env GOROOT)/misc/wasm/wasm_exec.js ./public
+        run: cp $(go env GOROOT)/lib/wasm/wasm_exec.js ./public/js
 
       - name: Deploy GitHub pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        go: ['1.20.1']
+        go: ['1.24.4']
     name: Test with Go ${{ matrix.go }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     env:
@@ -20,7 +20,7 @@ jobs:
         shell: bash
     steps:
       - name: Setup Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
 

.github/workflows/test-and-build.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        go: ['1.20.1']
+        go: ['1.24.4']
     name: Test with Go ${{ matrix.go }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     env:
@@ -27,7 +27,7 @@ jobs:
         shell: bash
     steps:
       - name: Setup Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
 

.vscode/launch.json

@@ -10,7 +10,7 @@
 			"type": "go",
 			"request": "launch",
 			"mode": "auto",
-			"program": "${fileDirname}",
+			"program": "./",
 			"env": {},
 			"args": []
 		}

.vscode/settings.json

@@ -8,5 +8,10 @@
     },
     "custom": true, // Enable the `custom` dictionary
     "internal-terms": false // Disable the `internal-terms` dictionary
-  }
+  },
+  "cSpell.words": [
+    "gomobile",
+    "miniweb"
+  ],
+  "sarif-viewer.connectToGithubCodeScanning": "off"
 }

assets/fonts/fonts.go

@@ -1,59 +1,55 @@
 package fonts
 
 import (
+	"bytes"
 	"fmt"
 
-	"github.com/golang/freetype/truetype"
-	"golang.org/x/image/font"
+	"github.com/hajimehoshi/ebiten/v2/text/v2"
 )
 
 var (
-	GamerFontSS font.Face
+	// GamerFontSS is the very small size font of the strong gamer font.
+	GamerFontSS *text.GoTextFace
+
 	// GamerFontS is the small size font of the strong gamer font.
-	GamerFontS font.Face
+	GamerFontS *text.GoTextFace
 
 	// GamerFontM is the middle size font of the strong gamer font.
-	GamerFontM font.Face
+	GamerFontM *text.GoTextFace
 
 	// GamerFontL is the large size font of the strong gamer font.
-	GamerFontL font.Face
+	GamerFontL *text.GoTextFace
 
 	// GamerFontLL is the extra large size font of the strong gamer font.
-	GamerFontLL font.Face
+	GamerFontLL *text.GoTextFace
 )
 
 // LoadFonts loads the fonts data.
 func LoadFonts() error {
-	tt, err := truetype.Parse(the_strong_gamer_ttf)
+	fontSource, err := text.NewGoTextFaceSource(bytes.NewReader(the_strong_gamer_ttf))
 	if err != nil {
-		return fmt.Errorf("failed to load TheStrongGamer font,%s", err)
+		return fmt.Errorf("failed to load font, %v", err)
 	}
 
-	const dpi = 72
-	GamerFontSS = truetype.NewFace(tt, &truetype.Options{
-		Size:    12,
-		DPI:     dpi,
-		Hinting: font.HintingFull,
-	})
-	GamerFontS = truetype.NewFace(tt, &truetype.Options{
-		Size:    16,
-		DPI:     dpi,
-		Hinting: font.HintingFull,
-	})
-	GamerFontM = truetype.NewFace(tt, &truetype.Options{
-		Size:    24,
-		DPI:     dpi,
-		Hinting: font.HintingFull,
-	})
-	GamerFontL = truetype.NewFace(tt, &truetype.Options{
-		Size:    36,
-		DPI:     dpi,
-		Hinting: font.HintingFull,
-	})
-	GamerFontLL = truetype.NewFace(tt, &truetype.Options{
-		Size:    60,
-		DPI:     dpi,
-		Hinting: font.HintingFull,
-	})
+	GamerFontSS = &text.GoTextFace{
+		Source: fontSource,
+		Size:   12,
+	}
+	GamerFontS = &text.GoTextFace{
+		Source: fontSource,
+		Size:   16,
+	}
+	GamerFontM = &text.GoTextFace{
+		Source: fontSource,
+		Size:   24,
+	}
+	GamerFontL = &text.GoTextFace{
+		Source: fontSource,
+		Size:   36,
+	}
+	GamerFontLL = &text.GoTextFace{
+		Source: fontSource,
+		Size:   60,
+	}
 	return nil
 }

assets/messages/ui_texts.go

@@ -2,14 +2,13 @@ package messages
 
 // Texts for UI
 const (
-	TitleStart      = "Spaceキー を おすか スタートボタン を\nマウス や タッチ で おしてね！"
-	SelectStart     = "さゆう の カーソルキー を おすか マウス や タッチ で キャラ を えらんだら スペースキー を おすか しゅっぱつボタン を おしてね"
-	GameStart       = "Spaceキー を おすか\nボタン を マウス や タッチ で おしてね！"
+	SelectStart     = "さゆう の カーソルキー を おすか キャラ を おして えらんだら スペースキー を おすか しゅっぱつボタン を おしてね"
+	GameStart       = "Spaceキー を おすか ボタン を おしてね！"
 	GameReady       = "Ready?"
 	GameGo          = "Go!"
 	GamePause       = "いちじ ていし しているよ！"
 	GameStageClear  = "やったね！ ステージクリアー だよ！"
-	GameStageClear2 = "Spaceキー を おすか マウス や タッチ で ボタン を おして"
+	GameStageClear2 = "Spaceキー を おすか ボタン を おして"
 	GameStageClear3 = "つぎの ステージ へ すすもう。"
-	GameOver        = "ゲームオーバー！ Spaceキー を おすか ボタン を おして\nタイトル へ もどろう"
+	GameOver        = "ゲームオーバー！ Spaceキー を おすか ボタン を おしてね！"
 )

assets/se/type.go

@@ -8,4 +8,5 @@ const (
 	Drop
 	Attack
 	Blocked
+	SpVoice
 )

documents/design/README.md

@@ -58,11 +58,14 @@ sequenceDiagram
 
 * SceneManager: ゲームの各画面を`Scene`と表現しており、それらの画面遷移を制御する仕組み
 
-### Titleシーンの懸案事項
+### `SceneManager`の懸案事項
 
-`Scene`の`Update`メソッドで`GameState`という状態を示す情報を渡しているが、現状この内部は`SceneManager`のポインタが入っているのみ。
+`Scene`の`Update`メソッドで`GameState`という状態を示す情報を渡しているが、
+現状この内部は`SceneManager`のポインタが入っているのみ。
 
-画面遷移するため`Scene`から`SceneManager`の`GoTo`メソッドを呼び出したかったのだと思うが、これでは各`Scene`が「自分の次はXX画面に遷移する」という情報を知っている必要があり、設計的に微妙。これでは、`SceneManager`に仕事してもらえていない状態。
+画面遷移するため`Scene`から`SceneManager`の`GoTo`メソッドを呼び出したかったのだと思うが、これでは各`Scene`が「自分の次はXX画面に遷移する」という情報を知っている必要があり、設計的に微妙。画面遷移の順序を自由にするため、`Scene`同士はできるだけ疎結合にしたい。
+
+`Scene`から`Scene`への遷移については、`SceneManager`に任せたい。
 
 例えば、`Scene`作成時にチャンネルを渡しておいて、そのチャンネルに対して通知すれば`SceneManager`が次の画面への遷移を実行してくれる・・という機構にすれば、各所が名前の通りの働きになるのではないだろうか。その方が画面遷移の制御コードが`SceneManager`に集約できるのと、ジワッと画面遷移するような処理も一箇所で実装するだけで済みそう。
 
@@ -225,8 +228,12 @@ classDiagram
     - tension
   }
 
+  class VelocityController {
+    <<interface>>
+  }
+
   Scene <|-- Stage01Scene
-  Field <|-- PrairieLane
+  Field <|-- PrairieField
 
   Stage01Scene --> charaPlayer
   Stage01Scene --> Field
@@ -240,6 +247,11 @@ classDiagram
 
   charaPlayer --> StateMachine
   charaPlayer --> StepAnimation
+  charaPlayer --> VelocityController
+
+  VelocityController <|-- KuronaVc
+  VelocityController <|-- KomaVc
+  VelocityController <|-- ShishimaruVc
 ```
 
 ### GameStateのステートマシン図
@@ -269,5 +281,95 @@ stateDiagram-v2
 
 ### プレイヤーStateのステートマシン図
 
-WIP
+`chara.Player`が内部で`StateMachine`実装に移譲して管理しているプレイヤーキャラのStateについて記述する。
+
+まずは現状を書き出してみる。
+
+```mermaid
+stateDiagram-v2
+  [*] --> Dash
+
+  Dash --> Walk: 1
+  Walk --> Dash: 2
+  
+  Dash --> Ascending: 3
+  Dash --> SkillEffect: 4
+
+  SkillAscending --> Dash: 5
+  Ascending --> Dash: 5
+  Descending --> Dash: 6
+  SkillDescending --> Dash: 6
+
+  Walk --> SkillDash: 2
+  SkillDash --> SkillWalk: 1
+  SkillDash --> Dash: 7
+
+  SkillWalk --> SkillDash: 2
+  SkillWalk --> Dash: 7
 
+  SkillWalk --> SkillAscending: 3
+  SkillDash --> SkillAscending: 3
+  Walk --> Ascending: 3
+
+  SkillWalk --> SkillDescending: 8
+  SkillDash --> SkillDescending: 8
+  Walk --> Descending: 8
+```
+
+#### パターン一覧
+
+1. スタミナ0または障害物に衝突中
+2. スタミナ回復または障害物との衝突解消
+3. ユーザーが上昇ボタン押下
+4. テンションMaxでユーザーがスキルボタン押下
+5. 上のレーンに到着
+6. 下のレーンに到着
+7. テンション0
+8. ユーザーが下降ボタンを押下
+
+スキル発動後はエフェクトやボイスの再生などがあるため、状態遷移とそのための操作がやや複雑になっている。現状は、`Scene`の実装が、`Player`の`UpdateSkillEffect`と`FinishSpEffect`をUpdateのたびに呼び出し、返り値がtrueになったらrun状態に戻す、という実装。（書き出してみて分かったが、上昇・下降前後での状態遷移に不具合がある。）
+
+すでにサウンドの再生にはチャンネルの仕組みを使っており、こちらも同様にチャンネルによる連携にしたい。
+スキルエフェクトを担う仕組みからチャンネルを渡しておけば実現できそう。
+
+* `StateMachine`内部では`SkillEffect`に遷移する
+* 次回以降の状態遷移では、スキル完了フラグをチェック
+* チャンネルから完了通知があれば、スキル完了フラグをtrueにする
+* スキル完了フラグがtrueになったのを受けて、状態を`SkillDash`に変更
+
+複雑になっている要因として、内部で「前の状態」を保持・更新して次回の状態遷移に用いている点が挙げられる。
+もっとシンプルに、上昇や下降が終了したらまずは`Dash`または`SkillDash`に遷移するようにした方がよいのではないだろうか。
+
+これから作る理想の形としては以下。
+
+```mermaid
+stateDiagram-v2
+  [*] --> Dash
+
+  Dash --> Walk: 1
+  Walk --> Dash: 2
+  
+  Dash --> Ascending: 3
+  Walk --> Ascending: 3
+  Ascending --> Dash: 5
+  Dash --> Descending: 8
+  Walk --> Descending: 8
+  Descending --> Dash: 6
+
+  Dash --> SkillEffect: 4
+  Walk --> SkillEffect: 4
+
+  SkillEffect --> SkillDash: スキルエフェクト完了
+  SkillDash --> SkillWalk: 1
+  SkillWalk --> SkillDash: スタミナ回復、障害物除去
+  
+  SkillDash --> SkillAscending: 3
+  SkillWalk --> SkillAscending: 3
+  SkillAscending --> SkillDash: 5
+  SkillDash --> SkillDescending: 8
+  SkillWalk --> SkillDescending: 8
+  SkillDescending --> SkillDash: 6
+
+  SkillDash --> Dash: テンション0
+  SkillWalk --> Walk: テンション0
+```

documents/developers-guide.md

@@ -2,7 +2,7 @@
 
 ## 前提条件
 
-- golang Ver. 1.9 以降
+- golang Ver. 1.24.4 以降
 
 ## 実行方法
 
@@ -38,6 +38,8 @@ miniweb -p 9000 public
 
 上記を実行した場合、ブラウザで `http://localhost:9000/` を開きましょう。
 
+`golang`自体の更新によってファイルの置き場所や処理が変わる場合があるので、 [公式のWiki](https://go.dev/wiki/WebAssembly) をチェックしよう。
+
 ### Mobile
 
 スマホにデプロイして遊んでみる場合は、[gomobile](https://github.com/golang/mobile)を使うのが便利です。[公式の手順](https://github.com/golang/go/wiki/Mobile)を見ながらインストールします。