https://github.com/workadventure/wam-preset-school

https://github.com/workadventure/wam-preset-school

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/workadventure/wam-preset-school
• Owner: workadventure
• License: other
• Created: 2023-04-28T15:16:39.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-29T13:41:44.000Z (9 months ago)
• Last Synced: 2024-05-01T11:41:41.886Z (8 months ago)
• Language: HTML
• Homepage: https://workadventure.github.io/wam-preset-school/
• Size: 3.34 MB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.assets

Awesome Lists containing this project

README

        
# WorkAdventure Map Starter Kit

![map](./map.png)

This is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re).

To understand how to use this starter kit, follow the tutorial at [https://workadventu.re/map-building](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](https://nodejs.org/en/)), run the following commands into a terminal in the root directory of this project:

```shell

npm install

npm run dev

```

## Test production map

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

```sh

npm run build

npm run prod

```

## Licenses

This project contains multiple licenses as follows:

* [Code license](./LICENSE.code) *(all files except those for other licenses)*

* [Map license](./LICENSE.map) *(`map.tmj` and the map visual as well)*

* [Assets license](./LICENSE.assets) *(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