Skip to content

Commit

Permalink
doc: add general infos about Tiled
Browse files Browse the repository at this point in the history
  • Loading branch information
adrien-bon committed Sep 13, 2024
1 parent 16c0f37 commit 7bb7b0a
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ See the [examples](./examples/README.md) for more advanced use cases.

If you can contribute, please do!

If you would like to contribute but don't know where to start, [read this discussion](https://github.com/adrien-bon/bevy_ecs_tiled/discussions/1).
If you would like to contribute but don't know where to start, [read this section in the book](https://adrien-bon.github.io/bevy_ecs_tiled/misc/contributing.html).

## LICENSE

Expand Down
8 changes: 8 additions & 0 deletions book/src/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# FAQ

## What is the current status of the crate ?

While the crate is already definitely usable, it is still under active development.

Expect bugs and missing features !

I plan to follow semver and try to only break API upon new Bevy release.

## What kind of maps are supported ?

Currently, we support :
Expand Down
2 changes: 1 addition & 1 deletion book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Design and explanation

- [Why using Tiled ?]()
- [Why using Tiled ?](design/why-tiled.md)
- [Entities tree and component markers]()
- [Layers Z-ordering]()

Expand Down
20 changes: 20 additions & 0 deletions book/src/design/why-tiled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Why using Tiled ?

[Tiled](https://www.mapeditor.org/) may feel a bit outdated in terms of "look and feel", especially when compared with more modern map editor tools like [LDTK](https://ldtk.io/).
However it has **a lot** of features which make it very interesting.

If we compare with [LDTK](https://ldtk.io/), they both have a set of powerful features like:

- auto-tiling
- adding gameplay informations to map tiles and objects
- working with worlds

But [Tiled](https://www.mapeditor.org/) also have a set of unique features:

- support for both isometric and hexagonal maps
- native support for animated tiled

Since I specifically wanted to work with hexagonal maps the choice was obvious for me!

However, if it's not your case and you just want to use orthogonal map, you could give a shot at using [LDTK](https://ldtk.io/) instead, especially using the [`bevy_ecs_ldtk` crate](https://github.com/Trouv/bevy_ecs_ldtk).
Or stay with [Tiled](https://www.mapeditor.org/), it also works :)

0 comments on commit 7bb7b0a

Please sign in to comment.