EscapeShip

This is a starter kit to help you build your own map for WorkAdventure.

To understand how to use this starter kit, follow the tutorial at https://workadventu.re/map-building.

Structure

• public: Static files like PDFs or audio files
• src: Scripts files
• tilesets: All tilesets
• map.tmj: Map file
• map.png: The map thumbnail displayed on the in-game map information

If you want to use more than one map file, just add the new map file on root or in a folder.

we recommend using 500x500 images for the map thumbnails.

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.

Requirements

Node.js version >=16

Installation

With npm installed (comes with node), run the following commands into a terminal in the root directory of this project:

npm install
npm run dev

Test production map

You can test the optimized map as it will be in production:

npm run build
npm run prod

Licenses

This project contains multiple licenses as follows:

• Code license (all files except those for other licenses)
• Map license (map.tmj and the map visual as well)
• Assets license (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.tmj file
2. Add the license text in LICENSE.assets