Initial commit

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

@@ -0,0 +1,40 @@
+name: Optimize map and deploy
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Optimize map
+        uses: thecodingmachine/map-optimizer-action@master
+
+      - name: Bash
+        run: |
+          ls -al
+          git config --global user.email "d.negrier@thecodingmachine.com"
+          git config --global user.name "David Négrier"
+          git checkout master
+          git commit -am "Adding files"
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: . # The folder the action should deploy.
+          BASE_BRANCH: master
+
+      - name: Bash2
+        run: |
+          ls -al

README.md

@@ -0,0 +1,79 @@
+# WorkAdventure Map Starter Kit
+
+This is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re).
+
+## Tools you will need
+
+In order to build your own map for WorkAdventure, you need:
+
+- the [Tiled editor](https://www.mapeditor.org/) software
+- "tiles" (i.e. images) to create your map (this starter kit provides a good default tileset for offices)
+- a web-server to serve your map (this starter kit proposes to use Github static pages as a web-server which is both free and performant)
+
+## Getting started
+
+On the [Github repository page](https://github.com/thecodingmachine/workadventure-map-starter-kit),
+click the **"Use this template"** button. You will be prompted to enter a repository name for your map.
+
+![](docs/create_repo.png)
+
+Be sure to keep the repository "Public".
+
+In your newly created repository, click on the **Settings tab** and scroll down to the **GitHub Pages** section.
+Then select the **gh-pages** branch. 
+
+![](docs/github_pages.png)
+
+Wait a few minutes a Github will deploy a new website with the content of the repository.
+The address of the website is visible in the "GitHub Pages" section.
+
+![](docs/website_address.png)
+
+Click on the link. You should be redirected directly to WorkAdventure, on your map!
+
+## Customizing your map
+
+Your map is now up and online. You need to customize it.
+
+### Cloning the map
+
+Start by cloning the map. If you are used to Git and GitHub, simply clone the map
+to your computer using your preferred tool and [jump to the next chapter](#loading-the-map-in-tiled).
+
+If you are new to Git, cloning the map means downloading the map to your computer.
+To do this, you will need Git, or a Git compatible tool. Our advice is to use
+[GitHub Desktop](https://desktop.github.com/).
+
+TODO: test and continue
+
+### Loading the map in Tiled
+
+The sample map is in the file `map.json`.
+You can load this file in [Tiled](https://www.mapeditor.org/).
+
+Now, it's up to you to edit the map and write your own map.
+
+Some resources regarding Tiled:
+
+- [Tiled documentation](https://doc.mapeditor.org/en/stable/manual/introduction/)
+- [Tiled video tutorials](https://www.gamefromscratch.com/post/2015/10/14/Tiled-Map-Editor-Tutorial-Series.aspx)
+
+### About WorkAdventu.re maps
+
+In order to design a map that will be readable by WorkAdventure, you will have to respect some constraints.
+
+In particular, you will need to:
+
+- set a start position for the players
+- configure the "floor layer" (so that WorkAdventure can correctly display characters above the floor, but under the ceiling)
+- eventually, you can place exits that link to other maps
+
+All this is described in the [WorkAdventure documentation](https://github.com/thecodingmachine/workadventure/#designing-a-map).
+Please be sure to check it out. 
+
+### Pushing the map
+
+When your changes are ready, you need to "commit" and "push" the changes back to GitHub.
+Just wait a few minutes, and your map will be propagated automatically to the GitHub pages web-server.
+
+TODO: describe how to push

index.html

@@ -0,0 +1,20 @@
+<html>
+    <head>
+        <script>
+            window.onload = function() {
+                var path = window.location.pathname;
+                if (path.endsWith('index.html')) {
+                    path = path.substr(path, path.length - 'index.html'.length);
+                }
+                var url = 'https://play.workadventu.re/_/global/'+window.location.host+path+'map.json';
+                document.getElementById('mapLink').href = url;
+                document.getElementById('mapLink').innerText = url;
+            };
+        </script>
+    </head>
+    <body>
+        This website contains a map for <a href="https://workadventu.re">Workadventu.re</a>.
+        <br/>
+        You can access this map at <a id="mapLink" href=""></a>
+    </body>
+</html>