diff --git a/README.md b/README.md index 84b90be..1bdbe4b 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,18 @@ assets of our planet - the Moon, you must protect it at all costs against alien You need to build or [install O3DE engine](https://o3de.org/download/). +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. + ## How to run -1. Download (green "Code" button, then "Download ZIP") or clone the github repository (`git clone https://github.com/o3de/Protect-the-Moon.git`) +1. Clone the github repository (`git clone https://github.com/o3de/Protect-the-Moon.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 download (and make sure it is unzipped). Open this folder. The project should now be registered. +3. Navigate to the cloned repository. Open this folder. The project should now be registered. build 4. Click on the **Build Project** button, located on the **Protect-the-Moon** image. -5. Once the project has been built sucessfully, use the **Open Editor** button. +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. ## Controls