https://github.com/bfncs/workadventure-map-ms
https://github.com/bfncs/workadventure-map-ms
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bfncs/workadventure-map-ms
- Owner: bfncs
- Created: 2020-11-27T21:03:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-24T18:54:40.000Z (about 5 years ago)
- Last Synced: 2025-08-17T04:33:06.826Z (10 months ago)
- Language: HTML
- Homepage: https://play.workadventu.re/_/global/bfncs.github.io/workadventure-map-ms/map.json
- Size: 39.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WorkAdventure Map Starter Kit
## 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).
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](https://desktop.github.com/).
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](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
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