Compare commits
43 commits
4f8c94a9c8
...
9163389a01
| Author | SHA1 | Date | |
|---|---|---|---|
|
9163389a01 | ||
|
|
07b6845f44 | ||
|
|
d2b101c2cb | ||
|
|
65836737c1 | ||
|
|
a856b6227c | ||
|
|
e7269eb638 | ||
|
|
d024ca9c98 | ||
|
|
105614bb7c | ||
|
|
521d11da98 | ||
|
|
137811aa5e | ||
|
|
349533c77d | ||
|
|
0b092d6793 | ||
|
|
ae065ea342 | ||
|
|
fe5ba6ae68 | ||
|
|
b023419956 | ||
|
|
cf00b11d2a | ||
|
|
d68e2e1905 | ||
|
|
bad2b98c27 | ||
|
|
6f7bc3c820 | ||
|
|
7dbb7cee64 | ||
|
|
ba21e38d5a | ||
|
|
6d387fda2d | ||
|
|
f53e0ce6c8 | ||
|
|
5117019bfd | ||
|
|
bab44c70f4 | ||
|
|
e2158b0fb5 | ||
|
|
9a0d25d3c8 | ||
|
|
aa4d1c7e07 | ||
|
|
d34c617e3f | ||
|
|
4ea9cf62b0 | ||
|
|
6626518fe5 | ||
|
|
c6e927d441 | ||
|
|
77b8879942 | ||
|
|
9739c380fd | ||
|
|
dfac5ad251 | ||
|
|
6dcc74af24 | ||
|
|
753aac4a82 | ||
|
|
47af88ee5b | ||
|
|
0d26b1e133 | ||
|
|
538c934216 | ||
|
|
44e95ec696 | ||
|
|
47331e6839 | ||
|
|
4697c47272 |
12 changed files with 1623 additions and 0 deletions
79
leinelab/README.md
Normal file
79
leinelab/README.md
Normal file
|
|
@ -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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
BIN
leinelab/docs/create_repo.png
Normal file
BIN
leinelab/docs/create_repo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 158 KiB |
BIN
leinelab/docs/github_pages.png
Normal file
BIN
leinelab/docs/github_pages.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 175 KiB |
BIN
leinelab/docs/website_address.png
Normal file
BIN
leinelab/docs/website_address.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
BIN
leinelab/drinks_leinelab.png
Normal file
BIN
leinelab/drinks_leinelab.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8 KiB |
BIN
leinelab/floors_leinelab.png
Normal file
BIN
leinelab/floors_leinelab.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 787 B |
BIN
leinelab/floortileset.png
Normal file
BIN
leinelab/floortileset.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
20
leinelab/index.html
Normal file
20
leinelab/index.html
Normal file
|
|
@ -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.wa-test.rc3.cccv.de/_/global/'+window.location.host+path+'main.json';
|
||||||
|
document.getElementById('mapLink').href = url;
|
||||||
|
document.getElementById('mapLink').innerText = url;
|
||||||
|
};
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
This website contains a map for <a href="https://howto.rc3.world/">rc3</a>.
|
||||||
|
<br/>
|
||||||
|
You can access this map at <a id="mapLink" href=""></a>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
BIN
leinelab/kallax_leinelab.png
Normal file
BIN
leinelab/kallax_leinelab.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
1524
leinelab/main.json
Normal file
1524
leinelab/main.json
Normal file
File diff suppressed because one or more lines are too long
BIN
leinelab/objects_leinelab.png
Normal file
BIN
leinelab/objects_leinelab.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
BIN
leinelab/tilesets_deviant_milkian_1.png
Normal file
BIN
leinelab/tilesets_deviant_milkian_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Loading…
Reference in a new issue