Browse Source

gem stub scaffolding and readme

Signed-off-by: HogJonny-AMZN <[email protected]>
HogJonny-AMZN 3 years ago
parent
commit
230dd02cd3
36 changed files with 491 additions and 0 deletions
  1. 3 0
      Gems/character_mps/Assets/char_test.fbx
  2. 8 0
      Gems/character_mps/CMakeLists.txt
  3. 18 0
      Gems/character_mps/Registry/assetprocessor_settings.setreg
  4. 21 0
      Gems/character_mps/gem.json
  5. 3 0
      Gems/character_mps/preview.png
  6. 3 0
      Gems/kb3d_mps/Assets/kb3d_test.fbx
  7. 8 0
      Gems/kb3d_mps/CMakeLists.txt
  8. 18 0
      Gems/kb3d_mps/Registry/assetprocessor_settings.setreg
  9. 21 0
      Gems/kb3d_mps/gem.json
  10. 3 0
      Gems/kb3d_mps/preview.png
  11. 3 0
      Gems/landscape_mps/Assets/land_test.fbx
  12. 8 0
      Gems/landscape_mps/CMakeLists.txt
  13. 18 0
      Gems/landscape_mps/Registry/assetprocessor_settings.setreg
  14. 21 0
      Gems/landscape_mps/gem.json
  15. 3 0
      Gems/landscape_mps/preview.png
  16. 3 0
      Gems/level_art_mps/Assets/level_test.fbx
  17. 8 0
      Gems/level_art_mps/CMakeLists.txt
  18. 18 0
      Gems/level_art_mps/Registry/assetprocessor_settings.setreg
  19. 21 0
      Gems/level_art_mps/gem.json
  20. 3 0
      Gems/level_art_mps/preview.png
  21. 3 0
      Gems/particlefx_mps/Assets/pfx_test.fbx
  22. 8 0
      Gems/particlefx_mps/CMakeLists.txt
  23. 18 0
      Gems/particlefx_mps/Registry/assetprocessor_settings.setreg
  24. 21 0
      Gems/particlefx_mps/gem.json
  25. 3 0
      Gems/particlefx_mps/preview.png
  26. 3 0
      Gems/pbr_material_pack_mps/Assets/pbr_test.fbx
  27. 8 0
      Gems/pbr_material_pack_mps/CMakeLists.txt
  28. 18 0
      Gems/pbr_material_pack_mps/Registry/assetprocessor_settings.setreg
  29. 21 0
      Gems/pbr_material_pack_mps/gem.json
  30. 3 0
      Gems/pbr_material_pack_mps/preview.png
  31. 3 0
      Gems/props_mps/Assets/prop_test.fbx
  32. 8 0
      Gems/props_mps/CMakeLists.txt
  33. 18 0
      Gems/props_mps/Registry/assetprocessor_settings.setreg
  34. 21 0
      Gems/props_mps/gem.json
  35. 3 0
      Gems/props_mps/preview.png
  36. 120 0
      readme.md

+ 3 - 0
Gems/character_mps/Assets/char_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/character_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME character_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/character_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder character_mps/Assets": {
+                    "watch": "@GEMROOT:character_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder character_mps/Registry": {
+                    "watch": "@GEMROOT:character_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/character_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "character_mps",
+    "display_name": "character_mps",
+    "license": "What license character_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for character_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of character_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "character_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements character_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of character_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "character_mps"
+}

+ 3 - 0
Gems/character_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 3 - 0
Gems/kb3d_mps/Assets/kb3d_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/kb3d_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME kb3d_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/kb3d_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder kb3d_mps/Assets": {
+                    "watch": "@GEMROOT:kb3d_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder kb3d_mps/Registry": {
+                    "watch": "@GEMROOT:kb3d_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/kb3d_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "kb3d_mps",
+    "display_name": "kb3d_mps",
+    "license": "What license kb3d_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for kb3d_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of kb3d_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "kb3d_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements kb3d_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of kb3d_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "kb3d_mps"
+}

+ 3 - 0
Gems/kb3d_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 3 - 0
Gems/landscape_mps/Assets/land_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/landscape_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME landscape_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/landscape_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder landscape_mps/Assets": {
+                    "watch": "@GEMROOT:landscape_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder landscape_mps/Registry": {
+                    "watch": "@GEMROOT:landscape_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/landscape_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "landscape_mps",
+    "display_name": "landscape_mps",
+    "license": "What license landscape_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for landscape_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of landscape_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "landscape_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements landscape_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of landscape_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "landscape_mps"
+}

+ 3 - 0
Gems/landscape_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 3 - 0
Gems/level_art_mps/Assets/level_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/level_art_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME level_art_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/level_art_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder level_art_mps/Assets": {
+                    "watch": "@GEMROOT:level_art_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder level_art_mps/Registry": {
+                    "watch": "@GEMROOT:level_art_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/level_art_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "level_art_mps",
+    "display_name": "level_art_mps",
+    "license": "What license level_art_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for level_art_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of level_art_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "level_art_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements level_art_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of level_art_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "level_art_mps"
+}

+ 3 - 0
Gems/level_art_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 3 - 0
Gems/particlefx_mps/Assets/pfx_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/particlefx_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME particlefx_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/particlefx_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder particlefx_mps/Assets": {
+                    "watch": "@GEMROOT:particlefx_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder particlefx_mps/Registry": {
+                    "watch": "@GEMROOT:particlefx_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/particlefx_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "particlefx_mps",
+    "display_name": "particlefx_mps",
+    "license": "What license particlefx_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for particlefx_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of particlefx_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "particlefx_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements particlefx_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of particlefx_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "particlefx_mps"
+}

+ 3 - 0
Gems/particlefx_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 3 - 0
Gems/pbr_material_pack_mps/Assets/pbr_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/pbr_material_pack_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME pbr_material_pack_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/pbr_material_pack_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder pbr_material_pack_mps/Assets": {
+                    "watch": "@GEMROOT:pbr_material_pack_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder pbr_material_pack_mps/Registry": {
+                    "watch": "@GEMROOT:pbr_material_pack_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/pbr_material_pack_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "pbr_material_pack_mps",
+    "display_name": "pbr_material_pack_mps",
+    "license": "What license pbr_material_pack_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for pbr_material_pack_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of pbr_material_pack_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "pbr_material_pack_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements pbr_material_pack_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of pbr_material_pack_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "pbr_material_pack_mps"
+}

+ 3 - 0
Gems/pbr_material_pack_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 3 - 0
Gems/props_mps/Assets/prop_test.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ddb5998d53d7f5415c04630f10f1c12b390afbbd8b97b942a3b3a397e01dbcde
+size 864496

+ 8 - 0
Gems/props_mps/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+# This will export the path to the directory containing the gem.json
+# to the "SourcePaths" entry within the "cmake_dependencies.<project>.assetbuilder.setreg"
+# which is generated when cmake is run
+# This path is the gem root directory
+if(PAL_TRAIT_BUILD_HOST_TOOLS)
+    ly_create_alias(NAME props_mps.Builders NAMESPACE Gem)
+endif()

+ 18 - 0
Gems/props_mps/Registry/assetprocessor_settings.setreg

@@ -0,0 +1,18 @@
+{
+    "Amazon": {
+        "AssetProcessor": {
+            "Settings": {
+                "ScanFolder props_mps/Assets": {
+                    "watch": "@GEMROOT:props_mps@/Assets",
+                    "recursive": 1,
+                    "order": 101
+                },
+                "ScanFolder props_mps/Registry": {
+                    "watch": "@GEMROOT:props_mps@/Registry",
+                    "recursive": 1,
+                    "order": 102
+                }
+            }
+        }
+    }
+}

+ 21 - 0
Gems/props_mps/gem.json

@@ -0,0 +1,21 @@
+{
+    "gem_name": "props_mps",
+    "display_name": "props_mps",
+    "license": "What license props_mps uses goes here: i.e. Apache-2.0 or MIT",
+    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
+    "origin_url": "The primary repo for props_mps goes here: i.e. http://www.mydomain.com",
+    "type": "Asset",
+    "summary": "A short description of props_mps goes here.",
+    "canonical_tags": [
+        "Gem"
+    ],
+    "user_tags": [
+        "props_mps"
+    ],
+    "icon_path": "preview.png",
+    "requirements": "Notice of any requirements props_mps has goes here. i.e. This requires X other gem",
+    "documentation_url": "Link to any documentation of props_mps goes here: i.e. https://o3de.org/docs/user-guide/gems/reference/design/white-box/",
+    "dependencies": [],
+    "restricted": "props_mps"
+}

+ 3 - 0
Gems/props_mps/preview.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:248e3ffe1fc9ffc02afb2ba8914e222a5a5d13ac45a48b98c95ee062e959a94c
+size 4475

+ 120 - 0
readme.md

@@ -0,0 +1,120 @@
+# O3DE MultiPlayerSample Assets
+
+This repository contains:
+
+1. A collection of O3DE Asset Gems, used in o3de-multiplayersample project
+   1. The source gem folder for development
+2. A `repo.json` file containing information about this O3DE Remote Gem Repository
+3. A GitHub release folder
+   1. The gem .zip containing the gem and associated gem.json for each gem
+
+## If you are using o3de-multiplayer sample
+
+These gems are required for and utilized by the o3de-multiplayer sample project, you can find the repo and instructions for that project and adding these gems here:
+
+[GitHub - o3de/o3de-multiplayersample: Multiplayer sample project for the Open 3D Engine](https://github.com/o3de/o3de-multiplayersample)
+
+## If you want to use these Gems in your own o3de project
+
+### Option #1. Remote Repository, use packaged Gems with the Project Manager
+
+**!!! Skip to Option #2 !!!**
+
+**Use of this as a remote gem repository is not yet implemented</u>**
+
+Add this remote repository in the Project Manager using this URL
+
+```
+https://raw.githubusercontent.com/AMZN-temp-user-replace-me/o3de-remote-gem-repo-demo/main
+```
+
+You can then browse the gems in the Project Manager and add them to your Project.
+
+### Option #2.  Download and use source Gems
+
+You can clone and download the repository source, then register the local gem source folders with the engine to make available for use in a Project.  This entails the same steps as a developer contributing content creation or performing other maintenance of the gem data. (see the next section below.)
+
+## If you are a developer contributing to these asset gems
+
+### Download and Install
+
+This repository uses Git LFS for storing large binary files.  You will need to create a Github personal access token to authenticate with the LFS service.
+
+#### Create a Git Personal Access Token
+
+You will need your personal access token credentials to authenticate when you clone the repository.
+
+[Create a personal access token with the 'repo' scope.](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
+
+#### (Recommended) Verify you have a credential manager installed to store your credentials
+
+Recent versions of Git install a credential manager to store your credentials so you don't have to put in the credentials for every request. It is highly recommended you check that you have a [credential manager installed and configured](https://github.com/microsoft/Git-Credential-Manager-Core)
+
+#### Step 1. Clone the repository
+
+You can clone the project to any folder locally, including inside the engine folder. If you clone the project inside an existing Git repository (e.g. o3de) you should add the project folder to the Git exclude file for the existing repository.ne-the-repository)
+
+##### Option #1 (Highly Recommended) - cloning into a folder outside the engine repository folder
+
+```shell
+# clone the project into a folder outside your engine repository folder
+> git clone https://github.com/o3de/o3de-multiplayersample-assets.git
+Cloning into 'o3de-multiplayersample-assets'...
+```
+
+##### Option #2 - cloning into the engine repository folder
+
+```shell
+# clone the project into a folder named 'o3de-multiplayersample' in your existing engine repository folder
+> git clone https://github.com/o3de/o3de-multiplayersample-assets.git c:/path/to/o3de/o3de-multiplayersample-assets
+Cloning into 'o3de-multiplayersample'...
+
+# modify the local engine git exclude file to ignore the project folder
+> echo o3de-multiplayersample-assets > c:/path/to/o3de/.git/info/exclude
+```
+
+If you have a Git credential helper configured, you should not be prompted for your credentials anymore.
+
+### Step 2. Register the gems with the engine
+
+You may have already done this, these are the same steps as setting up the o3de-multiplayer sample project.  But if you are adding them to your own project these are the steps to do so.
+
+Make sure your engine is registered.
+
+```batch
+:: register the gems with the engine, you only need to do this once
+> c:\path\to\o3de\scripts\o3de register --this-engine
+```
+
+Make sure your project is registered.
+
+```batch
+:: register the project with the engine, you only need to do this once
+> c:\path\to\o3de\scripts\o3de register -p c:/path\to\o3de-multiplayersample
+```
+
+Now make sure that the source gems are registered
+
+```batch
+:: register the gems with the engine, you only need to do this once
+> o3de register --all-gems-path c:\path\to\o3de-multiplayersample-assets\Gems
+```
+
+ The above command will recursively scan the input path, then registers all paths with gem.json files into the ~/.o3de/o3de_manifest.json
+
+Now these Gems will be available in the Project Manager and can be added to your Project.
+
+# Appendix
+
+How these Asset Gems were made with O3DE.
+
+```batch
+cd c:\path\to\o3de\
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\props_mps --template-path C:\o3de\Templates\AssetGem
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\level_art_mps --template-path C:\o3de\Templates\AssetGem
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\character_mps --template-path C:\o3de\Templates\AssetGem
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\landscape_mps --template-path C:\o3de\Templates\AssetGem
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\pbr_material_pack_mps --template-path C:\o3de\Templates\AssetGem
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\particlefx_mps --template-path C:\o3de\Templates\AssetGem
+scripts\o3de create-gem --gem-path C:\o3de-multiplayersample-assets\Gems\kb3d_mps --template-path C:\o3de\Templates\AssetGem
+```