-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/naikmubashir/FeF-WhackAMole
- Loading branch information
Showing
2 changed files
with
132 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 naikmubashir | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,111 @@ | ||
| # FeF-WhackAMole | ||
|  | ||
|
|
||
| <p align="center"> | ||
| <a href="https://www.w3.org/"> | ||
| <img src="https://img.shields.io/badge/HTML-FFA500?style=for-the-badge" alt="HTML"> | ||
| <img src="https://img.shields.io/badge/CSS-00FFFF?style=for-the-badge" alt="CSS"> | ||
| <img src="https://img.shields.io/badge/JavaScript-FFFF00?style=for-the-badge" alt="JavaScript"> | ||
| </a> | ||
| <img src="https://img.shields.io/github/issues/naikmubashir/FeF-WhackAMole?style=for-the-badge" alt="Issues"> | ||
| <img src="https://img.shields.io/github/forks/naikmubashir/FeF-WhackAMole?style=for-the-badge" alt="Forks"> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| <h1 align="center">Whack - A - Mole 🔨</h1> | ||
|
|
||
| **Whack-a-Mole** is an exciting, interactive web-based game where the player’s goal is to quickly "whack" moles that randomly pop up from a grid of holes. | ||
| The game is built using `HTML`, `CSS`, and `JavaScript`, providing a simple yet enjoyable challenge for players. Every successful click on a mole earns points, testing both the player’s speed and accuracy. | ||
|
|
||
| HTML is used to structure the game’s interface, CSS adds styling and animations for dynamic mole appearances, while JavaScript drives the game logic, such as random mole pop-ups, the scoring system.. This fun project is a great way to practice front-end web development skills while creating an engaging user experience! 🎮🎯 | ||
|
|
||
| --- | ||
|
|
||
| ## Table of Contents | ||
| - [How to Play](#how-to-play) | ||
| - [Screenshot](#Screenshot) | ||
| - [How to Contribute](#how-to-contribute) | ||
| - [Contact](#contact) | ||
| - [License](#license) | ||
|
|
||
| --- | ||
|
|
||
| ### How to Play 🕹️ | ||
| 1. **[Go here](https://naikmubashir.github.io/FeF-WhackAMole/)** to access the website | ||
| 1. **Press the "Start" button** to begin the game. | ||
| 2. **Moles will randomly pop up** from the holes on the screen. | ||
| 3. **Click on as many moles as you can** to increase your score! | ||
| 4. Your score is displayed at the end, and you can restart the game to beat your own high score. | ||
|
|
||
| --- | ||
| ### Screenshot 🖼 | ||
|
|
||
|  | ||
|
|
||
| --- | ||
| ### How to Contribute 🤝 | ||
|
|
||
| We’re always open to contributions that can make this game more fun and functional! Here’s how you can get involved: | ||
|
|
||
| 1. **Fork the Repository**: | ||
| - Navigate to the GitHub repository and click "Fork" to create your own copy. | ||
| - Clone the forked repo to your local machine for development. | ||
|
|
||
| 2. **Create a Branch**: | ||
| - Use `git checkout -b your-branch-name` to create a new branch for your feature or bug fix. | ||
| - Keeping your work in a separate branch makes it easier to collaborate and review changes. | ||
|
|
||
| 3. **Make Your Changes**: | ||
| - You can add new features (such as sound effects, difficulty levels, or animations), improve the user interface, or fix bugs. | ||
| - Test your changes thoroughly before committing them. | ||
|
|
||
| 4. **Submit a Pull Request**: | ||
| - Once you’ve made your changes, submit a pull request (PR) to the main repository. Make sure to describe your changes clearly, including what they fix or add to the game. | ||
| - Here’s an example of the process: | ||
| ```bash | ||
| git add . | ||
| git commit -m "Added mole popping sound effect" | ||
| git push origin your-branch-name | ||
| ``` | ||
| - Visit the original repository and submit your PR for review. | ||
|
|
||
| 5. **Collaborate**: | ||
| - Keep an eye on any feedback from maintainers. There may be suggestions or questions about your changes, so be ready to discuss or make revisions. | ||
| - Feel free to join discussions by submitting or responding to issues. | ||
|
|
||
| --- | ||
|
|
||
| ### Types of Contributions 🎉 | ||
|
|
||
| - **Feature Enhancements**: Add extra game features like different game modes, sound effects, or a difficulty level selection. | ||
| - **UI/UX Improvements**: Make the game more visually appealing, responsive, or accessible for users of all devices and abilities. | ||
| - **Bug Fixes**: Identify and fix any issues that disrupt gameplay or affect performance. | ||
| - **Code Refactoring**: Clean up and optimize the JavaScript, HTML, or CSS to improve readability and performance. | ||
| - **Documentation**: Enhance the documentation by explaining how the game works in more detail, or provide tips for future contributors. | ||
|
|
||
| --- | ||
|
|
||
| ### Contributor Guidelines 📜 | ||
|
|
||
| We want to ensure the collaboration process is smooth and productive. Please follow these guidelines when contributing: | ||
|
|
||
| - **Code Consistency**: Follow consistent coding practices (indentation, comments, etc.). Keep the code clean and organized. | ||
| - **Test Thoroughly**: Before submitting a PR, make sure your feature or bug fix works correctly and doesn’t break other functionality. | ||
| - **Respectful Communication**: We encourage friendly, respectful discussions and value contributions from everyone. Let’s collaborate positively! | ||
| - **Licensing**: By contributing, you agree that your code will be licensed under the same open-source license as this project. | ||
|
|
||
| --- | ||
|
|
||
| ### Contact 📧 | ||
|
|
||
| If you have any questions, feedback, or just want to get in touch, feel free to reach out: | ||
|
|
||
| - **GitHub**: [naikmubashir](https://github.com/naikmubashir) | ||
| - **Email**: [email protected] | ||
|
|
||
| --- | ||
|
|
||
| ## license 💳 | ||
|
|
||
| This Project is under The MIT License. See the License file for more details | ||
|
|