♊️ Mirror

Alexis Faizeau 3273b61d46 Update map optimizer plugin to 1.1.2 5 days ago
.github fd4c8e6324 Replace Webpack by Vite 3 weeks ago
public eb69ff91c0 Modify folder architecture 1 week ago
src af7be2b1ec Add typing on script 2 weeks ago
tilesets 01ca1478ad Removed example folder and old assets 1 week ago
.gitignore fd4c8e6324 Replace Webpack by Vite 3 weeks ago
LICENSE.assets 744cb2ef9f Update third party notice and fix licence typo 11 months ago
LICENSE.code 744cb2ef9f Update third party notice and fix licence typo 11 months ago
LICENSE.map 744cb2ef9f Update third party notice and fix licence typo 11 months ago
README.md 4210a5e356 Update README.md 1 week ago
index.html fd4c8e6324 Replace Webpack by Vite 3 weeks ago
map.json 6ecdb1ebbf Replaced jitsi and silent layers by areas 1 week ago
map.png 6ecdb1ebbf Replaced jitsi and silent layers by areas 1 week ago
package-lock.json c19aef8e28 Update map optimizer to 1.1.1 5 days ago
package.json 3273b61d46 Update map optimizer plugin to 1.1.2 5 days ago
tsconfig.json fd4c8e6324 Replace Webpack by Vite 3 weeks ago
vite.config.ts b38159f9f6 Change base module to be relative 6 days 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

  • tilesets : All tilesets
  • public : Static files
  • src : All TypeScript/Javascript scripts
  • map.json : Map file
  • map.png : Image displayed on README.md and on the map infos in-game

If you want to use more than one map file, just add the new map file in the root folder, your tilesets in the assets folder and a new script if you need it in the src folder (it will be automaticaly optimized in production).

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 optimized map

You can test the optimized map as you do 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