Skip to content

Latest commit

 

History

History
264 lines (201 loc) · 8.55 KB

README.md

File metadata and controls

264 lines (201 loc) · 8.55 KB
Raw

GitHub contributors GitHub issues GitHub license GitHub forks GitHub stars GitHub Language

Froggie Frenzy🐸

📝 Table of Contents

📙 About

3D Frog Frenzy is an exciting game that puts the player in control of a frog within a vibrant 3D environment. The objective of the game is to navigate through a series of challenging levels, collecting coins while avoiding various obstacles and hazards.

🌠 Features

  1. 3D Environment: The game takes place in a visually appealing 3D environment, providing an immersive and engaging experience for players.

  2. Maze-Like Levels: The game offers a series of maze-like levels filled with obstacles, hazards, and coins to collect, presenting a challenge that requires strategic navigation and problem-solving skills.

  3. Collision System: The game incorporates a collision system that allows the frog character to interact with the environment, avoiding obstacles and detecting collisions with other objects.

  4. Movement Controls: Players can control the movement of the frog using arrow keys, enabling precise and responsive maneuvering through the levels.

  5. Level Ups: As players progress, they encounter increasingly challenging levels that test their skills and require quick reflexes and careful planning to overcome obstacles and reach the next level.

  6. Menu System: The game features an intuitive menu system that allows players to start the game, access game options, and navigate through different game states.

  7. End Game State: The game provides a satisfying end game state that reflects the player's performance, displaying their score and achievements.

  8. Coins and Power-ups: Throughout the levels, players can collect coins to increase their score and unlock power-ups, adding an element of strategy and enhancing gameplay.

  9. Lives and Hearts: Players start with a set number of lives, which can be replenished by collecting hearts scattered throughout the levels, allowing for extended gameplay and additional chances to overcome challenges.

  10. Timer: A timer adds a time pressure element to the gameplay, requiring players to complete levels within a specified time limit, adding excitement and a sense of urgency.

📂 Folder Structure 

├───assets
│   ├───audios
│   ├───fonts
│   ├───images
│   │   ├───ground
│   │   ├───metal
│   │   └───suzanne
│   ├───models
│   ├───shaders
│   │   └───postprocess
│   └───textures
│       └───rockTextures
├───config
│   ├───entity-test
│   ├───material-test
│   ├───mesh-test
│   ├───pipeline-test
│   ├───postprocess-test
│   ├───renderer-test
│   ├───sampler-test
│   ├───shader-test
│   ├───sky-test
│   ├───texture-test
│   └───transform-test
├───scripts
├───source
│   ├───common
│   │   ├───components
│   │   ├───ecs
│   │   ├───input
│   │   ├───material
│   │   ├───mesh
│   │   ├───shader
│   │   ├───systems
│   │   └───texture
│   └───states
└───vendor
    ├───glad
    │   ├───include
    │   │   ├───glad
    │   │   └───KHR
    │   └───src
    ├───glfw
    │   ├───CMake
    │   │   └───modules
    │   ├───deps
    │   │   ├───glad
    │   │   ├───mingw
    │   │   └───vs2008
    │   ├───include
    │   │   └───GLFW
    │   └───src
    ├───glm
    │   └───glm
    │       ├───detail
    │       ├───ext
    │       ├───gtc
    │       ├───gtx
    │       └───simd
    ├───imgui
    │   └───imgui_impl
    ├───irrklang
    │   ├───dlls
    │   │   └───winx64-visualStudio
    │   ├───include
    │   └───lib
    │       └───Winx64-visualStudio
    └───utils
        ├───flags
        ├───json
        ├───stb
        ├───tinygltf
        └───tinyobj

🏁 Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.

Prerequisite

  1. C++ Compiler
    1. Clang
    2. GCC (GNU Compiler Collection)
  2. CMake
  3. Integrated Development Environments (IDEs)
    1. Visual Studio Code (VS Code)
    2. CLion
    3. Visual Studio (VS)

Installation

  1. Clone the repository
$ git clone https://github.com/ZeyadTarekk/Frog-Frenzy.git
  1. Navigate to Frog-Frenzy
$ cd Frog-Frenzy

Running

Running program

  1. Build projects

  2. Start program

.\bin\GAME_APPLICATION.exe

💻 Built Using

  • C++
  • GlFW
  • Glad
  • imgui
  • IrrKlang

📸 Demo Screens

Menu

Level 1

Level 2

Level 3

Level 4

Level 5

Winning

🎥 Demo Videos

FrogFrenzy_Team13.mp4

🕴 Contributors

Ziad Sherif
Ziad Sherif 		Zeyad Tarek
Zeyad Tarek 		Waleed Hesham
Waleed Hesham 		Abdelhamid Emad
Abdelhamid Emad

📃 License

This software is licensed under MIT License, See License for more information ©Frog-Frenzy.