{"id":20028731,"url":"https://github.com/workadventure/map-starter-kit","last_synced_at":"2026-01-28T10:32:39.788Z","repository":{"id":37424388,"uuid":"266410716","full_name":"workadventure/map-starter-kit","owner":"workadventure","description":"A starter kit to help you get started developing your own maps for WorkAdventure","archived":false,"fork":false,"pushed_at":"2025-12-30T10:20:51.000Z","size":4845,"stargazers_count":135,"open_issues_count":14,"forks_count":169,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-01-02T19:24:39.580Z","etag":null,"topics":["hacktoberfest","workadventure"],"latest_commit_sha":null,"homepage":"https://workadventure.github.io/map-starter-kit/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workadventure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.assets","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":"2020-05-23T20:04:43.000Z","updated_at":"2025-12-30T07:42:58.000Z","dependencies_parsed_at":"2023-11-22T19:30:26.276Z","dependency_job_id":"c135cbbc-7d87-4680-8693-18e5360e41fa","html_url":"https://github.com/workadventure/map-starter-kit","commit_stats":null,"previous_names":["workadventure/map-starter-kit","thecodingmachine/workadventure-map-starter-kit"],"tags_count":30,"template":true,"template_full_name":null,"purl":"pkg:github/workadventure/map-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workadventure%2Fmap-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workadventure%2Fmap-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workadventure%2Fmap-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workadventure%2Fmap-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workadventure","download_url":"https://codeload.github.com/workadventure/map-starter-kit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workadventure%2Fmap-starter-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28844014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T07:39:25.367Z","status":"ssl_error","status_checked_at":"2026-01-28T07:39:24.487Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["hacktoberfest","workadventure"],"created_at":"2024-11-13T09:16:16.036Z","updated_at":"2026-01-28T10:32:34.780Z","avatar_url":"https://github.com/workadventure.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🗺️ WorkAdventure Map Starter Kit\n\n\u003ca href=\"https://discord.gg/G6Xh9ZM9aR\" target=\"blank\"\u003e\u003cimg src=\"https://img.shields.io/discord/821338762134290432.svg?style=flat\u0026label=Join%20Community\u0026color=7289DA\" alt=\"Join Community Badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://x.com/workadventure_\" target=\"blank\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/workadventure_.svg?style=social\" /\u003e\u003c/a\u003e\n![visitors](https://vbr.nathanchung.dev/badge?page_id=workadventure.map-starter-kit\u0026color=00cf00)\n\n![office map thumbnail](./office.png)\n\n🗺️ This is a starter kit to help you build your own map for [WorkAdventure](https://workadventu.re).\n\n📚 To understand how to use this starter kit, follow [our tutorial](https://docs.workadventu.re/map-building/tiled-editor/).\n\n👨🏻‍🔧 If you have any questions, feel free to ask in the [WorkAdventure office](https://play.staging.workadventu.re/@/tcm/workadventure/wa-village).\n\n## 🚀 Upload your map\n\nIn the `.env` file, you can set your upload strategy to `GH_PAGES` (default) or `MAP_STORAGE`. Simply comment out the option you don't want to use.\n\nUploading a map using [GitHub Pages](https://docs.github.com/pages) will host your project on GitHub servers, and it's the most straightforward way to add new maps to your world.\n\nUploading a map using the [WA map storage](https://docs.workadventu.re/map-building/tiled-editor/publish/wa-hosted) will host your project on WA servers. It's a bit more difficult to set up, but it comes with great advantages, like being able to have private repositories.\n\n## 🗂️ Structure\n\nWe recommend following this file structure:\n\n- *`public/`*: Static files like PDFs or audio files\n- *`src/`*: Script files or design source files\n- *`tilesets/`*: All PNG tilesets\n\n\u003e [!TIP]\n\u003e - 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 *office.tmj* and editing it to avoid any mistakes).\n\u003e - We recommend using **512x512** images for the map thumbnails.\n\u003e - 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*.\n\n## 📜 Requirements\n\n- Node.js version \u003e= 18\n\n## Installation and testing\n\n## 🛠️ Installation and Testing\n\nWith npm installed (which comes with [Node.js](https://nodejs.org/en/)), run the following command in the root directory of the project:\n\n```bash\nnpm install\n```\n\nThen, you can test your map by running:\n\n```bash\nnpm run dev\n```\n\nYou can also test the optimized map as it will be in production by running:\n\n```bash\nnpm run build\nnpm run prod\n```\n\nYou can manually [upload your map to the WA Map Storage]([WA Map Storage](https://github.com/workadventure/upload-maps)) by running:\n\n```bash\nnpm run upload\n```\n\nThe three important variables that control the upload feature are:\n\n1. `MAP_STORAGE_URL` *(local: created in .env by the upload command / CI: to be added as a Github secret optionally)*\n2. `MAP_STORAGE_API_KEY` *(local: created in .env.secret by the upload command / CI: to be added as a Github secret)*\n3. `UPLOAD_DIRECTORY` *(local: created in .env by the upload command / CI: to be added as a Github secret optionally)*\n\nRead [the documentation](https://docs.workadventu.re/map-building/tiled-editor/publish/wa-hosted) to learn more about the upload feature.\n\n## 📜 Licenses\n\nThis project contains multiple licenses as follows:\n\n* [Code license](./LICENSE.code) *(all files except those for other licenses)*\n* [Map license](./LICENSE.map) *(`office.tmj` and the map visual as well)*\n* [Assets license](./LICENSE.assets) *(the files inside the `tilesets/` folder)*\n\n\u003e [!IMPORTANT]\n\u003e If you add third party assets in your map, do not forget to:\n\u003e 1. Credit the author and license of a tileset with the \"tilesetCopyright\" property by etiding the tileset in Tiled.\n\u003e 2. Add the tileset license text in *LICENSE.assets*.\n\u003e 3. Credit the author and license of a map with the \"mapCopyright\" property in the custom properties of the map.\n\u003e 4. Add the map license text in *LICENSE.map*.\n\n## ❓ Need Help\n\nIf you have any questions or need further assistance, don't hesitate to ask either by [email](mailto:hello@workadventu.re) or [Discord](https://discord.gg/G6Xh9ZM9aR)!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkadventure%2Fmap-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkadventure%2Fmap-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkadventure%2Fmap-starter-kit/lists"}