Add unified readme and check project against 23.10.3

Signed-off-by: guillaume-haerinck <[email protected]>

.gitattributes

@@ -52,7 +52,6 @@
 *.fsq filter=lfs diff=lfs merge=lfs -text
 *.fxl filter=lfs diff=lfs merge=lfs -text
 *.gfx filter=lfs diff=lfs merge=lfs -text
-*.gif filter=lfs diff=lfs merge=lfs -text
 *.grd filter=lfs diff=lfs merge=lfs -text
 *.hdr filter=lfs diff=lfs merge=lfs -text
 *.i_caf filter=lfs diff=lfs merge=lfs -text
@@ -90,7 +89,6 @@
 *.pkat filter=lfs diff=lfs merge=lfs -text
 *.pkfx filter=lfs diff=lfs merge=lfs -text
 *.pkmm filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
 *.ppm filter=lfs diff=lfs merge=lfs -text
 *.prototype filter=lfs diff=lfs merge=lfs -text
 *.psd filter=lfs diff=lfs merge=lfs -text

Project/Code/enabled_gems.cmake

@@ -1,6 +1,5 @@
 
 set(ENABLED_GEMS
-    Project::Samples
     Atom_AtomBridge
     Camera
     CameraFramework
@@ -28,12 +27,9 @@ set(ENABLED_GEMS
     StartingPointCamera
     PhysX
     PhysXDebug
-    PhysXSamples
     Terrain
-    PythonExamples
     PrimitiveAssets
     ScriptCanvas
-    ScriptCanvasDeveloperGem
     ScriptCanvasPhysics
     ScriptCanvasTesting
     ScriptedEntityTweener

Project/Levels/archvis/Interior_01/Interior_01.prefab

@@ -32,10 +32,6 @@
                 "$type": "EditorEntityIconComponent",
                 "Id": 5688118765544765547
             },
-            "Component_[6545738857812235305]": {
-                "$type": "SelectionComponent",
-                "Id": 6545738857812235305
-            },
             "Component_[7247035804068349658]": {
                 "$type": "EditorPrefabComponent",
                 "Id": 7247035804068349658
@@ -60,10 +56,6 @@
             "Id": "Entity_[1155164325235]",
             "Name": "Sun",
             "Components": {
-                "Component_[10440557478882592717]": {
-                    "$type": "SelectionComponent",
-                    "Id": 10440557478882592717
-                },
                 "Component_[13620450453324765907]": {
                     "$type": "EditorLockComponent",
                     "Id": 13620450453324765907
@@ -130,10 +122,6 @@
             "Id": "Entity_[1159459292531]",
             "Name": "Ground",
             "Components": {
-                "Component_[11701138785793981042]": {
-                    "$type": "SelectionComponent",
-                    "Id": 11701138785793981042
-                },
                 "Component_[12260880513256986252]": {
                     "$type": "EditorEntityIconComponent",
                     "Id": 12260880513256986252
@@ -205,8 +193,7 @@
                     "Id": 16880285896855930892,
                     "Controller": {
                         "Configuration": {
-                            "Field of View": 55.0,
-                            "EditorEntityId": 8929576024571800510
+                            "Field of View": 55.0
                         }
                     }
                 },
@@ -224,21 +211,17 @@
                     "Parent Entity": "Entity_[1176639161715]",
                     "Transform Data": {
                         "Translate": [
-                            -2.3000001907348633,
-                            -3.9368600845336914,
-                            1.0
+                            0.5503278374671936,
+                            -3.227426290512085,
+                            1.4350610971450806
                         ],
                         "Rotate": [
-                            -2.050307512283325,
-                            1.9552897214889526,
-                            -43.623355865478516
+                            -11.30810260772705,
+                            -2.6336212158203125,
+                            12.941014289855957
                         ]
                     }
                 },
-                "Component_[18387556550380114975]": {
-                    "$type": "SelectionComponent",
-                    "Id": 18387556550380114975
-                },
                 "Component_[2654521436129313160]": {
                     "$type": "EditorVisibilityComponent",
                     "Id": 2654521436129313160
@@ -276,10 +259,6 @@
                     "$type": "EditorEntityIconComponent",
                     "Id": 11443347433215807130
                 },
-                "Component_[11779275529534764488]": {
-                    "$type": "SelectionComponent",
-                    "Id": 11779275529534764488
-                },
                 "Component_[14249419413039427459]": {
                     "$type": "EditorInspectorComponent",
                     "Id": 14249419413039427459
@@ -357,10 +336,6 @@
                     "$type": "EditorLockComponent",
                     "Id": 14988041764659020032
                 },
-                "Component_[15808690248755038124]": {
-                    "$type": "SelectionComponent",
-                    "Id": 15808690248755038124
-                },
                 "Component_[15900837685796817138]": {
                     "$type": "EditorVisibilityComponent",
                     "Id": 15900837685796817138
@@ -414,10 +389,6 @@
                         }
                     }
                 },
-                "Component_[11980494120202836095]": {
-                    "$type": "SelectionComponent",
-                    "Id": 11980494120202836095
-                },
                 "Component_[1428633914413949476]": {
                     "$type": "EditorLockComponent",
                     "Id": 1428633914413949476
@@ -509,15 +480,10 @@
                     "Id": 13163239682556593994,
                     "Controller": {
                         "Configuration": {
-                            "Field of View": 39.999996185302734,
-                            "EditorEntityId": 11298051038054503515
+                            "Field of View": 39.999996185302734
                         }
                     }
                 },
-                "Component_[13454646933006731835]": {
-                    "$type": "SelectionComponent",
-                    "Id": 13454646933006731835
-                },
                 "Component_[13501349964178077830]": {
                     "$type": "EditorLockComponent",
                     "Id": 13501349964178077830
@@ -564,10 +530,6 @@
                     "$type": "EditorEntitySortComponent",
                     "Id": 14762304447392003323
                 },
-                "Component_[15842906493188018471]": {
-                    "$type": "SelectionComponent",
-                    "Id": 15842906493188018471
-                },
                 "Component_[18429032171837010139]": {
                     "$type": "EditorOnlyEntityComponent",
                     "Id": 18429032171837010139
@@ -648,10 +610,6 @@
                     "$type": "EditorEntityIconComponent",
                     "Id": 14288435870968794513
                 },
-                "Component_[14694209781494157359]": {
-                    "$type": "SelectionComponent",
-                    "Id": 14694209781494157359
-                },
                 "Component_[5205314791062056480]": {
                     "$type": "EditorPendingCompositionComponent",
                     "Id": 5205314791062056480
@@ -728,10 +686,6 @@
                     "$type": "EditorEntityIconComponent",
                     "Id": 14288435870968794513
                 },
-                "Component_[14694209781494157359]": {
-                    "$type": "SelectionComponent",
-                    "Id": 14694209781494157359
-                },
                 "Component_[5205314791062056480]": {
                     "$type": "EditorPendingCompositionComponent",
                     "Id": 5205314791062056480

Project/project.json

@@ -16,5 +16,6 @@
     "external_subdirectories": [
         "../Gems/ArchVis",
         "Code"
-    ]
+    ],
+    "engine_version": "2.2.2"
 }

Project/project.json.bak0

@@ -0,0 +1,20 @@
+{
+    "project_name": "LoftSample",
+    "project_id": "{6B644ACC-D83D-40AD-9EB1-793A01633A86}",
+    "origin": "https://github.com/aws-lumberyard/loft-arch-vis-sample",
+    "license": "https://opensource.org/licenses/MIT",
+    "display_name": "O3DE Loft Sample",
+    "summary": "This project contains the O3DE Loft sample scene.",
+    "canonical_tags": [
+        "Project"
+    ],
+    "user_tags": [
+        "LoftSample"
+    ],
+    "icon_path": "preview.png",
+    "engine": "o3de",
+    "external_subdirectories": [
+        "../Gems/ArchVis",
+        "Code"
+    ]
+}

README.md

@@ -1,61 +1,41 @@
-# O3DE Loft ArchVis Sample Scene
+<u>Supported o3de versions</u> : **23.10**
 
-![image](https://user-images.githubusercontent.com/23222931/197286449-77ecd592-464c-49b1-88d0-487e2546b5ab.png)
+# Loft ArchVis
 
-## Download and Install
+![gameplay](doc/gameplay.gif?raw=true)
 
-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.
+Loft Architectural Visualization is a set of multiple indoor scene. This project can be used to test direct and indirect lighting setup.
 
-### Create a Git Personal Access Token
+## Prerequisites
 
-You will need your personal access token credentials to authenticate when you clone the repository.
+You need to build or [install O3DE engine](https://o3de.org/download/).
 
-[Create a personal access token with the 'repo' scope.](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
+You need to [install git with lfs support](https://git-scm.com/downloads), and [setup a token on your github account](https://www.docs.o3de.org/docs/welcome-guide/setup/setup-from-github/#configure-credentials-for-git-lfs). Needed as the repository uses Git LFS, the "Download ZIP" button will not download assets.
 
-### (Recommended) Verify you have a credential manager installed to store your credentials
+## How to run
 
-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)
+1. Clone the github repository (`git clone https://github.com/o3de/loft-arch-vis-sample.git`). When prompted to authenticate, use your github username and the token as password.
+2. Launch O3DE. It will open the Project manager. Click on the **New Project** button then **Open Existing Project** option.
+3. Navigate to your repository. Open the **Project** folder. The project should now be registered.
 
-### Step 1. Clone the repository
+![project](doc/cover.png?raw=true)
 
-You can clone the gems to any folder locally, including inside the engine folder. If you clone to a folder inside an existing Git repository (e.g. o3de) you should add the folder to the Git exclude file for the existing repository.
+4. Click on the **Build Project** button, located on the **O3DE Loft Sample** image.
+5. Once the project has been built successfully, use the **Open Editor** button.
+6. The asset pre-processor will run for a bit. Once it is over you will be welcomed with the **Open a Level** window, simply pick the first one.
 
-#### Option #1 (Recommended) - cloning into a folder outside the engine repository folder
+## Project Highlights
 
-```shell
-# clone into a folder outside your engine repository folder
-> git clone https://github.com/o3de/loft-arch-vis-sample.git
-Cloning into 'loft-arch-vis-sample'...
-```
+- **Benchmarking**, this scene was made to test rendering performances of O3DE.
+- **Realistic environment**, the scene uses many assets all in realistic style.
 
-#### Option #2 - cloning into the engine repository folder
+### Screenshots
 
-```shell
-# clone the project into a folder named 'loft-arch-vis-sample' in your existing engine repository folder
-> git clone https://github.com/o3de/loft-arch-vis-sample.git c:/path/to/o3de/loft-arch-vis-sample
-Cloning into 'loft-arch-vis-sample'...
+![screenshot](doc/screenshot-1.png?raw=true)
 
-# modify the local engine git exclude file to ignore the project folder
-> echo loft-arch-vis-sample > c:/path/to/o3de/.git/info/exclude
-```
+![screenshot](doc/screenshot-2.png?raw=true)
 
-If you have a Git credential helper configured, you should not be prompted for your credentials anymore.
-
-### Step 2. Register the engine and gems
-
-```shell
-# register the engine (If you already have built O3DE in project-centric mode then you don't need this step.)
-> c:/path/to/o3de/scripts/o3de register --this-engine
-
-# register the project 
-> c:/path/to/o3de/scripts/o3de register -pp c:/path/to/loft-arch-vis-sample/Project
-
-# register the gem (OPTIONAL) - Only needed if you plan to use the gem from another project. 
-> c:/path/to/o3de/scripts/o3de register -gp c:/path/to/loft-arch-vis-sample/Gems/ArchVis
-```
-
-You are now setup to use these gems in your projects.
+![screenshot](doc/screenshot-3.png?raw=true)
 
 ## License