From 5a56604038172b209f601a808cc92ad40ec7daec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20N=C3=A9grier?= Date: Sun, 5 Jul 2020 19:08:37 +0200 Subject: [PATCH] Adding documentation page regarding editing your own map This commit adds a new documentation page to the website explaining how to create your own map. --- README.md | 48 ----- website/dist/choose-map.html | 10 + website/dist/create-map.html | 171 ++++++++++++++++++ website/dist/docs/create_repo.png | Bin 0 -> 162239 bytes .../dist/docs}/exit_layer_map.png | Bin website/dist/docs/github_pages.png | Bin 0 -> 74318 bytes website/dist/docs/start_layer.png | Bin 0 -> 108665 bytes .../dist/docs}/tiled_screenshot_1.png | Bin website/dist/docs/use_this_template.png | Bin 0 -> 33179 bytes website/dist/docs/website_address.png | Bin 0 -> 44610 bytes website/src/sass/_custom.scss | 3 +- 11 files changed, 183 insertions(+), 49 deletions(-) create mode 100644 website/dist/create-map.html create mode 100644 website/dist/docs/create_repo.png rename {doc/images => website/dist/docs}/exit_layer_map.png (100%) create mode 100644 website/dist/docs/github_pages.png create mode 100644 website/dist/docs/start_layer.png rename {doc/images => website/dist/docs}/tiled_screenshot_1.png (100%) create mode 100644 website/dist/docs/use_this_template.png create mode 100644 website/dist/docs/website_address.png diff --git a/README.md b/README.md index 5d2966f6..faafed98 100644 --- a/README.md +++ b/README.md @@ -36,54 +36,6 @@ Note: on some OSes, you will need to add this line to your `/etc/hosts` file: workadventure.localhost 127.0.0.1 ``` -## Designing a map - -If you want to design your own map, you can use [Tiled](https://www.mapeditor.org/). - -A few things to notice: - -- your map can have as many layers as you want -- your map MUST contain a layer named "floorLayer" of type "objectgroup" that represents the layer on which characters will be drawn. -- the tilesets in your map MUST be embedded. You cannot refer to an external typeset in a TSX file. Click the "embed tileset" button in the tileset tab to embed tileset data. -- your map MUST be exported in JSON format. You need to use a recent version of Tiled to get JSON format export (1.3+) -- WorkAdventure doesn't support object layers and will ignore them -- If you are starting from a blank map, your map MUST be orthogonal and tiles size should be 32x32. - -![](doc/images/tiled_screenshot_1.png) - -### Defining a default entry point - -In order to define a default start position, you MUST create a layer named "start" on your map. -This layer MUST contain at least one tile. The players will start on the tile of this layer. -If the layer contains many tiles selected, the players will start randomly on one of those tiles. - -### Defining exits - -In order to place an exit on your scene that leads to another scene: - -- You must create a specific layer. When a character reaches ANY tile of that layer, it will exit the scene. -- In layer properties, you MUST add "exitSceneUrl" property. It represents the map URL of the next scene. For example : `//.json`. Be careful, if you want the next map to be correctly loaded, you must check that the map files are in folder `back/src/Assets/Maps/`. The files will be accessible by url `/map/files//...`. -- In layer properties, you CAN add an "exitInstance" property. If set, you will join the map of the specified instance. Otherwise, you will stay on the same instance. -- If you want to have multiple exits, you can create many layers with name "exit". Each layer has a different key `exitSceneUrl` and have tiles that represent exits to another scene. - -![](doc/images/exit_layer_map.png) - -### Defining several entry points - -Often your map will have several exits, and therefore, several entry points. For instance, if there -is an exit by a door that leads to the garden map, when you come back from the garden you expect to -come back by the same door. Therefore, a map can have several entry points. -Those entry points are "named" (they have a name). - -In order to create a named entry point: - -- You must create a specific layer. When a character enters the map by this entry point, it will enter the map randomly on ANY tile of that layer. -- In layer properties, you MUST add a boolean "startLayer" property. It should be set to true. -- The name of the entry point is the name of the layer -- To enter via this entry point, simply add a hash with the entry point name to the URL ("#[*startLayerName*]"). For instance: "https://workadventu.re/_/global/mymap.com/path/map.json#my-entry-point". -- You can of course use the "#" notation in an exit scene URL (so an exit scene URL will point to a given entry scene URL) - - ### MacOS developers, your environment with Vagrant If you are using MacOS, you can increase Docker performance using Vagrant. If you want more explanations, you can read [this medium article](https://medium.com/better-programming/vagrant-to-increase-docker-performance-with-macos-25b354b0c65c). diff --git a/website/dist/choose-map.html b/website/dist/choose-map.html index a528ac43..7d00d885 100644 --- a/website/dist/choose-map.html +++ b/website/dist/choose-map.html @@ -38,6 +38,11 @@

CHOOSE YOUR MAP !

+
+
+

Pick a map that suits your mood! If you don't find what you need, you can always CREATE YOUR OWN map.

+
+
@@ -90,6 +95,11 @@
+
+
+

Could not find what you need? No worries, you can always CREATE YOUR OWN map.

+
+