From 8c880df4e67f5250f5944ca4011d65474b67c341 Mon Sep 17 00:00:00 2001 From: renancaraujo Date: Wed, 22 Jan 2020 05:22:17 +0000 Subject: [PATCH 1/3] add splash screen --- doc/README.md | 1 + doc/splash_screen.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 doc/splash_screen.md diff --git a/doc/README.md b/doc/README.md index 5e096d154..1ca60483b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -57,3 +57,4 @@ And start using it! - [Box2D](box2d.md) - [Tiled](tiled.md) - [Debugging](debug.md) + - [Splash screen](debug.md) diff --git a/doc/splash_screen.md b/doc/splash_screen.md new file mode 100644 index 000000000..4756a830c --- /dev/null +++ b/doc/splash_screen.md @@ -0,0 +1,16 @@ +## Splash screen + +![](ssdemo.gif) + +Style your flame game with a beautiful splash screen. + +Flame splash screen is a very customizable splash screen package. + +```dart +FlameSplashScreen( + theme: FlameSplashTheme.dark, + onFinish: (BuildContext context) => Navigator.pushNamed(context, '/your-game-initial-screen') +) +``` + +Check the [package's repo](https://github.com/flame-engine/flame_splash_screen) and the [pub page](https://pub.dev/packages/flame_splash_screen) for more details. \ No newline at end of file From e6c407a2ab967a8a88451dce26619ca2b1debf34 Mon Sep 17 00:00:00 2001 From: renancaraujo Date: Wed, 22 Jan 2020 05:29:40 +0000 Subject: [PATCH 2/3] fix gif --- doc/splash_screen.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/splash_screen.md b/doc/splash_screen.md index 4756a830c..5e077d1bb 100644 --- a/doc/splash_screen.md +++ b/doc/splash_screen.md @@ -1,6 +1,6 @@ ## Splash screen -![](ssdemo.gif) +![](https://raw.githubusercontent.com/flame-engine/flame_splash_screen/master/demogif.gif) Style your flame game with a beautiful splash screen. From 9b06018f6294afe044df0b6c72acc9630e8da65b Mon Sep 17 00:00:00 2001 From: renancaraujo Date: Wed, 22 Jan 2020 05:31:17 +0000 Subject: [PATCH 3/3] fix gif --- CHANGELOG.md | 1 + doc/README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 428decbf7..1e07ea272 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ ## next - Fixing compilations errors regarding changes on `box2_flame` +- Add splash screen docs ## 0.17.3 - Tweaking text box rendering to reduce pixelated text (thanks, @kurtome) diff --git a/doc/README.md b/doc/README.md index 1ca60483b..9bbf56803 100644 --- a/doc/README.md +++ b/doc/README.md @@ -57,4 +57,4 @@ And start using it! - [Box2D](box2d.md) - [Tiled](tiled.md) - [Debugging](debug.md) - - [Splash screen](debug.md) + - [Splash screen](splash_screen.md)