バージョン

menu_open

Migrating your projects

When you are ready to upgrade to a new major version of Wwise, you must follow a coordinated protocol to ensure that your projects created in an earlier version are migrated smoothly to the later version. The goal is to avoid putting any aspect of your game at risk, so you must examine the changes in the new version and selectively and systematically implement any modifications to your game code.

The protocol for upgrade and migration can vary depending on the following conditions:

  • Projects under source control: The project must be checked in at key points.

  • Multiple users: The Wwise upgrade, project migration, SDK upgrade, and game code update must be completed on a local system before multiple users can upgrade Wwise on their workstations.

  • Integrated game project: The game code must be modified as specified in the migration notes.

We strongly recommend that a migration team, composed of one or two designated individuals, perform the following tasks on a local system first:

After the migration team has carried out these tasks, you can proceed with:

また、ソースコントロールで管理しているプロジェクトをアップグレードして移行する時の概要は、下図に示します:

Preparing your projects for migration

Before you upgrade to a new version of Wwise, you must prepare your projects for the upgrade, particularly if your Wwise project has been integrated into a game. これから説明する手順を、移行したいプロジェクト毎に繰り返してください。

The migration team must carry out the following tasks to prepare projects to be migrated to the latest version.

  1. 全てのプロジェクトをコミットします:

    1. プロジェクトをソースコントロールで管理している場合は、他のチームメンバーに全ての変更をコミットするように依頼します。

      あとでマージ問題が起きるのを防ぐためです。

  2. 移行する全てのプロジェクトの最新バージョンを入手します:

    1. プロジェクトをソースコントロールで管理している場合は、全てのプロジェクトをローカルでシステムにインポートします。

    2. 全てのプロジェクトファイルの読み込みと書き込みが許可されていることを確認します。

      For projects under source control, you might need to check out the project file (WPROJ) and all Work Unit files (WWU) from the various subfolders.

  3. 移行するプロジェクトを検証します:

    1. In the current version of Wwise, open each project that you plan to migrate and save.

    2. If the Project Load Log dialog displays messages and suggested fixes, accept these fixes, save the changes, and close the project. このようなメッセージがなくなるまで、これを繰り返してください。これは、プロジェクトエラーを全て排除して、アップグレードをシンプルにすることが目的です。

  4. 移行するプロジェクトにタグ付けします:

    1. プロジェクトをソースコントロールで管理している場合は、プロジェクトをコミットして、アップグレード直前の最後のバージョンとしてタグ付けまたはラベル付けします。

      Committing the project at this point records all changes made prior to the migration process. それ以外は、移行に直接関連する変更としてソースコントロール履歴に残ります。

Upgrading Wwise and migrating your project

移行によって機能の内容に大幅な変更が出ても、移行後のプロジェクトが必ず今までと非常に似たサウンドとなるように、プロジェクトの移行処理が設計されています。移行による変更点の詳細については、 Wwiseリリースノート の最新版と、そこに記載されたリンク先の 重要な移行の注意 を参照してください。

We recommend that the migration team migrates the Wwise project to the new Wwise version on a local system first. All other users must not modify the project until the migrated project has been tested and then committed by the migration team.

[注釈]注釈

Depending on the types of changes made to Wwise from one version to another, your projects might not need to be migrated when upgrading to a new version.

  • Major Release: 新しいバージョンの年度が変わったり、年度のあとの小数点の数値が変わった場合は、メジャーリリースであり、いくつかの大きい変更点があると考えられます。For example, 2019.1 and 2019.2 were both major releases. When opening a project saved in the former version of Wwise with the latter version, Wwise will prompt you to migrate the project. If you accept, it's no longer possible to open that project with the 2019.1 version.

  • Minor Release: 年度や、年度のあとの小数点の数値が同じで、そのあとにさらに小数点と数値が追加された場合は、マイナーリリースです。For example, 2019.1.3 and 2019.1.4 were both minor releases with only a few changes. When opening a project saved in the former version of Wwise with the latter version, no migration is necessary.

  1. Wwiseをアップグレードします:

    1. Upgrade Wwise on your local system as described in Installing Wwise and Component Packages.

  2. プロジェクトを1つ、新バージョンに移行します。

    1. 現行のWwiseプロジェクトで、全てのプロジェクトファイルの読み込みと書き込みのステータスがあることを確認します。

    2. プロジェクトをバックアップして、バックアップしたプロジェクトをシステム上またはネットワーク上の別のフォルダに保存します。The project will be backed up automatically by Wwise, but it is good practice to create your own backup as well.

    3. Open the new version of Wwise. In the Project Launcher dialog that opens, select the project you plan to migrate.

      The Project Migration dialog opens prompting you to migrate the project to the later version of Wwise.

      [注釈]注釈

      The Migration dialog is only displayed when significant changes have been made to the project file between versions. プロジェクトの移行が必要なければ、Wwiseは移行処理の次の手順に移ります。

    4. Click Migrate.

      Wwise migrates the project. プロジェクトの移行後に、Wwiseは、既存のプロジェクトキャッシュフォルダがWwiseの新バージョンと互換性があるかどうかを確認します。互換性がなければ、Wwiseがプロジェクトキャッシュフォルダを削除します。When the project cache is deleted, the following message is displayed.

    5. OK をクリックします。

    6. Wwiseメニューバーで、Views > Utilities > Logsをクリックします。Logsビューが開きます。

    7. In the Logs view, select the Project Load tab. The Project Load log displays messages related to the migration and indicates if any files were created for the new version of Wwise.

      [注釈]注釈

      This information is stored in the file named projectname.wproj_migration.log in the project folder. If needed, you can click Copy to clipboard to save this information for later reference.

    8. ソースコントロールで管理している場合は、移行処理中に作成された新規ファイルがあれば、それをソースコントロールシステムに追加します。

    9. Logsビューを閉じます。

  3. サウンドバンク生成

    1. 移行したプロジェクトのテスト用に、複数のSoundBankを生成します。

Upgrading the Wwise SDK and updating game code

In addition to upgrading the Wwise authoring application, carry out the following tasks to upgrade the Wwise SDK and update the game code.

  1. Wwise SDKをアップグレードします:

    1. Confirm that your system meets the Wwise SDK Platform Requirements.

    2. Optionally, uninstall the earlier version of the Wwise SDK.

      It's good practice to also manually remove any temporary files created by the sample C++ projects.

    3. Install the later version of the Wwise SDK. Refer to Install Wwise through the Launcher and select SDK (C++) under Packages.

    4. Verify that the WWISESDK environment variable points to the installation folder of the later version. (環境変数の設定については、 Wwise SDKの複数のバージョンを使って作業する を参照してください。)

  2. Update the game code for the later version of the Wwise SDK:

    1. Refer to the migration notes in the Wwise SDK documentation to familiarize yourself with the modifications you will be making.

    2. To migrate the game code, you must port the existing functionalities of the C++ project from the earlier version of the Wwise SDK to the later version. This task might include modifying or refactoring code in different modules. Changes to the following modules might need to be addressed to update the game code:

      • Sound Engine

      • メモリマネージャ

      • Stream Manager

      • Communications Module

      [注釈]注釈

      To ensure that your game is not adversely affected by some of the new features in the later version, we recommend you first upgrade the components that you need for your game. ゲームが安定していると確認できたた時点で、必要に応じて新機能をインテグレートすると良いでしょう。

    3. 必要に応じてコードを修正します。

      [ヒント]ヒント

      It's good practice to rebuild the C++ project often when you are modifying the code.

  3. ゲームをビルドします。

ゲームプロジェクトのテスト

Before you can complete the upgrade and migration, you need to test the migrated game. To augment any testing protocol you might already use at your workplace, we have included a procedure. We recommend these tests are carried out by the migration team in both the Wwise authoring application and the game.

移行したゲームプロジェクトをテストして、コミットします:

  1. ゲーム内で、サウンドやオーディオの動作を検証します。以下の検証などを行うことができます。

    • 基本的なオーディオ再生。

    • コードを変更したことで影響を受ける動作。

    • プラットフォーム動作。

    • Wwiseオーサリングアプリケーションとのコミュニケーション。

  2. 移行したWwiseプロジェクトやコードの変更を、ソースコントロールにコミットします。

テストが完了して結果に満足できたら、他のユーザーにWwiseの最新バージョンのアップグレードを指示します。

Upgrading Wwise on all workstations

After Wwise has been upgraded, the project has been successfully migrated, the SDK has been upgraded, game code changes have been made, and testing is completed on a local system, you are ready to advise other users to upgrade Wwise on their workstations.

このアップグレードは、Wwiseが使われている全てのワークステーションで実施する必要があり、以下が含まれます:

  • ビルドマシン

  • サウンドデザイナーのワークステーション

  • デベロッパーのワークステーション

  • その他の全てのWwiseユーザーのワークステーション

Ensure you have identified all the workstations that run Wwise so that you can upgrade them all.

全てのワークステーションでWwiseをアップグレードします:

  1. 希望すれば、全てのWwiseコンポーネントをアンインストールすることができます。This might include:

    • Wwiseオーサリングアプリケーション

    • Wwise SDK

    For more information on uninstalling, refer to Uninstalling Wwise.

    [注釈]注釈

    Wwiseをアンインストールする必要はありません。必要に応じて、1つのワークステーションにWwiseの複数のビルドやバージョンを維持することができます。

  2. Install the later version of Wwise. This might include:

    • Wwiseオーサリングアプリケーション

    • Wwise SDK

    • Wwise Game Simulator

    For more information about installing, refer to Installing Wwise and Component Packages.

Access the migrated Wwise project on all workstations:

  1. After you have installed the later version of Wwise, retrieve the migrated Wwise project.

  2. Wwiseを開きます。

    エンドユーザーライセンス契約が表示されます。

  3. 本Agreementを読み、同意する場合はAcceptをクリックする。

    Project Launcherウィンドウが開きます。

  4. 移行したプロジェクトを開きます。

    [注釈]注釈

    If some users have Work Units in the Wwise project that have been saved locally and are not under source control, a message appears prompting them to accept that these Work Units will be migrated when the project opens in the new version of Wwise.

    プロジェクトをロードする前に、Wwiseは、既存のプロジェクトキャッシュフォルダがWwiseの新バージョンと互換性があるかどうかを確認します。互換性がなければ、Wwiseがプロジェクトキャッシュフォルダを削除します。プロジェクトキャッシュフォルダが削除されると、以下のメッセージボックスが表示されます。

  5. OK をクリックします。

    キャッシュを削除すると、プロジェクトがWwiseにロードされます。


このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう