https://github.com/workadventure/cea-deeplabverse

https://github.com/workadventure/cea-deeplabverse

workadventure

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/workadventure/cea-deeplabverse
• Owner: workadventure
• License: other
• Created: 2022-09-01T10:26:15.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T17:23:46.000Z (2 months ago)
• Last Synced: 2024-10-28T17:46:57.867Z (2 months ago)
• Topics: workadventure
• Language: HTML
• Homepage: https://valdotr.github.io/cea-deeplabverse/
• Size: 2.51 MB
• Stars: 0
• Watchers: 2
• 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

* **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](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 optimized map

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

2. Add the license text in LICENSE.assets