flame/doc

Getting Started!

About Flame

Flame is a minimalist Flutter game engine built on top of Flutter.

Goals

The goal of this project is to provided a complete set of out-of-the-way solutions for the common problems every game developed in Flutter will share. Currently it provides you with: a few utilities, images/sprites/sprite sheets, audio, a game loop and a component/object system.

You can use whatever ones you want, as they are all somewhat independent.

Learning resources

The community has created some articles and examples of a good usage of Flame.

Check out this great series of articles/tutorials written by Alekhin:

• Create a Mobile Game with Flutter and Flame – Beginner Tutorial (Part 0 of 5)
• 2D Casual Mobile Game Tutorial – Step by Step with Flame and Flutter (Part 1 of 5)
• Game Graphics and Animation Tutorial – Step by Step with Flame and Flutter (Part 2 of 5)
• Views and Dialog Boxes Tutorial – Step by Step with Flame and Flutter (Part 3 of 5)
• Scoring, Storage, and Sound Tutorial – Step by Step with Flame and Flutter (Part 4 of 5)
• Game Finishing and Packaging Tutorial – Step by Step with Flame and Flutter (Part 5 of 5)

Installation

Put the pub package as your dependency by dropping the following in your pubspec.yaml:

dependencies:
  flame: ^0.18.1

And start using it!

Topics

• Core Concepts
  • Structure
  • Game Loop
  • Components
  • Input
• Audio
  • General Audio
  • Looping Background Music
• Rendering
  • Images, Sprites and Animations
  • Text Rendering
  • Colors and the Palette
  • Particles
• Other Modules
  • Util
  • Gamepad
  • Widgets
  • Box2D
  • Tiled
  • Debugging
  • Splash screen