Tutorial: Upgrading a game project

Transcription

1 Tutorial: Upgrading a game project This tutorial walks you through the steps needed to upgrade a game project from a previous version of Lumberyard. You will learn how to do the following: Upgrade Lumberyard using source control Upgrade a project using source control Upgrade a project without source control Use the Project Configurator Prerequisites This tutorial assumes you have installed a previous version of Lumberyard and have set up your development environment. You must have the following before starting this tutorial: Windows 7 or higher (64bit) Processor Intel Quad-Core (I 2300), AMD Octo-Core (FX810), or better Memory 8 GM RAM or higher Graphics card NVIDIA GeForce 660Ti, Radeon HD790, or better Disk space 8 GB minimum Visual C++ Redistributable Packages for Visual Studio 2013 Visual Studio 2013 [Community/Pro/Ultimate] with update 5 or above Step 1: Upgrade Lumberyard using source control This step in the tutorial will show you how to upgrade Lumberyard using source control. To upgrade Lumberyard using source control 1. Before beginning the upgrade process, make sure to have the previous pristine version of Lumberyard checked in to source control. 2. In Windows Explorer, navigate to the folder where the previous pristine version of Lumberyard is located and delete the contents of the folder. NOTE: If you don t follow this step, old files that should be removed after upgrading won t be removed from source control.

2 3. Install or copy the new version of Lumberyard to the empty folder. Make sure the general folder structure is the same as the previous version before continuing. 4. Using source control, reconcile the files in the folder with those in the pristine Lumberyard branch. For example, if you re using Perforce, use the Reconcile offline work feature. 5. Commit the reconciled version to the pristine Lumberyard branch as the new version of Lumberyard. 6. Integrate the updated pristine Lumberyard branch into your development branch Step 2: Upgrade a project using source control After upgrading your development branch to a new version of Lumberyard you must add a project.json file and configure the new project. To upgrade a project using source control 1. Create a file named project.json and place it in your game folder. For example if your game project is called MyProject the file path should be dev/myproject/project.json. 2. Open project.json in your favorite text editor and paste the following in it: { } "project_name": "MyProject", "product_name": "MyProject", "executable_name": "MyProjectLauncher", "code_folder": "Code/MyProject", "modules" : ["MyProject"] 3. Replace every instance of MyProject with the name of your project, then save and close the file. 4. Rename your _WAF_/user_settings.options file to _WAF_/user_settings.bak 5. Open a command window and navigate to the Lumberyard dev folder. 6. Run lmbr_waf configure to generate a new user_settings.options file. NOTE: If you made any manual changes to your previous user_settings.options file (saved as user_settings.bak), now is a good time to make them.

3 7. Run the Project Configurator from the Start Menu or by running ProjectConfigurator.exe from the dev/bin64 folder. The Project Configurator will open and display a list of projects. 8. Select your project then press Set as default to make it the active project.

4 9. Open a command window and navigate to the Lumberyard dev folder. 10. Run lmbr_waf configure 11. Fix any configuration issues and then build your project by running lmbr_waf build_win_x64_profile -p all 12. See the release notes for the new version of Lumberyard for information about changes to Lumberyard and to help you resolve any compile or linker issues.

5 13. Commit the project.json file and updated project code to source control. Congratulations! You have successfully upgraded your game project. Step 3: Upgrade a project without source control If you want to upgrade a game project outside of source control (not recommended) you can move the project code and game folder to the new version of Lumberyard and compile it against the new version. To upgrade a project without using source control 1. Copy your project s code folder inside dev/code from the old Lumberyard install location to the new Lumberyard location. For example, if your project name was MyProject you would copy the dev/code/myproject folder from the old Lumberyard install location to the dev/code/myproject folder of the new Lumberyard location. 2. Next, copy your project s game folder inside dev from the old Lumberyard install location to the dev folder of the new Lumberyard install. For example, if your project name is MyProject, copy dev/myproject from the old Lumberyard install to dev/myproject in the new Lumberyard location. 3. Create a file named project.json and place it in your game folder. For example if your game project is called MyProject the file path should be dev/myproject/project.json. 4. Open project.json in your favorite text editor and paste the following in it: { } "project_name": "MyProject", "product_name": "MyProject", "executable_name": "MyProjectLauncher", "code_folder": "Code/MyProject", "modules" : ["MyProject"] 5. Replace every instance of MyProject with the name of your project, then save and close the file.

6 6. Run the Project Configurator from the Start Menu or by running ProjectConfigurator.exe from the dev/bin64 folder. The Project Configurator will open and display a list of projects. 7. Select your project then press Set as default to make it the active project. 8. Open a command window and navigate to the Lumberyard dev folder.

7 9. Run lmbr_waf configure 10. Fix any configuration issues and then build your project by running lmbr_waf build_win_x64_profile -p all 11. See the release notes for the new version of Lumberyard for information about changes to Lumberyard and to help you resolve any compile or linker issues.

8 Congratulations! You have successfully upgraded your game project. Related tasks and tutorials Now that you have updated your game project, here are some related tutorials: Tutorial: Creating a Gem with code Tutorial: Compiling the Engine, Editor and Game We d love to hear from you! Head to our Tutorial Discussion forum to share any feedback you have, including what you do or don t like about our tutorials or new content you d like to see in the near future.