Skip to content

Commit

Permalink
Fix map-building doc link and update README intructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ValdoTR committed May 17, 2024
1 parent c0faff6 commit 69bb661
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,44 @@

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).
To understand how to use this starter kit, follow the tutorial at [https://docs.workadventu.re/map-building/tiled-editor/](https://docs.workadventu.re/map-building/tiled-editor/).

## Structure
* *public*: Static files like PDFs or audio files
* *src*: Scripts files
* *tilesets*: All tilesets

We recommend following this file structure:

* *public/*: Static files like PDFs or audio files
* *src/*: Scripts files or design source files
* *tilesets/*: All PNG tilesets
* *map.tmj*: Map file
* *map.png*: The map thumbnail displayed on the in-game map information
* *map.png*: The map thumbnail used as meta-data

If you want to use more than one map file, just add the new map file on root or in a folder.
If you want to use more than one map file, just add the new map file in the root folder ( we recommend creating a copy of *map.tmj* and editing it, in order to avoid any mistakes).

we recommend using 500x500 images for the map thumbnails.
We recommend using 512x512 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 >=17

## Installation
## Installation and testing

With npm installed (comes with [node](https://nodejs.org/en/)), run the following commands into a terminal in the root directory of this project:
With npm installed (comes with [node](https://nodejs.org/en/)), run the following commands into a terminal in the root directory of the project:

```shell
npm install
```

Then, you can test your map by running:

```sh
npm run dev
```

## Test production map
You can also test the optimized map as it will be in production by running:

You can test the optimized map as it will be in production:
```sh
npm run build
npm run prod
Expand All @@ -51,5 +58,6 @@ 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.tmj` file
2. Add the license text in LICENSE.assets

0 comments on commit 69bb661

Please sign in to comment.