Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and check against 23.10 #16

Merged
merged 4 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
690 changes: 690 additions & 0 deletions Levels/Neighborhood/Neighborhood.prefab

Large diffs are not rendered by default.

721 changes: 691 additions & 30 deletions Levels/NeighborhoodAlex/NeighborhoodAlex.prefab

Large diffs are not rendered by default.

File renamed without changes
Binary file added Media/gameplay-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/gameplay.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Media/gameplay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed Media/image10.png
Binary file not shown.
Binary file removed Media/image11.png
Binary file not shown.
Binary file removed Media/image12.png
Binary file not shown.
Binary file removed Media/image13.png
Binary file not shown.
Binary file removed Media/image14.png
Binary file not shown.
Binary file removed Media/image7.png
Binary file not shown.
Binary file removed Media/image8.png
Binary file not shown.
Binary file removed Media/image9.png
Binary file not shown.
File renamed without changes
Binary file added Media/project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
211 changes: 29 additions & 182 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,206 +1,53 @@
# Newspaper Delivery Game Demo Project
<u>Supported o3de versions</u> : **23.10**

**Project Description:**
The player takes the role of a newspaper delivery kid who, within a vast fictional 3D world, delivers newspapers to customer’s homes within a set time limit. If all deliveries are made before the timer expires, the player will be allowed to progress on to the next level. Gameplay becomes exceedingly more difficult, by the numerous obstacles in the players path. Obstacles such as electric lawnmowers, cars and trucks.
# Newspaper Delivery Game

![gameplay](Media/gameplay.gif?raw=true)

The player takes the role of a newspaper delivery kid who, within a vast fictional 3D world, delivers newspapers to customer's homes within a set time limit. If all deliveries are made before the timer expires, the player will be allowed to progress on to the next level. Gameplay becomes exceedingly more difficult, by the numerous obstacles in the players path. Obstacles such as electric lawnmowers, cars and trucks.

https://user-images.githubusercontent.com/87207603/207639297-110dcaf4-dd8c-4a97-8d3c-92a34e6040c8.mp4



## Project Screenshots

<img src="./Media/image7.png">

## The Project Includes

- **Sprawling suburban environment**, includes homes, lawnmowers, vans and other 3D environment asset models
- **Newspaper delivery kid**, a ready to use character model, with multiple character animations such as, walk run, strafe and toss.
- **Script Canvas Visual Scripts,** editable Script Canvas visual scripts for main and in game menu interaction, gameplay and player movement.

## Game Levels

- **Character Sample**, a test level utilized for testing and analyzing main character animations.
- **Neighborhood,** the main gameplay level for the Paper Delivery Game.

## Requirements

### Platforms

The project supports the following platforms:
## Prerequisites

- **Windows 10 version 1809 (10.0.17763)** or later is required.
You need to build or [install O3DE engine](https://o3de.org/download/).

## O3DE Installation
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.

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.
## How to run

# Building the project
1. Clone the github repository (`git clone https://github.com/o3de/NewspaperDeliveryGame.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 the cloned repository. Open the folder. The project should now be registered.

## Build Steps
![project](Media/project.png?raw=true)

1. Clone the Newspaper Delivery game project from the following repo:
1. git clone <https://github.com/o3de/NewspaperDeliveryGame>
2. 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. Click on the **Build Project** button, located on the **Newspaper_Delivery_Game** 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. Pick the **Neighborhood**.

<img src="./Media/image8.png">
## Controls

3. Once Windows Explorer opens, navigate to and select the **NewspaperDeliveryGame** folder. Once selected click on the **Select Folder** button.
The Newspaper Kid can be moved around the level using the W,A,S,D keyboard keys.

<img src="./Media/image9.png">
![keyboard](Media/keyboard.png?raw=true)

4. This will load the **NewspaperDeliveryGame** project into the **Project Manager**.
5. In order to build the project, locate and click on the **Build Project** button, located on the **NewspaperDeliveryGame** icon.
Press the left **Mouse Button** toss the newspaper around the level.

<img src="./Media/image10.png">
![character](Media/character.png?raw=true)

## Launching the Project
## Project Highlights

1. Once the project has been built sucessfully, 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 **NewspaperDeliveryGame** project.

<img src="./Media/image11.png">

## Opening the Gameplay Level

1. Once the Asset Processor has completed importing and processing a signifgance 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.

<img src="./Media/image12.png">

3. This will open the **Open a Level** window
4. Select the Neighborhood level and click the open level to launch the level.

<img src="./Media/image13.png">

5. Once the level opens click the play button in the upper hand corner to launch the main menu of the game.

<img src="./Media/image14.png">

6. Once presented with the main menu press the **enter key** on your keyboard to start the game.
7. <img src="./Media/image15.png">

**Controlling the Newspaper Kid Model**

**Navigation**

1. **The Newspaper Kid model can be moved around the level using the W,A,S,D keyboard keys.**
https://user-images.githubusercontent.com/87207603/207639297-110dcaf4-dd8c-4a97-8d3c-92a34e6040c8.mp4

**<img src="./Media/image16.png">**
- **Sprawling suburban environment**, includes homes, lawnmowers, vans and other 3D environment asset models
- **Newspaper delivery kid**, a ready to use character model, with multiple character animations such as, walk run, strafe and toss.
- **Script Canvas Visual Scripts,** editable Script Canvas visual scripts for main and in game menu interaction, gameplay and player movement.

**Tossing The Newspaper**
### Screenshots

1. Press the left **Mouse Button** toss the newspaper around the level.
![gameplay](Media/gameplay.png?raw=true)

**<img src="./Media/image17.png">**
![gameplay](Media/gameplay-2.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.
3 changes: 2 additions & 1 deletion project.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@
"engine": "o3de",
"external_subdirectories": [
"Gem"
]
],
"engine_version": "2.2.2"
}
21 changes: 21 additions & 0 deletions project.json.bak1
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"project_name": "Paper_Kid",
"product_name": "Paper_Kid",
"project_id": "{4A7C157B-A820-441E-A9BA-5D51113BD9E5}",
"origin": "https://github.com/o3de/o3de-NewspaperDeliveryGame",
"origin_uri": "https://github.com/o3de/NewspaperDeliveryGame.git",
"license": "For terms please see the LICENSE*.TXT file at the root of this distribution.",
"display_name": "Newspaper_Delivery_Game",
"summary": "A short description of Newspaper_Delivery_Game.",
"canonical_tags": [
"Project"
],
"user_tags": [
"Paper_Kid"
],
"icon_path": "preview.png",
"engine": "o3de",
"external_subdirectories": [
"Gem"
]
}