Search Results for

    Show / Hide Table of Contents

    Voice Pack Practice

    中文 | English

    Run this command at the repository root to replay the examples through the local Unity MCP. The command also captures screenshots in both languages.

    python Docs/Manual/manual/tools/tutorials.py run voice-pack-practice --capture
    
    Click to expand MCP actionsClick to collapse MCP actions

    Prepare the teaching sample. The recipe provides ${variables}.

    {
      "variables": {
        "package": "${fixture}/Docs_${runId}_Package.asset",
        "pipeline": "${fixture}/Docs_${runId}_Pipeline.asset",
        "packageGuid": "5cd6ae9b-1231-5334-90e0-87a3974c3d4a",
        "bankConfig": "${fixture}/TutorialVoiceBank.asset",
        "bankPipeline": "${fixture}/TutorialVoicePipeline.asset",
        "crew": "${fixture}/TutorialCrewVoice.asset"
      },
      "calls": [
        {
          "tool": "invoke",
          "arguments": {
            "path": "static:UnityEditor.AssetDatabase/CreateFolder",
            "args": [
              "${fixtureParent}",
              "${folder}"
            ]
          },
          "expect": {
            "contains": "(String)"
          }
        },
        {
          "tool": "invoke",
          "arguments": {
            "path": "static:UnityEditor.AssetDatabase/CreateAsset",
            "args": [
              "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.ModPackageData)",
              "${package}"
            ]
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "invoke",
          "arguments": {
            "path": "static:UnityEditor.AssetDatabase/CreateAsset",
            "args": [
              "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.ModPackageBuildPiplineData)",
              "${pipeline}"
            ]
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/localizedModName/defaultName",
            "value": "Tutorial Package"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/localizedDescription/defaultName",
            "value": "Documentation teaching package"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/author",
            "value": "Documentation"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/supportURL",
            "value": "https://doc.game.windyverse.net/"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${package}/guid",
            "value": "${packageGuid}"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        },
        {
          "tool": "inspect_set",
          "arguments": {
            "path": "asset:${pipeline}/linkedModPackage",
            "value": "@asset:${package}"
          },
          "expect": {
            "contains": "OK:"
          },
          "phase": "build"
        }
      ]
    }
    

    Following FMOD project setup, work in a usable Studio project:

    1. In the Audio Bin, create a subfolder under crew, then import the recordings.
    2. Under Events crew/ground, create a subfolder, duplicate a group with Ctrl+D, and rename the suffix (for example cn -> jp).
    3. Replace the original Playlist clips with your recordings while preserving the event parameters.
    4. Press Ctrl+2 to open Mixer and check that the new events route to dialogs. Separately, create a voice bank under Banks and assign the new events to it. Build the target platforms and check the .bank files in the corresponding folders under the FMOD project's Build directory.

    Back in Unity, create SoundBankBuildPiplineData. Assign the matching output folders for Desktop and Mobile. Use Pick Multi Banks to select the .bank files, then inspect the generated SoundBankConfig entries and platform paths before saving.

    Click to expand MCP actionsClick to collapse MCP actions
    [
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/CreateAsset",
          "args": [
            "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.SoundBankConfig)",
            "${bankConfig}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/CreateAsset",
          "args": [
            "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.SoundBankBuildPiplineData)",
            "${bankPipeline}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${bankConfig}/soundBankName",
          "value": "tanks_crews_cn"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEngine.JsonUtility/FromJsonOverwrite",
          "args": [
            "{\"eventRefList\":[]}",
            "@asset:${bankConfig}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:ShanghaiWindy.Editor.SoundBankConfigEditor/RefreshBanks",
          "args": [
            "@asset:${bankConfig}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${bankPipeline}/desktopSoundBankPath",
          "value": "../Fmod/Build/Desktop"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${bankPipeline}/mobileSoundBankPath",
          "value": "../Fmod/Build/Mobile"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:ShanghaiWindy.Core.AssetBundleManager/LuaEnv/DoString",
          "args": [
            "local U, E = CS.UnityEngine, CS.UnityEditor\nlocal bank = E.AssetDatabase.LoadMainAssetAtPath('${bankConfig}')\nlocal pipeline = E.AssetDatabase.LoadMainAssetAtPath('${bankPipeline}')\nlocal configType = CS.ShanghaiWindy.Core.SoundBankBuildPiplineData.Config\nlocal row = configType()\nrow.soundBankConfig = bank\nrow.desktopSoundBankPath = pipeline.desktopSoundBankPath .. '/' .. bank.soundBankName .. '.bank'\nrow.mobileSoundBankPath = pipeline.mobileSoundBankPath .. '/' .. bank.soundBankName .. '.bank'\nlocal rows = CS.System.Array.CreateInstance(typeof(configType), 1)\nrows:SetValue(row, 0)\npipeline.configs = rows\nassert(CS.System.IO.File.Exists(row.desktopSoundBankPath))\nE.EditorUtility.SetDirty(pipeline)\nE.AssetDatabase.SaveAssets()\nreturn 'Bank row linked'\n",
            "link-voice-bank",
            "null"
          ]
        },
        "expect": {
          "contains": "Bank row linked"
        }
      }
    ]
    

    Create CrewFmodVoiceData and use the event reference picker to assign the events you created, including StartBattleEvent. Add both the crew and bank pipeline assets to Linked Objects, build for the target platform, and package the mod.

    Battle start event in crew voice data

    Click to expand MCP actionsClick to collapse MCP actions
    [
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/CreateAsset",
          "args": [
            "@static:UnityEngine.ScriptableObject/CreateInstance(ShanghaiWindy.Core.CrewFmodVoiceData)",
            "${crew}"
          ]
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "inspect_set",
        "arguments": {
          "path": "asset:${crew}/voiceName/defaultName",
          "value": "Tutorial Crew"
        },
        "expect": {
          "contains": "OK:"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:ShanghaiWindy.Core.AssetBundleManager/LuaEnv/DoString",
          "args": [
            "local E = CS.UnityEditor\nlocal bank = E.AssetDatabase.LoadMainAssetAtPath('${bankConfig}')\nlocal crew = E.AssetDatabase.LoadMainAssetAtPath('${crew}')\nfor index = 0, bank.eventRefList.Count - 1 do\n    local evt = bank.eventRefList[index]\n    if evt.Path:lower():find('start_battle_cn', 1, true) then\n        crew.StartBattleEvent = evt\n        E.EditorUtility.SetDirty(crew)\n        E.AssetDatabase.SaveAssets()\n        return evt.Path\n    end\nend\nerror('No start-battle event found in bank')\n",
            "wire-voice-crew",
            "null"
          ]
        },
        "expect": {
          "contains": "start_battle_cn"
        }
      },
      {
        "tool": "inspect",
        "arguments": {
          "path": "asset:${crew}/StartBattleEvent/Path"
        },
        "expect": {
          "contains": "start_battle_cn"
        }
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "asset:${pipeline}/linkedObjects/Add",
          "args": [
            "@asset:${bankPipeline}"
          ]
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "asset:${pipeline}/linkedObjects/Add",
          "args": [
            "@asset:${crew}"
          ]
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.EditorUtility/SetDirty",
          "args": [
            "@asset:${pipeline}"
          ]
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:UnityEditor.AssetDatabase/SaveAssets",
          "args": []
        },
        "expect": {
          "contains": "OK:"
        },
        "phase": "build"
      },
      {
        "tool": "modpack_plan",
        "arguments": {
          "pipeline": "${pipeline}"
        },
        "expect": {
          "equals": {
            "ok": true,
            "built": false
          },
          "contains": "\"crewvoice\""
        },
        "phase": "build"
      },
      {
        "tool": "modpack_build",
        "arguments": {
          "pipeline": "${pipeline}"
        },
        "expect": {
          "equals": {
            "ok": true,
            "archiveExists": true,
            "published": false,
            "installed": false
          }
        },
        "capture": {
          "archivePath": {
            "path": "archivePath"
          }
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:Frontend.Editor.ModPackageWorkshopMeta/WriteSidecar",
          "args": [
            "${archivePath}"
          ]
        },
        "expect": {
          "contains": ".modpack.json"
        },
        "capture": {
          "sidecarPath": {
            "regex": "\\(String\\) (.+)"
          }
        },
        "phase": "build"
      },
      {
        "tool": "invoke",
        "arguments": {
          "path": "static:System.IO.File/ReadAllText",
          "args": [
            "${sidecarPath}"
          ]
        },
        "expect": {
          "contains": "${packageGuid}"
        },
        "phase": "build"
      }
    ]
    
    In this article
    Back to top Panzer War Document