README.md (1727B)
1 # WorkAdventure Map Starter Kit 2 3  4 5 This is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re). 6 7 To understand how to use this starter kit, follow the tutorial at [https://workadventu.re/map-building](https://workadventu.re/map-building). 8 9 ## Structure 10 * *public*: Static files like PDFs or audio files 11 * *src*: Scripts files 12 * *tilesets*: All tilesets 13 * *map.tmj*: Map file 14 * *map.png*: The map thumbnail displayed on the in-game map information 15 16 If you want to use more than one map file, just add the new map file on root or in a folder. 17 18 we recommend using 500x500 images for the map thumbnails. 19 20 If you are going to create custom websites to embed in the map, please reference the HTML files in the `input` option in *vite.config.js*. 21 22 ## Requirements 23 24 Node.js version >=17 25 26 ## Installation 27 28 With npm installed (comes with [node](https://nodejs.org/en/)), run the following commands into a terminal in the root directory of this project: 29 30 ```shell 31 npm install 32 npm run dev 33 ``` 34 35 ## Test production map 36 37 You can test the optimized map as it will be in production: 38 ```sh 39 npm run build 40 npm run prod 41 ``` 42 43 ## Licenses 44 45 This project contains multiple licenses as follows: 46 47 * [Code license](./LICENSE.code) *(all files except those for other licenses)* 48 * [Map license](./LICENSE.map) *(`map.tmj` and the map visual as well)* 49 * [Assets license](./LICENSE.assets) *(the files inside the `src/assets/` folder)* 50 51 ### About third party assets 52 53 If you add third party assets in your map, do not forget to: 54 1. Credit the author and license with the "tilesetCopyright" property present in the properties of each tilesets in the `map.tmj` file 55 2. Add the license text in LICENSE.assets