o3de-multiplayersample
o3de-multiplayersample copied to clipboard
o3de
MultiplayerPlayerSample (MPS) Doesn't Compile Because Bad Icon File in GitHub zip
Describe the bug MPS doesn't compile because a bad GameSDK.ico
Steps to reproduce Steps to reproduce the behavior:
- Download MPS development branch
- Use ProjectManager to compile.
- Notice build error...
Expected behavior Build success
Actual behavior Build error C:\o3de\projects\o3de-multiplayersample-development\build\windows\o3de\Code\LauncherUnified\MultiplayerSample.GameLauncher.rc(9): error RC2175: resource file C:/o3de/projects/o3de-multiplayersample-development/Gem/Resources/GameSDK.ico is not in 3.00 format [C:\o3de\projects\o3de-multiplayersample-development\build\windows\o3de\Code\LauncherUnified\MultiplayerSample.GameLauncher.vcxproj]
Found in Branch development
Desktop/Device (please complete the following information):
- OS: Windows
AutomatedTesting version has not been updated for 9 months, so it does not appear to be caused by an update https://github.com/o3de/o3de/blob/development/AutomatedTesting/Gem/Resources/GameSDK.ico
@adamarjian1 how did you download the project? git clone? or download zip off github? this sounds like an LFS (large file system) issue. This would also explain issues you were seeing with asset processor failing to process assets. because you didn't install LFS so the large files are actually being downloaded. What happens when you run the commandline: git lfs version
@AMZN-Gene I just downloaded the project I will clone the project and rebuild and see if the issue still exists.
when i use "download zip off github", l meet the same issue , use "git clone "will solve the problem. beause GameSDK.ico is not downloaded correctly by "download zip off github"
@chenyihaha - That behaviour is expected, the project uses Git LFS to store these binary file types. The MPS file extensions stored in such format can be found in the .gitattributes file. When you download the zip file only pointer files representing the binary files are generated so the images (and indeed any file represented by LFS) will not be correct.
I can file a request to docs to mention that folks shouldn't use the zip file from GitHub.
@chenyihaha - That behaviour is expected, the project uses Git LFS to store these binary file types. The file extensions stored in such format can be found in the .gitattributes file. When you download the zip file only pointer files representing the binary files are generated so the images (and indeed any file represented by LFS) will not be correct.
I can file a request to docs to mention that folks shouldn't use the zip file from GitHub.
Docs will help, I wouldn't mind just updating this issue and moving it into doc's triage.
Aside from docs, pressing that "zip download" button is too enticing, especially if you're just following a tutorial. The asset processor will show all the failed files, but I wish there was a way to remove this option or have the engine be more explicit if it detects assets that haven't been pulled down by LFS.
We can convert this task into updating readme file for o3de-multiplayersample stating that downloading zip is not a supported option with git LFS content. It is advised to git clone instead.
We can fix the zip to include the lfs artifacts: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository
But as our LFS files are externally sourced this would not help, plus its unsure if we would want to cover all the download costs.