Skip to content

Contributing Collections RU

hcan359 edited this page May 18, 2026 · 2 revisions

Контрибуция коллекций

Любой может добавить готовую коллекцию в репозиторий tonkatsu-collections. Ваша коллекция станет доступна всем пользователям Tonkatsu Box через Каталог онлайн-коллекций.

Простой способ

  1. Соберите коллекцию в Tonkatsu Box
  2. Экспортируйте её (Меню > Экспорт - выберите .xcoll для лёгкого или .xcollx для полного формата)
  3. Сделайте форк репозитория tonkatsu-collections
  4. Положите файл в правильную папку (см. ниже)
  5. Создайте Pull Request
  6. CI автоматически проверит файл
  7. После проверки - мерж!

Куда класть файл

Тип Расположение
По платформе (все игры SNES, лучшие RPG для NES) platforms/{platform}/your-collection.xcoll
Фильмы / Сериалы / Аниме media/{type}/your-collection.xcoll
Кросс-платформенные / смешанные curated/your-collection.xcoll

Правила

  1. Одна коллекция = один файл - не редактируйте несколько коллекций в одном PR
  2. Не редактируйте index.json - он генерируется автоматически
  3. Используйте правильную папку - см. таблицу выше
  4. Имя файла в kebab-case - best-rpgs.xcoll, а не Best RPGs.xcoll
  5. Экспортируйте из Tonkatsu Box - это гарантирует правильный формат

Форматы файлов

Принимаются оба формата:

  • .xcoll (лёгкий) - только ID элементов и метаданные, маленький размер
  • .xcollx (полный) - с обложками и раскладкой Canvas, работает офлайн при импорте

Полная спецификация формата: RCOLL_FORMAT.md.

Добавление новой платформы

Если для вашей платформы ещё нет папки:

  1. Создайте platforms/{platform-id}/
  2. Добавьте файл _platform.json:
{
  "id": "platform-id",
  "name": "Полное название платформы",
  "shortName": "SHORT",
  "igdbId": 123
}
  1. Добавьте ваш файл .xcoll/.xcollx

ID платформ IGDB можно найти в docs/IGDB_PLATFORMS.md в репозитории.

Добавление нового типа медиа

  1. Создайте media/{type-id}/
  2. Добавьте файл _media.json:
{
  "id": "type-id",
  "name": "Название типа",
  "shortName": "Short",
  "source": "TMDB"
}
  1. Добавьте ваш файл .xcoll/.xcollx

CI-валидация

Каждый pull request автоматически проверяется:

  • Формат файла (должен быть XcollFile v2)
  • Обязательные поля: name, author, created
  • Каждый элемент должен иметь media_type и external_id
  • Нет дубликатов
  • Имя файла в kebab-case
  • ZIP-файлы: проверка на path traversal, лимиты размера, корректное содержимое

После мержа index.json перегенерируется автоматически.

Идеи для коллекций

  • Лучшие игры конкретного десятилетия (80-е, 90-е, 2000-е)
  • По жанрам (метроидвании, шутеры, файтинги)
  • Региональные эксклюзивы (только Япония, только PAL)
  • Игры с определёнными фичами (кооп, 4 игрока, link cable)
  • Персональные подборки «лучшее»
  • Челленджи (пройди эти 12 игр за 2026 год)
  • Лучшие фантастические фильмы, хоррор-сериалы, фильмы Studio Ghibli

Вопросы?

Создайте issue в репозитории коллекций.

Смотрите также

🏠 Home


🇬🇧 English


🇷🇺 Русский


🇨🇳 中文


💬 Discord

Clone this wiki locally