diff --git a/doc/README.md b/doc/README.md index f45e6aed5..b4f515ecc 100644 --- a/doc/README.md +++ b/doc/README.md @@ -12,6 +12,7 @@ This is the index of the documentation for Flame, updated to version `0.8.3`. * [Components](components.md) * [The Game Loop](game.md) * [Input](input.md) +* [Tiled](tiled.md) * [Util](util.md) * [Box2d](box2d.md) * [Debug](debug.md) diff --git a/doc/tiled.md b/doc/tiled.md new file mode 100644 index 000000000..28648f7db --- /dev/null +++ b/doc/tiled.md @@ -0,0 +1,7 @@ +# Tiled + +[Tiled](https://www.mapeditor.org/) is an awesome tool to design level and maps. Flame bundles a [dart package](https://pub.dev/packages/tiled) that parses tmx files and implements a very simple component for the map renderization. + +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](examples/tiled).