From 830cd284dd84584b58c1715ac91445a00567b360 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20N=C3=A9grier?= Date: Sun, 24 May 2020 15:43:50 +0200 Subject: [PATCH] Some more doc --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0608eca..e2d659e 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,28 @@ TODO: test and continue ### Loading the map in Tiled -TODO +The sample map is in the file `map.json`. +You can load this file in [Tiled](https://www.mapeditor.org/). + +Now, it's up to you to edit the map and write your own map. + +Some resources regarding Tiled: + +- [Tiled documentation](https://doc.mapeditor.org/en/stable/manual/introduction/) +- [Tiled video tutorials](https://www.gamefromscratch.com/post/2015/10/14/Tiled-Map-Editor-Tutorial-Series.aspx) + +### About WorkAdventu.re maps + +In order to design a map that will be readable by WorkAdventure, you will have to respect some constraints. + +In particular, you will need to: + +- set a start position for the players +- configure the "floor layer" (so that WorkAdventure can correctly display characters above the floor, but under the ceiling) +- eventually, you can place exits that link to other maps + +All this is described in the [WorkAdventure documentation](https://github.com/thecodingmachine/workadventure/#designing-a-map). +Please be sure to check it out. ### Pushing the map