Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.19 KB

README.md

File metadata and controls

60 lines (35 loc) · 2.19 KB
Raw

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)
    • optionally Krita to modify tiles
  • 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

https://muccc.github.io/wa-map-club/

Click on the link. You should be redirected directly to WorkAdventure, on your map!

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.

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