Sfoglia il codice sorgente

updated readme

Signed-off-by: Jonny Galloway <[email protected]>
Jonny Galloway 3 anni fa
parent
commit
15df46d37f
1 ha cambiato i file con 13 aggiunte e 8 eliminazioni
  1. 13 8
      readme.md

+ 13 - 8
readme.md

@@ -3,24 +3,25 @@
 This repository contains:
 This repository contains:
 
 
 1. A collection of O3DE Asset Gems, used in o3de-multiplayersample project
 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 source folder for each Gem, for development by Contributors.
+   2. e.g. a gem for sample characters: https://github.com/o3de/o3de-multiplayersample-assets/Gems/character_mps
+2. (Future) A `repo.json` file containing information about this O3DE Remote Gem Repository
+3. (Future) A GitHub release folder
    1. The gem .zip containing the gem and associated gem.json for each gem
    1. The gem .zip containing the gem and associated gem.json for each gem
 
 
-## If you are using o3de-multiplayer sample
+## If you are using o3de-multiplayer-sample Game
 
 
 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:
 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)
 [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
+## If you want to use these Gems in your own o3de game project
 
 
-### Option #1. Remote Repository, use packaged Gems with the Project Manager
+### (Future) Option #1. Remote Repository, use packaged Gems with the Project Manager
 
 
 **!!! Skip to Option #2 !!!**
 **!!! Skip to Option #2 !!!**
 
 
-**<u>Use of this as a remote gem repository is not yet implemented</u>**
+**<u>Use of this as a remote gem repository is not yet implemented!</u>**
 
 
 Add this remote repository in the Project Manager using this URL:
 Add this remote repository in the Project Manager using this URL:
 
 
@@ -32,7 +33,7 @@ You can then browse the gems in the Project Manager and add them to your Project
 
 
 ### Option #2.  Download and use source Gems
 ### 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.)
+You can clone the repo to 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
 ## If you are a developer contributing to these asset gems
 
 
@@ -108,6 +109,10 @@ Now these Gems will be available in the Project Manager and can be added to your
 
 
 How these Asset Gems were made with O3DE.
 How these Asset Gems were made with O3DE.
 
 
+1. The Gems were created from the Asset Gem template
+
+2. Then the gem.json (metadata) was manually updated per-gem
+
 ```batch
 ```batch
 cd c:\path\to\o3de\
 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\props_mps --template-path C:\o3de\Templates\AssetGem