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

Updated Several Engine Gem's CMakeLists.txt to add themselves as required Gems (#1262)

Browse Source 
* Fixed organization of the AssetProcessor SourceAssetBrowser

Assets within the Engine Root were grouped under a '/' entry.
That has been fixed to use the relative path within the engine root for
those assets
Assets outside of the Engine Root, but on the same drive were using
absolute paths before. Now there are child entries that navigate up the
directory hierarchy to those asset locations

* Added ly_enable_gems call to Atom gems targets that are required

The DefaultLevel.prefab contains several Atom components, that require
the Atom RHI, RPI, Common_Feature, ShaderBuilder and AtomLyIntegration CommonFeatures
gems to be enabled in order to successfully process in the
AssetProcessor.

* Added ly_enable_gems call to make the Camera gem required in Tools,
Builders and Clients.

This is needed as the DefaultLevel.prefab contains an Editor Camera
Component

* Adding the ly_enable_gem call to make the Maestro gem required

CrySystem currently requires Maestro to be enabled in order to
initialize

* Added ly_enable_gems call to the SceneProcessing gem to make it required

The SceneCore and SceneData libraries that are part of the core engine
Code folder requires the SceneProcessing gem to be enabled in order to
invoke the InitializeDynamicModule hooks in DllMain.cpp in order to
initialize those libraries.

* Fixed bad argument in comment for Prefab CMakeLists.txt

* Fixed Assert in Asset Builders due to the Atom RPI Builder

The Atom RPI Builder was enabling the Asset Catalog for the ScriptAsset a second time

The Atom Feature Common EditorSystemCommonComponent.cpp which also loads
in the AssetBuilder is enabling the Asset Catalog for the ScriptAsset

Added BehaviorContext reflection to the OutputDeviceTransformType enum
to fix the BehaviorContext errors about reflecting a method that returns
such an enum

* Added TypeId output to the JsonDeserializer report message about missing
ClassData

Previously the report callback would indicate that the target type was
missing Serialization class data, but didn't indicate the TypeId of the
target type

* Added support to the ly_enable_gems function to be able to support
0 gems being enabled.

Updated the Install step for CMake to propagate any ly_enable_gems
within a CMakeLists.txt for a target into the generated CMakeLists.txt
that is made for each installed IMPORTED target

* Adding newline to the end of the Camera Gem CMakeLists.txt

* Fixing target TYPE parameter for actual Gem Modules to use the GEM_MODULE tag instead of MODULE

* Reverting change to the DESTINATION directory for the installed CMakeLists.txt to use the relative path to the installed directory

* Adding the Atom_Bootstrap gem as a required gem

The Client and GameLaunchers required the Atom_Bootstrap gem in order to create the NativeWindow
Added Atom_Feature_Common client module as a runtime dependency of the AtomLyIntegration CommonsFeature client module

* Fixed register.py --all-projects-path and --all-gems-path arguments to
NOT register projects or gems that are within a template folder
Fixed reading of old pre-1.0 o3de_manifest.json files where the
"engines" key was a json array

* Changed how the relative target source directory is calculated when that source directroy resides outside of the engine root.
The final dirname component is used with a unique SHA256 has to form a <dirname>-<8 char SHA256> folder for installing files into

* Adding newline to the end of Atom_Bootstrap CMakeLists.txt

* Moving ly_enable_gems variants for Tools and Builders inside of PAL_TRAIT_BUILD_HOST_TOOLS block

* Adding a comment to AWSCore.ResourceMappingTool target to indicate that it is not a GEM_MODULE.
Furthermore it cannot be loaded with the Gem system because the library is in a different directory the executable
This commit is contained in:
lumberyard-employee-dm
2021-06-17 13:58:20 -05:00
committed by GitHub
parent 4be9ce56c4
commit 7dabe8b6e9
41 changed files with 521 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/o3de/o3de/register.py
+96 -80
View File
@@ -64,9 +64,9 @@ def register_shipped_engine_o3de_objects(force: bool = False) -> int:
return ret_val
def register_all_in_folder(folder_path: str or pathlib.Path,
def register_all_in_folder(folder_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None,
engine_path: pathlib.Path = None,
exclude: list = None) -> int:
if not folder_path:
logger.error(f'Folder path cannot be empty.')
@@ -136,10 +136,11 @@ def register_all_in_folder(folder_path: str or pathlib.Path,
return ret_val
def register_all_o3de_objects_of_type_in_folder(o3de_object_path: str or pathlib.Path,
def register_all_o3de_objects_of_type_in_folder(o3de_object_path: pathlib.Path,
o3de_object_type: str,
remove: bool,
force: bool,
stop_iteration_callable: callable,
**register_kwargs) -> int:
if not o3de_object_path:
logger.error(f'Engines path cannot be empty.')
@@ -155,8 +156,11 @@ def register_all_o3de_objects_of_type_in_folder(o3de_object_path: str or pathlib
ret_val = 0
for root, dirs, files in os.walk(o3de_object_path):
# Skip subdirectories where the stop iteration callback is true
if stop_iteration_callable and stop_iteration_callable(dirs, files):
dirs[:] = []
if f'{o3de_object_type}.json' in files:
o3de_object_type_set.add(root)
o3de_object_type_set.add(pathlib.Path(root))
# Stop iteration of any subdirectories
# Nested o3de objects of the same type aren't supported(i.e an engine cannot be inside of a engine).
dirs[:] = []
@@ -170,41 +174,49 @@ def register_all_o3de_objects_of_type_in_folder(o3de_object_path: str or pathlib
return ret_val
def register_all_engines_in_folder(engines_path: str or pathlib.Path,
def stop_on_template_folders(dirs: list, files: list) -> bool:
return 'template.json' in files
def register_all_engines_in_folder(engines_path: pathlib.Path,
remove: bool = False,
force: bool = False) -> int:
return register_all_o3de_objects_of_type_in_folder(engines_path, 'engine', remove, force)
return register_all_o3de_objects_of_type_in_folder(engines_path, 'engine', remove, force, None)
def register_all_projects_in_folder(projects_path: str or pathlib.Path,
def register_all_projects_in_folder(projects_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(projects_path, 'project', remove, False, engine_path=engine_path)
engine_path: pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(projects_path, 'project', remove, False,
stop_on_template_folders, engine_path=engine_path)
def register_all_gems_in_folder(gems_path: str or pathlib.Path,
def register_all_gems_in_folder(gems_path: pathlib.Path,
remove: bool = False,
engine_path: pathlib.Path = None,
project_path: pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(gems_path, 'gem', remove, False, engine_path=engine_path)
return register_all_o3de_objects_of_type_in_folder(gems_path, 'gem', remove, False, stop_on_template_folders,
engine_path=engine_path)
def register_all_templates_in_folder(templates_path: str or pathlib.Path,
def register_all_templates_in_folder(templates_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(templates_path, 'template', remove, False, engine_path=engine_path)
engine_path: pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(templates_path, 'template', remove, False, None,
engine_path=engine_path)
def register_all_restricted_in_folder(restricted_path: str or pathlib.Path,
def register_all_restricted_in_folder(restricted_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(restricted_path, 'restricted', remove, False, engine_path=engine_path)
engine_path: pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(restricted_path, 'restricted', remove, False, None,
engine_path=engine_path)
def register_all_repos_in_folder(repos_path: str or pathlib.Path,
def register_all_repos_in_folder(repos_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(repos_path, 'repo', remove, force, engine_path=engine_path)
engine_path: pathlib.Path = None) -> int:
return register_all_o3de_objects_of_type_in_folder(repos_path, 'repo', remove, force, None, engine_path=engine_path)
def remove_engine_name_to_path(json_data: dict,
@@ -252,7 +264,7 @@ def add_engine_name_to_path(json_data: dict, engine_path: pathlib.Path, force: b
def register_engine_path(json_data: dict,
engine_path: str or pathlib.Path,
engine_path: pathlib.Path,
remove: bool = False,
force: bool = False) -> int:
if not engine_path:
@@ -260,8 +272,11 @@ def register_engine_path(json_data: dict,
return 1
engine_path = pathlib.Path(engine_path).resolve()
for engine_object in json_data.get('engines', {}):
engine_object_path = pathlib.Path(engine_object['path']).resolve()
for engine_object in json_data.get('engines', []):
if isinstance(engine_object, dict):
engine_object_path = pathlib.Path(engine_object['path']).resolve()
else:
engine_object_path = pathlib.Path(engine_object).resolve()
if engine_object_path == engine_path:
json_data['engines'].remove(engine_object)
@@ -362,7 +377,7 @@ def register_o3de_object_path(json_data: dict,
def register_external_subdirectory(json_data: dict,
external_subdir_path: str or pathlib.Path,
external_subdir_path: pathlib.Path,
remove: bool = False,
engine_path: pathlib.Path = None,
project_path: pathlib.Path = None) -> int:
@@ -375,7 +390,7 @@ def register_external_subdirectory(json_data: dict,
def register_gem_path(json_data: dict,
gem_path: str or pathlib.Path,
gem_path: pathlib.Path,
remove: bool = False,
engine_path: pathlib.Path = None,
project_path: pathlib.Path = None) -> int:
@@ -384,9 +399,9 @@ def register_gem_path(json_data: dict,
def register_project_path(json_data: dict,
project_path: str or pathlib.Path,
project_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
engine_path: pathlib.Path = None) -> int:
result = register_o3de_object_path(json_data, project_path, 'projects', 'project.json',
validation.valid_o3de_project_json, remove, engine_path, None)
@@ -408,9 +423,10 @@ def register_project_path(json_data: dict,
update_project_json = True
if update_project_json:
project_json_path = project_path / 'project.json'
project_json_data['engine'] = this_engine_json['engine_name']
utils.backup_file(project_json)
if not manifest.save_o3de_manifest(project_json_data, project_path):
utils.backup_file(project_json_path)
if not manifest.save_o3de_manifest(project_json_data, project_json_path):
return 1
@@ -418,17 +434,17 @@ def register_project_path(json_data: dict,
def register_template_path(json_data: dict,
template_path: str or pathlib.Path,
template_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
engine_path: pathlib.Path = None) -> int:
return register_o3de_object_path(json_data, template_path, 'templates', 'template.json',
validation.valid_o3de_template_json, remove, engine_path, None)
def register_restricted_path(json_data: dict,
restricted_path: str or pathlib.Path,
restricted_path: pathlib.Path,
remove: bool = False,
engine_path: str or pathlib.Path = None) -> int:
engine_path: pathlib.Path = None) -> int:
return register_o3de_object_path(json_data, restricted_path, 'restricted', 'restricted.json',
validation.valid_o3de_restricted_json, remove, engine_path, None)
@@ -468,7 +484,7 @@ def register_repo(json_data: dict,
def register_default_o3de_object_folder(json_data: dict,
default_o3de_object_folder: str or pathlib.Path,
default_o3de_object_folder: pathlib.Path,
o3de_object_key: str) -> int:
# make sure the path exists
default_o3de_object_folder = pathlib.Path(default_o3de_object_folder).resolve()
@@ -482,7 +498,7 @@ def register_default_o3de_object_folder(json_data: dict,
def register_default_engines_folder(json_data: dict,
default_engines_folder: str or pathlib.Path,
default_engines_folder: pathlib.Path,
remove: bool = False) -> int:
return register_default_o3de_object_folder(json_data,
manifest.get_o3de_engines_folder() if remove else default_engines_folder,
@@ -490,7 +506,7 @@ def register_default_engines_folder(json_data: dict,
def register_default_projects_folder(json_data: dict,
default_projects_folder: str or pathlib.Path,
default_projects_folder: pathlib.Path,
remove: bool = False) -> int:
return register_default_o3de_object_folder(json_data,
manifest.get_o3de_projects_folder() if remove else default_projects_folder,
@@ -498,7 +514,7 @@ def register_default_projects_folder(json_data: dict,
def register_default_gems_folder(json_data: dict,
default_gems_folder: str or pathlib.Path,
default_gems_folder: pathlib.Path,
remove: bool = False) -> int:
return register_default_o3de_object_folder(json_data,
manifest.get_o3de_gems_folder() if remove else default_gems_folder,
@@ -506,7 +522,7 @@ def register_default_gems_folder(json_data: dict,
def register_default_templates_folder(json_data: dict,
default_templates_folder: str or pathlib.Path,
default_templates_folder: pathlib.Path,
remove: bool = False) -> int:
return register_default_o3de_object_folder(json_data,
manifest.get_o3de_templates_folder() if remove else default_templates_folder,
@@ -514,7 +530,7 @@ def register_default_templates_folder(json_data: dict,
def register_default_restricted_folder(json_data: dict,
default_restricted_folder: str or pathlib.Path,
default_restricted_folder: pathlib.Path,
remove: bool = False) -> int:
return register_default_o3de_object_folder(json_data,
manifest.get_o3de_restricted_folder() if remove else default_restricted_folder,
@@ -527,18 +543,18 @@ def register_default_third_party_folder(json_data: dict,
manifest.get_o3de_third_party_folder() if remove else default_third_party_folder,
'default_third_party_folder')
def register(engine_path: str or pathlib.Path = None,
project_path: str or pathlib.Path = None,
gem_path: str or pathlib.Path = None,
external_subdir_path: str or pathlib.Path = None,
template_path: str or pathlib.Path = None,
restricted_path: str or pathlib.Path = None,
def register(engine_path: pathlib.Path = None,
project_path: pathlib.Path = None,
gem_path: pathlib.Path = None,
external_subdir_path: pathlib.Path = None,
template_path: pathlib.Path = None,
restricted_path: pathlib.Path = None,
repo_uri: str or pathlib.Path = None,
default_engines_folder: str or pathlib.Path = None,
default_projects_folder: str or pathlib.Path = None,
default_gems_folder: str or pathlib.Path = None,
default_templates_folder: str or pathlib.Path = None,
default_restricted_folder: str or pathlib.Path = None,
default_engines_folder: pathlib.Path = None,
default_projects_folder: pathlib.Path = None,
default_gems_folder: pathlib.Path = None,
default_templates_folder: pathlib.Path = None,
default_restricted_folder: pathlib.Path = None,
default_third_party_folder: pathlib.Path = None,
external_subdir_engine_path: pathlib.Path = None,
external_subdir_project_path: pathlib.Path = None,
@@ -576,32 +592,32 @@ def register(engine_path: str or pathlib.Path = None,
result = 0
# do anything that could require a engine context first
if isinstance(project_path, str) or isinstance(project_path, pathlib.PurePath):
if isinstance(project_path, pathlib.PurePath):
if not project_path:
logger.error(f'Project path cannot be empty.')
return 1
result = result or register_project_path(json_data, project_path, remove, engine_path)
if isinstance(gem_path, str) or isinstance(gem_path, pathlib.PurePath):
if isinstance(gem_path, pathlib.PurePath):
if not gem_path:
logger.error(f'Gem path cannot be empty.')
return 1
result = result or register_gem_path(json_data, gem_path, remove,
external_subdir_engine_path, external_subdir_project_path)
if isinstance(external_subdir_path, str) or isinstance(external_subdir_path, pathlib.PurePath):
if isinstance(external_subdir_path, pathlib.PurePath):
if not external_subdir_path:
logger.error(f'External Subdirectory path is None.')
return 1
result = result or register_external_subdirectory(json_data, external_subdir_path, remove,
external_subdir_engine_path, external_subdir_project_path)
if isinstance(template_path, str) or isinstance(template_path, pathlib.PurePath):
if isinstance(template_path, pathlib.PurePath):
if not template_path:
logger.error(f'Template path cannot be empty.')
return 1
result = result or register_template_path(json_data, template_path, remove, engine_path)
if isinstance(restricted_path, str) or isinstance(restricted_path, pathlib.PurePath):
if isinstance(restricted_path, pathlib.PurePath):
if not restricted_path:
logger.error(f'Restricted path cannot be empty.')
return 1
@@ -613,28 +629,28 @@ def register(engine_path: str or pathlib.Path = None,
return 1
result = result or register_repo(json_data, repo_uri, remove)
if isinstance(default_engines_folder, str) or isinstance(default_engines_folder, pathlib.PurePath):
if isinstance(default_engines_folder, pathlib.PurePath):
result = result or register_default_engines_folder(json_data, default_engines_folder, remove)
if isinstance(default_projects_folder, str) or isinstance(default_projects_folder, pathlib.PurePath):
if isinstance(default_projects_folder, pathlib.PurePath):
result = result or register_default_projects_folder(json_data, default_projects_folder, remove)
if isinstance(default_gems_folder, str) or isinstance(default_gems_folder, pathlib.PurePath):
if isinstance(default_gems_folder, pathlib.PurePath):
result = result or register_default_gems_folder(json_data, default_gems_folder, remove)
if isinstance(default_templates_folder, str) or isinstance(default_templates_folder, pathlib.PurePath):
if isinstance(default_templates_folder, pathlib.PurePath):
result = result or register_default_templates_folder(json_data, default_templates_folder, remove)
if isinstance(default_restricted_folder, str) or isinstance(default_restricted_folder, pathlib.PurePath):
if isinstance(default_restricted_folder, pathlib.PurePath):
result = result or register_default_restricted_folder(json_data, default_restricted_folder, remove)
if isinstance(default_third_party_folder, str) or isinstance(default_third_party_folder, pathlib.PurePath):
if isinstance(default_third_party_folder, pathlib.PurePath):
result = result or register_default_third_party_folder(json_data, default_third_party_folder, remove)
# engine is done LAST
# Now that everything that could have an engine context is done, if the engine is supplied that means this is
# registering the engine itself
if isinstance(engine_path, str) or isinstance(engine_path, pathlib.PurePath):
if isinstance(engine_path, pathlib.PurePath):
if not engine_path:
logger.error(f'Engine path cannot be empty.')
return 1
@@ -789,41 +805,41 @@ def add_parser_args(parser):
group.add_argument('--this-engine', action='store_true', required=False,
default=False,
help='Registers the engine this script is running from.')
group.add_argument('-ep', '--engine-path', type=str, required=False,
group.add_argument('-ep', '--engine-path', type=pathlib.Path, required=False,
help='Engine path to register/remove.')
group.add_argument('-pp', '--project-path', type=str, required=False,
group.add_argument('-pp', '--project-path', type=pathlib.Path, required=False,
help='Project path to register/remove.')
group.add_argument('-gp', '--gem-path', type=str, required=False,
group.add_argument('-gp', '--gem-path', type=pathlib.Path, required=False,
help='Gem path to register/remove.')
group.add_argument('-es', '--external-subdirectory', type=str, required=False,
group.add_argument('-es', '--external-subdirectory', type=pathlib.Path, required=False,
help='External subdirectory path to register/remove.')
group.add_argument('-tp', '--template-path', type=str, required=False,
group.add_argument('-tp', '--template-path', type=pathlib.Path, required=False,
help='Template path to register/remove.')
group.add_argument('-rp', '--restricted-path', type=str, required=False,
group.add_argument('-rp', '--restricted-path', type=pathlib.Path, required=False,
help='A restricted folder to register/remove.')
group.add_argument('-ru', '--repo-uri', type=str, required=False,
help='A repo uri to register/remove.')
group.add_argument('-aep', '--all-engines-path', type=str, required=False,
group.add_argument('-aep', '--all-engines-path', type=pathlib.Path, required=False,
help='All engines under this folder to register/remove.')
group.add_argument('-app', '--all-projects-path', type=str, required=False,
group.add_argument('-app', '--all-projects-path', type=pathlib.Path, required=False,
help='All projects under this folder to register/remove.')
group.add_argument('-agp', '--all-gems-path', type=str, required=False,
group.add_argument('-agp', '--all-gems-path', type=pathlib.Path, required=False,
help='All gems under this folder to register/remove.')
group.add_argument('-atp', '--all-templates-path', type=str, required=False,
group.add_argument('-atp', '--all-templates-path', type=pathlib.Path, required=False,
help='All templates under this folder to register/remove.')
group.add_argument('-arp', '--all-restricted-path', type=str, required=False,
group.add_argument('-arp', '--all-restricted-path', type=pathlib.Path, required=False,
help='All templates under this folder to register/remove.')
group.add_argument('-aru', '--all-repo-uri', type=str, required=False,
group.add_argument('-aru', '--all-repo-uri', type=pathlib.Path, required=False,
help='All repos under this folder to register/remove.')
group.add_argument('-def', '--default-engines-folder', type=str, required=False,
group.add_argument('-def', '--default-engines-folder', type=pathlib.Path, required=False,
help='The default engines folder to register/remove.')
group.add_argument('-dpf', '--default-projects-folder', type=str, required=False,
group.add_argument('-dpf', '--default-projects-folder', type=pathlib.Path, required=False,
help='The default projects folder to register/remove.')
group.add_argument('-dgf', '--default-gems-folder', type=str, required=False,
group.add_argument('-dgf', '--default-gems-folder', type=pathlib.Path, required=False,
help='The default gems folder to register/remove.')
group.add_argument('-dtf', '--default-templates-folder', type=str, required=False,
group.add_argument('-dtf', '--default-templates-folder', type=pathlib.Path, required=False,
help='The default templates folder to register/remove.')
group.add_argument('-drf', '--default-restricted-folder', type=str, required=False,
group.add_argument('-drf', '--default-restricted-folder', type=pathlib.Path, required=False,
help='The default restricted folder to register/remove.')
group.add_argument('-dtpf', '--default-third-party-folder', type=pathlib.Path, required=False,
help='The default 3rd Party folder to register/remove.')
@@ -831,7 +847,7 @@ def add_parser_args(parser):
default=False,
help='Refresh the repo cache.')
parser.add_argument('-ohf', '--override-home-folder', type=str, required=False,
parser.add_argument('-ohf', '--override-home-folder', type=pathlib.Path, required=False,
help='By default the home folder is the user folder, override it to this folder.')
parser.add_argument('-r', '--remove', action='store_true', required=False,
default=False,