Settings Overview - theRAPTLab/gsgo GitHub Wiki
After installing the development tools, you need to configure your local development (if you're coding) or production (if you're a researcher setting a 'game server') environment before running the simulation.
Generally you'll want to do four things:
- Set up Local Settings
- Set up Local Assets
- Connect Pozyx to GEMSTEP (optional)
- Connect PTrack to GEMSTEP (optional)
Here's an overview of what they are. There are four key types of settings to configure. The settings are stored either in the "Locale" or "Local" settings:
- Transforms for Pozyx and PTrack -- Defines the transforms used to convert Pozyx and PTrack tracking data into world coordinates. These are defined in
Locale
settings. - Tracking Server URL -- Defines the IP address of the Pozyx and PTrack servers. This is defined in
Local
settings. - Project Folder -- Defines the file path of the local project folder. This is defined in
Local
settings. - Local Assets -- A collection of projects, project templates, and sprites that are available to load and run. This is defined in
Local
settings.
"Locale" settings are settings pecular to a specific physical location's set up of Pozyx and PTrack system.
- Defines the Pozyx and PTrack transforms that map Pozyx/PTrack inputs into the game world, e.g. X-Scale, Y-Scale, Rotation, Offsets.
- The currently selected
**localeId**
is saved in the browser's LocalStorage so that the locale is automatically read each time the browser is started. - You can select and change the locale via the "tracker" button on Main.
- This information is stored in the
dbinit-loki.json
database, which is stored locally on the server computer. It is not saved to the repo, nor is it easily shared among servers. - Currently there is no UI for creating a new Locale. The easiest way to do this is to edit the
dbinit-loki.json
file. See instructions for creating one in !150.
For more information, see !150.
"Local" settings are generally overrides of default values defined by the system. "Local" settings allow you to configure each server differently from each other without clobbering the default values in the repo.
- Defines the server file path of the folder that contains the project and sprite data that should be made available to students (Local Assets).
- Generally, you would update this whenever you switch classrooms/study groups. The rationale for this design is that this enables us to show and hide projects for particular groups of participants.
- Also defines the MQTT (Pozyx) and PTrack server URLs. Generally you would only need to update the URLs if the Pozyx or PTrack servers change their IP addresses.
See Setup Local Settings for instructions.
"Local" assets refer to the collection of projects, templates, and sprites that are made available to users for loading and running.
- The default location of the Local Assets folder can be changed via Local Settings (see above).
- "Local" assets provide students with access to a collection of projects and resources for all users of the system. You can have different sets of "Local" assets for different classrooms/periods/study groups.
See Setup Local Assets for instructions.