diff --git a/CHANGELOG.md b/CHANGELOG.md index fcfbc3860..5a83cb317 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ ## 0.17.4 - 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 4e1d70634..2e3fc9d12 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](splash_screen.md) diff --git a/doc/splash_screen.md b/doc/splash_screen.md new file mode 100644 index 000000000..5e077d1bb --- /dev/null +++ b/doc/splash_screen.md @@ -0,0 +1,16 @@ +## Splash screen + +![](https://raw.githubusercontent.com/flame-engine/flame_splash_screen/master/demogif.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