📚 Added Documentation

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+adeeteya@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing
+
+Thank you for considering and taking the time to contribute to this project ❤️
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Code of Conduct
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+
+## Download & install
+
+First, clone the repository with the 'clone' command, or just download the zip.
+
+```
+$ git clone git@github.com:adeeteya/EasyPong.git
+```
+
+Then, download either Android Studio or Visual Studio Code, with their respective [Flutter editor plugins](https://flutter.io/get-started/editor/). For more information about Flutter installation procedure, check the [official install guide](https://flutter.io/get-started/install/).
+
+Install dependencies from pubspec.yaml by running `flutter packages get` from the project root (see [using packages documentation](https://flutter.io/using-packages/#adding-a-package-dependency-to-an-app) for details and how to do this in the editor).
+
+There you go, you can now open & edit the project. Enjoy!
+
+## How to Report Bugs and Request Feature
+
+Please open [a new issue in the GitHub repository](https://github.com/adeeteya/EasyPong/issues) with steps to reproduce the problem you're experiencing.
+
+Be sure to include as much information including screenshots, text output, and both your expected and actual results.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Aditya
+
+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.

README.md

@@ -1,16 +1,80 @@
-# easy_pong
+# 🕹️ Easy Pong
 
-Over Engineered Pong Game Made Using Flutter and Flame.
+Welcome to Easy Pong, a classic Pong game built using Flutter and the Flame game engine! Easy Pong provides a smooth and engaging experience with modern UI and simple controls.
 
-## Getting Started
+The Game Runs On All Platform (Android, Windows, Linux, Web, macOS and iOS)
 
-This project is a starting point for a Flutter application.
+If you like what you see, please ⭐ the repo.
 
-A few resources to get you started if this is your first Flutter project:
+## 📸 Screenshots
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+![Easy Pong Classic Theme](screenshots/classic_theme.png)
+![Easy Pong Football Theme](screenshots/football_theme.png)
+![Easy Pong Matrix Theme](screenshots/matrix_theme.png)
+![Easy Pong Modern Theme](screenshots/modern_theme.png)
+![Easy Pong Instructions Screen](screenshots/instructions_screen.png)
+![Easy Pong Winner Screen](screenshots/winner_screen.png)
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+## ✨ Features
+
+- 🧑‍🤝‍🧑 Ability to play Local Multiplayer (1v1)
+- 🕹️ Supported By The Keyboard as well as the Joystick
+- 🎨 Ability To Select From Multiple Different Themes (eq:- classic,football,matrix)
+- 🔉 Built In Sound Effects
+
+### 🔜 Upcoming Features
+- 🎮 Play Against The Computer
+- 🌍 Play Realtime Online Multiplayer Against a Friend
+
+## 💻 Installation links
+
+<table>
+  <tr>
+    <th>Platform</th>
+    <th>Installation Links</th>
+  </tr>
+  <tr>
+    <td>Android</td>
+    <td>
+    <a href="https://play.google.com/store/apps/details?id=com.adeeteya.easy_pong">
+        <img width="220" alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png">
+      </a>
+      <br>
+      <a href="https://github.com/adeeteya/EasyPong/releases/latest/easy_pong_android.apk">
+        <img width="220" alt="APK download" src="https://user-images.githubusercontent.com/114044633/223920025-83687de0-e463-4c5d-8122-e06e4bb7d40c.png">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Windows</td>
+    <td>
+      <a href="https://github.com/adeeteya/EasyPong/releases/latest/easy_pong_windows.exe">
+        <img width="220" alt="Windows Download" src="https://get.todoist.help/hc/article_attachments/4403191721234/WindowsButton.svg">
+      </a>
+  </tr>
+  <tr>
+
+</table>
+
+
+## 🔌 Plugins
+
+| Name                                                                  | Usage                                |
+|-----------------------------------------------------------------------|--------------------------------------|
+| [**flame**](https://pub.dev/packages/flame)                           | Game Engine Used to Develop the Game |
+| [**flame_audio**](https://pub.dev/packages/flame_audio)               | To play game sound effects           |
+| [**flutter_animate**](https://pub.dev/packages/flutter_animate)       | For Quick and Easy Animations        |
+| [**flutter_riverpod**](https://pub.dev/packages/flutter_riverpod)     | For State Management                 |
+| [**shared_preferences**](https://pub.dev/packages/shared_preferences) | To store system settings             |
+| [**flutter_lints**](https://pub.dev/packages/flutter_lints)           | For linting                          |
+
+## 🤓 Author
+
+**[Aditya R](https://github.com/adeeteya)**
+
+## 🔖 LICENCE
+Copyright (c) 2024 Aditya R
+[MIT LICENCE](https://github.com/adeeteya/EasyPong/blob/master/LICENSE)
+
+## 🙏 Attributions
+<a href="https://www.flaticon.com/free-icons/pong" title="pong icons">Pong icons created by Freepik - Flaticon</a>

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+|---------|--------------------|
+| 1.0.0   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Either mail to me at adeeteya@gmail.com or open a [Issue](www.github.com/EasyPong/issues)

android/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "fastlane"