mirror of
https://gitlab.com/dezentrale/workadventure/maps.git
synced 2024-11-14 20:11:02 +01:00
28 lines
944 B
Markdown
28 lines
944 B
Markdown
|
# WorkAdventure Map Starter Kit
|
||
|
|
|
||
|
|
This is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re).
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
With npm installed (comes with [node](https://nodejs.org/en/)), run the following commands into a terminal in the root directory of this project:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
npm install
|
||
|
|
npm run start
|
||
|
|
```
|
||
|
|
|
||
|
|
The project will run at http://localhost:8080/
|
||
|
|
|
||
|
|
## Licenses
|
||
|
|
|
||
|
|
This project contains multiple licenses:
|
||
|
|
|
||
|
|
* [Code license](./LICENSE.code) *(all files except those for other licenses)*
|
||
|
|
* [Map license](./LICENSE.map) *(`main.json` and the map visual as well)*
|
||
|
|
* [Assets license](./LICENSE.assets) *(the files inside the `src/assets/` folder)*
|
||
|
|
|
||
|
|
### About third party assets
|
||
|
|
|
||
|
|
If you add third party assets in your map, do not forget to:
|
||
|
|
1. Credit the author and license with the "tilesetCopyright" property present in the properties of each tilesets in the `map.json` file
|
||
|
|
2. Add the license text in LICENSE.assets
|