{"id":21275704,"url":"https://github.com/halimath/battlemap","last_synced_at":"2025-03-15T13:13:51.940Z","repository":{"id":146620453,"uuid":"440892589","full_name":"halimath/battlemap","owner":"halimath","description":"Virtual table top (VTT) battlemap editor","archived":false,"fork":false,"pushed_at":"2022-05-04T17:19:02.000Z","size":550,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-22T03:27:53.167Z","etag":null,"topics":["battlemap","tabletop","vtt"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/halimath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-12-22T14:54:40.000Z","updated_at":"2022-02-05T13:22:52.000Z","dependencies_parsed_at":"2023-06-26T01:43:58.334Z","dependency_job_id":null,"html_url":"https://github.com/halimath/battlemap","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halimath%2Fbattlemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halimath%2Fbattlemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halimath%2Fbattlemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halimath%2Fbattlemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/halimath","download_url":"https://codeload.github.com/halimath/battlemap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243732303,"owners_count":20338839,"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":["battlemap","tabletop","vtt"],"created_at":"2024-11-21T09:36:30.733Z","updated_at":"2025-03-15T13:13:51.920Z","avatar_url":"https://github.com/halimath.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# battlemap\n\n[![CI Status](https://github.com/halimath/battlemap/workflows/CI/badge.svg)](https://github.com/halimath/battlemap/actions/workflows/ci.yml)\n[![CD Status](https://github.com/halimath/battlemap/workflows/CD/badge.svg)](https://github.com/halimath/battlemap/actions/workflows/cd.yml)\n\nA virtual table top (VTT) web-based battle map editor and viewer for playing role-playing games remotely, \nspecificially targetting [Fate Core](https://www.evilhat.com/home/fate-core/) (but works with any rpg).\n\n## About\n\nThis repo contains a web application that supports people playing any kind of _Fate Core_ based role playing\ngame remotely using whatever video conferencing tool they like. This app provides a battle map for easier\nhandling of combat situations.\n\nThe app allows the Game Master (GM) to draw a scene (with support for touch devices and stylus pens), draw\n\"zones\" (which are important in Fate) and place tokens which can be moved around. The drawing canvas has\ninfinite size so the combat can evolve in whatever direction the story advances. Players can join the map\nand view it allowing them to move the scene and zoom in/out. All changes made by the GM are reflected in the\nplayers view.\n\n# Development\n\nThe backend is implemented using Golang. The frontend is implemented using TypeScript and the \n[wecco framework](https://github.com/weccoframework/core). Almost all CSS is coming from \n[Tailwind](https://tailwindcss.com/) with minimal CSS being written to embed the Fate Core font for displaying\ndice results. The battlemap editor and viewer are created as a separate module and are published as web\ncomponents for easy embedding in other apps. The canvas drawing is handled by [`@halimath/scenic](./scenic)\nwhich is contained in this repo but intentions are to move it to its own repo once feature set and maturity\nare relatively stable.\n\n## Local Environment\n\nFor being able to develop the app, you should have a local install of\n* Golang \u003e= 1.18beta2\n* Node v16\n* NPM (\u003e=8.1)\n\nYou should also have an IDE which supports TypeScript. VSCode works perfectly, IntelliJ IDEA works,\ntoo. I haven't tried other IDEs, but the should work the same.\n\nTo start development, you need to open four terminal (tabs) for each of the following directories:\n* scenic\n* battlemap\n* app\n* backend\n\nRun the following command in each of the first three terminals:\n\n```shell\n$ npm i\n$ npm start\n```\n\nand run \n\n```shell\n$ go run .\n```\n\nin the third one. This will start the dev server and bring up the app on `localhost:3000`. The backend runs on\n`localhost:8080` but only the rest api backend part is needed.\n\n## CI/CD\n\nAll parts of the application are wrapped in a single OCI container build with `docker`. The container build \nuses multiple stages and builds the whole app as part of the container build. The final container will only \ncontain the compiled application, though.\n\nWe use [Github Actions](https://github.com/features/actions) to build the application, run the tests, build\nthe container image and publish it to [https://ghcr.io](https://github.com/features/packages).\n\n# License\n\nCopyright 2021, 2022 Alexander Metzner.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalimath%2Fbattlemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhalimath%2Fbattlemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalimath%2Fbattlemap/lists"}