Документация

Всё, что нужно для запуска и сопровождения ядра.

Установка

Требуется Docker 24+ или Linux с ядром 5.15+. Ядро не хранит состояние вне каталога /data.

docker run -d --name gamingcore \
  -p 8080:8080 \
  -v /srv/gamingcore:/data \
  ghcr.io/gamingcore/gamingcore:latest

Конфигурация

Файл /data/config.yaml читается при старте. Неуказанные значения берутся по умолчанию.

listen: 0.0.0.0:8080
data_dir: /data

log:
  level: info
  format: json

limits:
  max_instances: 32
  cpu_per_instance: 2
  memory_per_instance: 2GiB

metrics:
  enabled: true
  path: /metrics

GraphQL API

Схема доступна по адресу /graphql. Аутентификация — заголовок Authorization: Bearer <token>.

curl -s http://localhost:8080/graphql \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN' \
  -d '{"query":"{ instances { id name state players } }"}'

Мутации startInstance, stopInstance и restartInstance возвращают текущее состояние процесса.

Метрики

Эндпоинт /metrics совместим с Prometheus. Основные ряды:

Плагины

Плагин — отдельный исполняемый файл, который регистрируется в каталоге /data/plugins и общается с ядром по gRPC. Протокол описан в pkg/plugin.