feat: Add network assets package.

.github/.cspell/flame_dictionary.txt

@@ -32,3 +32,4 @@ yarnspinner
 рушниці
 рушниць
 рушниця
+unawaited

doc/flame/rendering/images.md

@@ -119,6 +119,45 @@ class MyGame extends Game {
 }
 ```
 
+## Loading images from the network
+
+Flame core package doesn't offer a built in method to loading images from the network.
+
+The reason for that is that Flutter/Dart does not have a built in http client, which required
+a package to be used and since there are a couple of packages available out there, we refrain
+from forcing, on even pushing the user in a specific package.
+
+With that said, it is quite simple to load images from the network once a http client package
+is chosen by the user. The following snippet shows how an `Image` can be fetched from the web
+using the [http](https://pub.dev/packages/http) package.
+
+```dart
+import 'package:http/http.dart' as http;
+import 'package:flutter/painting.dart';
+
+final response = await http.get('https://url.com/image.png');
+final image = await decodeImageFromList(response.bytes);
+```
+
+## FlameNetworkImages
+
+The snippet above can be enough for simple games, or simple features of some games, but
+more than often, developers will want to cache the images that were fetched from the web.
+
+To help in that regards, Flame provides a package that makes is easy to fetch images from the
+network, with automatic memory and file system cache.
+
+To use it, just add the `flame_network_image` package to your project and use the following
+code to fetch images:
+
+```dart
+final networkImages = FlameNetworkImages();
+final charSprite = await networkImages.load('https://url.com/image.png');
+```
+
+By default, that package relies on the `http` package to make http requests, and `path_provider`
+to get the place to store the local cache, to use a different approach for those, check the
+optional arguments in `FlameNetworkImages` constructor in order to customize that.
 
 ## Sprite
 

packages/flame_network_image/.gitignore

@@ -0,0 +1,30 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/

packages/flame_network_image/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+ revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ channel: stable
+
+project_type: package

packages/flame_network_image/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.

packages/flame_network_image/LICENSE

@@ -0,0 +1 @@
+TODO: Add your license here.

packages/flame_network_image/README.md

@@ -0,0 +1,26 @@
+# flame_network_image
+
+<!-- markdownlint-disable MD013 -->
+<p align="center">
+ <a href="https://flame-engine.org">
+ <img alt="flame" width="200px" src="https://user-images.githubusercontent.com/6718144/101553774-3bc7b000-39ad-11eb-8a6a-de2daa31bd64.png">
+ </a>
+</p>
+
+<p align="center">
+Adds network images support to <a href="https://github.com/flame-engine/flame">Flame</a>.
+</p>
+
+<p align="center">
+ <img src="https://github.com/flame-engine/flame_network_image/workflows/Lint/badge.svg?branch=master&event=push" alt="Test" />
+ <a title="Discord" href="https://discord.gg/pxrBmy4" ><img src="https://img.shields.io/discord/509714518008528896.svg" /></a>
+</p>
+<!-- markdownlint-enable MD013 -->
+
+---
+
+This package makes it easy to use and cache images from the network inside a Flame game.
+
+For instructions on how to use this package, check Flame docs:
+
+https://docs.flame-engine.org/1.6.0/flame/rendering/images.html

packages/flame_network_image/analysis_options.yaml

@@ -0,0 +1,5 @@
+include: package:flame_lint/analysis_options.yaml
+
+linter:
+ rules:
+ - public_member_api_docs

packages/flame_network_image/example/.gitignore

@@ -0,0 +1,51 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
+
+android
+ios
+web
+linux
+macos
+windows

packages/flame_network_image/example/.metadata

@@ -0,0 +1,45 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled.
+
+version:
+ revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ channel: stable
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+ platforms:
+ - platform: root
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ - platform: android
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ - platform: ios
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ - platform: linux
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ - platform: macos
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ - platform: web
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ - platform: windows
+ create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+ base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
+
+ # User provided section
+
+ # List of Local paths (relative to this file) that should be
+ # ignored by the migrate tool.
+ #
+ # Files that are not part of the templates will be ignored by default.
+ unmanaged_files:
+ - 'lib/main.dart'
+ - 'ios/Runner.xcodeproj/project.pbxproj'

packages/flame_network_image/example/README.md

@@ -0,0 +1,3 @@
+# example
+
+`flame_network_images` example app.

packages/flame_network_image/example/analysis_options.yaml

@@ -0,0 +1,29 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+ # The lint rules applied to this project can be customized in the
+ # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+ # included above or to enable additional rules. A list of all available lints
+ # and their documentation is published at
+ # https://dart-lang.github.io/linter/lints/index.html.
+ #
+ # Instead of disabling a lint rule for the entire project in the
+ # section below, it can also be suppressed for a single line of code
+ # or a specific dart file by using the `// ignore: name_of_lint` and
+ # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+ # producing the lint.
+ rules:
+ # avoid_print: false # Uncomment to disable the `avoid_print` rule
+ # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

packages/flame_network_image/example/lib/main.dart

@@ -0,0 +1,43 @@
+import 'dart:async';
+
+import 'package:flame/components.dart';
+import 'package:flame/extensions.dart';
+import 'package:flame/game.dart';
+import 'package:flame/input.dart';
+import 'package:flame_network_image/flame_network_image.dart';
+import 'package:flutter/material.dart' hide Image;
+
+void main() {
+ runApp(GameWidget.controlled(gameFactory: MyGame.new));
+}
+
+class MyGame extends FlameGame with TapDetector {
+ final networkImages = FlameNetworkImages();
+ late Image charSprite;
+
+ @override
+ Future<void> onLoad() async {
+ charSprite = await networkImages.load(
+ 'https://examples.flame-engine.org/assets/assets/images/bomb_ptero.png',
+ );
+ }
+
+ @override
+ bool onTapUp(TapUpInfo info) {
+ add(
+ SpriteAnimationComponent.fromFrameData(
+ charSprite,
+ SpriteAnimationData.sequenced(
+ textureSize: Vector2(48, 32),
+ amount: 4,
+ stepTime: .2,
+ ),
+ size: Vector2(100, 50),
+ anchor: Anchor.center,
+ position: info.eventPosition.game,
+ ),
+ );
+
+ return true;
+ }
+}

packages/flame_network_image/example/pubspec.yaml

@@ -0,0 +1,16 @@
+name: example
+description: A flame network images example.
+publish_to: 'none'
+
+version: 1.0.0+1
+
+environment:
+ sdk: '>=2.18.0 <3.0.0'
+
+dependencies:
+ flutter:
+ sdk: flutter
+ flame: ^1.6.0
+ flame_network_image:
+ path: ../
+ cupertino_icons: ^1.0.2

packages/flame_network_image/lib/flame_network_image.dart

@@ -0,0 +1,3 @@
+library flame_network_image;
+
+export 'src/flame_network_image.dart';