https://github.com/webfreak001/jlcompanion
Unofficial fan-made companion app for the JetLag: The Game Hide & Seek card game
https://github.com/webfreak001/jlcompanion
Last synced: 4 months ago
JSON representation
Unofficial fan-made companion app for the JetLag: The Game Hide & Seek card game
- Host: GitHub
- URL: https://github.com/webfreak001/jlcompanion
- Owner: WebFreak001
- License: mit
- Created: 2025-01-02T00:38:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-02T00:40:58.000Z (over 1 year ago)
- Last Synced: 2026-02-01T23:56:31.425Z (6 months ago)
- Language: TypeScript
- Homepage: https://jlcompanion.webfreak.org/
- Size: 14.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unofficial JetLag Hide & Seek Companion App
Currently early WIP
Goals:
- support for fully offline
- ability to play with friends that don't use the app
- be close to the show
## OSM Data
Currently most OSM data in the repo is excluded due to file sizes, you can generate it using the WIP scripts in `preprocess` or try to get the files from my deployed instance (e.g. `public/railways.pmtiles`)
This is currently still changing how I want to deploy it though, so don't rely on downloading it or the data you have exported already, since it's going to change a few times.
You can also ask me on discord for help.
## Core Technology
Maps:
- [turf.js](https://turfjs.org/) - implements all needed GeoJSON / polygon manipulation features, used heavily
- data: [OpenStreetMap](https://openstreetmap.org)
- rendering: [MapLibre](https://maplibre.org/) (fork of MapTiler/MapBox GL JS)
- server-less map serving [PMTiles](https://docs.protomaps.com/pmtiles/) (might be able to export extracts that can be fully offline cached)
- [tippecanoe](https://github.com/felt/tippecanoe) - rendering GeoJSON shapes to map-loadable vector tiles (currently for debugging)
- Planetiler / [Protomaps' config](https://github.com/protomaps/basemaps) for generating vector tiles from OSM (vendor-less, so only OSM attribution required)
See [preprocess](./preprocess/) for scripts converting data from OSM into POIs (heavily WIP).
Everything else:
- basic react app, using react-icons