Initial commit

.env

@@ -0,0 +1,9 @@
+
+# Log level (0 = none, 1 = info, 2 = verbose)
+LOG_LEVEL=1
+
+# Tileset optimization
+TILESET_OPTIMIZATION=false
+# Tileset optimization quality (0.0 - 1.0)
+TILESET_OPTIMIZATION_QUALITY_MIN=0.9
+TILESET_OPTIMIZATION_QUALITY_MAX=1.0

.github/workflows/build-and-deploy.yml

@@ -0,0 +1,40 @@
+name: Optimize map and deploy
+
+on: [ push ]
+
+permissions:
+  contents: write
+  pages: write
+  actions: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: "Install dependencies"
+        run: npm install
+
+      - name: "Build scripts"
+        run: npm run build
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        if: github.ref == 'refs/heads/master'
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: dist/ # The folder the action should deploy.
+          BASE_BRANCH: master
+
+      - name: Bash2
+        run: |
+          ls -al

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

LICENSE.assets

@@ -0,0 +1,17 @@
+ASSETS LICENSE
+
+(Notice)
+Assets distributed with a map are subject to different licenses.
+The license attributed to each tileset can be found or have to be added in the "tilesetCopyright" property of each tileset in the map.
+In addition, you have to add a section below with the specific license of the asset you want to use.
+
+
+WORKADVENTURE SPECIFIC RESOURCES LICENSE
+
+The User shall handle assets with the WorkAdventure specific resources license as follows:
+
+1. These Assets may be used only in maps produced for WorkAdventure (SAAS or self-hosted version).
+
+2. These Assets may be modified (colors or size changed, inverted, trimmed, etc.) only for purposes of use in maps produced for WorkAdventure (SAAS or self-hosted version).
+
+3. These Assets or those modified pursuant to the previous item may undergo Distribution, etc. with maps produced for WorkAdventure. Furthermore, the User may not perform Distribution, etc. of individual Assets or those modified, or Distribution, etc. in combination with programs, etc. other than the map. However, the User may duplicate, transfer, publicly transmit, or enable transmission of personally-modified Assets to other Authorized Users free of charge.

LICENSE.code

@@ -0,0 +1,12 @@
+CODE LICENSE
+
+
+MIT License
+
+Copyright (c) 2021 TheCodingMachine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,55 @@
+# 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 >=17
+
+## 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