RPGMV-SmartDeploy-forWEB

概要

ツクールMVプロジェクトのWEBデプロイを効率化するツールです。

• プラグインやスクリプトを考慮に入れた、未使用素材チェックによる軽量デプロイメント。
• デプロイ後、そのままGitHubにプッシュすれば、GitHub Pagesにゲームを公開可能。
• Netlifyでのゲーム公開に対応。

必要なもの

• パソコン
  • Windowsを推奨。
  • Linuxでも動くかもしれない。
  • Macで動くかは確認してない。
• インストールしておく必要があるもの
  • 最新の Git
    • コマンドプロンプトやターミナルで以下のコマンドを打ってバージョンが出たら入ってる。

    git --version
    

  • 最新の Node.js (npm)
    • コマンドプロンプトやターミナルで以下のコマンドを全部打ってバージョンが出たら入ってる。

    node -v
    npm -v
    npx -v
    

  • 最新の Yarn
    • コマンドプロンプトやターミナルで以下のコマンドを打ってバージョンが出たら入ってる。

    yarn -v
    

• 無いと話にならない
  • RPGツクールMVで編集可能なプロジェクトファイル
• あると便利なもの
  • GitHubのアカウント
  • Netlifyのアカウント

インストール

0. コマンドプロンプトやターミナルを開き、インストールしたいディレクトリのパスをカレントディレクトリにする

cd <インストールしたいディレクトリのパス>

1. コマンドプロンプトやターミナルで以下を入力

git clone https://github.com/katai5plate/RPGMV-SmartDeploy-forWEB
cd RPGMV-SmartDeploy-forWEB
yarn setup

2. インストール完了

アンインストール

• インストールしたRPGMV-SmartDeploy-forWEBディレクトリを削除すればいい

基本的な使い方

1. srcディレクトリに、RPGツクールMVで編集可能なプロジェクトファイルを入れる。
2. script.config.jsonを開きgameDirNameの値をSampleから作業するプロジェクトファイル名に変更して保存する
3. ある程度作業して、デプロイしたいと思ったら、以下のコマンドをコマンドプロンプトやターミナルから入力

cd <RPGMV-SmartDeploy-forWEBディレクトリ>
yarn build

4. 問題なければdocsディレクトリに最適化されたWEBデプロイメントファイルが生成される。

補足

• yarn buildに失敗する場合は、もう一度やってみるとうまくいくことがある。（既知のバグ #1 ）
• RPGアツマールにアップロードしたいなら、デプロイされたdocsをzipで圧縮したものをアップロードすればいい
• RPGMV-SmartDeploy-forWEBというディレクトリ名をそのまま好きな名前に変更したり、
  新しく作ったGitHubブランチに内容をそのまま入れたりするとワンポイント使いやすいかも

GitHub Pagesでゲームを遊べるようにする（上級者向け）

準備

0. GitHubのアカウントを作る
1. 製作中のゲーム専用のリポジトリを作る。
2. 基本的な使い方の手順でデプロイメントを行う。
3. 1.で作ったリポジトリをgit cloneでローカルに落とす。
4. RPGMV-SmartDeploy-forWEBディレクトリの内容をそのままコピーする。
5. コミット＆プッシュする。git add -A -> git commit -m "Update" -> git push origin master

設定

6. ブランチにファイルがアップロードされたことを確認したら、ブランチのSettingを開く。
7. Setting -> Options -> GitHub Pages -> Source
   -> Noneからmaster branch /docs folderに設定し、Saveをクリック。
8. しばらくしたら、http://<GitHubのユーザー名>.github.io/<リポジトリ名>/にゲームが公開される。

Netlifyでゲームを遊べるようにする（上級者向け）

準備

0. GitHubとNetlifyのアカウントを作る
1. GitHub Pagesでゲームを遊べるようにする（上級者向け）の 1～5 を行う

設定

2. ブランチにファイルがアップロードされたことを確認したら、https://app.netlify.com/を開く。
3. New site from Gitをクリック -> Continuous DeploymentからGitHubをクリック。
4. 1.で作ったリポジトリ名を見つけてクリック
5. Branch to deployはmasterを選択 ->
   Build commandはyarn server:deployを入力 -> Publich directoryはdocsを入力 ->
   Deploy siteをクリック。
6. 遷移したページの上の方に、デプロイが成功したらURLが表示される。

補足

• デプロイが成功しなかった場合は、Build command：yarn server:deploy:redecodeも試してみる。
• 試してないけど、BitBucketからでもNetlifyで公開可能だと思われ。

バグを見つけたら

• こちらで報告お願いします。(要GitHubアカウント)
  • https://github.com/katai5plate/RPGMV-SmartDeploy-forWEB/issues

免責事項

このツールを使用していかなる問題が起きても、私はその責を負いません。使用は自己責任でお願いします。