This repository holds default configurations used by AsTeRICS Grid. Data from the master
branch is made available via GitHub pages, which is used by the app to download default configurations.
These are the most important files and folders of this repository:
boards
: contains single boards about specific topicscommunicators
: contains self-contained communicators (shown by default at the import page for new users in AsTeRICS Grid)live_metadata.json
: contains metadata about all boards
and communicators
, used by AsTeRICS Grid to retrieve metadata about all existing configurations.The following sections describe step-by-step how to add or alter board configurations from this repository in order to use them in AsTeRICS Grid afterwards.
In general most changes require to run npm run generate
after the changes have been applied. If you're editing the files locally and know how to run it, please do it before creating a pull request. If you're editing files directly on GitHub and creating a pull request, a maintainer of this repository will run it for you. Before running npm run generate
the first time, you need to run npm install
.
info.json
updating the metadata in a separate branch / fork (you can directly use the "edit" button in GitHub to do this)..jpg
and resolution of 1920x1080px
is recommended.npm run generate
in order to generate the updated thumbnail.jpg
out of the first screenshot.Manage grids -> more -> Save backup to file
.grd.json
in this folder with the .grd
backup file from step (3). You can rename it to .grd.json
, but don't have to, it's done automatically.Manage grids -> more -> Save backup to file
boards/UEFA Euro 2024 - John Doe
.info.json
containing metadata about the boards. See Content of info.json below for possible content of this file.1.jpg
, 2.jpg
etc.) and add them to the folder. File format .jpg
and resolution of 1920x1080px
is recommended. The first image (alphabetic order) will be copied to a lower resolution thumbnail.jpg
used for an overview of configurations.See docs about difference between multilingual and monolingual configurations.
Follow steps of Update the contents of the boards of existing configuration where step (2) is translating the configuration to a new language. For docs about how to add a translation see Translation of a multilingual default gridset in the docs.
See docs about difference between multilingual and monolingual configurations.
Follow these steps:
en
if you translated the configuration to English..grd
file resulting from (2) to the new folder (e.g. en
).info.json
or screenshots of the configuration to the new folder (e.g. en
). These files override data from the parent folder.The contents of the subfolders of boards
and communicators
are managed in the same way. The name of subfolders is not important. They (may) contain:
info.json
: information about the configuration*.img, *.png
: screenshots of the configuration (resolution should be 1920x1080
). The special image thumbnail.jpg
is automatically created from the first screenshot (alphabetic order) with a width of 500px
. It's used by AsTeRICS Grid for the preview miniature on the import page.*.grd.json
: AsTeRICS Grid backup file containing the actual configuration (*.grd
files are automatically renamed to *.grd.json
- causes use of gzip compression by GitHub pages)en
, de
, es
contain translated versions of this configuration. These folders contain an own .grd.json
backup file and may contain additional images (.png, .jpg
) or an additional info.json
which overwrite information from the base folder.Look at boards/Hora de la ducha for an example. It contains:
en
, es
, it
, pt
: containing .grd.json
files representing the backup files containing the content, translated to different languagesinfo.json
: contains metadata shared by all translated configurations of "Hora de la ducha".jpg files
: full-size screenshots shown in details modal, thumbnail.jpg
for preview in grid viewThe file info.json may contain the following properties in JSON format:
name
: the name of the configurationauthor
: the author of the configurationwebsite
: optional URL for more information about the authorlanguages
: an array of 2-digit codes of languages of this configuration, e.g. ["en", "de", "es"]
.description
: a short description of the configurationpriority
: optional integer value, where a higher value means higher priority and will cause the result be listed first in AsTeRICS Grid.wordPrediction
: optional boolean property to indicate that the configuration contains a keyboard with word prediction. This can be used in order to ask the user if they want to import a dictionary after importing.tags
: an array of tags, indicating the properties of the configuration (e.g. topic and grid size, example: ["BASIC", "4x5", "MEDICAL"]
)