games

Home to the official code for the Flutter Casual Games Toolkit and other Flutter gaming templates.

Visit flutter.dev/games for more information.

If you're new to Flutter, you first need to install the Flutter SDK.

<a href="https://idx.google.com/new?template=https%3A%2F%2Fgithub.com%2Fflutter%2Fgames"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://cdn.idx.dev/btn/try_light_32.svg"> <source media="(prefers-color-scheme: light)" srcset="https://cdn.idx.dev/btn/try_dark_32.svg"> <img height="32" alt="Try in IDX" src="https://cdn.idx.dev/btn/try_purple_32.svg"> </picture> </a>

Organization

The projects in this repository are divided into two broad categories:

1. Templates. A small number of starting points for your game project. Templates are intended to give you a simple project structure on top of which you can build your game. They differ to accommodate different game types, from the simplest casual games through drag&drop board games to 2D platformers.

2. Samples. Intended to show functionality beyond the basics, such as multiplayer or ads integration.

.
├── templates
│   ├── basic
│   ├── card
│   └── endless_runner
└── samples
    ├── ads
    ├── multiplayer
    └── ...

How to use

The easiest way to get any of the samples and templates from this repository is to install the sample_downloader tool and use it.

On the command line, while having the Flutter SDK installed, run the following command:

dart pub global activate sample_downloader

Then, from any directory, run the newly installed tool and follow its instructions.

sample_downloader

The manual way

If, for any reason, you prefer not to use the sample_downloader tool, follow these steps.

1. Clone this repository.

   To minimize download size, you can use a partial clone:

   git clone --filter=blob:none https://github.com/flutter/games.git
   

   (Alternatively, you can download the ZIP file and uncompress it on your workstation.)

2. cd into the project you are interested in. For example:

   cd templates/card
   

   (Alternatively, you can copy the contents of a project to somewhere else, and change to that directory.)

3. (Optional) Rename the project with the rename tool.

4. Open the project in your favorite editor and enjoy.

Interested in contributing?

See the contributor's guide!

Questions or issues?

If you have a general question about one of these samples or how to adapt its techniques for one of your own apps, try one of these resources:

• The FlutterDev Discord
• The Flame Discord
• StackOverflow

If you run into a bug in one of the samples, please file an issue in the flutter/flutter issue tracker.