Flutter Casual Games Toolkit

The flutter/games repository is organized into two main categories to help you find the right starting point for your project:

1. Templates: Simple starting points providing a project structure for different game types (e.g., basic, card, or endless_runner). These are designed to be built upon.
2. Samples: More advanced projects intended to demonstrate specific functionalities like ads integration or multiplayer capabilities.

Directory Structure

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

The project uses a feature-first organization. Core gameplay logic should be implemented in lib/play_session/.

Key directories include:

• lib/audio/: Audio management logic.
• lib/main_menu/: Main menu screens.
• lib/settings/: Settings and persistence.
• lib/style/: Theming and styling.
• lib/game_internals/: Core game mechanics.

State management is intentionally low-level to avoid dependencies on code generation (like build_runner), but you are encouraged to replace it with your preferred paradigm.

The project uses a loose, shallow, feature-first directory structure in lib/. Core gameplay logic is located in lib/flame_game/. Other features are organized by name (e.g., audio, main_menu, settings). State management is intentionally low-level to avoid dependencies on code generation like build_runner during initial development.

lib
├── app_lifecycle
├── audio
├── flame_game
├── level_selection
├── main_menu
├── player_progress
├── settings
├── style
└── main.dart
└── router.dart

The template supports building for iOS, Android, Web, and Desktop.

• iOS: Builds an IPA and opens the archive in Xcode.
• Android: Builds an app bundle and opens the release folder.
• Web: Requires the peanut package. It builds using the canvaskit renderer and can be configured to push directly to GitHub Pages.
• Desktop: Follow standard Flutter platform integration instructions for Windows, Linux, or macOS.

# iOS
flutter build ipa && open build/ios/archive/Runner.xcarchive

# Android
flutter build appbundle && open build/app/outputs/bundle/release

# Web (requires peanut package)
flutter pub global run peanut \
--web-renderer canvaskit \
--extra-args "--base-href=/name_of_your_github_repo/" \
&& git push origin --set-upstream gh-pages

The easiest way to access templates and samples is by using the sample_downloader tool. This tool allows you to download specific projects from this repository without cloning the entire repository manually.

Prerequisites

• The Flutter SDK must be installed on your system.

Installation Steps

1. Activate the tool globally using Dart:

   dart pub global activate sample_downloader

2. Run the tool from any directory and follow the interactive instructions:

   sample_downloader

To change the icon, update assets/icon-adaptive-foreground.png and assets/icon.png. Then, run the flutter_launcher_icons tool. You can further configure the icon appearance in the flutter_icons: section of your pubspec.yaml.

dart run flutter_launcher_icons:main