Repository navigation
Contributing Collections RU
hcan359 edited this page May 18, 2026
·
2 revisions
Любой может добавить готовую коллекцию в репозиторий tonkatsu-collections. Ваша коллекция станет доступна всем пользователям Tonkatsu Box через Каталог онлайн-коллекций.
- Соберите коллекцию в Tonkatsu Box
- Экспортируйте её (Меню > Экспорт - выберите
.xcollдля лёгкого или.xcollxдля полного формата) - Сделайте форк репозитория tonkatsu-collections
- Положите файл в правильную папку (см. ниже)
- Создайте Pull Request
- CI автоматически проверит файл
- После проверки - мерж!
| Тип | Расположение |
|---|---|
| По платформе (все игры SNES, лучшие RPG для NES) | platforms/{platform}/your-collection.xcoll |
| Фильмы / Сериалы / Аниме | media/{type}/your-collection.xcoll |
| Кросс-платформенные / смешанные | curated/your-collection.xcoll |
- Одна коллекция = один файл - не редактируйте несколько коллекций в одном PR
- Не редактируйте index.json - он генерируется автоматически
- Используйте правильную папку - см. таблицу выше
-
Имя файла в kebab-case -
best-rpgs.xcoll, а неBest RPGs.xcoll - Экспортируйте из Tonkatsu Box - это гарантирует правильный формат
Принимаются оба формата:
-
.xcoll(лёгкий) - только ID элементов и метаданные, маленький размер -
.xcollx(полный) - с обложками и раскладкой Canvas, работает офлайн при импорте
Полная спецификация формата: RCOLL_FORMAT.md.
Если для вашей платформы ещё нет папки:
- Создайте
platforms/{platform-id}/ - Добавьте файл
_platform.json:
{
"id": "platform-id",
"name": "Полное название платформы",
"shortName": "SHORT",
"igdbId": 123
}- Добавьте ваш файл
.xcoll/.xcollx
ID платформ IGDB можно найти в docs/IGDB_PLATFORMS.md в репозитории.
- Создайте
media/{type-id}/ - Добавьте файл
_media.json:
{
"id": "type-id",
"name": "Название типа",
"shortName": "Short",
"source": "TMDB"
}- Добавьте ваш файл
.xcoll/.xcollx
Каждый 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 в репозитории коллекций.
- Каталог онлайн-коллекций - скачивание коллекций из приложения
- Импорт / Экспорт - экспорт ваших коллекций
- Getting Started
- API Keys Setup
- Collections
- Search
- Item Details
- Personalization
- Statistics
- Canvas Board
- Wishlist
- Releases & Calendar
- Import / Export
- Data, Sync & Backup
- Browse Online Collections
- Trakt Import
- Simkl Import
- Steam Import
- RetroAchievements Import
- MyAnimeList Import
- AniList Import
- Hardcover Import
- IGDB List Import
- Kinorium Import
- Custom Cards Import
- Kodi Sync
- Tier Lists
- Mood Grid
- User Profiles
- Settings
- Self-Hosting (Web)
- Discord Rich Presence
- Contributing Collections
- FAQ
- Быстрый старт
- Настройка API ключей
- Коллекции
- Поиск
- Детали элемента
- Персонализация
- Статистика
- Визуальные доски
- Список желаний
- Релизы и календарь
- Импорт / Экспорт
- Данные, синхронизация и копии
- Каталог коллекций
- Импорт из Trakt
- Импорт из Simkl
- Импорт из Steam
- Импорт из RetroAchievements
- Импорт из MyAnimeList
- Импорт из AniList
- Импорт из Hardcover
- Импорт списка IGDB
- Импорт из Kinorium
- Импорт своих карточек
- Синхронизация Kodi
- Тир-листы
- Mood-сетка
- Профили пользователей
- Настройки
- Selfhost (веб)
- Discord Rich Presence
- Контрибуция коллекций
- FAQ
- 快速开始
- API 密钥设置
- 收藏
- 搜索
- 项目详情
- 个性化
- 统计
- 看板
- 愿望单
- 发行与日历
- 导入 / 导出
- 数据、同步与备份
- 收藏目录
- 从 Trakt 导入
- 从 Simkl 导入
- 从 Steam 导入
- 从 RetroAchievements 导入
- 从 MyAnimeList 导入
- 从 AniList 导入
- 从 Hardcover 导入
- 导入 IGDB 列表
- 从 Kinorium 导入
- 导入自定义卡片
- Kodi 同步
- 等级列表
- 心情格
- 用户配置
- 设置
- 自托管(Web)
- Discord Rich Presence
- 贡献收藏
- 常见问题
💬 Discord