WorkAdventure Map Starter Kit
This is a starter kit to help you build your own map for WorkAdventure.
Tools you will need
In order to build your own map for WorkAdventure, you need:
- the Tiled editor software
- "tiles" (i.e. images) to create your map (this starter kit provides a good default tileset for offices)
- a web-server to serve your map (this starter kit proposes to use Github static pages as a web-server which is both free and performant)
Getting started
- Download this repository (Click Code and Download Zip) or use the GitHub Desktop client (Highly recommended!)
- Open the map.json file in Tiled
- Make the changes you want
- Submit them to this repository. Pull requests are lovely for that, but if you want to make it easier just send me a message somewhere with the files you have updated attached. You can also create an "issue" and upload the files there.
Customizing your map
Your map is now up and online. You need to customize it.
Cloning the map
Start by cloning the map. If you are used to Git and GitHub, simply clone the map to your computer using your preferred tool and jump to the next chapter.
If you are new to Git, cloning the map means downloading the map to your computer. To do this, you will need Git, or a Git compatible tool. Our advice is to use GitHub Desktop.
TODO: test and continue
Loading the map in Tiled
The sample map is in the file map.json
.
You can load this file in Tiled.
Now, it's up to you to edit the map and write your own map.
Some resources regarding Tiled:
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. Please be sure to check it out.
Pushing the map
When your changes are ready, you need to "commit" and "push" the changes back to GitHub. Just wait a few minutes, and your map will be propagated automatically to the GitHub pages web-server.
TODO: describe how to push