Skip to content

README.md

Latest commit

 

History

History
110 lines (76 loc) · 3.5 KB

README.md

File metadata and controls

110 lines (76 loc) · 3.5 KB

🫧 Bubleman

A 2D Unity game where you control a bubble character navigating through various challenges and obstacles.

🎮 Game Description

Bubleman is a 2D platformer game created during a Global Game Jam event. Players control a bubble character that must navigate through levels while avoiding obstacles like thorn bushes, cacti, and other hazards. The game features unique bubble mechanics and particle effects.

✨ Features

  • Bubble Physics: Realistic bubble movement and behavior
  • Particle Effects: Beautiful bubble particle systems
  • Multiple Obstacles: Various environmental hazards to overcome
  • Smooth Camera: Dynamic camera following system
  • Input System: Modern Unity Input System integration
  • Universal Render Pipeline: High-quality graphics rendering

🚀 Getting Started

Prerequisites

  • Unity 2022.3 LTS or later
  • Universal Render Pipeline (URP) package
  • TextMesh Pro package

Installation

  1. Clone this repository:

    git clone https://github.com/yourusername/bubleman.git
cd bubleman

  2. Open the project in Unity Hub or Unity Editor

  3. Wait for Unity to import all assets and compile scripts

  4. Open the main scene from Assets/Scenes/

  5. Press Play to start the game!

🎯 How to Play

  • Use the input controls to move your bubble character
  • Navigate through the level while avoiding obstacles
  • Collect items and reach the goal
  • Try to achieve the best time or score

🏗️ Project Structure

Assets/
├── Scripts/           # C# game scripts
│   ├── Player/        # Player-related scripts
│   ├── UI/           # User interface scripts
│   ├── Soap/         # Soap mechanics
│   ├── Mikrob/       # Microbe-related scripts
│   ├── Kaktos/       # Cactus obstacle scripts
│   └── ThornBush/    # Thorn bush obstacle scripts
├── Scenes/           # Game scenes
├── Images/           # Game artwork and sprites
├── Tiles/            # Tilemap assets
├── TextMesh Pro/     # Text rendering assets
└── Settings/         # Project configuration

🛠️ Development

Scripts Overview

  • GameOverManager.cs: Handles game over state and restart functionality
  • CameraFollow.cs: Smooth camera following system for the player
  • Player Scripts: Core player movement and bubble physics
  • Obstacle Scripts: Various environmental hazards and their behaviors

Building the Game

  1. In Unity, go to File > Build Settings
  2. Choose your target platform (PC, Mac, Linux, WebGL, etc.)
  3. Click Build and select your output directory

🤝 Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create a 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

Development Guidelines

  • Follow Unity coding conventions
  • Add comments to complex logic
  • Test your changes before submitting
  • Update documentation if needed

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Created during Global Game Jam
  • Built with Unity Engine
  • Special thanks to all contributors and testers

Note: This is a game jam project and may contain experimental features or incomplete implementations. Feel free to contribute improvements!