Термины Racelink — Документация

Оверлей и где он показывается

Оверлей: Небольшая веб-страница, которую Racelink показывает поверх игры: таблица, спидометр, карта. Ваш проект — это один оверлей.
Макет: Набор оверлеев с их местами и размерами на экране. У игрока может быть несколько макетов, например для гонки и для тренировки, и он переключается между ними.
Экземпляр: Одна копия оверлея в макете. Игрок может добавить один оверлей несколько раз; у каждой копии свои настройки и размер.
Режим редактирования: Время, когда игрок двигает и растягивает оверлеи макета. Оверлей знает об этом и может показать подсказки.
Ссылка для OBS: Адрес оверлея для источника «Браузер» в OBS: стрим видит тот же оверлей с теми же данными.
Превью: Короткий показ оверлея на демо-данных: в окне «Добавить оверлей» и анимацией на странице в Мастерской.

Данные

Телеметрия: Данные игры: скорость, педали, круги, положение машин, погода и всё остальное, что Racelink отдаёт оверлеям.
Блок данных (topic): Группа связанных значений, которые приходят вместе: car — педали, скорость, передача; timing — времена кругов; drivers — все машины сессии. В коде и API такой блок называется topic. Список всех блоков — в справочнике полей.
Поле: Одно значение внутри блока данных, например скорость speedKph в блоке car.
Путь: Адрес поля: блок и поле через точку, car.speedKph. Скобки [] означают список: drivers[].lastLapSeconds — последний круг каждой машины.
Общее поле и поле одной игры: Общее поле есть во всех играх, где игра его даёт (газ, времена кругов). Поле одной игры лежит в ext.<игра>, например iRating в ext.iracing.
null: Значение «нет данных»: игра это значение не даёт или оно ещё не пришло.
Демо-данные: Выдуманная гонка, которую Racelink или SDK показывают вместо игры: чтобы делать оверлей без запущенной игры.
Запись сессии: Файл с данными настоящей гонки, который Racelink может проиграть оверлеям вместо игры (Проверка на записях сессий).

Инструменты

Overlay API: Служба внутри Racelink, которая отдаёт оверлеям данные и настройки. Работает только на компьютере игрока.
SDK: npm-пакет @racelink/overlay: подключается к Overlay API, хранит последние данные, даёт типы и команды сборки. Ваш код общается с Racelink через него.
Манифест: Файл racelink.overlay.json в корне проекта: имя, версия, игры, размер, настройки и разрешения оверлея.
Настройки: То, что игрок меняет в панели оверлея: цвета, единицы, что показывать. Вы описываете их в манифесте.
Действие: Настройка типа binding: игрок назначает на неё клавишу или кнопку руля, а оверлей реагирует на нажатие.
Разрешение: Доступ сверх обычного (музыка, сообщения Steam, интернет), который оверлей просит, а игрок даёт или нет.
Dev-сервер: То, что запускает npm run dev: страница оверлея на вашем компьютере, которая обновляется при каждом сохранении. Racelink видит её сам.
Пакет: Готовый оверлей, папка dist/ после npm run build. Именно он уходит в Мастерскую и к игрокам.
Studio: Вкладка Racelink для авторов: проекты, проверка, данные API, превью и публикация. Включается в Настройках, раздел «Для разработчиков», или в меню по правому клику на заголовке окна.
Мастерская: Мастерская Steam: там игроки находят и ставят оверлеи, а вы их публикуете.