Merge pull request #2552 from guillaume-haerinck/samples

Signed-off-by: Jan Hanca <[email protected]>
o3de · Aug 16, 2024 · e96b945 · e96b945
1 parent ccf8b64
commit e96b945
Show file tree

Hide file tree

Showing 29 changed files with 177 additions and 225 deletions.
diff --git a/content/docs/learning-guide/_index.md b/content/docs/learning-guide/_index.md
@@ -13,10 +13,9 @@ This guide contains video tutorials, written step-by-step tutorials, and sample
 
 | Section | Description |
 | - | - |
-| [Create your first O3DE game: Pong](tutorials/first-project/) | Start from a new O3DE project and build your first game: Pong! What's "Pong"? Two paddles square off, in a ball-based battle to land the highest score. This tutorial series will introduce you to basic game UI development, scripting, and controls in O3DE. |
 | [Video Tutorials](#video-tutorials) | These video tutorials cover all the topics you need to get started, including an overview of O3DE, instructions on installing O3DE, building O3DE from source, and creating projects. It also introduces important features and key systems such as the Editor, the modular Gem system, networking, the visual scripting environment, and O3DE's integrated renderer, Atom. |
 | [Tutorials](tutorials) | These written tutorials are grouped by concept and focus on specific features, tools, and processes. |
-| [Sample Documentation](samples) | These topics cover sample projects and sample Gems available for O3DE. |
+| [Samples](samples) | These topics cover sample projects and sample Gems available for O3DE. |
 
 ## Video Tutorials
 

diff --git a/content/docs/learning-guide/samples/_index.md b/content/docs/learning-guide/samples/_index.md
@@ -7,8 +7,12 @@ weight: 300
 
 To help you on your journey with **Open 3D Engine (O3DE)**, we offer samples that demonstrate fully self-contained O3DE projects, levels, or Gems that are meant to be used as starting points or playgrounds for experimentation.<!-- If you're a developer focused on finding smaller, quick, standalone examples, you should check out the [O3DE Cookbooks](/docs/learning-guide/cookbooks) for things like C++ samples, Script Canvas functions, and more.-->
 
-## Available samples
-
-| Sample | Description |
-| - | - |
-| [Kythera City Demo Level](ai/kythera-city-level-overview) | Overview of the Kythera AI demo level "Kythera City", included with the [Kythera AI](/docs/user-guide/gems/reference/kythera-ai) Gem. |
+| | Type | Description |
+| - | - | - |
+| {{< icon "trackview-editor.svg" >}} | [Follow Along](follow-along) | Basic samples with a video playlist to create them step by step |
+| {{< icon "animation-editor.svg" >}} | [Templates](templates) | Gameplay templates to use as a quick start |
+| {{< icon "play.svg" >}} | [Prototypes](prototypes) | Games prototypes used as a proof of concept  |
+| {{< icon "camera.svg" >}} | [Benchmark](benchmark) | Benchmarking project used to stress test the renderer |
+| {{< icon "grid.svg" >}} | [Feature Showcase](feature-showcase) | In-Depth showcase of an engine feature |
+| {{< icon "material-canvas.svg" >}} | [Advanced](advanced) | Advanced game projects with various mechanics and large world |
+| {{< icon "simulate-physics.svg" >}} | [Robotic](robotic) | Robotic simulation projects |
diff --git a/content/docs/learning-guide/samples/advanced/_index.md b/content/docs/learning-guide/samples/advanced/_index.md
@@ -0,0 +1,12 @@
+---
+linktitle: Advanced
+title: Advanced
+description: Advanced O3DE games.
+weight: 600
+---
+
+Advanced projects are made and maintained over a long period of times. They are used to showcase how O3DE handles a large number of entities and the workflow for big projects.
+
+| Image | Link | Description | Last Updated |
+| - | - | - | - |
+| <img src="/images/learning-guide/samples/advanced/multiplayer-sample.png" width="300px" /> | [Multiplayer Sample](https://github.com/o3de/o3de-multiplayersample) | Third-person multiplayer game where robots battle one another for dominance in an under construction, multi-tiered starbase | O3DE **23.10.3**. April 28, 2024 |
diff --git a/content/docs/learning-guide/samples/ai/kythera-city-level-overview.md b/content/docs/learning-guide/samples/ai/kythera-city-level-overview.md
diff --git a/content/docs/learning-guide/samples/benchmark/_index.md b/content/docs/learning-guide/samples/benchmark/_index.md
@@ -0,0 +1,13 @@
+---
+linktitle: Benchmark
+title: Benchmark
+description: Benchmarking projects to stress test the O3DE rendering pipeline.
+weight: 400
+---
+
+Benchmarking project are made to be visually appealing so that they can be used to showcase the rendering features of the engine.
+
+| Image | Link | Description | Last Updated |
+| - | - | - | - |
+| <img src="/images/learning-guide/samples/benchmark/buongiorno.png" width="300px" /> | [Buon(G.I)orno ](https://github.com/o3de/buongiorno-sample) | Stylized representation of a small italian village to showcase mobile raytracing features | O3DE **23.10.3**. April 28, 2024 |
+| <img src="/images/learning-guide/samples/benchmark/loft-archviz-sample.png" width="300px" /> | [Loft ArchViz Sample](https://github.com/o3de/loft-arch-vis-sample) | Small loft interiors used to test rendering fidelity | O3DE **23.10.3**. April 28, 2024 |
diff --git a/content/docs/learning-guide/samples/feature-showcase/_index.md b/content/docs/learning-guide/samples/feature-showcase/_index.md
@@ -0,0 +1,12 @@
+---
+linktitle: Feature Showcase
+title: Feature Showcase
+description: In-Depth Showcase of a specific feature of the engine 
+weight: 500
+---
+
+Feature Showcase projects serves as a live documentation for engine features and can also be useful to detect bugs or regressions.
+
+| Image | Link | Description | Last Updated |
+| - | - | - | - |
+| <img src="/images/learning-guide/samples/feature-showcase/procedural-worlds.png" width="300px" /> | [Procedural Worlds](https://github.com/o3de/o3de-workshops-2022) | Showcase terrain gem to proceduraly generate high-quality terrain. Presentation video [is available here](https://www.youtube.com/watch?v=x5NtCK15AGo&list=PLCQwFpnHSZQgzCpMmbxruFkWr3d73ZfEJ&index=27) | O3DE **23.10.3**. April 28, 2024 |
diff --git a/content/docs/learning-guide/samples/follow-along/_index.md b/content/docs/learning-guide/samples/follow-along/_index.md
@@ -0,0 +1,20 @@
+---
+linktitle: Follow Along
+title: Follow Along
+description: Make a game step by step by following the documentation.
+weight: 100
+---
+
+The following samples are the perfect entry for O3DE newcommers. Follow the provided video playlist to learn about basic scripting, scene editing and material setup.
+
+| Image | Link | Description |
+| - | - | - |
+| <img src="/images/learning-guide/samples/follow-along/pong.png" width="300px" /> | [Pong](pong) | The classic "Pong" game revisited in 3D |
+| <img src="/images/learning-guide/samples/follow-along/protect-the-moon.png" width="300px" />  | [Protect the moon](protect-the-moon) | A side-scrolling shooter inspired by "Space Invader" |
+
+## Community curated
+
+| Image | Link | Description | Last Updated |
+| - | - | - | - |
+| <img src="/images/learning-guide/samples/follow-along/o3de-book.png" width="300px" />  | [O3DE Book](https://o3debook.com/) | The book "Game programming with O3DE" by Olex Lozitskiy will have you make a multiplayer soccer game with chickens. Source code [is available here](https://github.com/SelfishOlex/O3DEBookCode2111). | N/A |
+| <img src="/images/learning-guide/samples/follow-along/multiplayer-workshop.png" width="300px" /> | [Multiplayer Workshop](https://github.com/AMZN-Gene/o3dcon-2022-multiplayer-workshop) | Basic multiplayer game with 3rd person player movement. Video of the workshop [is available here](https://www.youtube.com/watch?v=4f4olmUo44k&list=PLCQwFpnHSZQjDIkT9EqCNDWepsh8sTGMm) | N/A |
diff --git a/...g-guide/tutorials/first-project/_index.md → ...arning-guide/samples/follow-along/pong.md b/...g-guide/tutorials/first-project/_index.md → ...arning-guide/samples/follow-along/pong.md
@@ -5,6 +5,10 @@ description: Videos to guide you through creating a basic Pong game in Open 3D E
 toc: true
 ---
 
+| Repository | Time to Complete | Feature Focus | Last Updated |
+| - | - | - | - |
+| N/A | 2 Hours | Visual scripting, UI | O3DE **23.10.3**. April 28, 2024  |
+
 This topic contains video tutorials that will guide you through creating a Pong game in **Open 3D Engine (O3DE)**, from creating a new project to defining gameplay state and user interface elements.
 
 ## Video Tutorial Series: Create the Pong Game with O3DE

diff --git a/content/docs/learning-guide/samples/follow-along/protect-the-moon.md b/content/docs/learning-guide/samples/follow-along/protect-the-moon.md
@@ -0,0 +1,48 @@
+---
+linkTitle: Protect the moon
+title: Protect the moon
+description: Videos to guide you through creating a basic side scroller shooter in Open 3D Engine (O3DE).
+toc: true
+---
+
+| Repository | Time to Complete | Feature Focus | Last Updated |
+| - | - | - | - |
+| [Github](https://github.com/o3de/Protect-the-Moon ) | 2 Hours | Visual scripting, UI | O3DE **23.10.3**. April 28, 2024  |
+
+This topic contains video tutorials that will guide you through creating a side scrolling shooter with **Open 3D Engine (O3DE)**.
+
+## Video Tutorial Series: Create "Protect the moon" with O3DE
+
+[Take me to the full playlist!](https://www.youtube.com/playlist?list=PLCQwFpnHSZQgyIu4JeOUDCsNCVgWOz3Mf)
+
+### Project setup
+
+{{< youtube-width id="rJBAChtWPCs" title="01 Project Setup" >}}
+
+### Creating the Main Menu
+
+{{< youtube-width id="wMbszzKs3ME" title="02 Creating The Main Menu" >}}
+
+### Setting up project assets
+
+{{< youtube-width id="r0JNHOtevPA" title="03 Setting Up Project Assets" >}}
+
+### Player movement
+
+{{< youtube-width id="DtVudWEkmOM" title="04 Player Movement" >}}
+
+### Enemies & Spawning
+
+{{< youtube-width id="yk3PJ-HdshQ" title="05 Enemies & Spawning" >}}
+
+### Projectiles & Collisions
+
+{{< youtube-width id="Jqolu6iSQzM" title="06 Enemies & Spawning" >}}
+
+### Scoring and Lives part 1
+
+{{< youtube-width id="yKtTlGb7Jbo" title="07 Scoring and Lives Part 1" >}}
+
+### Scoring and Lives part 2
+
+{{< youtube-width id="2_9XsWPM-kM" title="08 Scoring and Lives Part 2" >}}