From 2223e548becfba993ea084793962dccef69dc4a1 Mon Sep 17 00:00:00 2001 From: guillaume-haerinck Date: Sat, 27 Apr 2024 20:21:47 +0200 Subject: [PATCH 1/3] Update readme and check against 23.10 Signed-off-by: guillaume-haerinck --- README.md | 194 +++++++--------------------------------------- project.json | 2 +- project.json.bak1 | 48 ++++++++++++ 3 files changed, 78 insertions(+), 166 deletions(-) create mode 100644 project.json.bak1 diff --git a/README.md b/README.md index 1b0b3e2..34fe00e 100644 --- a/README.md +++ b/README.md @@ -1,188 +1,52 @@ -# Protect-the-Moon +Supported o3de versions : **23.10** -Project Or Game Description: -Protect the Moon is a retro-style game that features classic arcade gameplay. As the defender of one of the most essential and precious -assets of our planet - the Moon, you must protect it at all costs against alien invaders who have taken control of it. - -**This game is just one example of the many games included in the O3DE learning series -available at the following link: https://youtube.com/playlist?list=PLCQwFpnHSZQgyIu4JeOUDCsNCVgWOz3Mf** - -![SplashScreen](https://user-images.githubusercontent.com/87207603/235951250-4684e278-e83d-462c-95ab-ce1d51d2026d.jpg) - -## The Project Includes - -- **Project Setup** Introduction to game development, setup of development environment and introduction to the game concept. -- **A Creating The Main Menu** Here we create a simple menu that launches the first level of the game. -- **Enemies & Spawning Assets Prefabs** Importing the player and enemy ships. -- **Player Movement** Implementing player movement. -- **Projectiles & Collision** Implementing enemy movement and Projectiles. -- **In Game HUD - Scoring and Lives** Setting Up the In Game HUD UI Canvas and Script Canvas. -- **Game Assets Prefabs** The of the Alien Enemies, Projectiles, and the Main Player Character. +# Protect the Moon -## Protect the Moon Tutorial Video Series![Protect_the_Moon_01](https://user-images.githubusercontent.com/87207603/235951941-332c2166-11d3-4b6b-acc0-ef62ec3e7912.png) -## In Editor Game Shots! -![in_editor_shot](https://user-images.githubusercontent.com/87207603/235952125-1ab1c72d-a571-4db4-b4b5-db523526af0e.gif) -## Full Screen Game Play! ![full_screen](https://user-images.githubusercontent.com/87207603/235952195-ed90adac-f32a-4226-aa6f-5bc1ebede266.gif) -## GAME PLAY VIDEO -https://user-images.githubusercontent.com/87207603/235952495-29eacd36-fbbf-4fcc-8e86-c816cafcad7c.mp4 - -## Game Levels -- **Level_01** is the main game play level for a full game loop. - -## Requirements - -### Platforms - -The project supports the following platforms: - -- **Windows 10 version 1809 (10.0.17763)** or later is required. +Protect the Moon is a retro-style game that features classic arcade gameplay. As the defender of one of the most essential and precious +assets of our planet - the Moon, you must protect it at all costs against alien invaders who have taken control of it. -## O3DE Installation +**You can learn to make this project from scratch by [following this youtube playlist](https://www.youtube.com/playlist?list=PLCQwFpnHSZQgyIu4JeOUDCsNCVgWOz3Mf)** -1. Refer to the [O3DE System Requirements](https://www.o3de.org/docs/welcome-guide/requirements/) documentation to make sure that the system/hardware requirements are met. -2. Please follow the instructions to [set up O3DE from GitHub](https://o3de.org/docs/welcome-guide/setup/setup-from-github/). -3. **Use the development branch**: git checkout development. +## Prerequisites -# Building the project +You need to build or [install O3DE engine](https://o3de.org/download/). -## Build Steps +## How to run -1. Clone the **Protect-the-Moon** game project from the following repo: -2. git clone https://github.com/o3de/Protect-the-Moon -3. Within the Project manager locate and click on the **New Project** button. Then from the drop down menu select the **Open Existing Project** option. -4. Once Windows Explorer opens, navigate to and select the **Protect-the-Moon** folder. Once selected click on the **Select Folder** button. -5. This will load the **Protect-the-Moon** project into the **Project Manager**. +1. Download (green "Code" button, then "Download ZIP") or clone the github repository (`git clone https://github.com/o3de/Protect-the-Moon.git`) +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. 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. +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. -1. In order to build the project, locate and click on the **Build Project** button, located on the **Protect-the-Moon** icon. +## Controls -## Launching the Project +The player can be moved around the level using the A and D commands and Left Mouse Clicks will fire your weapon. -1. Once the project has been built successfully, the **Build Project** button will disappear and an **Open Editor** button should be the only option you can select. -2. Click on the **Open Editor** button this will open the **Protect-the-Moon** project. +## Project Highlights -## Opening the Game-play Level +https://user-images.githubusercontent.com/87207603/235952495-29eacd36-fbbf-4fcc-8e86-c816cafcad7c.mp4 -1. Once the Asset Processor has completed importing and processing a significance portion of the assets the O3DE Editor will open. -2. In the **Welcome to O3DE** splash screen select the **Open** button to open a new level. -3. This will open the **Open a Level** window -4. Select the **Level_01** level and click the open level to launch the level. -5. Once the level opens, the menu splash screen will ask you to mouse click to start the game. +- **Project Setup** Introduction to game development, setup of development environment and introduction to the game concept. +- **Main Menu** Here we create a simple menu that launches the first level of the game. +- **Enemies & Spawning Assets Prefabs** Importing the player and enemy ships. +- **Player Movement** Implementing player movement. +- **Projectiles & Collision** Implementing enemy movement and Projectiles. +- **In Game HUD - Scoring and Lives** Setting Up the In Game HUD UI Canvas and Script Canvas. +- **Game Assets Prefabs** Alien Enemies, Projectiles, and the Main Player Character. -**Controlling the Main Player** +### Screenshots -**Navigation** +![SplashScreen](https://user-images.githubusercontent.com/87207603/235951250-4684e278-e83d-462c-95ab-ce1d51d2026d.jpg) -1. The Main Player model can be moved around the level using the A and D commands and Left Mouse Clicks will fire your weapon. +![screeshot](screenshot-1.png?raw=true) -**License** +## License For terms please see the LICENSE\*.TXT files at the root of this repository. - -For the sake of clarification licensing information can be also be found below. - -| OPEN 3D ENGINE LICENSING | -| ------------------------ | -| | - -| The default license for Open 3D Engine is the Apache License, Version 2.0 | -| ------------------------------------------------------------------------- | -| | - -| (see LICENSE_APACHE2.TXT); you may elect at your option to use the Open 3D | -| -------------------------------------------------------------------------- | -| | - -| Engine under the MIT License (see LICENSE_MIT.TXT). Contributions must be | -| ------------------------------------------------------------------------- | -| | - -| made under both licenses. | -| ------------------------- | -| | - -| | -| --- | -| | - -| THIRD PARTY COMPONENTS | -| ---------------------- | -| | - -| Open 3D Engine requires the use of (and in some cases makes available to you) | -| ----------------------------------------------------------------------------- | -| | - -| software and assets that have been developed by third parties and are subject | -| ----------------------------------------------------------------------------- | -| | - -| to separate license terms (such as code licensed under other open source | -| ------------------------------------------------------------------------ | -| | - -| licenses). It is your responsibility to comply with the applicable licenses. | -| ---------------------------------------------------------------------------- | -| | - -| Information on third party materials, and the applicable license terms, are | -| --------------------------------------------------------------------------- | -| | - -| referenced in or included with the materials, such as in separate LICENSE.txt | -| ----------------------------------------------------------------------------- | -| | - -| files accompanying the materials. | -| --------------------------------- | -| | - -| | -| --- | -| | - -| Please note that certain materials are subject to "copyleft" licenses, which | -| ---------------------------------------------------------------------------- | -| | - -| require distribution of source code, including: | -| ----------------------------------------------- | -| | - -| | -| --- | -| | - -| - Qt Toolkit https://github.com/qtproject/, which is subject to the GNU | -| ----------------------------------------------------------------------- | -| | - -| Lesser General Public License version 3 (with certain exceptions). A copy of | -| ---------------------------------------------------------------------------- | -| | - -| the source code for Qt Toolkit may be found at | -| ---------------------------------------------- | -| | - -| https://s3-us-west-2.amazonaws.com/ly-legal/LicenseConformance/Qt/Src.zip | -| ------------------------------------------------------------------------- | -| | - -| | -| --- | -| | - -| - The AWS Python SDK uses Chardet https://chardet.github.io/, which is | -| ---------------------------------------------------------------------- | -| | - -| subject to the GNU Lesser General Public License version 2.1. A copy of the | -| --------------------------------------------------------------------------- | -| | - -source code may be found at https://github.com/chardet/chardet. diff --git a/project.json b/project.json index fa02590..8289802 100644 --- a/project.json +++ b/project.json @@ -44,5 +44,5 @@ "WhiteBox", "LyShineExamples" ], - "engine_version": "2.0.0" + "engine_version": "2.2.2" } diff --git a/project.json.bak1 b/project.json.bak1 new file mode 100644 index 0000000..fa02590 --- /dev/null +++ b/project.json.bak1 @@ -0,0 +1,48 @@ +{ + "project_name": "Protect-the-Moon", + "version": "1.0.0", + "project_id": "{92A07177-CB9C-49C0-B7EB-3729B0154A48}", + "origin": "The primary repo for Protect-the-Moon goes here: i.e. http://www.mydomain.com", + "license": "What license Protect-the-Moon uses goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT etc.", + "display_name": "Protect-the-Moon", + "summary": "A short description of Protect-the-Moon.", + "canonical_tags": [ + "Project" + ], + "user_tags": [ + "Protect-the-Moon" + ], + "icon_path": "preview.png", + "engine": "o3de", + "external_subdirectories": [ + "Gem" + ], + "restricted": "Protect-the-Moon", + "gem_names": [ + "Protect-the-Moon", + "Atom", + "AudioSystem", + "AWSCore", + "CameraFramework", + "Compression", + "DebugDraw", + "DiffuseProbeGrid", + "EditorPythonBindings", + "EMotionFX", + "GameState", + "ImGui", + "LandscapeCanvas", + "LyShine", + "PhysX", + "PrimitiveAssets", + "PrefabBuilder", + "SaveData", + "ScriptCanvasPhysics", + "ScriptEvents", + "StartingPointInput", + "TextureAtlas", + "WhiteBox", + "LyShineExamples" + ], + "engine_version": "2.0.0" +} From b825fabd77bb4c1a2c72ef6a69e79326a2cd5ebe Mon Sep 17 00:00:00 2001 From: guillaume-haerinck Date: Sat, 27 Apr 2024 20:22:14 +0200 Subject: [PATCH 2/3] remove screenhot as issue with lfs setup Signed-off-by: guillaume-haerinck --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 34fe00e..84b90be 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,6 @@ https://user-images.githubusercontent.com/87207603/235952495-29eacd36-fbbf-4fcc- ![SplashScreen](https://user-images.githubusercontent.com/87207603/235951250-4684e278-e83d-462c-95ab-ce1d51d2026d.jpg) -![screeshot](screenshot-1.png?raw=true) - ## License For terms please see the LICENSE\*.TXT files at the root of this repository. From 3253ed17793dc4169ce851d71f39830082a65d78 Mon Sep 17 00:00:00 2001 From: guillaume-haerinck Date: Sun, 28 Apr 2024 08:47:26 +0200 Subject: [PATCH 3/3] Only include clone repo method Signed-off-by: guillaume-haerinck --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) 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