Skip to content

Latest commit

 

History

History
141 lines (95 loc) · 4.52 KB

README.md

File metadata and controls

141 lines (95 loc) · 4.52 KB

WintAR

Spice up your video conferencing this Winter ❄️🎅❄️
View Demo · Report Bug · Request Feature

Table of Contents

About The Project

WintAR

WintAR is a TF.js based gesture recognition interface to spice up Video Conferencing calls during your Winter Holidays ☃️❄️. WintAR is easy to run & requires no custom application/software installation. Just click on View Demo & directly use it on the browser!

WintAR runs on both on PC & mobile directly on the browser (on Canvas), although PC is always recommended for much better experience! ✨

  • Story
We all know how boring it is to stay at home during this pandemic lockdown. It's Winter, and most of us are accustomed to going out and chilling with our friends which unfortunately isn't possible this winter. Although we are connected virtually, with that, the enthusiasm level of enjoying Christmas with our near ones has touched the surface, which simultaneously led to the depression of minds, especially the young ones. Besides, not only the young ones are badly affected, but also those who are physically or mentally inaccessible because of certain disabilities. Our project **WintAR** bridges the gap and makes video conferencing more intuitive and fun for not only kids and toddlers but also for everyone!

Built With

  • Javascript

  • TF.js

  • ml5.js

  • p5.js

  • HTML

  • CSS

  • Deployed on Vercel. Thanks to MLH for providing free learning resources!

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

🚀 Local Development

  1. Clone the repository:
git clone https://github.com/Neilblaze/wintAR.git
cd wintAR
  1. Start live server or download the extension!

Now you're ready to do something awesome!

Platform support

Demos are supported on all Chromium Browsers including iOS Safari.

It should also run on Chrome on Android and potentially more Android mobile browsers though support has not been tested yet.

Roadmap

  • Improve the UI.
  • Add more features regarding conferencing software integration.
  • Background blur / remove feature.
  • Add extra filter and particle effects.

And many more! 🌟

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

This project is maintained by ➡️ Pratyay Banerjee ⚡, Sandipan Dey 🍕, Saif Ali 😎


Acknowledgements

  • Tensorflow docs.
  • P5.js (processing) docs
  • Posenet & Facemesh docs & others :)