{"id":17125232,"url":"https://github.com/zner0l/wa-fun-map","last_synced_at":"2026-01-05T02:53:48.307Z","repository":{"id":96915132,"uuid":"334176035","full_name":"zner0L/wa-fun-map","owner":"zner0L","description":null,"archived":false,"fork":false,"pushed_at":"2021-01-30T13:58:49.000Z","size":5082,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-29T09:45:03.652Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zner0L.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-29T14:55:26.000Z","updated_at":"2021-01-30T13:57:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"0714929a-85b6-4b5b-bdfd-aa5aa6e4e57f","html_url":"https://github.com/zner0L/wa-fun-map","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"workadventure/map-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zner0L%2Fwa-fun-map","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zner0L%2Fwa-fun-map/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zner0L%2Fwa-fun-map/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zner0L%2Fwa-fun-map/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zner0L","download_url":"https://codeload.github.com/zner0L/wa-fun-map/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245204763,"owners_count":20577405,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T18:44:29.928Z","updated_at":"2026-01-05T02:53:48.265Z","avatar_url":"https://github.com/zner0L.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WorkAdventure Map Starter Kit\n\nThis is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re).\n\n## Tools you will need\n\nIn order to build your own map for WorkAdventure, you need:\n\n- the [Tiled editor](https://www.mapeditor.org/) software\n- \"tiles\" (i.e. images) to create your map (this starter kit provides a good default tileset for offices)\n- 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)\n\n## Getting started\n\nOn the [Github repository page](https://github.com/thecodingmachine/workadventure-map-starter-kit),\nclick the **\"Use this template\"** button. You will be prompted to enter a repository name for your map.\n\n![](docs/create_repo.png)\n\nBe sure to keep the repository \"Public\".\n\nIn your newly created repository, click on the **Settings tab** and scroll down to the **GitHub Pages** section.\nThen select the **gh-pages** branch. \n\n![](docs/github_pages.png)\n\nWait a few minutes a Github will deploy a new website with the content of the repository.\nThe address of the website is visible in the \"GitHub Pages\" section.\n\n![](docs/website_address.png)\n\nClick on the link. You should be redirected directly to WorkAdventure, on your map!\n\n## Customizing your map\n\nYour map is now up and online. You need to customize it.\n\n### Cloning the map\n\nStart by cloning the map. If you are used to Git and GitHub, simply clone the map\nto your computer using your preferred tool and [jump to the next chapter](#loading-the-map-in-tiled).\n\nIf you are new to Git, cloning the map means downloading the map to your computer.\nTo do this, you will need Git, or a Git compatible tool. Our advice is to use\n[GitHub Desktop](https://desktop.github.com/).\n\nTODO: test and continue\n\n### Loading the map in Tiled\n\nThe sample map is in the file `map.json`.\nYou can load this file in [Tiled](https://www.mapeditor.org/).\n\nNow, it's up to you to edit the map and write your own map.\n\nSome resources regarding Tiled:\n\n- [Tiled documentation](https://doc.mapeditor.org/en/stable/manual/introduction/)\n- [Tiled video tutorials](https://www.gamefromscratch.com/post/2015/10/14/Tiled-Map-Editor-Tutorial-Series.aspx)\n\n### About WorkAdventu.re maps\n\nIn order to design a map that will be readable by WorkAdventure, you will have to respect some constraints.\n\nIn particular, you will need to:\n\n- set a start position for the players\n- configure the \"floor layer\" (so that WorkAdventure can correctly display characters above the floor, but under the ceiling)\n- eventually, you can place exits that link to other maps\n\nAll this is described in the [WorkAdventure documentation](https://github.com/thecodingmachine/workadventure/#designing-a-map).\nPlease be sure to check it out. \n\n### Pushing the map\n\nWhen your changes are ready, you need to \"commit\" and \"push\" the changes back to GitHub.\nJust wait a few minutes, and your map will be propagated automatically to the GitHub pages web-server.\n\nTODO: describe how to push\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzner0l%2Fwa-fun-map","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzner0l%2Fwa-fun-map","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzner0l%2Fwa-fun-map/lists"}