♊️ Mirror

Valdo 626730dd16 Release 3.3.3 4 weeks ago
.github fd4c8e6324 Replace Webpack by Vite 1 year ago
public 20de50bb0c Change typo on index.html 2 months ago
src c6a834c920 Fixed clock zone and script path 5 months ago
tilesets ff50fa2a30 Updated READMEs 8 months ago
.gitignore fd4c8e6324 Replace Webpack by Vite 1 year ago
LICENSE.assets 744cb2ef9f Update third party notice and fix licence typo 1 year ago
LICENSE.code 744cb2ef9f Update third party notice and fix licence typo 1 year ago
LICENSE.map 744cb2ef9f Update third party notice and fix licence typo 1 year ago
README.md 20de50bb0c Change typo on index.html 2 months ago
conference.png 20de50bb0c Change typo on index.html 2 months ago
conference.tmj 3481c10f1c Migrated exits & entries fomr layer to areas 2 months ago
index.html 755b5d7c8f Fixed map link 4 weeks ago
map.png 20de50bb0c Change typo on index.html 2 months ago
map.tmj 3481c10f1c Migrated exits & entries fomr layer to areas 2 months ago
package-lock.json b9391f5bd4 Update plugin optimizer to 1.1.15 1 month ago
package.json 626730dd16 Release 3.3.3 4 weeks ago
tsconfig.json fd4c8e6324 Replace Webpack by Vite 1 year ago
vite.config.ts 20de50bb0c Change typo on index.html 2 months ago

README.md

WorkAdventure Map Starter Kit

map

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:

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