https://github.com/workadventure/oitf-map-design

OITF map design
https://github.com/workadventure/oitf-map-design

Last synced: about 2 months ago
JSON representation

OITF map design

• Host: GitHub
• URL: https://github.com/workadventure/oitf-map-design
• Owner: workadventure
• License: other
• Created: 2022-02-07T12:29:18.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-28T17:06:46.000Z (10 months ago)
• Last Synced: 2024-05-01T11:41:35.435Z (8 months ago)
• Language: HTML
• Size: 73.8 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.assets

Awesome Lists containing this project

README

        
# WorkAdventure Map Starter Kit

![map](./wa-oitf-cercles.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).

## OITF Admin maps naming

- RDC / Carte 1: wa-oitf.json

- RDC / Carte 2: wa-oitf-decli1.json

- RDC / Carte 3: wa-oitf-decli2.json

- RDC / Carte 4: wa-oitf-decli3.json

- RDC / Carte 5: wa-oitf-decli4.json

- 1er étage / Cercle: wa-oitf-cercle.json

The rest of the maps are not being used at the moment.

## Structure

* *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 the tilesets

If you want to use more than one map file, just add the new map file in the root directory.

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 preview

```

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