birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

LYN-2537 engine assets (#254)

Browse Source 
* LYN-2537 Moved the Engine and Editor folder to be within the EngineAssets folder

* Fixed Documentation in bootstrap.cfg to correct the path to the user project specific registry file

* Adding a newline to the output of AssetCatalog 'Registering asset..., but type is not set' message

* Updating the AssetProcessorPlatformConfig.setreg Scan Folder to detect
the @ENGINEROOT@/EngineAssets/Engine path for engine runtime assets and
@ENGINEROOT@/EngineAssets/Editor path for engine tool assets

* Updating references to Icons and other assets to account for moving the
Engine and Editor folder under a single EngineAssets folder

* Moving the Engine Settings Registry folder from Engine/Registry -> Registry

* Removed the LY_PROJECT_CMAKE_PATH define as it is not portable to other locations. It is hard coded to the project location that was used for the CMake configuration. Furthermore it paths with backslashes within it are treated as escape characters and not a path separator

* Updated the LyTestTools asset_processor.py script to copy the exclude.filetag from the EngineAssets/Engine directory now

* Fixed Atom Shader Preprocessing when running using an External Project

* Updated the TSGenerateAction.cpp to fix the build error with using a renamed variable

* Updated the Install_Common.cmake ly_setup_others function to install the
EngineAssets directory and the each of the Gem's Assets directory while
maintaining the relative directory structure to the Engine Root
Also updated the install step to install the Registry folder at the
engine root

* Fixed the copying of the Registry folder to be in the install root, instead of under a second 'Registry' folder

* Moving the AssetProcessorPlatformConfig.setreg file over to the Registry folder

* Updated the LyTestTools and C++ code to point that the new location of
the AssetProcessorPlatformConfig.setreg file inside of the Registry
folder

* Renamed Test AssetProcessor*Config.ini files to have the .setreg extension

* Converted the AssetProcessor test setreg files from ini format to json
format using the SerializeContextTools convert-ini command

* Updated the AssetProcessor CMakeLists.txt to copy over the test setreg files to the build folder

* Updated the assetprocessor test file list to point at the renamed AsssetProcessor*Config setreg filenames

* Removed the Output Prefix code from the AssetProcessor. The complexity that it brought to the AP code is not needed, as users can replicate the behavior by just moving there assets underneath a another folder, underneath the scan folder

* Adding back support to read the AssetProcessorPlatformConfig.setreg file from the asset root. This is only needed for C++ UnitTests as they run in an environment where the accessing the Engine Settings Registry is not available

* Updating the Install_common.cmake logic to copy any "Assets" folder to
the install layout.
The Script has also been updated to copy over the "Assets" folder in the
Engine Root to the install layout instead of an "EngineAssets" folder

* Updating References to EngineAssets source asset folder in code to be the Assets source folder

* Moved the Engine Source Asset folder of 'EngineAssets' to a new folder name of 'Assets'. This is inline with the naming scheme we use for Gem asset folders

* Adding the EngineFinder.cmake to the AutomatedTesting project to allow it to work in a project centric manner

* Updating the LyTestTools copy_assets_to_project function to be able to copy assets with folders to the temporary project root
Fixed an issue in LyTestTools where the temporary log directory could have shutil.rmtree being called twice on it leading to an exception which fails an automated test

Updated the asset_procesor_gui_tests_2 AddScanFolder test to not use the
output prefix, but instead place the source asset root into a
subdirectory

* Correct the AssetProcessorPlatformConfig Scan Folders for the EngineAssets directory to point at the Assets directory

* Updated the asset procesor batch dependency test scan folder to point at the 'Assets' folder instead of 'EngineAssets'
This commit is contained in:
lumberyard-employee-dm
2021-04-28 21:38:43 -05:00
committed by GitHub
parent ed74bb9166
commit 3dec5d3b71
2087 changed files with 1208 additions and 3655 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Code/Tools/AssetProcessor/testdata/DummyProject/AssetProcessorGamePlatformConfig.ini
Vendored
-19
View File
@@ -1,19 +0,0 @@
; this is an override config that should "add" the provo platform
; and "remove" the server platform.
[Platform provo]
tags=console, renderer
[Platforms]
server=disabled
provo=enabled
; this ONLY overrides the "provo" value
; becuase this is being loaded on top of the defaults, this should LEAVE the others
; as they are.
[RC i_caf]
provo=copy
; this will remove "mov" from the default configuration
[RC mov]
ignore=true
Code/Tools/AssetProcessor/testdata/DummyProject/AssetProcessorGamePlatformConfig.setreg
Vendored
+21
View File
@@ -0,0 +1,21 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"Platform provo": {
"tags": "console, renderer"
},
"Platforms": {
"server": "disabled",
"provo": "enabled"
},
"RC i_caf": {
"provo": "copy"
},
"RC mov": {
"ignore": true
}
}
}
}
}
Code/Tools/AssetProcessor/testdata/EmptyDummyProject/AssetProcessorGamePlatformConfig.ini
Vendored
View File
Code/Tools/AssetProcessor/testdata/EmptyDummyProject/AssetProcessorGamePlatformConfig.setreg
Vendored
+7
View File
@@ -0,0 +1,7 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {}
}
}
}
Code/Tools/AssetProcessor/testdata/config_broken_badplatform/AssetProcessorPlatformConfig.ini
Vendored
-22
View File
@@ -1,22 +0,0 @@
; Used by unit tests. This is a broken configuration file.
[Platform pc]
tags=tools,renderer
[Platform osx_gl]
tags=tools,renderer
[Platforms]
es3=enabled ; note - bad platform - its not one of the above ones!
; without a scan folder, it is an invalid file.
[ScanFolder Game]
watch=@PROJECTROOT@
recursive=1
order=0
; without at least one recognizer, its not an invalid file. (this is not what this unit test is checking)
[RC i_caf]
glob=*.i_caf
params=copy
priority=5
Code/Tools/AssetProcessor/testdata/config_broken_badplatform/AssetProcessorPlatformConfig.setreg
Vendored
+27
View File
@@ -0,0 +1,27 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"Platform pc": {
"tags": "tools,renderer"
},
"Platform osx_gl": {
"tags": "tools,renderer"
},
"Platforms": {
"es3": "enabled"
},
"ScanFolder Game": {
"watch": "@PROJECTROOT@",
"recursive": 1,
"order": 0
},
"RC i_caf": {
"glob": "*.i_caf",
"params": "copy",
"priority": 5
}
}
}
}
}
Code/Tools/AssetProcessor/testdata/config_broken_noplatform/AssetProcessorPlatformConfig.ini
Vendored
-13
View File
@@ -1,13 +0,0 @@
; Used by unit tests. This is a broken configuration file.
; without a scan folder, it is an invalid file.
[ScanFolder Game]
watch=@PROJECTROOT@
recursive=1
order=0
; without at least one recognizer, its an invalid file.
[RC i_caf]
glob=*.i_caf
params=copy
priority=5
Code/Tools/AssetProcessor/testdata/config_broken_noplatform/AssetProcessorPlatformConfig.setreg
Vendored
+18
View File
@@ -0,0 +1,18 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"ScanFolder Game": {
"watch": "@PROJECTROOT@",
"recursive": 1,
"order": 0
},
"RC i_caf": {
"glob": "*.i_caf",
"params": "copy",
"priority": 5
}
}
}
}
}
Code/Tools/AssetProcessor/testdata/config_broken_noscans/AssetProcessorPlatformConfig.ini
Vendored
-15
View File
@@ -1,15 +0,0 @@
; Used by unit tests. This is a broken configuration file.
[Platform pc]
tags=tools,renderer
[Platform osx_gl]
tags=tools,renderer
; without a scan folder, it is an invalid file.
; without at least one recognizer, its not an invalid file. (this is not what this unit test is checking)
[RC i_caf]
glob=*.i_caf
params=copy
priority=5
Code/Tools/AssetProcessor/testdata/config_broken_noscans/AssetProcessorPlatformConfig.setreg
Vendored
+19
View File
@@ -0,0 +1,19 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"Platform pc": {
"tags": "tools,renderer"
},
"Platform osx_gl": {
"tags": "tools,renderer"
},
"RC i_caf": {
"glob": "*.i_caf",
"params": "copy",
"priority": 5
}
}
}
}
}
Code/Tools/AssetProcessor/testdata/config_broken_recognizers/AssetProcessorPlatformConfig.ini
Vendored
-16
View File
@@ -1,16 +0,0 @@
; Used by unit tests. This is a broken configuration file.
[Platform pc]
tags=tools,renderer
[Platform osx_gl]
tags=tools,renderer
; without a scan folder, it is an invalid file.
[ScanFolder Game]
watch=@PROJECTROOT@
recursive=1
order=0
; without at least one recognizer, its an invalid file.
Code/Tools/AssetProcessor/testdata/config_broken_recognizers/AssetProcessorPlatformConfig.setreg
Vendored
+19
View File
@@ -0,0 +1,19 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"Platform pc": {
"tags": "tools,renderer"
},
"Platform osx_gl": {
"tags": "tools,renderer"
},
"ScanFolder Game": {
"watch": "@PROJECTROOT@",
"recursive": 1,
"order": 0
}
}
}
}
}
Code/Tools/AssetProcessor/testdata/config_regular/AssetProcessorPlatformConfig.ini
Vendored
-109
View File
@@ -1,109 +0,0 @@
; this is a regular config file that ought to load successfully.
[Platform pc]
tags=tools,renderer
[Platform es3]
tags=android,mobile,renderer
[Platform osx_gl]
tags=tools,renderer
[Platform server]
tags=server
; for the purposes of this test, we enable only server and es3, but we make sure the CURRENT_PLATFORM is auto enabled.
[Platforms]
;pc=enabled
es3=enabled
;ios=enabled
;osx_gl=enabled
;provo=enabled
server=enabled
; ---- The number of worker jobs, 0 means use the number of Logical Cores
[Jobs]
minJobs=1
maxJobs=0
[MetaDataTypes]
exportsettings=
animsettings=i_caf
Animations/SkeletonList.xml=i_caf
cbc=abc
fbx.assetinfo=fbx
[ScanFolder Game]
watch=@PROJECTROOT@
; use a special display name here to make sure macros work
display=@PROJECTROOT@ Scan Folder
recursive=1
order=0
; this test makes sure that those macros make sense and are present as well as that order is preserved.
; it also makes sure that the friendly name ("FeatureTests") is used, if no display is present and does not lose its case.
[ScanFolder FeatureTests]
watch=@PROJECTROOT@FeatureTests
output=featuretestsoutputfolder
recursive=0
order=5000
; this test makes sure that the scan folders system uses the portable key of the scan Folder to find duplicates.
; (which is constructed from its name in the square brackets)
; instead of other attributes such as the watch folder, or output prefix.
[ScanFolder FeatureTests2]
watch=@PROJECTROOT@FeatureTests
output=featuretestsoutputfolder
recursive=0
order=6000
[Exclude HoldFiles]
pattern=.*\\/Levels\\/.*_hold\\/.*
[Exclude TempFiles]
pattern=.*\\/\\$tmp[0-9]*_.*
[RC i_caf]
glob=*.i_caf
params=defaultparams
; server should not appear
server=skip
; es3 should have this overridden
es3=mobile
; host should have defaultparams
; make sure priority is used.
priority=5
checkServer=true
[RC caf]
glob=*.caf
params=copy
; all platforms with 'renderer' tag should have these params applied. (so host platform and es3 but not server)
renderer=rendererparams
[RC mov]
glob=*.mov
params=copy
; this one proves that platforms override more broader tags (es3 has both the es3 platform and the renderer tag)
es3=platformspecificoverride
; hosts should use this
renderer=rendererparams
; this tests to make sure that even if "params" is missing, it is assumed to be default operation
; this is because if you wanted to skip a platform, we have a specific verb for that ('skip') and simply omitting the defaults means
; that you just want the default behavior. only the platforms indicated have a role
[RC rend]
glob=*.rend
renderer=rendererparams
; this tests to make sure that even if you have no params at all, it is assumed to be default operation
[RC alldefault]
glob=*.alldefault
; this tests to make sure if you set default to skip you can still specify one platform to compile on
[RC skipallbutone]
glob=*.files
params=skip
server=copy
Code/Tools/AssetProcessor/testdata/config_regular/AssetProcessorPlatformConfig.setreg
Vendored
+89
View File
@@ -0,0 +1,89 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"Platform pc": {
"tags": "tools,renderer"
},
"Platform es3": {
"tags": "android,mobile,renderer"
},
"Platform osx_gl": {
"tags": "tools,renderer"
},
"Platform server": {
"tags": "server"
},
"Platforms": {
"es3": "enabled",
"server": "enabled"
},
"Jobs": {
"minJobs": 1,
"maxJobs": 0
},
"MetaDataTypes": {
"animsettings": "i_caf",
"Animations/SkeletonList.xml": "i_caf",
"cbc": "abc",
"fbx.assetinfo": "fbx"
},
"ScanFolder Game": {
"watch": "@PROJECTROOT@",
"display": "@PROJECTROOT@ Scan Folder",
"recursive": 1,
"order": 0
},
"ScanFolder FeatureTests": {
"watch": "@PROJECTROOT@FeatureTests",
"output": "featuretestsoutputfolder",
"recursive": 0,
"order": 5000
},
"ScanFolder FeatureTests2": {
"watch": "@PROJECTROOT@FeatureTests",
"output": "featuretestsoutputfolder",
"recursive": 0,
"order": 6000
},
"Exclude HoldFiles": {
"pattern": ".*\\\\/Levels\\\\/.*_hold\\\\/.*"
},
"Exclude TempFiles": {
"pattern": ".*\\\\/\\\\$tmp[0-9]*_.*"
},
"RC i_caf": {
"glob": "*.i_caf",
"params": "defaultparams",
"server": "skip",
"es3": "mobile",
"priority": 5,
"checkServer": true
},
"RC caf": {
"glob": "*.caf",
"params": "copy",
"renderer": "rendererparams"
},
"RC mov": {
"glob": "*.mov",
"params": "copy",
"es3": "platformspecificoverride",
"renderer": "rendererparams"
},
"RC rend": {
"glob": "*.rend",
"renderer": "rendererparams"
},
"RC alldefault": {
"glob": "*.alldefault"
},
"RC skipallbutone": {
"glob": "*.files",
"params": "skip",
"server": "copy"
}
}
}
}
}
Code/Tools/AssetProcessor/testdata/config_regular_platform_scanfolder/AssetProcessorPlatformConfig.ini
Vendored
-129
View File
@@ -1,129 +0,0 @@
; this is a regular config file that ought to load successfully.
[Platform pc]
tags=tools,renderer
[Platform es3]
tags=android,mobile,renderer
[Platform ios]
tags=mobile,renderer
[Platform osx_gl]
tags=tools,renderer
[Platform server]
tags=server
; we define an test platform in order to make sure that it does NOT show up anywhere
[Platform test]
tags=console,renderer
; for the purposes of this test, we enable only server and es3, but we make sure the CURRENT_PLATFORM is auto enabled.
[Platforms]
;pc=enabled
es3=enabled
ios=enabled
;osx_gl=enabled
;test=enabled
server=enabled
; ---- The number of worker jobs, 0 means use the number of Logical Cores
[Jobs]
minJobs=1
maxJobs=0
[MetaDataTypes]
exportsettings=
animsettings=i_caf
Animations/SkeletonList.xml=i_caf
cbc=abc
fbx.assetinfo=fbx
[ScanFolder Game]
watch=@PROJECTROOT@
display=gameoutput
recursive=1
order=0
[ScanFolder Editor]
watch=@ENGINEROOT@/Editor
display=editoroutput
recursive=1
order=30000
include=tools,renderer
exclude=ios
[ScanFolder Folder1]
watch=@ENGINEROOT@/Folder1
display=folder1output
recursive=1
order=50000
include=es3
[ScanFolder Folder2]
watch=@ENGINEROOT@/Folder2
display=folder2output
recursive=1
order=60000
exclude=es3
[ScanFolder Folder3]
watch=@ENGINEROOT@/Folder3
display=folder3output
recursive=1
order=70000
include=test
[Exclude HoldFiles]
pattern=.*\\/Levels\\/.*_hold\\/.*
[Exclude TempFiles]
pattern=.*\\/\\$tmp[0-9]*_.*
[RC i_caf]
glob=*.i_caf
params=defaultparams
; server should not appear
server=skip
; es3 should have this overridden
es3=mobile
test=copy
; host should have defaultparams
; make sure priority is used.
priority=5
[RC caf]
glob=*.caf
params=copy
; all platforms with 'renderer' tag should have these params applied. (so host platform and es3 but not server)
renderer=rendererparams
[RC mov]
glob=*.mov
params=copy
; this one proves that platforms override more broader tags (es3 has both the es3 platform and the renderer tag)
es3=platformspecificoverride
; hosts should use this
renderer=rendererparams
; this tests to make sure that even if "params" is missing, it is assumed to be default operation
; this is because if you wanted to skip a platform, we have a specific verb for that ('skip') and simply omitting the defaults means
; that you just want the default behavior. only the platforms indicated have a role
[RC rend]
glob=*.rend
renderer=rendererparams
; this tests to make sure that even if you have no params at all, it is assumed to be default operation
[RC alldefault]
glob=*.alldefault
; this tests to make sure if you set default to skip you can still specify one platform to compile on
[RC skipallbutone]
glob=*.files
params=skip
server=copy
Code/Tools/AssetProcessor/testdata/config_regular_platform_scanfolder/AssetProcessorPlatformConfig.setreg
Vendored
+113
View File
@@ -0,0 +1,113 @@
{
"Amazon": {
"AssetProcessor": {
"Settings": {
"Platform pc": {
"tags": "tools,renderer"
},
"Platform es3": {
"tags": "android,mobile,renderer"
},
"Platform ios": {
"tags": "mobile,renderer"
},
"Platform osx_gl": {
"tags": "tools,renderer"
},
"Platform server": {
"tags": "server"
},
"Platform test": {
"tags": "console,renderer"
},
"Platforms": {
"es3": "enabled",
"ios": "enabled",
"server": "enabled"
},
"Jobs": {
"minJobs": 1,
"maxJobs": 0
},
"MetaDataTypes": {
"animsettings": "i_caf",
"Animations/SkeletonList.xml": "i_caf",
"cbc": "abc",
"fbx.assetinfo": "fbx"
},
"ScanFolder Game": {
"watch": "@PROJECTROOT@",
"display": "gameoutput",
"recursive": 1,
"order": 0
},
"ScanFolder Editor": {
"watch": "@ENGINEROOT@/Editor",
"display": "editoroutput",
"recursive": 1,
"order": 30000,
"include": "tools,renderer",
"exclude": "ios"
},
"ScanFolder Folder1": {
"watch": "@ENGINEROOT@/Folder1",
"display": "folder1output",
"recursive": 1,
"order": 50000,
"include": "es3"
},
"ScanFolder Folder2": {
"watch": "@ENGINEROOT@/Folder2",
"display": "folder2output",
"recursive": 1,
"order": 60000,
"exclude": "es3"
},
"ScanFolder Folder3": {
"watch": "@ENGINEROOT@/Folder3",
"display": "folder3output",
"recursive": 1,
"order": 70000,
"include": "test"
},
"Exclude HoldFiles": {
"pattern": ".*\\\\/Levels\\\\/.*_hold\\\\/.*"
},
"Exclude TempFiles": {
"pattern": ".*\\\\/\\\\$tmp[0-9]*_.*"
},
"RC i_caf": {
"glob": "*.i_caf",
"params": "defaultparams",
"server": "skip",
"es3": "mobile",
"test": "copy",
"priority": 5
},
"RC caf": {
"glob": "*.caf",
"params": "copy",
"renderer": "rendererparams"
},
"RC mov": {
"glob": "*.mov",
"params": "copy",
"es3": "platformspecificoverride",
"renderer": "rendererparams"
},
"RC rend": {
"glob": "*.rend",
"renderer": "rendererparams"
},
"RC alldefault": {
"glob": "*.alldefault"
},
"RC skipallbutone": {
"glob": "*.files",
"params": "skip",
"server": "copy"
}
}
}
}
}