Green Paw Chefs: A Food Waste Awareness Game

This game is designed to educate and raise awareness about the importance of reducing food waste. Built with Flutter, it challenges players to manage a virtual restaurant, where they must carefully select ingredients, prepare dishes that cater to the diverse preferences of guests, and minimize waste. The game progresses through increasingly challenging levels, introducing various dietary restrictions, calorie-conscious meal planning, and an ingredient inventory management system.

Features

• Dietary Restriction Matching: Create dishes that meet specific dietary needs of guests.
• Calorie-Conscious Meal Planning: Balance guest satisfaction with calorie limits.
• Ingredient Inventory System: Manage your pantry to reduce waste and use ingredients before they expire.
• Progressive Difficulty: Levels increase in complexity, introducing guests with more complex dietary restrictions and preferences.
• Educational Content: Learn tips and facts about food sustainability, seasonal ingredients, and waste reduction.
• Unlockable Content: Achieve certain milestones to unlock new recipes, kitchen upgrades, and chef avatars.

Game Application Testing installation - for game testers

App distribution ver 1.0.0 by firebase for Android devices

• if you cannot access this link or it has expired, please contact greenpawchefs@gmail.com for access.

Repository Installation instructions

To install and run the Food Waste Awareness Game, follow these steps:

1. Ensure you have Flutter installed on your machine. If not, follow the installation guide on the Flutter official website.
   • For Windows:
   • Download the Flutter SDK from the official Flutter website.
   • Extract the downloaded ZIP file to a location on your computer (e.g., C:\flutter).
   • Add the Flutter bin directory to your system PATH:
   • Search for "Environment Variables" in the Windows search bar and open it.
   • Select "Path" from the "System Variables" section and click "Edit".
   • Click "New" and add the path to the Flutter bin directory (e.g., C:\flutter\bin).
   • Click "OK" to save the changes.
   • For macOS:
   • Follow the instructions on the official Flutter website.
   • Ensure that you have Xcode installed from the App Store.
2. Install Android Studio / Xcode:
   • For Windows:
   • Download and install Android Studio from the official website.
   • Follow the setup instructions to install the Android SDK and configure it with Flutter.
   • For macOS:
   • Install Xcode from the App Store.
3. Clone the repository to your local machine:
   • For Windows:
   • Download and install Git from the official Git website.
   • For macOS:
   • Git usually comes pre-installed with macOS. If not, you can install it using Homebrew or download it from the official Git website.

• Open Command Prompt (Windows) or Terminal (macOS).
• Navigate to the directory where you want to clone the project using the cd command.

Run the following command to clone the project:

git clone https://github.com/yourrepository/food_waste_game.git

3. Navigate to the project directory:

   cd food_waste_game

4. Get all dependencies

   flutter pub get

5. Run the app on your preferred device (emulator or physical device):
   • For Windows:
   • Ensure that an Android emulator or a physical Android device is connected and recognized by Flutter. You can also use a web browser as your target device e.g. Chrome.
   • Run the following command to start the app:

     flutter run

   • For macOS:
   • Ensure that either an iOS simulator or a physical iOS device is connected and recognized by Flutter.
   • Run the following command to start the app:

flutter run

Contribution guidelines

We welcome contributions to help improve the game! If you're interested in contributing, please follow these guidelines:

• Bug Reports: Open an issue to report a bug. Please include detailed information about the bug and steps to reproduce it.
• Feature Requests: Feel free to suggest new features or improvements by opening an issue.
• Pull Requests: If you're implementing a bug fix or adding a feature, create a pull request against the develop branch. Ensure your code follows the project's coding standards and include a detailed description of your changes.

Known issues/Roadmap

• Performance Optimization: Further optimizations are needed for smoother gameplay on all devices.
• Multi-Language Support: Plans to introduce multiple language options for wider accessibility.
• Cloud Save Feature: Implement cloud save to retain player progress across devices.

"How to Play"

1. Start a New Game: Begin by managing your virtual restaurant. Pay attention to your pantry and the preferences of incoming guests.
2. Select Ingredients: Choose ingredients from your inventory to prepare dishes. Be mindful of dietary restrictions and calorie limits.
3. Serve Guests: Match the prepared dishes with guest preferences to earn points. Incorrect matches or excessive waste will penalize you.
4. Progress Through Levels: Complete each level by achieving specific goals. Unlock new ingredients, recipes, and kitchen upgrades as you advance.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.