Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.1 KB

README.md

File metadata and controls

76 lines (50 loc) · 3.1 KB
Raw

WinterFind - Find Your Way in Winter

WinterFind is a 3D interactive web-based game where the user has to search for a gift hidden in a winter wonderland. This game was originally developed as a hackathon project and won #1 Overall and Best Dressed Hack in HackComing 2.0.

Demo

image

Play Online

Click here to play the game!

Key Highlights

  • Hackathon Winner: WinterFind won #1 Overall and Best Dressed Hack in HackComing 2.0.
  • Challenging Obstacles: We've added various obstacles such as houses, trees, and snowmen to make it harder for players to find the hidden gift.
  • Fog: To increase the complexity of the game, we managed to reduce the intensity of the objects after a certain distance.
  • Smooth Gaming Experience: Our goal with this project was to make the experience of web gaming smooth and enjoyable.

Technologies Used

WinterFind was developed using the following technologies:

  • Bootstrap, Blender, TypeScript, Next.js, Three.js, React Three, Vercel

Installation

To run this project locally, follow these steps:

  1. Install Node.js on your system from here.
  2. Clone this GitHub repository: git clone https://github.com/kpatel0170/Winter-Find
  3. Open the terminal and navigate to the "Winter-Find" folder.
  4. Run the command npm install to install dependencies.
  5. Run the command npm run dev to run the web app.
  6. Open Google Chrome browser and visit http://localhost:3000

Contributing

To contribute to WinterFind, follow these steps:

  1. Fork this repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch: git checkout -b my-new-feature.
  4. Make your changes and commit them: git commit -am 'Add some feature'.
  5. Push your changes to the branch: git push origin my-new-feature.
  6. Submit a pull request.

Pull Requests

We welcome pull requests from everyone. Please ensure your pull request adheres to the following guidelines:

  1. Explain the problem your pull request solves.
  2. Make sure your changes are well-tested and documented.
  3. Ensure your code follows the coding conventions and standards used in the project.
  4. Ensure your code is properly formatted using Prettier.
  5. Make sure your commits are descriptive and have a clear message.

Read more on creating a pull request from a fork here.

Issues

If you find any issues with WinterFind, please submit them through the GitHub Issues page. When submitting an issue, please provide the following information:

  1. A clear and descriptive title.
  2. Steps to reproduce the issue.
  3. Expected behavior.
  4. Actual behavior.
  5. Screenshots or code snippets (if applicable).

License

This project is licensed under the MIT License.

Contributors