♊️ Mirror

Valdo 1593cf40f6 Added requirements for node v 3 weeks ago
.github fd4c8e6324 Replace Webpack by Vite 2 months ago
public eb69ff91c0 Modify folder architecture 2 months ago
src af7be2b1ec Add typing on script 2 months ago
tilesets 01ca1478ad Removed example folder and old assets 2 months ago
.gitignore fd4c8e6324 Replace Webpack by Vite 2 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 1593cf40f6 Added requirements for node v 3 weeks ago
index.html fd4c8e6324 Replace Webpack by Vite 2 months ago
map.json 6ecdb1ebbf Replaced jitsi and silent layers by areas 2 months ago
map.png 6ecdb1ebbf Replaced jitsi and silent layers by areas 2 months ago
package-lock.json c19aef8e28 Update map optimizer to 1.1.1 1 month ago
package.json e62cd71625 Merge branch 'master' of github.com:thecodingmachine/workadventure-map-starter-kit 1 month ago
tsconfig.json fd4c8e6324 Replace Webpack by Vite 2 months ago
vite.config.ts b38159f9f6 Change base module to be relative 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

  • 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).

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