Cross-component documentation for the GeoGami platform. Audience-first: start with the document that matches your role.
- Platform Overview — what the platform consists of, how a study flows through it (design → run → analyze → export), what data is recorded, and how access works. Start here.
- Glossary — definitions of every platform term: games, tasks, tracks, map settings, roles, …
- Track Data Reference — the structure of exported track JSON files, field by field, for analysis in R/Python.
- Dashboard User Guide — step-by-step guide to analyzing and exporting track data.
How-to guides for the study workflow:
- Create a game as a study instrument — environment/mode choices, tasks, experimental controls, piloting.
- Run a virtual study session — session checklist, multiplayer, VR headsets, remote participants, troubleshooting.
- Export and analyze track data — from dashboard download to tidy data frames, with R and Python starters.
- Developer Overview — system architecture, REST and Socket.IO contracts, data model, and how to run the full stack locally. Start here.
- REST API Reference — every HTTP endpoint of the server: auth requirements, payloads, responses, gotchas.
- Socket.IO Event Reference — every real-time event between app, server, and virtual environment: payloads, directions, rooms model.
Each component repository has its own README with setup, configuration, and deployment instructions:
- geogami — Angular/Ionic mobile & web client
- origami-backend — Node/Express + Socket.IO backend
- geogami-dashboard — R Shiny analytics dashboard
- geogami-virtual-environment-dev — Unity 3D virtual environment