Vue3でハロプロスネークゲームを作った

# 背景
- Vue3を勉強したいと思った  
- Composition APIを使ってみたかった
- どうせなら大好きなハロプロメンバーに関連づけたかった


# 作ったもの

### ゲーム画面
http://hello-snake-hosting.s3-website-ap-northeast-1.amazonaws.com/

### GitHub
https://github.com/yuya8696/hello-snake

# 環境
- Macbook Air
- VSCode
- Vue3
- Vite
- yarn
- SCSS



# 本題

### ViteをつかってVue3インストール

こちらを参考にVite環境、Vue3環境を構築しました。
https://vitejs.dev/guide/#index-html-and-project-root



### スネークゲームのベースを導入
こちらのスネークゲームをベースとさせていただきました。
https://qiita.com/miyauchoi/items/f753e5fa0209ab2034dd

↑ はHTMLファイルで完結しているので、
- App.vue
- src/HelloSnake.vue
に分けて簡単にコンポーネント化しました。

ベースとなるApp.vueでHelloSnake.vueをインポートしています。
HelloSnake.vueにはHTML部分とCSS部分を記載し、JS部分は下記のJSファイルに処理ごとに分離しています。
- src/assets/scripts/gatheringMembersAction.js
- src/assets/scripts/goingTimeAction.js
- src/assets/scripts/setupAction.js


### Vue3仕様に変更
Vue3の特徴はComposition APIです。  

`<script>`タグ内、`export default{}`文内の書き方が特に変わるので要注意です。

```vuejs:HelloSnake.vue
<script>
import { computed, onMounted, ref, reactive } from "vue";
import {
  setupAction,
  randomizeMemberIndex,
} from "../assets/scripts/setupAction";
import gatheringMembersAction from "../assets/scripts/gatheringMembersAction";
import { goingTimeAction } from "../assets/scripts/goingTimeAction";
import memberImages from "../assets/library/imagePaths";
import nameLists from "../assets/library/nameLists";
export default {
  name: "HelloSnake",
  setup() {
    let isStart = ref(true);
    let gridSize = ref(10); // 10 x 10 マス
    let memberIndex = ref(0); // メンバーの位置インデックス
    // ヘビに関するデータ
    const snake = reactive({
      headPos: {
        x: 1,
        y: 3,
      }, // 初期位置
      bodyIndexes: [0], // 体の位置インデックスたち
      direction: "→", // 進行方向
      speed: 400, // 1マス進むのにかかる時間[ms]
    });
    const isFrameout = computed(() => {
      const head = snake.headPos;
      return (
        head.x < 0 ||
        gridSize.value <= head.x ||
        head.y < 0 ||
        gridSize.value <= head.y
      );
    });
    const snakeHeadIndex = computed(() => {
      if (isFrameout.value) return null;
      return snake.headPos.y * gridSize.value + snake.headPos.x;
    });
    // メンバーを集めた？
    const isGatheringMember = computed(() => {
      return snakeHeadIndex.value === memberIndex.value;
    });
    // 自己衝突してる？
    const isSuicided = computed(() => {
      return snake.bodyIndexes.includes(snakeHeadIndex.value);
    });
    // ゲームオーバー？
    const isGameover = computed(() => {
      return isSuicided.value || isFrameout.value;
    });
    // 初期化処理
    onMounted(() => {
      // メンバーの初期位置決定とキーボード入力定義
      memberIndex.value = randomizeMemberIndex(gridSize, memberIndex).value;
      snake.value = setupAction(snake).value;
    });
    const startingGame = () => {
      // 時間経過によるスネークのアクション
      snake.value = goingTimeAction(
        isGameover,
        isGatheringMember,
        snake,
        snakeHeadIndex
      ).value;
      isStart.value = false;
    };
    const { memberIndexUpdated, snakeUpdated, ImageFilePath } =
      gatheringMembersAction(gridSize, memberIndex, snake, isGatheringMember);
    memberIndex.value = memberIndexUpdated.value;
    Object.assign(snake.bodyIndexes, snakeUpdated.bodyIndexes);
    Object.assign(snake.speed, snakeUpdated.speed);
    const memberIndexImage = computed(() => ({
      "--member-index-image": `url(${ImageFilePath.member})`,
    }));
    const snakeHeadImage = computed(() => ({
      "--snake-head-image": `url(${ImageFilePath.head})`,
    }));
    const setSnakeBodyImage = (gridIndex) => {
      if (!snake.bodyIndexes.includes(gridIndex - 1)) return "";
      if (ImageFilePath.body.length === 0) return;
      // gridIndexの順番ごとに異なる画像をセットする
      return {
        "background-image": `url(${
          ImageFilePath.body[snake.bodyIndexes.indexOf(gridIndex - 1)]
        })`,
        "background-position": "center center",
        "background-repeat": "no-repeat",
        "background-size": "cover",
      };
    };
    return {
      isStart,
      startingGame,
      gridSize,
      memberIndex,
      snake,
      isFrameout,
      snakeHeadIndex,
      isGameover,
      isGatheringMember,
      memberIndexImage,
      snakeHeadImage,
      setSnakeBodyImage,
      memberImages,
      nameLists,
    };
  },
};
</script>
```


**Composition APIの特徴**

- 処理は全部`setup(){}`関数内に書こう
- `setup(){}`関数で定義する変数は`ref()`でリアクティブにしよう
- オブジェクト変数は`reactive()`でリアクティブにしよう
- リアクティブにした変数の値を参照するときは`変数.value`と書こう
- `setup(){}`関数内で定義した変数、関数を`<tamplate>`タグ内でも使いたい場合は、returnに記載しよう


### スネークをハロプロメンバー集めに変更
スネークゲームのコンセプトとしては、
リーダーのふくちゃん（譜久村聖）とサブリーダーのえりぽん（生田衣梨奈）を先頭にして、次々と表示されるハロプロメンバーを集めていく
というものにしました。


ふくちゃんとえりぽん
<blockquote class="instagram-media" data-instgrm-permalink="https://www.instagram.com/p/CNpffBVn-wq/?utm_source=ig_embed&amp;utm_campaign=loading" data-instgrm-version="13" style=" background:#FFF; border:0; border-radius:3px; box-shadow:0 0 1px 0 rgba(0,0,0,0.5),0 1px 10px 0 rgba(0,0,0,0.15); margin: 1px; max-width:540px; min-width:326px; padding:0; width:99.375%; width:-webkit-calc(100% - 2px); width:calc(100% - 2px);"><div style="padding:16px;"> <a href="https://www.instagram.com/p/CNpffBVn-wq/?utm_source=ig_embed&amp;utm_campaign=loading" style=" background:#FFFFFF; line-height:0; padding:0 0; text-align:center; text-decoration:none; width:100%;" target="_blank"> <div style=" display: flex; flex-direction: row; align-items: center;"> <div style="background-color: #F4F4F4; border-radius: 50%; flex-grow: 0; height: 40px; margin-right: 14px; width: 40px;"></div> <div style="display: flex; flex-direction: column; flex-grow: 1; justify-content: center;"> <div style=" background-color: #F4F4F4; border-radius: 4px; flex-grow: 0; height: 14px; margin-bottom: 6px; width: 100px;"></div> <div style=" background-color: #F4F4F4; border-radius: 4px; flex-grow: 0; height: 14px; width: 60px;"></div></div></div><div style="padding: 19% 0;"></div> <div style="display:block; height:50px; margin:0 auto 12px; width:50px;"><svg width="50px" height="50px" viewBox="0 0 60 60" version="1.1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink"><g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g transform="translate(-511.000000, -20.000000)" fill="#000000"><g><path d="M556.869,30.41 C554.814,30.41 553.148,32.076 553.148,34.131 C553.148,36.186 554.814,37.852 556.869,37.852 C558.924,37.852 560.59,36.186 560.59,34.131 C560.59,32.076 558.924,30.41 556.869,30.41 M541,60.657 C535.114,60.657 530.342,55.887 530.342,50 C530.342,44.114 535.114,39.342 541,39.342 C546.887,39.342 551.658,44.114 551.658,50 C551.658,55.887 546.887,60.657 541,60.657 M541,33.886 C532.1,33.886 524.886,41.1 524.886,50 C524.886,58.899 532.1,66.113 541,66.113 C549.9,66.113 557.115,58.899 557.115,50 C557.115,41.1 549.9,33.886 541,33.886 M565.378,62.101 C565.244,65.022 564.756,66.606 564.346,67.663 C563.803,69.06 563.154,70.057 562.106,71.106 C561.058,72.155 560.06,72.803 558.662,73.347 C557.607,73.757 556.021,74.244 553.102,74.378 C549.944,74.521 548.997,74.552 541,74.552 C533.003,74.552 532.056,74.521 528.898,74.378 C525.979,74.244 524.393,73.757 523.338,73.347 C521.94,72.803 520.942,72.155 519.894,71.106 C518.846,70.057 518.197,69.06 517.654,67.663 C517.244,66.606 516.755,65.022 516.623,62.101 C516.479,58.943 516.448,57.996 516.448,50 C516.448,42.003 516.479,41.056 516.623,37.899 C516.755,34.978 517.244,33.391 517.654,32.338 C518.197,30.938 518.846,29.942 519.894,28.894 C520.942,27.846 521.94,27.196 523.338,26.654 C524.393,26.244 525.979,25.756 528.898,25.623 C532.057,25.479 533.004,25.448 541,25.448 C548.997,25.448 549.943,25.479 553.102,25.623 C556.021,25.756 557.607,26.244 558.662,26.654 C560.06,27.196 561.058,27.846 562.106,28.894 C563.154,29.942 563.803,30.938 564.346,32.338 C564.756,33.391 565.244,34.978 565.378,37.899 C565.522,41.056 565.552,42.003 565.552,50 C565.552,57.996 565.522,58.943 565.378,62.101 M570.82,37.631 C570.674,34.438 570.167,32.258 569.425,30.349 C568.659,28.377 567.633,26.702 565.965,25.035 C564.297,23.368 562.623,22.342 560.652,21.575 C558.743,20.834 556.562,20.326 553.369,20.18 C550.169,20.033 549.148,20 541,20 C532.853,20 531.831,20.033 528.631,20.18 C525.438,20.326 523.257,20.834 521.349,21.575 C519.376,22.342 517.703,23.368 516.035,25.035 C514.368,26.702 513.342,28.377 512.574,30.349 C511.834,32.258 511.326,34.438 511.181,37.631 C511.035,40.831 511,41.851 511,50 C511,58.147 511.035,59.17 511.181,62.369 C511.326,65.562 511.834,67.743 512.574,69.651 C513.342,71.625 514.368,73.296 516.035,74.965 C517.703,76.634 519.376,77.658 521.349,78.425 C523.257,79.167 525.438,79.673 528.631,79.82 C531.831,79.965 532.853,80.001 541,80.001 C549.148,80.001 550.169,79.965 553.369,79.82 C556.562,79.673 558.743,79.167 560.652,78.425 C562.623,77.658 564.297,76.634 565.965,74.965 C567.633,73.296 568.659,71.625 569.425,69.651 C570.167,67.743 570.674,65.562 570.82,62.369 C570.966,59.17 571,58.147 571,50 C571,41.851 570.966,40.831 570.82,37.631"></path></g></g></g></svg></div><div style="padding-top: 8px;"> <div style=" color:#3897f0; font-family:Arial,sans-serif; font-size:14px; font-style:normal; font-weight:550; line-height:18px;"> この投稿をInstagramで見る</div></div><div style="padding: 12.5% 0;"></div> <div style="display: flex; flex-direction: row; margin-bottom: 14px; align-items: center;"><div> <div style="background-color: #F4F4F4; border-radius: 50%; height: 12.5px; width: 12.5px; transform: translateX(0px) translateY(7px);"></div> <div style="background-color: #F4F4F4; height: 12.5px; transform: rotate(-45deg) translateX(3px) translateY(1px); width: 12.5px; flex-grow: 0; margin-right: 14px; margin-left: 2px;"></div> <div style="background-color: #F4F4F4; border-radius: 50%; height: 12.5px; width: 12.5px; transform: translateX(9px) translateY(-18px);"></div></div><div style="margin-left: 8px;"> <div style=" background-color: #F4F4F4; border-radius: 50%; flex-grow: 0; height: 20px; width: 20px;"></div> <div style=" width: 0; height: 0; border-top: 2px solid transparent; border-left: 6px solid #f4f4f4; border-bottom: 2px solid transparent; transform: translateX(16px) translateY(-4px) rotate(30deg)"></div></div><div style="margin-left: auto;"> <div style=" width: 0px; border-top: 8px solid #F4F4F4; border-right: 8px solid transparent; transform: translateY(16px);"></div> <div style=" background-color: #F4F4F4; flex-grow: 0; height: 12px; width: 16px; transform: translateY(-4px);"></div> <div style=" width: 0; height: 0; border-top: 8px solid #F4F4F4; border-left: 8px solid transparent; transform: translateY(-4px) translateX(8px);"></div></div></div> <div style="display: flex; flex-direction: column; flex-grow: 1; justify-content: center; margin-bottom: 24px;"> <div style=" background-color: #F4F4F4; border-radius: 4px; flex-grow: 0; height: 14px; margin-bottom: 6px; width: 224px;"></div> <div style=" background-color: #F4F4F4; border-radius: 4px; flex-grow: 0; height: 14px; width: 144px;"></div></div></a><p style=" color:#c9c8cd; font-family:Arial,sans-serif; font-size:14px; line-height:17px; margin-bottom:0; margin-top:8px; overflow:hidden; padding:8px 0 7px; text-align:center; text-overflow:ellipsis; white-space:nowrap;"><a href="https://www.instagram.com/p/CNpffBVn-wq/?utm_source=ig_embed&amp;utm_campaign=loading" style=" color:#c9c8cd; font-family:Arial,sans-serif; font-size:14px; font-style:normal; font-weight:normal; line-height:17px; text-decoration:none;" target="_blank">譜久村 聖/モーニング娘。’21(@mizuki_fukumura.official)がシェアした投稿</a></p></div></blockquote> <script async src="//www.instagram.com/embed.js"></script>

※現状、モーニング娘。'21、Juice=Juice、アンジュルムの３グループのメンバーが出るようにしてます。本当はつばきファクトリーとBEYOOOOONDSもいるよ。


**スタート画面**
スネークゲームを作った目的の１つはハロプロメンバーを知ってもうことなので、メンバー画像と一緒にしっかり名前も出してあげないといけません。

まずはふくちゃんとえりぽんの紹介と共にスタート画面を準備します。
テンプレートはこんな感じで、`isStart`がtrueの場合に表示させます。

```vue:HelloSnake.vue
<template>
~~中略~~
    <div v-if="isStart" class="hellosnake__start">
      <p style="font-size: 50px; color: coral; font-family: sans-serif">
        HELLO-PROJECT SNAKE GAME
      </p>
      <button class="hellosnake__start__btn" @click="startingGame()">
        START
      </button>
      <p></p>
      <div>
        <img :src="memberImages[0]" />
        <img :src="memberImages[1]" />
        <br />
        <h1 class="hellosnake__start__text">　{{ nameLists[0] }}</h1>
        <h1 class="hellosnake__start__text">　{{ nameLists[1] }}</h1>
      </div>
      <p style="font-size: 20px">↑↑ このメンバーで始めまるよ ↑↑</p>
    </div>
~~中略~~
</template>
```
`isStart`変数は`setup(){}`関数内で定義したものなので、関数の最後でしっかりreturnしてあります。

```vuejs:HelloSnake.vue
<script>
~~中略~~
export default {
  name: "HelloSnake",
  setup() {
  ~~中略~~
    return {
      isStart,
      ~~中略~~
    };
  },
};
</script>
```

**初期設定とスタート後の処理**
初期設定はこちらに書き出しています。
src/assets/scripts/setupAction.js
やっていることは
- メンバーをランダムに表示する処理
- 矢印を押されたらスネークの進行方向を決める処理
です。
ベースにしたものからほとんど変更はありません。

スタート後の時間が進むにつれて実行する処理はこちらです。
src/assets/scripts/goingTimeAction.js
やっていることはこんな感じ。
- 時間が進むごとにスネークを進める
- ゲームオーバーしてたらスネークは進めない
- メンバーを集めた直後はスネークは進めない
こちらもメンバーを集めた直後にスリープを入れた以外は、ベースにしたものからほとんど変更はありません。



**メンバーを集めた時**
ふくちゃんとえりぽんがメンバーを集めたら次の処理を実行します。
- 集めたメンバーの画像と名前を３秒間表示します
- 集めたメンバーをスネークの後方に追加します
- スネークの移動速度を少し早くします
- 次のメンバーをランダムな位置に表示します

処理は以下ファイルに書き出しました。
src/assets/scripts/gatheringMembersAction.js

```javascript:gatheringMembersAction.js
import { watch, ref, reactive } from "vue";
import { randomizeMemberIndex } from "../scripts/setupAction";
import { sleep } from "../scripts/goingTimeAction";

import memberImages from "../library/imagePaths";

export default function gatheringMembersAction(
  gridSize,
  memberIndex,
  snake,
  isGatheringMember
) {
  const memberIndexUpdated = ref(0);
  const snakeUpdated = reactive({});
  const ImageFilePath = reactive({
    member: "src/assets/images/morning/ishida.jpg",
    head: "src/assets/images/morning/fukumura.jpg",
    body: ["src/assets/images/morning/ikuta.jpg"],
  });

  const growUpSnake = () => {
    snake.bodyIndexes.unshift(snake.bodyIndexes[0]);
    return snake;
  };

  const speedUpSnake = () => {
    snake.speed -= 10;
    return snake;
  };

  const defineImages = () => {
    // メンバーの出現の順番
    ImageFilePath.member = memberImages[snake.bodyIndexes.length + 1];

    // snakeの先頭はふくちゃんで固定
    ImageFilePath.head = memberImages[0];

    // 集めたメンバーをスネークの後方に足していく
    ImageFilePath.body.unshift(memberImages[snake.bodyIndexes.length]);
  };

  watch(isGatheringMember, async (newValue) => {
    if (!newValue) return;
    await sleep(3);

    // snakeの長さを増やす
    snakeUpdated.value = growUpSnake().value;

    // snakeのスピードを増やす
    snakeUpdated.value = speedUpSnake().value;

    // snakeの先頭とメンバー画像のファイルパス指定する
    defineImages();

    // 次のメンバーの表示位置を決める
    memberIndexUpdated.value = randomizeMemberIndex(
      gridSize,
      memberIndex
    ).value;
    await sleep(2);
  });

  return {
    memberIndexUpdated,
    snakeUpdated,
    ImageFilePath,
  };
}
```

メンバーを集めたことを示す変数`isGatheringMember`をwatchして、
trueの場合に処理を実行しています。
この関数はHelloSnake.vueで呼び出しています。

```vuejs:HelloSnake.vue
<script>
~~中略~~
    const { memberIndexUpdated, snakeUpdated, ImageFilePath } =
      gatheringMembersAction(gridSize, memberIndex, snake, isGatheringMember);

    memberIndex.value = memberIndexUpdated.value;
    Object.assign(snake.bodyIndexes, snakeUpdated.bodyIndexes);
    Object.assign(snake.speed, snakeUpdated.speed);
~~中略~~
</script>
```


### AWS S3で公開
以下ページを参考にサクッとS3で公開しています。
https://qiita.com/kiyokiyo_kzsby/items/77bdb81a1ce1852b30ca

ビルドしたindex.htmlとjs, css, 画像ファイルをS3におくだけ。簡単です。


# 感想
もともと１枚のHTMLだったスネークゲームをVue3で書き直して、ハロプロメンバー仕様に改造しました。
Vue3のComposition APIはルールさえ覚えてしまえば簡単でした。
RefやReactiveの概念、setup関数内で利用するものはimportが必要などついつい忘れがちな部分はありますが、まあそれも慣れかなと。

今回作ったものだとComposition APIの恩恵を受けるには少し足りない気がしますが、
勉強がてら書き方を学べたのでよかったかなと思います。