♊️ Mirror

Nolway e50ebbdca5 Update vite map optimizer to 1.1.13 5 days ago
.github fd4c8e6324 Replace Webpack by Vite 8 months ago
maps cb70ce6582 Change map file extension 5 days ago
public ff50fa2a30 Updated READMEs 4 months ago
src c6a834c920 Fixed clock zone and script path 1 month ago
tilesets ff50fa2a30 Updated READMEs 4 months ago
.gitignore fd4c8e6324 Replace Webpack by Vite 8 months 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 790a206988 Fix README typo 1 month ago
index.html 0bdac920e9 Change map handling 1 month ago
package-lock.json e50ebbdca5 Update vite map optimizer to 1.1.13 5 days ago
package.json e50ebbdca5 Update vite map optimizer to 1.1.13 5 days ago
tsconfig.json fd4c8e6324 Replace Webpack by Vite 8 months ago
vite.config.ts 0bdac920e9 Change map handling 1 month 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

  • maps: Map files
    • map.(json/tmj): Map file
    • map.png: The map thumbnail displayed on the in-game map information
  • public: Static files like PDFs
  • src: Source files like scripts or PSDs.
  • tilesets: All tilesets

If you want to use more than one map file, just add the new map file in the /maps folder.

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 preview

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.json file
  2. Add the license text in LICENSE.assets