diff --git a/.gitignore b/.gitignore index 07e32a4b8..a55676115 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,7 @@ .pub/ packages pubspec.lock -doc/api/ +docs/api/ .flutter-plugins .vscode/ **/.flutter-plugins diff --git a/CHANGELOG.md b/CHANGELOG.md index 454ce6147..454a9e74c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # CHANGELOG ## [next] +- Updated the doc structure and minor language fixes ## 0.20.2 - Fix text component bug with anchor being applied twice diff --git a/FAQ.md b/FAQ.md index 9181d280a..1988ec238 100644 --- a/FAQ.md +++ b/FAQ.md @@ -36,7 +36,7 @@ To prevent that exception from happening, add the following line before calling We have a few examples! The simplest of all is in [the root example folder](/example/). This folder must be called `example` and contain a single project, so it's a very simple generic example game. -However there is an [examples folder inside the docs](/doc/examples) that contains many more examples. Most newer features we are adding we are trying to add a specific example for that. Those are directed to specific features. +However there is an [examples folder inside the docs](/docs/examples) that contains many more examples. Most newer features we are adding we are trying to add a specific example for that. Those are directed to specific features. If you want a more full-fledged game, please check [BGUG](https://github.com/fireslime/bgug), FireSlime's open source fast paced side-scrolling platformer. It is mostly up-to-date with Flame and uses a good chunck of the featues offered by the engine. Other examples game are [feroult](https://github.com/feroult)'s [Haunt](https://github.com/feroult/haunt), which is outdated but showcases Box2D,[renancaraujo](https://github.com/renancaraujo)'s port of the [trex](https://github.com/flame-engine/trex-flame) chrome game in Flame, and also [Bob Box](https://github.com/fireslime/bounce_box), which is easy to grasp and a good display of our core features. diff --git a/README.md b/README.md index 324589fad..a716188f8 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,19 @@ A minimalist Flutter game engine. -Any help is appreciated! Comment, suggestions, issues, PR's! Give us a star to help! +Any help is appreciated! Comments, suggestions, issues, PRs! Give us a star to show your support! ## Help -We have a Flame help channel on Fireslime's Discord, join it [here](https://discord.gg/pxrBmy4). Also we now have a [FAQ](FAQ.md), so please search your questions there first. +We have a Flame help channel on Fireslime's Discord, join it [here](https://discord.gg/pxrBmy4). Also we now have a [FAQ](FAQ.md), so please search for your question there first. ## Goals -The goal of this project is to provided a complete set of out-of-the-way solutions for the common problems every game developed in Flutter will share. +The goal of this project is to provide a complete set of out-of-the-way solutions for the common problems every game developed in Flutter will share. -Currently it provides you with: a few utilities, images/sprites/sprite sheets, audio, a game loop and a component/object system. +Currently it provides you with: a few utilities, images/sprites/sprite sheets, audio, a physics engine, a game loop and a component/object system. -You can use whatever ones you want, as they are all somewhat independent. +You can use whichever ones you want, as they are all somewhat independent. ## Support @@ -26,7 +26,7 @@ Support us by becoming a patron on Patreon [![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/fireslime) -Or making a single donation buying us a coffee: +Or making a single donation by buying us a coffee: [![Buy Me A Coffee](https://user-images.githubusercontent.com/835641/60540201-fcd7fa00-9ce4-11e9-87ec-1e98568e9f58.png)](https://www.buymeacoffee.com/fireslime) @@ -44,7 +44,7 @@ You can also show support by showing on your repository that your game is made w ## Contributing -Found a bug on Flame and want to contribute with a PR? PRs are always very welcome, just be sure to create your PR from the `develop` branch. +Found a bug in Flame and want to contribute with a PR? PRs are always very welcome, just be sure to create your PR from the `develop` branch. ## Getting started @@ -61,7 +61,9 @@ We also offer a curated list of Games, Libraries and Articles over at [awesome-f ## Documentation -The complete documentation can be found [here](doc/README.md). +The complete documentation can be found [here](docs/README.md). + +A lot of examples of different features can be found [here](docs/examples) and a good starting example can be found [here](./example). A very cool docs site can be found [here](https://flame-engine.org/). diff --git a/doc/examples/svg/.flutter-plugins-dependencies b/doc/examples/svg/.flutter-plugins-dependencies deleted file mode 100644 index 8b065d7c0..000000000 --- a/doc/examples/svg/.flutter-plugins-dependencies +++ /dev/null @@ -1 +0,0 @@ -{"_info":"// This is a generated file; do not edit or check into version control.","dependencyGraph":[{"name":"audioplayers","dependencies":["path_provider"]},{"name":"path_provider","dependencies":[]}]} \ No newline at end of file diff --git a/doc/README.md b/docs/README.md similarity index 100% rename from doc/README.md rename to docs/README.md diff --git a/doc/animation_widget_article/article.md b/docs/animation_widget_article/article.md similarity index 100% rename from doc/animation_widget_article/article.md rename to docs/animation_widget_article/article.md diff --git a/doc/animation_widget_article/cover.gif b/docs/animation_widget_article/cover.gif similarity index 100% rename from doc/animation_widget_article/cover.gif rename to docs/animation_widget_article/cover.gif diff --git a/doc/animation_widget_article/folder_structure.png b/docs/animation_widget_article/folder_structure.png similarity index 100% rename from doc/animation_widget_article/folder_structure.png rename to docs/animation_widget_article/folder_structure.png diff --git a/doc/animation_widget_article/minotaur.gif b/docs/animation_widget_article/minotaur.gif similarity index 100% rename from doc/animation_widget_article/minotaur.gif rename to docs/animation_widget_article/minotaur.gif diff --git a/doc/animation_widget_article/minotaur.png b/docs/animation_widget_article/minotaur.png similarity index 100% rename from doc/animation_widget_article/minotaur.png rename to docs/animation_widget_article/minotaur.png diff --git a/doc/animation_widget_article/result-small.gif b/docs/animation_widget_article/result-small.gif similarity index 100% rename from doc/animation_widget_article/result-small.gif rename to docs/animation_widget_article/result-small.gif diff --git a/doc/animation_widget_article/result.gif b/docs/animation_widget_article/result.gif similarity index 100% rename from doc/animation_widget_article/result.gif rename to docs/animation_widget_article/result.gif diff --git a/doc/animation_widget_article/result.webm b/docs/animation_widget_article/result.webm similarity index 100% rename from doc/animation_widget_article/result.webm rename to docs/animation_widget_article/result.webm diff --git a/doc/animation_widget_article/tileset-big.png b/docs/animation_widget_article/tileset-big.png similarity index 100% rename from doc/animation_widget_article/tileset-big.png rename to docs/animation_widget_article/tileset-big.png diff --git a/doc/animation_widget_article/tileset.png b/docs/animation_widget_article/tileset.png similarity index 100% rename from doc/animation_widget_article/tileset.png rename to docs/animation_widget_article/tileset.png diff --git a/doc/audio.md b/docs/audio.md similarity index 89% rename from doc/audio.md rename to docs/audio.md index 147dd6699..28d0ea81d 100644 --- a/doc/audio.md +++ b/docs/audio.md @@ -1,6 +1,19 @@ # Audio -To play an audio, it's really simple! Just run, at any moment: +To play an audio is really simple! + +Start by adding an entry in your `pubspec.yaml` for each file you want to use (and make sure at the files exist in path that you provide). + +For the examples below, your `pubspec.yaml` file needs to contain something like this: + +```yaml +flutter: + assets: + - assets/audio/explosion.mp3 + - assets/audio/music.mp3 +``` + +Then simply run: ```dart import 'package:flame/flame.dart'; diff --git a/doc/bgm.md b/docs/bgm.md similarity index 100% rename from doc/bgm.md rename to docs/bgm.md diff --git a/doc/box2d.md b/docs/box2d.md similarity index 100% rename from doc/box2d.md rename to docs/box2d.md diff --git a/doc/components.md b/docs/components.md similarity index 92% rename from doc/components.md rename to docs/components.md index 288fdb726..6900ffaf8 100644 --- a/doc/components.md +++ b/docs/components.md @@ -43,14 +43,14 @@ The `onDestroy` method can be overridden to run code before the component is rem There are also other implementations: -* The `AnimationComponent` takes an `Animation` object and renders a cyclic animated sprite (more details about Animations [here](/doc/images.md#Animation)) +* The `AnimationComponent` takes an `Animation` object and renders a cyclic animated sprite (more details about Animations [here](/docs/images.md#Animation)) * The `SvgComponent` takes an `Svg` object and renders the SVG on the game * The `ParallaxComponent` can render a parallax background with several frames * The `Box2DComponent`, that has a physics engine built-in (using the [Box2D](https://github.com/google/box2d.dart) port for Dart) ## Animation Component -This component uses an instance of the [Animation](/doc/images.md#Animation) class to represent a Component that has a sprite that runs a single cyclic animation. +This component uses an instance of the [Animation](/docs/images.md#Animation) class to represent a Component that has a sprite that runs a single cyclic animation. This will create a simple three frame animation @@ -59,7 +59,7 @@ This will create a simple three frame animation this.player = AnimationComponent(64.0, 64.0, new Animation.spriteList(sprites, stepTime: 0.01)); ``` -If you have a sprite sheet, you can use the `sequenced` constructor, identical to the one provided by the `Animation` class (check more details in [the appropriate section](/doc/images.md#Animation)): +If you have a sprite sheet, you can use the `sequenced` constructor, identical to the one provided by the `Animation` class (check more details in [the appropriate section](/docs/images.md#Animation)): ```dart this.player = AnimationComponent.sequenced(64.0, 64.0, 'player.png', 2); @@ -80,7 +80,7 @@ This component uses an instance of `Svg` class to represent a Component that has ## FlareAnimation Component -This component wraps an instance of the [FlareAnimation](/doc/images.md#FlareAnimation), it receives the filename of the Flare animation file, which animation from that file you want to use, and the `width` and `height` of the rendered animation. +This component wraps an instance of the [FlareAnimation](/docs/images.md#FlareAnimation), it receives the filename of the Flare animation file, which animation from that file you want to use, and the `width` and `height` of the rendered animation. ```dart final fileName = "assets/Bob_Minion.flr"; @@ -96,7 +96,7 @@ This component wraps an instance of the [FlareAnimation](/doc/images.md#FlareAni You can also change the current playing animation using the `updateAnimation` method. -For a working example, check this [source file](/doc/examples/flare/lib/main_component.dart). +For a working example, check this [source file](/docs/examples/flare/lib/main_component.dart). ## Composed component @@ -179,7 +179,7 @@ Once you are done with setting the parameters to your needs, render the Parallax Like the AnimationComponent, even if your parallax is static, you must call update on this component, so it runs its animation. Also, don't forget to add you images to the `pubspec.yaml` file as assets or they wont be found. -An example implementation can be found in the [examples directory](/doc/examples/parallax). +An example implementation can be found in the [examples directory](/docs/examples/parallax). ## Box2D Component @@ -195,7 +195,7 @@ You can see a more complete example of box2d usage on [this WIP game](https://gi Currently we have a very basic implementation of a Tiled component. This API uses the lib [Tiled](https://github.com/feroult/tiled.dart) to parse map files and render visible layers. -A example of how to use the API can be found [here](/doc/examples/tiled). +A example of how to use the API can be found [here](/docs/examples/tiled). # Nine Tile Box Component @@ -211,6 +211,6 @@ Check the example app `nine_tile_box` details on how to use it. ## Effects -Flame provides a set of effects that can be applied to a certain type of components, these effects can be used to animate some properties of your components, like position or dimensions. You can check the list of those effects [here](/doc/effects) +Flame provides a set of effects that can be applied to a certain type of components, these effects can be used to animate some properties of your components, like position or dimensions. You can check the list of those effects [here](/docs/effects) -Examples of the running effects can be found [here](/doc/examples/effects.md); +Examples of the running effects can be found [here](/docs/examples/effects.md); diff --git a/doc/debug.md b/docs/debug.md similarity index 94% rename from doc/debug.md rename to docs/debug.md index a322c5bd9..8dad6a9c5 100644 --- a/doc/debug.md +++ b/docs/debug.md @@ -4,4 +4,4 @@ Flame provides some features for debugging, these features are enabled when the BaseGame will also start record the fps when in debug mode, you can access the current fps by using the method `fps`. -To see an working example of the debugging features, [check this example](/doc/examples/debug). +To see an working example of the debugging features, [check this example](/docs/examples/debug). diff --git a/doc/effects.md b/docs/effects.md similarity index 100% rename from doc/effects.md rename to docs/effects.md diff --git a/doc/examples/README.md b/docs/examples/README.md similarity index 100% rename from doc/examples/README.md rename to docs/examples/README.md diff --git a/doc/examples/animation_widget/.gitignore b/docs/examples/animation_widget/.gitignore similarity index 100% rename from doc/examples/animation_widget/.gitignore rename to docs/examples/animation_widget/.gitignore diff --git a/doc/examples/animation_widget/.metadata b/docs/examples/animation_widget/.metadata similarity index 100% rename from doc/examples/animation_widget/.metadata rename to docs/examples/animation_widget/.metadata diff --git a/doc/examples/animation_widget/README.md b/docs/examples/animation_widget/README.md similarity index 100% rename from doc/examples/animation_widget/README.md rename to docs/examples/animation_widget/README.md diff --git a/doc/examples/animation_widget/assets/images/minotaur.png b/docs/examples/animation_widget/assets/images/minotaur.png similarity index 100% rename from doc/examples/animation_widget/assets/images/minotaur.png rename to docs/examples/animation_widget/assets/images/minotaur.png diff --git a/doc/examples/animation_widget/lib/main.dart b/docs/examples/animation_widget/lib/main.dart similarity index 100% rename from doc/examples/animation_widget/lib/main.dart rename to docs/examples/animation_widget/lib/main.dart diff --git a/doc/examples/animation_widget/pubspec.yaml b/docs/examples/animation_widget/pubspec.yaml similarity index 100% rename from doc/examples/animation_widget/pubspec.yaml rename to docs/examples/animation_widget/pubspec.yaml diff --git a/doc/examples/animations/.gitignore b/docs/examples/animations/.gitignore similarity index 100% rename from doc/examples/animations/.gitignore rename to docs/examples/animations/.gitignore diff --git a/doc/examples/animations/.metadata b/docs/examples/animations/.metadata similarity index 100% rename from doc/examples/animations/.metadata rename to docs/examples/animations/.metadata diff --git a/doc/examples/animations/README.md b/docs/examples/animations/README.md similarity index 100% rename from doc/examples/animations/README.md rename to docs/examples/animations/README.md diff --git a/doc/examples/animations/assets/images/chopper.png b/docs/examples/animations/assets/images/chopper.png similarity index 100% rename from doc/examples/animations/assets/images/chopper.png rename to docs/examples/animations/assets/images/chopper.png diff --git a/doc/examples/animations/assets/images/creture.png b/docs/examples/animations/assets/images/creture.png similarity index 100% rename from doc/examples/animations/assets/images/creture.png rename to docs/examples/animations/assets/images/creture.png diff --git a/doc/examples/animations/lib/main.dart b/docs/examples/animations/lib/main.dart similarity index 100% rename from doc/examples/animations/lib/main.dart rename to docs/examples/animations/lib/main.dart diff --git a/doc/examples/animations/pubspec.yaml b/docs/examples/animations/pubspec.yaml similarity index 100% rename from doc/examples/animations/pubspec.yaml rename to docs/examples/animations/pubspec.yaml diff --git a/doc/examples/aseprite/.gitignore b/docs/examples/aseprite/.gitignore similarity index 100% rename from doc/examples/aseprite/.gitignore rename to docs/examples/aseprite/.gitignore diff --git a/doc/examples/aseprite/.metadata b/docs/examples/aseprite/.metadata similarity index 100% rename from doc/examples/aseprite/.metadata rename to docs/examples/aseprite/.metadata diff --git a/doc/examples/aseprite/README.md b/docs/examples/aseprite/README.md similarity index 100% rename from doc/examples/aseprite/README.md rename to docs/examples/aseprite/README.md diff --git a/doc/examples/aseprite/assets/chopper.json b/docs/examples/aseprite/assets/chopper.json similarity index 100% rename from doc/examples/aseprite/assets/chopper.json rename to docs/examples/aseprite/assets/chopper.json diff --git a/doc/examples/aseprite/assets/images/chopper.png b/docs/examples/aseprite/assets/images/chopper.png similarity index 100% rename from doc/examples/aseprite/assets/images/chopper.png rename to docs/examples/aseprite/assets/images/chopper.png diff --git a/doc/examples/aseprite/lib/main.dart b/docs/examples/aseprite/lib/main.dart similarity index 100% rename from doc/examples/aseprite/lib/main.dart rename to docs/examples/aseprite/lib/main.dart diff --git a/doc/examples/aseprite/pubspec.yaml b/docs/examples/aseprite/pubspec.yaml similarity index 100% rename from doc/examples/aseprite/pubspec.yaml rename to docs/examples/aseprite/pubspec.yaml diff --git a/doc/examples/audiopool/.gitignore b/docs/examples/audiopool/.gitignore similarity index 100% rename from doc/examples/audiopool/.gitignore rename to docs/examples/audiopool/.gitignore diff --git a/doc/examples/audiopool/.metadata b/docs/examples/audiopool/.metadata similarity index 100% rename from doc/examples/audiopool/.metadata rename to docs/examples/audiopool/.metadata diff --git a/doc/examples/audiopool/README.md b/docs/examples/audiopool/README.md similarity index 100% rename from doc/examples/audiopool/README.md rename to docs/examples/audiopool/README.md diff --git a/doc/examples/audiopool/assets/audio/sfx/CREDITS b/docs/examples/audiopool/assets/audio/sfx/CREDITS similarity index 100% rename from doc/examples/audiopool/assets/audio/sfx/CREDITS rename to docs/examples/audiopool/assets/audio/sfx/CREDITS diff --git a/doc/examples/audiopool/assets/audio/sfx/laser.mp3 b/docs/examples/audiopool/assets/audio/sfx/laser.mp3 similarity index 100% rename from doc/examples/audiopool/assets/audio/sfx/laser.mp3 rename to docs/examples/audiopool/assets/audio/sfx/laser.mp3 diff --git a/doc/examples/audiopool/lib/main.dart b/docs/examples/audiopool/lib/main.dart similarity index 100% rename from doc/examples/audiopool/lib/main.dart rename to docs/examples/audiopool/lib/main.dart diff --git a/doc/examples/audiopool/pubspec.yaml b/docs/examples/audiopool/pubspec.yaml similarity index 100% rename from doc/examples/audiopool/pubspec.yaml rename to docs/examples/audiopool/pubspec.yaml diff --git a/doc/examples/box2d/contact_callbacks/.gitignore b/docs/examples/box2d/contact_callbacks/.gitignore similarity index 100% rename from doc/examples/box2d/contact_callbacks/.gitignore rename to docs/examples/box2d/contact_callbacks/.gitignore diff --git a/doc/examples/box2d/contact_callbacks/.metadata b/docs/examples/box2d/contact_callbacks/.metadata similarity index 100% rename from doc/examples/box2d/contact_callbacks/.metadata rename to docs/examples/box2d/contact_callbacks/.metadata diff --git a/doc/examples/box2d/contact_callbacks/README.md b/docs/examples/box2d/contact_callbacks/README.md similarity index 100% rename from doc/examples/box2d/contact_callbacks/README.md rename to docs/examples/box2d/contact_callbacks/README.md diff --git a/doc/examples/box2d/contact_callbacks/lib/boundaries.dart b/docs/examples/box2d/contact_callbacks/lib/boundaries.dart similarity index 100% rename from doc/examples/box2d/contact_callbacks/lib/boundaries.dart rename to docs/examples/box2d/contact_callbacks/lib/boundaries.dart diff --git a/doc/examples/box2d/contact_callbacks/lib/main.dart b/docs/examples/box2d/contact_callbacks/lib/main.dart similarity index 100% rename from doc/examples/box2d/contact_callbacks/lib/main.dart rename to docs/examples/box2d/contact_callbacks/lib/main.dart diff --git a/doc/examples/box2d/contact_callbacks/pubspec.yaml b/docs/examples/box2d/contact_callbacks/pubspec.yaml similarity index 100% rename from doc/examples/box2d/contact_callbacks/pubspec.yaml rename to docs/examples/box2d/contact_callbacks/pubspec.yaml diff --git a/doc/examples/box2d/simple/.gitignore b/docs/examples/box2d/simple/.gitignore similarity index 100% rename from doc/examples/box2d/simple/.gitignore rename to docs/examples/box2d/simple/.gitignore diff --git a/doc/examples/box2d/simple/.metadata b/docs/examples/box2d/simple/.metadata similarity index 100% rename from doc/examples/box2d/simple/.metadata rename to docs/examples/box2d/simple/.metadata diff --git a/doc/examples/box2d/simple/README.md b/docs/examples/box2d/simple/README.md similarity index 100% rename from doc/examples/box2d/simple/README.md rename to docs/examples/box2d/simple/README.md diff --git a/doc/examples/box2d/simple/lib/main.dart b/docs/examples/box2d/simple/lib/main.dart similarity index 100% rename from doc/examples/box2d/simple/lib/main.dart rename to docs/examples/box2d/simple/lib/main.dart diff --git a/doc/examples/box2d/simple/pubspec.yaml b/docs/examples/box2d/simple/pubspec.yaml similarity index 100% rename from doc/examples/box2d/simple/pubspec.yaml rename to docs/examples/box2d/simple/pubspec.yaml diff --git a/doc/examples/debug/.gitignore b/docs/examples/debug/.gitignore similarity index 100% rename from doc/examples/debug/.gitignore rename to docs/examples/debug/.gitignore diff --git a/doc/examples/debug/.metadata b/docs/examples/debug/.metadata similarity index 100% rename from doc/examples/debug/.metadata rename to docs/examples/debug/.metadata diff --git a/doc/examples/debug/README.md b/docs/examples/debug/README.md similarity index 100% rename from doc/examples/debug/README.md rename to docs/examples/debug/README.md diff --git a/doc/examples/debug/assets/android.svg b/docs/examples/debug/assets/android.svg similarity index 100% rename from doc/examples/debug/assets/android.svg rename to docs/examples/debug/assets/android.svg diff --git a/doc/examples/debug/lib/main.dart b/docs/examples/debug/lib/main.dart similarity index 100% rename from doc/examples/debug/lib/main.dart rename to docs/examples/debug/lib/main.dart diff --git a/doc/examples/debug/pubspec.yaml b/docs/examples/debug/pubspec.yaml similarity index 100% rename from doc/examples/debug/pubspec.yaml rename to docs/examples/debug/pubspec.yaml diff --git a/doc/examples/effects/.gitignore b/docs/examples/effects/.gitignore similarity index 100% rename from doc/examples/effects/.gitignore rename to docs/examples/effects/.gitignore diff --git a/doc/examples/effects/.metadata b/docs/examples/effects/.metadata similarity index 100% rename from doc/examples/effects/.metadata rename to docs/examples/effects/.metadata diff --git a/doc/examples/effects/README.md b/docs/examples/effects/README.md similarity index 100% rename from doc/examples/effects/README.md rename to docs/examples/effects/README.md diff --git a/doc/examples/effects/lib/main_move.dart b/docs/examples/effects/lib/main_move.dart similarity index 100% rename from doc/examples/effects/lib/main_move.dart rename to docs/examples/effects/lib/main_move.dart diff --git a/doc/examples/effects/lib/main_scale.dart b/docs/examples/effects/lib/main_scale.dart similarity index 100% rename from doc/examples/effects/lib/main_scale.dart rename to docs/examples/effects/lib/main_scale.dart diff --git a/doc/examples/effects/lib/square.dart b/docs/examples/effects/lib/square.dart similarity index 100% rename from doc/examples/effects/lib/square.dart rename to docs/examples/effects/lib/square.dart diff --git a/doc/examples/effects/pubspec.yaml b/docs/examples/effects/pubspec.yaml similarity index 100% rename from doc/examples/effects/pubspec.yaml rename to docs/examples/effects/pubspec.yaml diff --git a/doc/examples/flare/.gitignore b/docs/examples/flare/.gitignore similarity index 100% rename from doc/examples/flare/.gitignore rename to docs/examples/flare/.gitignore diff --git a/doc/examples/flare/.metadata b/docs/examples/flare/.metadata similarity index 100% rename from doc/examples/flare/.metadata rename to docs/examples/flare/.metadata diff --git a/doc/examples/flare/README.md b/docs/examples/flare/README.md similarity index 100% rename from doc/examples/flare/README.md rename to docs/examples/flare/README.md diff --git a/doc/examples/flare/assets/Bob_Minion.flr b/docs/examples/flare/assets/Bob_Minion.flr similarity index 100% rename from doc/examples/flare/assets/Bob_Minion.flr rename to docs/examples/flare/assets/Bob_Minion.flr diff --git a/doc/examples/flare/lib/main.dart b/docs/examples/flare/lib/main.dart similarity index 100% rename from doc/examples/flare/lib/main.dart rename to docs/examples/flare/lib/main.dart diff --git a/doc/examples/flare/lib/main_component.dart b/docs/examples/flare/lib/main_component.dart similarity index 100% rename from doc/examples/flare/lib/main_component.dart rename to docs/examples/flare/lib/main_component.dart diff --git a/doc/examples/flare/pubspec.yaml b/docs/examples/flare/pubspec.yaml similarity index 100% rename from doc/examples/flare/pubspec.yaml rename to docs/examples/flare/pubspec.yaml diff --git a/doc/examples/gestures/.gitignore b/docs/examples/gestures/.gitignore similarity index 100% rename from doc/examples/gestures/.gitignore rename to docs/examples/gestures/.gitignore diff --git a/doc/examples/gestures/.metadata b/docs/examples/gestures/.metadata similarity index 100% rename from doc/examples/gestures/.metadata rename to docs/examples/gestures/.metadata diff --git a/doc/examples/gestures/README.md b/docs/examples/gestures/README.md similarity index 100% rename from doc/examples/gestures/README.md rename to docs/examples/gestures/README.md diff --git a/doc/examples/gestures/lib/main.dart b/docs/examples/gestures/lib/main.dart similarity index 100% rename from doc/examples/gestures/lib/main.dart rename to docs/examples/gestures/lib/main.dart diff --git a/doc/examples/gestures/pubspec.yaml b/docs/examples/gestures/pubspec.yaml similarity index 100% rename from doc/examples/gestures/pubspec.yaml rename to docs/examples/gestures/pubspec.yaml diff --git a/doc/examples/go_desktop/.gitignore b/docs/examples/go_desktop/.gitignore similarity index 100% rename from doc/examples/go_desktop/.gitignore rename to docs/examples/go_desktop/.gitignore diff --git a/doc/examples/go_desktop/.metadata b/docs/examples/go_desktop/.metadata similarity index 100% rename from doc/examples/go_desktop/.metadata rename to docs/examples/go_desktop/.metadata diff --git a/doc/examples/go_desktop/README.md b/docs/examples/go_desktop/README.md similarity index 100% rename from doc/examples/go_desktop/README.md rename to docs/examples/go_desktop/README.md diff --git a/doc/examples/go_desktop/lib/game.dart b/docs/examples/go_desktop/lib/game.dart similarity index 100% rename from doc/examples/go_desktop/lib/game.dart rename to docs/examples/go_desktop/lib/game.dart diff --git a/doc/examples/go_desktop/lib/main.dart b/docs/examples/go_desktop/lib/main.dart similarity index 100% rename from doc/examples/go_desktop/lib/main.dart rename to docs/examples/go_desktop/lib/main.dart diff --git a/doc/examples/go_desktop/lib/main_desktop.dart b/docs/examples/go_desktop/lib/main_desktop.dart similarity index 100% rename from doc/examples/go_desktop/lib/main_desktop.dart rename to docs/examples/go_desktop/lib/main_desktop.dart diff --git a/doc/examples/go_desktop/pubspec.yaml b/docs/examples/go_desktop/pubspec.yaml similarity index 100% rename from doc/examples/go_desktop/pubspec.yaml rename to docs/examples/go_desktop/pubspec.yaml diff --git a/doc/examples/keyboard/.gitignore b/docs/examples/keyboard/.gitignore similarity index 100% rename from doc/examples/keyboard/.gitignore rename to docs/examples/keyboard/.gitignore diff --git a/doc/examples/keyboard/.metadata b/docs/examples/keyboard/.metadata similarity index 100% rename from doc/examples/keyboard/.metadata rename to docs/examples/keyboard/.metadata diff --git a/doc/examples/keyboard/README.md b/docs/examples/keyboard/README.md similarity index 100% rename from doc/examples/keyboard/README.md rename to docs/examples/keyboard/README.md diff --git a/doc/examples/keyboard/lib/main.dart b/docs/examples/keyboard/lib/main.dart similarity index 100% rename from doc/examples/keyboard/lib/main.dart rename to docs/examples/keyboard/lib/main.dart diff --git a/doc/examples/keyboard/pubspec.yaml b/docs/examples/keyboard/pubspec.yaml similarity index 100% rename from doc/examples/keyboard/pubspec.yaml rename to docs/examples/keyboard/pubspec.yaml diff --git a/doc/examples/nine_tile_box/.gitignore b/docs/examples/nine_tile_box/.gitignore similarity index 100% rename from doc/examples/nine_tile_box/.gitignore rename to docs/examples/nine_tile_box/.gitignore diff --git a/doc/examples/nine_tile_box/.metadata b/docs/examples/nine_tile_box/.metadata similarity index 100% rename from doc/examples/nine_tile_box/.metadata rename to docs/examples/nine_tile_box/.metadata diff --git a/doc/examples/nine_tile_box/README.md b/docs/examples/nine_tile_box/README.md similarity index 100% rename from doc/examples/nine_tile_box/README.md rename to docs/examples/nine_tile_box/README.md diff --git a/doc/examples/nine_tile_box/assets/images/nine-box.png b/docs/examples/nine_tile_box/assets/images/nine-box.png similarity index 100% rename from doc/examples/nine_tile_box/assets/images/nine-box.png rename to docs/examples/nine_tile_box/assets/images/nine-box.png diff --git a/doc/examples/nine_tile_box/lib/main.dart b/docs/examples/nine_tile_box/lib/main.dart similarity index 100% rename from doc/examples/nine_tile_box/lib/main.dart rename to docs/examples/nine_tile_box/lib/main.dart diff --git a/doc/examples/nine_tile_box/pubspec.yaml b/docs/examples/nine_tile_box/pubspec.yaml similarity index 100% rename from doc/examples/nine_tile_box/pubspec.yaml rename to docs/examples/nine_tile_box/pubspec.yaml diff --git a/doc/examples/parallax/.gitignore b/docs/examples/parallax/.gitignore similarity index 100% rename from doc/examples/parallax/.gitignore rename to docs/examples/parallax/.gitignore diff --git a/doc/examples/parallax/.metadata b/docs/examples/parallax/.metadata similarity index 100% rename from doc/examples/parallax/.metadata rename to docs/examples/parallax/.metadata diff --git a/doc/examples/parallax/README.md b/docs/examples/parallax/README.md similarity index 100% rename from doc/examples/parallax/README.md rename to docs/examples/parallax/README.md diff --git a/doc/examples/parallax/assets/images/bg.png b/docs/examples/parallax/assets/images/bg.png similarity index 100% rename from doc/examples/parallax/assets/images/bg.png rename to docs/examples/parallax/assets/images/bg.png diff --git a/doc/examples/parallax/assets/images/foreground-trees.png b/docs/examples/parallax/assets/images/foreground-trees.png similarity index 100% rename from doc/examples/parallax/assets/images/foreground-trees.png rename to docs/examples/parallax/assets/images/foreground-trees.png diff --git a/doc/examples/parallax/assets/images/license.txt b/docs/examples/parallax/assets/images/license.txt similarity index 100% rename from doc/examples/parallax/assets/images/license.txt rename to docs/examples/parallax/assets/images/license.txt diff --git a/doc/examples/parallax/assets/images/mountain-far.png b/docs/examples/parallax/assets/images/mountain-far.png similarity index 100% rename from doc/examples/parallax/assets/images/mountain-far.png rename to docs/examples/parallax/assets/images/mountain-far.png diff --git a/doc/examples/parallax/assets/images/mountains.png b/docs/examples/parallax/assets/images/mountains.png similarity index 100% rename from doc/examples/parallax/assets/images/mountains.png rename to docs/examples/parallax/assets/images/mountains.png diff --git a/doc/examples/parallax/assets/images/trees.png b/docs/examples/parallax/assets/images/trees.png similarity index 100% rename from doc/examples/parallax/assets/images/trees.png rename to docs/examples/parallax/assets/images/trees.png diff --git a/doc/examples/parallax/lib/main.dart b/docs/examples/parallax/lib/main.dart similarity index 100% rename from doc/examples/parallax/lib/main.dart rename to docs/examples/parallax/lib/main.dart diff --git a/doc/examples/parallax/pubspec.yaml b/docs/examples/parallax/pubspec.yaml similarity index 100% rename from doc/examples/parallax/pubspec.yaml rename to docs/examples/parallax/pubspec.yaml diff --git a/doc/examples/particles/.gitignore b/docs/examples/particles/.gitignore similarity index 100% rename from doc/examples/particles/.gitignore rename to docs/examples/particles/.gitignore diff --git a/doc/examples/particles/.metadata b/docs/examples/particles/.metadata similarity index 100% rename from doc/examples/particles/.metadata rename to docs/examples/particles/.metadata diff --git a/doc/examples/particles/README.md b/docs/examples/particles/README.md similarity index 72% rename from doc/examples/particles/README.md rename to docs/examples/particles/README.md index 52b22604f..ce4bce48a 100644 --- a/doc/examples/particles/README.md +++ b/docs/examples/particles/README.md @@ -3,4 +3,4 @@ A Flame application showcasing multiple different examples of using Flame particle system as well as some sample effects which could be used in your projects. -![Particles Example](/doc/examples/particles/assets/example.gif) \ No newline at end of file +![Particles Example](/docs/examples/particles/assets/example.gif) \ No newline at end of file diff --git a/doc/examples/particles/assets/diamond.flr b/docs/examples/particles/assets/diamond.flr similarity index 100% rename from doc/examples/particles/assets/diamond.flr rename to docs/examples/particles/assets/diamond.flr diff --git a/doc/examples/particles/assets/example.gif b/docs/examples/particles/assets/example.gif similarity index 100% rename from doc/examples/particles/assets/example.gif rename to docs/examples/particles/assets/example.gif diff --git a/doc/examples/particles/assets/images/boom3.png b/docs/examples/particles/assets/images/boom3.png similarity index 100% rename from doc/examples/particles/assets/images/boom3.png rename to docs/examples/particles/assets/images/boom3.png diff --git a/doc/examples/particles/assets/images/zap.png b/docs/examples/particles/assets/images/zap.png similarity index 100% rename from doc/examples/particles/assets/images/zap.png rename to docs/examples/particles/assets/images/zap.png diff --git a/doc/examples/particles/lib/main.dart b/docs/examples/particles/lib/main.dart similarity index 100% rename from doc/examples/particles/lib/main.dart rename to docs/examples/particles/lib/main.dart diff --git a/doc/examples/particles/pubspec.yaml b/docs/examples/particles/pubspec.yaml similarity index 100% rename from doc/examples/particles/pubspec.yaml rename to docs/examples/particles/pubspec.yaml diff --git a/doc/examples/render_flip/.gitignore b/docs/examples/render_flip/.gitignore similarity index 100% rename from doc/examples/render_flip/.gitignore rename to docs/examples/render_flip/.gitignore diff --git a/doc/examples/render_flip/.metadata b/docs/examples/render_flip/.metadata similarity index 100% rename from doc/examples/render_flip/.metadata rename to docs/examples/render_flip/.metadata diff --git a/doc/examples/render_flip/README.md b/docs/examples/render_flip/README.md similarity index 100% rename from doc/examples/render_flip/README.md rename to docs/examples/render_flip/README.md diff --git a/doc/examples/render_flip/assets/images/chopper.png b/docs/examples/render_flip/assets/images/chopper.png similarity index 100% rename from doc/examples/render_flip/assets/images/chopper.png rename to docs/examples/render_flip/assets/images/chopper.png diff --git a/doc/examples/render_flip/lib/main.dart b/docs/examples/render_flip/lib/main.dart similarity index 100% rename from doc/examples/render_flip/lib/main.dart rename to docs/examples/render_flip/lib/main.dart diff --git a/doc/examples/render_flip/pubspec.yaml b/docs/examples/render_flip/pubspec.yaml similarity index 100% rename from doc/examples/render_flip/pubspec.yaml rename to docs/examples/render_flip/pubspec.yaml diff --git a/doc/examples/sound/.gitignore b/docs/examples/sound/.gitignore similarity index 100% rename from doc/examples/sound/.gitignore rename to docs/examples/sound/.gitignore diff --git a/doc/examples/sound/.metadata b/docs/examples/sound/.metadata similarity index 100% rename from doc/examples/sound/.metadata rename to docs/examples/sound/.metadata diff --git a/doc/examples/sound/README.md b/docs/examples/sound/README.md similarity index 100% rename from doc/examples/sound/README.md rename to docs/examples/sound/README.md diff --git a/doc/examples/sound/assets/audio/boin.mp3 b/docs/examples/sound/assets/audio/boin.mp3 similarity index 100% rename from doc/examples/sound/assets/audio/boin.mp3 rename to docs/examples/sound/assets/audio/boin.mp3 diff --git a/doc/examples/sound/assets/audio/music.mp3 b/docs/examples/sound/assets/audio/music.mp3 similarity index 100% rename from doc/examples/sound/assets/audio/music.mp3 rename to docs/examples/sound/assets/audio/music.mp3 diff --git a/doc/examples/sound/lib/main.dart b/docs/examples/sound/lib/main.dart similarity index 100% rename from doc/examples/sound/lib/main.dart rename to docs/examples/sound/lib/main.dart diff --git a/doc/examples/sound/pubspec.yaml b/docs/examples/sound/pubspec.yaml similarity index 100% rename from doc/examples/sound/pubspec.yaml rename to docs/examples/sound/pubspec.yaml diff --git a/doc/examples/sprite_batch/.gitignore b/docs/examples/sprite_batch/.gitignore similarity index 100% rename from doc/examples/sprite_batch/.gitignore rename to docs/examples/sprite_batch/.gitignore diff --git a/doc/examples/sprite_batch/.metadata b/docs/examples/sprite_batch/.metadata similarity index 100% rename from doc/examples/sprite_batch/.metadata rename to docs/examples/sprite_batch/.metadata diff --git a/doc/examples/sprite_batch/README.md b/docs/examples/sprite_batch/README.md similarity index 100% rename from doc/examples/sprite_batch/README.md rename to docs/examples/sprite_batch/README.md diff --git a/doc/examples/sprite_batch/assets/images/boom3.png b/docs/examples/sprite_batch/assets/images/boom3.png similarity index 100% rename from doc/examples/sprite_batch/assets/images/boom3.png rename to docs/examples/sprite_batch/assets/images/boom3.png diff --git a/doc/examples/sprite_batch/lib/main.dart b/docs/examples/sprite_batch/lib/main.dart similarity index 100% rename from doc/examples/sprite_batch/lib/main.dart rename to docs/examples/sprite_batch/lib/main.dart diff --git a/doc/examples/sprite_batch/pubspec.yaml b/docs/examples/sprite_batch/pubspec.yaml similarity index 100% rename from doc/examples/sprite_batch/pubspec.yaml rename to docs/examples/sprite_batch/pubspec.yaml diff --git a/doc/examples/sprites/.gitignore b/docs/examples/sprites/.gitignore similarity index 100% rename from doc/examples/sprites/.gitignore rename to docs/examples/sprites/.gitignore diff --git a/doc/examples/sprites/.metadata b/docs/examples/sprites/.metadata similarity index 100% rename from doc/examples/sprites/.metadata rename to docs/examples/sprites/.metadata diff --git a/doc/examples/sprites/README.md b/docs/examples/sprites/README.md similarity index 100% rename from doc/examples/sprites/README.md rename to docs/examples/sprites/README.md diff --git a/doc/examples/sprites/assets/images/test.png b/docs/examples/sprites/assets/images/test.png similarity index 100% rename from doc/examples/sprites/assets/images/test.png rename to docs/examples/sprites/assets/images/test.png diff --git a/doc/examples/sprites/lib/main.dart b/docs/examples/sprites/lib/main.dart similarity index 100% rename from doc/examples/sprites/lib/main.dart rename to docs/examples/sprites/lib/main.dart diff --git a/doc/examples/sprites/lib/main_base64.dart b/docs/examples/sprites/lib/main_base64.dart similarity index 100% rename from doc/examples/sprites/lib/main_base64.dart rename to docs/examples/sprites/lib/main_base64.dart diff --git a/doc/examples/sprites/pubspec.yaml b/docs/examples/sprites/pubspec.yaml similarity index 100% rename from doc/examples/sprites/pubspec.yaml rename to docs/examples/sprites/pubspec.yaml diff --git a/doc/examples/spritesheet/.gitignore b/docs/examples/spritesheet/.gitignore similarity index 100% rename from doc/examples/spritesheet/.gitignore rename to docs/examples/spritesheet/.gitignore diff --git a/doc/examples/spritesheet/.metadata b/docs/examples/spritesheet/.metadata similarity index 100% rename from doc/examples/spritesheet/.metadata rename to docs/examples/spritesheet/.metadata diff --git a/doc/examples/spritesheet/README.md b/docs/examples/spritesheet/README.md similarity index 100% rename from doc/examples/spritesheet/README.md rename to docs/examples/spritesheet/README.md diff --git a/doc/examples/spritesheet/assets/images/spritesheet.png b/docs/examples/spritesheet/assets/images/spritesheet.png similarity index 100% rename from doc/examples/spritesheet/assets/images/spritesheet.png rename to docs/examples/spritesheet/assets/images/spritesheet.png diff --git a/doc/examples/spritesheet/lib/main.dart b/docs/examples/spritesheet/lib/main.dart similarity index 100% rename from doc/examples/spritesheet/lib/main.dart rename to docs/examples/spritesheet/lib/main.dart diff --git a/doc/examples/spritesheet/pubspec.yaml b/docs/examples/spritesheet/pubspec.yaml similarity index 100% rename from doc/examples/spritesheet/pubspec.yaml rename to docs/examples/spritesheet/pubspec.yaml diff --git a/doc/examples/svg/.gitignore b/docs/examples/svg/.gitignore similarity index 100% rename from doc/examples/svg/.gitignore rename to docs/examples/svg/.gitignore diff --git a/doc/examples/svg/.metadata b/docs/examples/svg/.metadata similarity index 100% rename from doc/examples/svg/.metadata rename to docs/examples/svg/.metadata diff --git a/doc/examples/svg/README.md b/docs/examples/svg/README.md similarity index 100% rename from doc/examples/svg/README.md rename to docs/examples/svg/README.md diff --git a/doc/examples/svg/assets/android.svg b/docs/examples/svg/assets/android.svg similarity index 100% rename from doc/examples/svg/assets/android.svg rename to docs/examples/svg/assets/android.svg diff --git a/doc/examples/svg/lib/main.dart b/docs/examples/svg/lib/main.dart similarity index 100% rename from doc/examples/svg/lib/main.dart rename to docs/examples/svg/lib/main.dart diff --git a/doc/examples/svg/pubspec.yaml b/docs/examples/svg/pubspec.yaml similarity index 100% rename from doc/examples/svg/pubspec.yaml rename to docs/examples/svg/pubspec.yaml diff --git a/doc/examples/tapeables/.gitignore b/docs/examples/tapeables/.gitignore similarity index 100% rename from doc/examples/tapeables/.gitignore rename to docs/examples/tapeables/.gitignore diff --git a/doc/examples/tapeables/.metadata b/docs/examples/tapeables/.metadata similarity index 100% rename from doc/examples/tapeables/.metadata rename to docs/examples/tapeables/.metadata diff --git a/doc/examples/tapeables/README.md b/docs/examples/tapeables/README.md similarity index 100% rename from doc/examples/tapeables/README.md rename to docs/examples/tapeables/README.md diff --git a/doc/examples/tapeables/lib/main.dart b/docs/examples/tapeables/lib/main.dart similarity index 100% rename from doc/examples/tapeables/lib/main.dart rename to docs/examples/tapeables/lib/main.dart diff --git a/doc/examples/tapeables/pubspec.yaml b/docs/examples/tapeables/pubspec.yaml similarity index 100% rename from doc/examples/tapeables/pubspec.yaml rename to docs/examples/tapeables/pubspec.yaml diff --git a/doc/examples/text/.gitignore b/docs/examples/text/.gitignore similarity index 100% rename from doc/examples/text/.gitignore rename to docs/examples/text/.gitignore diff --git a/doc/examples/text/.metadata b/docs/examples/text/.metadata similarity index 100% rename from doc/examples/text/.metadata rename to docs/examples/text/.metadata diff --git a/doc/examples/text/README.md b/docs/examples/text/README.md similarity index 100% rename from doc/examples/text/README.md rename to docs/examples/text/README.md diff --git a/doc/examples/text/lib/main.dart b/docs/examples/text/lib/main.dart similarity index 100% rename from doc/examples/text/lib/main.dart rename to docs/examples/text/lib/main.dart diff --git a/doc/examples/text/pubspec.yaml b/docs/examples/text/pubspec.yaml similarity index 100% rename from doc/examples/text/pubspec.yaml rename to docs/examples/text/pubspec.yaml diff --git a/doc/examples/tiled/.gitignore b/docs/examples/tiled/.gitignore similarity index 100% rename from doc/examples/tiled/.gitignore rename to docs/examples/tiled/.gitignore diff --git a/doc/examples/tiled/.metadata b/docs/examples/tiled/.metadata similarity index 100% rename from doc/examples/tiled/.metadata rename to docs/examples/tiled/.metadata diff --git a/doc/examples/tiled/README.md b/docs/examples/tiled/README.md similarity index 100% rename from doc/examples/tiled/README.md rename to docs/examples/tiled/README.md diff --git a/doc/examples/tiled/assets/images/coins.png b/docs/examples/tiled/assets/images/coins.png similarity index 100% rename from doc/examples/tiled/assets/images/coins.png rename to docs/examples/tiled/assets/images/coins.png diff --git a/doc/examples/tiled/assets/images/map-level1.png b/docs/examples/tiled/assets/images/map-level1.png similarity index 100% rename from doc/examples/tiled/assets/images/map-level1.png rename to docs/examples/tiled/assets/images/map-level1.png diff --git a/doc/examples/tiled/assets/images/map-level2.png b/docs/examples/tiled/assets/images/map-level2.png similarity index 100% rename from doc/examples/tiled/assets/images/map-level2.png rename to docs/examples/tiled/assets/images/map-level2.png diff --git a/doc/examples/tiled/assets/tiles/map.tmx b/docs/examples/tiled/assets/tiles/map.tmx similarity index 100% rename from doc/examples/tiled/assets/tiles/map.tmx rename to docs/examples/tiled/assets/tiles/map.tmx diff --git a/doc/examples/tiled/lib/main.dart b/docs/examples/tiled/lib/main.dart similarity index 100% rename from doc/examples/tiled/lib/main.dart rename to docs/examples/tiled/lib/main.dart diff --git a/doc/examples/tiled/pubspec.yaml b/docs/examples/tiled/pubspec.yaml similarity index 100% rename from doc/examples/tiled/pubspec.yaml rename to docs/examples/tiled/pubspec.yaml diff --git a/doc/examples/timer/.gitignore b/docs/examples/timer/.gitignore similarity index 100% rename from doc/examples/timer/.gitignore rename to docs/examples/timer/.gitignore diff --git a/doc/examples/timer/.metadata b/docs/examples/timer/.metadata similarity index 100% rename from doc/examples/timer/.metadata rename to docs/examples/timer/.metadata diff --git a/doc/examples/timer/README.md b/docs/examples/timer/README.md similarity index 100% rename from doc/examples/timer/README.md rename to docs/examples/timer/README.md diff --git a/doc/examples/timer/lib/main.dart b/docs/examples/timer/lib/main.dart similarity index 100% rename from doc/examples/timer/lib/main.dart rename to docs/examples/timer/lib/main.dart diff --git a/doc/examples/timer/pubspec.yaml b/docs/examples/timer/pubspec.yaml similarity index 100% rename from doc/examples/timer/pubspec.yaml rename to docs/examples/timer/pubspec.yaml diff --git a/doc/examples/widgets/.gitignore b/docs/examples/widgets/.gitignore similarity index 100% rename from doc/examples/widgets/.gitignore rename to docs/examples/widgets/.gitignore diff --git a/doc/examples/widgets/.metadata b/docs/examples/widgets/.metadata similarity index 100% rename from doc/examples/widgets/.metadata rename to docs/examples/widgets/.metadata diff --git a/doc/examples/widgets/README.md b/docs/examples/widgets/README.md similarity index 100% rename from doc/examples/widgets/README.md rename to docs/examples/widgets/README.md diff --git a/doc/examples/widgets/assets/images/buttons.png b/docs/examples/widgets/assets/images/buttons.png similarity index 100% rename from doc/examples/widgets/assets/images/buttons.png rename to docs/examples/widgets/assets/images/buttons.png diff --git a/doc/examples/widgets/assets/images/nine_tile_box.png b/docs/examples/widgets/assets/images/nine_tile_box.png similarity index 100% rename from doc/examples/widgets/assets/images/nine_tile_box.png rename to docs/examples/widgets/assets/images/nine_tile_box.png diff --git a/doc/examples/widgets/lib/generated_plugin_registrant.dart b/docs/examples/widgets/lib/generated_plugin_registrant.dart similarity index 100% rename from doc/examples/widgets/lib/generated_plugin_registrant.dart rename to docs/examples/widgets/lib/generated_plugin_registrant.dart diff --git a/doc/examples/widgets/lib/main.dart b/docs/examples/widgets/lib/main.dart similarity index 100% rename from doc/examples/widgets/lib/main.dart rename to docs/examples/widgets/lib/main.dart diff --git a/doc/examples/widgets/pubspec.yaml b/docs/examples/widgets/pubspec.yaml similarity index 100% rename from doc/examples/widgets/pubspec.yaml rename to docs/examples/widgets/pubspec.yaml diff --git a/doc/examples/with_widgets_overlay/.gitignore b/docs/examples/with_widgets_overlay/.gitignore similarity index 100% rename from doc/examples/with_widgets_overlay/.gitignore rename to docs/examples/with_widgets_overlay/.gitignore diff --git a/doc/examples/with_widgets_overlay/.metadata b/docs/examples/with_widgets_overlay/.metadata similarity index 100% rename from doc/examples/with_widgets_overlay/.metadata rename to docs/examples/with_widgets_overlay/.metadata diff --git a/doc/examples/with_widgets_overlay/README.md b/docs/examples/with_widgets_overlay/README.md similarity index 100% rename from doc/examples/with_widgets_overlay/README.md rename to docs/examples/with_widgets_overlay/README.md diff --git a/doc/examples/with_widgets_overlay/lib/example_game.dart b/docs/examples/with_widgets_overlay/lib/example_game.dart similarity index 100% rename from doc/examples/with_widgets_overlay/lib/example_game.dart rename to docs/examples/with_widgets_overlay/lib/example_game.dart diff --git a/doc/examples/with_widgets_overlay/lib/main.dart b/docs/examples/with_widgets_overlay/lib/main.dart similarity index 100% rename from doc/examples/with_widgets_overlay/lib/main.dart rename to docs/examples/with_widgets_overlay/lib/main.dart diff --git a/doc/examples/with_widgets_overlay/lib/main_dynamic_game.dart b/docs/examples/with_widgets_overlay/lib/main_dynamic_game.dart similarity index 100% rename from doc/examples/with_widgets_overlay/lib/main_dynamic_game.dart rename to docs/examples/with_widgets_overlay/lib/main_dynamic_game.dart diff --git a/doc/examples/with_widgets_overlay/pubspec.yaml b/docs/examples/with_widgets_overlay/pubspec.yaml similarity index 100% rename from doc/examples/with_widgets_overlay/pubspec.yaml rename to docs/examples/with_widgets_overlay/pubspec.yaml diff --git a/doc/game.md b/docs/game.md similarity index 97% rename from doc/game.md rename to docs/game.md index a1a2e1a4a..94354ff47 100644 --- a/doc/game.md +++ b/docs/game.md @@ -69,12 +69,12 @@ removeWidgetOverlay("PauseMenu"); // Use the overlay identifier to remove the ov Under the hood, Flame uses a [Stack widget](https://api.flutter.dev/flutter/widgets/Stack-class.html) to display the overlay, so it is important to __note that the order which the overlays are added matter__, where the last added overlay, will be in the front of those added before. -Here you can see a [working example](/doc/examples/with_widgets_overlay) of this feature. +Here you can see a [working example](/docs/examples/with_widgets_overlay) of this feature. ## BaseGame debug mode Flame's `BaseGame` class provides a method called `debugMode`, which by default returns false. It can however, be overridden to enable debug features over the components of the game. __Be aware__ that the state returned by this method is passed through its component when they added to the game, so if you change the `debugMode` in runtime, it may not affect already added components. -To see more about debugMode on Flame, please refer to the [Debug Docs](/doc/debug.md) +To see more about debugMode on Flame, please refer to the [Debug Docs](/docs/debug.md) diff --git a/doc/gamepad.md b/docs/gamepad.md similarity index 100% rename from doc/gamepad.md rename to docs/gamepad.md diff --git a/doc/images.md b/docs/images.md similarity index 96% rename from doc/images.md rename to docs/images.md index ca67c96f0..9d54a6c3f 100644 --- a/doc/images.md +++ b/docs/images.md @@ -43,7 +43,7 @@ All render methods from the Sprite class can receive a `Paint` instance on the o Sprites can also be used as widgets, to do so, just use `Flame.util.spriteAsWidget` -A complete example of using sprite as widgets can be found [here](/doc/examples/animation_widget). +A complete example of using sprite as widgets can be found [here](/docs/examples/animation_widget). ## SpriteBatch @@ -55,7 +55,7 @@ You render it with an `Canvas` and an optional `Paint`, `BlendMode` and `CullRec An `SpriteBatchComponent` is also available for your convenience. -See example [here](/doc/examples/sprite_batch). +See example [here](/docs/examples/sprite_batch). ## Svg @@ -172,7 +172,7 @@ Animations are normally used inside `AnimationComponent`s, but custom components Animations can also be used as widgets, to do so, just use `Flame.util.animationAsWidget` -A complete example of using animations as widgets can be found [here](/doc/examples/animation_widget). +A complete example of using animations as widgets can be found [here](/docs/examples/animation_widget). ## FlareAnimation @@ -216,7 +216,7 @@ class MyGame extends Game { ``` FlareAnimations are normally used inside `FlareComponent`s, that way `BaseGame` will handle calling `render` and `update` automatically. -You can see a full example of the SpriteSheet class [here](/doc/examples/flare). +You can see a full example of the SpriteSheet class [here](/docs/examples/flare). ## SpriteSheet @@ -244,4 +244,4 @@ You can also get a single frame of the sprite sheet using the `getSprite` method spritesheet.getSprite(0, 0) // row, column; ``` -You can see a full example of the SpriteSheet class [here](/doc/examples/spritesheet). +You can see a full example of the SpriteSheet class [here](/docs/examples/spritesheet). diff --git a/doc/input.md b/docs/input.md similarity index 96% rename from doc/input.md rename to docs/input.md index a64ed577d..d6bb9649f 100644 --- a/doc/input.md +++ b/docs/input.md @@ -80,7 +80,7 @@ class MyGame extends Game with TapDetector { } } ``` -You can also check a more complete example [here](/doc/examples/gestures). +You can also check a more complete example [here](/docs/examples/gestures). ## Tapable components @@ -143,4 +143,4 @@ class MyGame extends Game with KeyboardEvents { } ``` -You can also check a more complete example [here](/doc/examples/keyboard). +You can also check a more complete example [here](/docs/examples/keyboard). diff --git a/doc/palette.md b/docs/palette.md similarity index 100% rename from doc/palette.md rename to docs/palette.md diff --git a/doc/particles.md b/docs/particles.md similarity index 98% rename from doc/particles.md rename to docs/particles.md index 28cdcdae3..aab1aa92f 100644 --- a/doc/particles.md +++ b/docs/particles.md @@ -97,7 +97,7 @@ game.add( ) ``` -You can find more examples of using different built-int particles in various combinations [here](/doc/examples/particles/lib/main.dart). +You can find more examples of using different built-int particles in various combinations [here](/docs/examples/particles/lib/main.dart). ## Lifecycle @@ -142,7 +142,7 @@ Flame ships with a few built-in `Particle` behaviors: * The `ComponentParticle`, renders Flame `Component` within a `Particle` effect * The `FlareParticle`, renders Flare animation within a `Particle` effect -More examples of using these behaviors together are available [here](/doc/examples/particles/lib/main.dart). All the implementations are available in [particles](/lib/particles) folder in Flame sources. +More examples of using these behaviors together are available [here](/docs/examples/particles/lib/main.dart). All the implementations are available in [particles](/lib/particles) folder in Flame sources. ## Translated Particle diff --git a/doc/splash_screen.md b/docs/splash_screen.md similarity index 100% rename from doc/splash_screen.md rename to docs/splash_screen.md diff --git a/doc/structure.md b/docs/structure.md similarity index 100% rename from doc/structure.md rename to docs/structure.md diff --git a/doc/text.md b/docs/text.md similarity index 97% rename from doc/text.md rename to docs/text.md index 9093b3c6b..1b21a37a2 100644 --- a/doc/text.md +++ b/docs/text.md @@ -16,7 +16,7 @@ const TextConfig config = TextConfig(fontSize: 48.0, fontFamily: 'Awesome Font', * fontSize : font size, in pts (default `24.0`) * color : the color, as a `ui.Color` (default black) -For more information regarding colors and how to create then, see the [Colors and the Palette](/doc/palette.md) guide. +For more information regarding colors and how to create then, see the [Colors and the Palette](/docs/palette.md) guide. After the creation of the config you can use its `render` method to draw some string on a canvas: diff --git a/doc/tiled.md b/docs/tiled.md similarity index 86% rename from doc/tiled.md rename to docs/tiled.md index 3a0a05697..963551505 100644 --- a/doc/tiled.md +++ b/docs/tiled.md @@ -4,4 +4,4 @@ Right now Tiled support on Flame is quite simple and it only renders the map on the screen, other advanced features are not yet supported. -You can check a working example [here](/doc/examples/tiled). +You can check a working example [here](/docs/examples/tiled). diff --git a/doc/util.md b/docs/util.md similarity index 98% rename from doc/util.md rename to docs/util.md index 116a8de34..ae5ec7239 100644 --- a/doc/util.md +++ b/docs/util.md @@ -41,11 +41,11 @@ Returns a `Future` with the dimension (`Size`) of the screen. This has to be don ### `Flame.util.addGestureRecognizer()` and `Flame.util.removeGestureRecognizer()` -These two functions help with registering (and de-registering) gesture recognizers so that the game can accept input. More about these two functions [here](/doc/input.md#Input). +These two functions help with registering (and de-registering) gesture recognizers so that the game can accept input. More about these two functions [here](/docs/input.md#Input). ### Other functions -* `text`: discussed [here](/doc/text.md) +* `text`: discussed [here](/docs/text.md) * `drawWhere`: a very simple function that manually applies an offset to the `Canvas`, render stuff given via a function and then reset the `Canvas`, without using the `Canvas`' built-in `save`/`restore` functionality. This might be useful because `BaseGame` uses the state of the canvas, and you should not mess with it. ## Timer diff --git a/doc/widgets.md b/docs/widgets.md similarity index 96% rename from doc/widgets.md rename to docs/widgets.md index adfccb1c4..9546957a9 100644 --- a/doc/widgets.md +++ b/docs/widgets.md @@ -4,7 +4,7 @@ One cool feature when developing games with Flutter is the ability to use Flutte Here you can find all the available widgets provided by Flame. -You can also see all the widgets showcased inside a [Dashbook](https://github.com/erickzanardo/dashbook) sandbox [here](/doc/examples/widgets) +You can also see all the widgets showcased inside a [Dashbook](https://github.com/erickzanardo/dashbook) sandbox [here](/docs/examples/widgets) ## Nine Tile Box diff --git a/example/README.md b/example/README.md index e2a378fec..e01b07945 100644 --- a/example/README.md +++ b/example/README.md @@ -1,3 +1,5 @@ -# position_component +# Small sample game -A sample Flame game showcasing the basic game structure and the use of PositionComponents. \ No newline at end of file +A sample Flame game showcasing the basic game structure and the use of PositionComponents. + +There are a lot more more [examples](../docs/examples) and [docs](../docs). diff --git a/example/lib/main.dart b/example/lib/main.dart index 824d11f5c..185e9e6c5 100644 --- a/example/lib/main.dart +++ b/example/lib/main.dart @@ -41,6 +41,7 @@ class Square extends PositionComponent with HasGameRef { @override void update(double t) { + super.update(t); angle += SPEED * t; angle %= 2 * math.pi; }