n-dilo/heritage_hunt

Heritage Quest - AR Treasure Hunt Game

Welcome to the AR Treasure Hunt game! This application uses Augmented Reality (AR) to create an exciting treasure hunt experience.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Configuration
• Contributing
• License
• Contact

Introduction

AR Treasure Hunt is a mobile application that uses ARCore to provide a treasure hunting experience. Players move around in the real world to find and interact with virtual treasures displayed through their device’s camera.

Features

• Augmented Reality: Real-time 3D models of treasures that appear in the camera view.
• Location-Based Gameplay: Treasures appear based on the player's location.
• Treasure Interaction: Tap on treasures to collect them and receive rewards.
• Leaderboard: Track your score and compare with other players.

Installation

Prerequisites

• Flutter SDK
• ARCore-supported Android device or an ARKit-supported iOS device
• Android Studio or Xcode

Setup

1. Clone the Repository:

   git clone https://github.com/Joshokelola/heritage_hunt.git

2. Navigate to the Project Directory:

   cd ar_treasure_hunt

3. Install Dependencies:

   flutter pub get

4. Configure ARCore/ARKit:

   Follow the ARCore setup instructions for Android or ARKit setup instructions for iOS.

5. Run the App:

   flutter run

Usage

1. Launch the Application: Open the app on your AR-compatible device.

2. Move Around: Walk around in an open space to discover and interact with virtual treasures.

3. Interact with Treasures: Tap on the 3D models to collect treasures. Your score and collected items will be updated.

4. Check the Leaderboard: View your ranking and compare your score with other players in the leaderboard section.

Configuration

AR Models

• Place your AR models in the assets directory.
• Update the model URLs in the Treasure class to point to your 3D model files.

Firebase Integration

• Set up Firebase for user authentication and Firestore for the leaderboard.
• Update your Firebase configuration files in the android and ios directories.

Contributing

We welcome contributions! If you have any improvements or suggestions, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and test thoroughly.
4. Submit a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or issues, please contact:

• GitHub: yourusername