flutter_flame

A new Flutter project.

Overview

This repository contains a collection of Flutter projects and examples that demonstrate the use of the Flame game engine. The codebase is organized into various case studies and examples to help developers learn and experiment with game development in Flutter.

Codebase Structure

lib/

This directory contains the main Dart code for the project. It is organized into several subdirectories:

• main.dart: The entry point of the Flutter application.

Case Studies

• case_study_1_essentials/: Basic components and exercises to get started with Flame.

  • component_001.dart: Demonstrates a basic Flame component.
  • component_excercise_1.dart: An exercise to practice creating components.
  • lifebar.dart: Example of a life bar component.

• case_study_2_joystick/: Examples of implementing joystick controls.

  • bullet.dart: Demonstrates bullet mechanics.
  • joystick_example.dart: A complete joystick example.
  • joystick_player.dart: Player movement using a joystick.

• case_study_3_sounds/: Demonstrates how to integrate and play sounds in a Flame game.

  • sounds.dart: Example of sound effects.

• case_study_4_collidables/: Examples of collision detection.

  • circles.dart: Demonstrates circular collision detection.
  • my_collidable.dart: Custom collidable example.

• case_study_5_timers/: Examples of using timers in games.

  • case_5_exercise.dart: Timer-based exercise.
  • collidable_with_lifebar.dart: Combines collision and life bar mechanics.
  • timer_example_001.dart, timer_example_002.dart: Timer examples.

• case_study_6_essentials/: Parallax and other essential game mechanics.

  • parallax_flame_game.dart: Demonstrates parallax scrolling.
  • parallax_flame_game_1.dart: Another parallax example.

• case_study_7_particles/: Particle effects examples.

  • boom_explosion_example.dart: Explosion particle effect.
  • custom_particle.dart: Custom particle example.
  • explosion_particle_example.dart: Another explosion effect.
  • firework_particle_example.dart: Firework particle effect.

First Game

• first_game/: Contains the code for a simple first game built with Flame.

assets/

This directory contains the assets used in the project, such as images and audio files.

• audio/: Sound effects and background music.
• images/: Images used in the game.
  • parallax/: Images for parallax scrolling.

Platform-Specific Directories

• android/, ios/, linux/, macos/, web/, windows/: Platform-specific files and configurations for building the Flutter app on different platforms.

Getting Started

To run the project, ensure you have Flutter installed and set up on your machine. Then, run the following command:

flutter run

Contributing

Feel free to fork this repository and submit pull requests. Contributions are welcome!

License

This project is licensed under the MIT License.