Skip to content

OPCODE-Open-Spring-Fest/obstacle_dodge_game

Repository files navigation

🕹️ obstacle_dodge_game

Welcome to obstacle_dodge_game, an open-source Unity game designed for the OPCode tournament at our college. This project provides a foundational obstacle-dodge game where participants can unleash their creativity by adding scenes, levels, enemies, damage mechanics, and more. It's an excellent opportunity to learn, collaborate, and contribute to a growing game project.


🚀 Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

Cloning the Repository

Do not work directly on this repository. Please fork the repository and work on your forked copy.

To get a local copy of your forked repository:

git clone https://github.com/OPCODE-Open-Spring-Fest/obstacle_dodge_game.git
cd obastaceDodgeOPCode

Opening the Project in Unity

  1. Launch Unity Hub.
  2. Click on Add and navigate to your local obastaceDodgeOPCode folder.
  3. Select the folder to open the project.

Unity will automatically import the necessary packages and assets.


🕹️ How to Play

Once the project is open in Unity:

  1. Press the Play button in the Unity editor.
  2. Use the arrow keys or WASD to move the player character.
  3. Avoid incoming obstacles to survive as long as possible.

🛠️ How to Contribute

We welcome contributions of all kinds! Here's how you can get involved:

1. Fork the Repository

Click on the Fork button at the top-right of the repository page to create your own copy.

2. Create a New Branch

In your forked repository, create a new branch for your feature or fix:

git checkout -b feature/your-feature-name

3. Make Your Changes

Implement your feature or fix in Unity. Ensure your changes are well-documented and tested.

4. Commit Your Changes

git add .
git commit -m "Add: Description of your changes"

5. Push to Your Fork

git push origin feature/your-feature-name

6. Create a Pull Request

Go to your forked repository on GitHub and click on Compare & pull request. Provide a clear description of your changes and submit the pull request.


🧠 Project Structure

obastaceDodgeOPCode/
├── Assets/            # Game assets (sprites, sounds, etc.)
├── Packages/          # Unity packages
├── ProjectSettings/   # Unity project settings
├── .gitignore         # Git ignore file
└── README.md          # Project documentation

🎮 What You Can Contribute

  • Scenes: Design and implement new game scenes.
  • Levels: Create challenging levels with varying difficulty.
  • Enemies: Add new enemy types with unique behaviors.
  • Damage Mechanics: Implement health and damage systems.
  • UI Enhancements: Improve user interfaces and menus.
  • Audio: Add background music and sound effects.
  • Bug Fixes: Identify and resolve issues within the game.

Feel free to explore other areas and bring your ideas to life!


📚 Resources

About

A simple Unity obstacle-dodge game for participants to enhance with scene management, levels, and creativity!

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •