IWOC 2024 - Contributor Guidelines

[TusharAMD]

IWOC 2024

Greetings Contributors, hope you guys are excited about this year's IWOC. Runn (Gesture Gaming) would be taking part in IWOC 2024.
This readme would contain everything you need to know about contributing to this repo and do's and don'ts.

About Project

So, we all love playing games on computer, don't we? But what about introducing a twist? What if instead of using traditional keyboard, mouse; can we use our hand/body gestures to play games? This is the core concept about the project.

How it works

Thanks to ever evolving Computer Vision and AI we could now easily detect hand and body gestures using simple web camera in realtime. So by using this we made a game called Runn (https://youtu.be/o6Cnc5S1zg4) that uses Pygame library and Mediapipe that can be played using hand gestures. To find more details visit the video link about.

How to contribute in IWOC 2024

Summary

Contributors are free to use any language and platform of their choice. The main goal of the repo would be creating some unique games that can be played using gestures.
Now you might wonder do I have to make a complete game? The answer is no. Contributors can create parts of the game and every issue will have difficulty assigned to it. Non coders are also welcomed to contribute to documentation of game.

What exactly to contribute

Every game can mainly be divided into 3 parts.

1. Ideation/Documentation - In this phase game design would be developed. It would include detailed game description and how it would be created. After completion of game it should also include working and screenshots/videos.
2. Actual Game creation - This would be the core game where game logic will be written. This won't include gestures. Here you can use Python's pygame library, Unity, or even web game using JavaScript.
3. Gestures - Here we would be adding functionality that would enable user to feed their hand/body gestures in real time through web cam and users should be able to play game.
   Now these parts can be subdivided. For eg. in actual/core game we would be making sprites (game characters images). These tasks will be added as separate issues and contributors can make changes to it.

How to get started and file hierarchy

• First step fork this repo and clone it to local machine.
• Second, you need to create a branch and then make changes there. You can have a look at this video https://youtu.be/Lf3DYRvCPFo
• Now you will go to "games" directory and create a new folder which would contain name of your game.
  
• Here you are free to add your game contents, assets, application file etc.

If you guys got any questions ping me on discord channel. Happy hacking.