Skip to content
hcan359 edited this page Sep 17, 2026 · 18 revisions

🇬🇧 English

Do I need an internet connection?

Only for searching and adding new items. Once items are in your collection, everything works offline - covers, metadata, ratings, canvas boards.

Do I need to create an account?

No. The app stores everything locally on your device. No registration, no cloud sync, no data collection.

Are API keys free?

Yes. IGDB (via Twitch), TMDB, TheTVDB and SteamGridDB all offer free API keys. VNDB, Kitsu, AniList, MangaDex, MangaBaka, TVmaze, OpenLibrary and Fantlab don't require a key at all. See API Keys Setup for details.

What interface languages are there?

English, Русский, 中文 (Simplified), Español, Português (Brasil) and Français. Switch in Settings → App Language; the whole interface changes immediately. The language of movie and TV descriptions is a separate setting (Content Language, about 45 options).

Can I use the app without any API keys?

Yes! You can import pre-made collections (.xcollx files), organize items, rate them, use canvas boards, and export collections - all without API keys. Keys are only needed for searching new items.

Download pre-made collections: tonkatsu-collections

Can I mix different media types in one collection?

Yes. A single collection can contain games, movies, TV shows, anime, visual novels, manga, books, albums and podcasts together.

How do I transfer my data to another device?

Export your collections as .xcollx files (Collections → Export) and import them on the new device. For app settings, use Settings → Database → Export/Import Configuration.

Is my data safe?

All data is stored locally on your device. The app does not send your data anywhere. Export regularly as a backup.

How do I back up my data?

All app data is stored in the Application Support directory:

Platform Path
Windows %APPDATA%\tonkatsu_box\
Linux ~/.local/share/tonkatsu_box/
Android /data/data/com.hacan359.tonkatsu_box/files/tonkatsu_box/

Full copy: copy the entire tonkatsu_box folder. This includes the data file (tonkatsu_box.db) and saved images.

Data only: copy just tonkatsu_box.db. It holds all your collections, items, ratings, canvas layouts, and settings.

To restore, replace the folder or the data file and restart the app.

Note: API keys are stored separately in system settings, not in this folder. After a clean install you'll need to enter them again.

What platforms are supported?

Windows, Linux, Android, and macOS (experimental - the build is unsigned and not yet tested by the maintainers). iOS is not supported.

Can I share collections with friends?

Yes. Export a collection as a .xcollx file and send it. The recipient imports it into their Tonkatsu Box - all items, covers, and canvas layouts transfer.

The app crashes / something doesn't work

Please open an issue on GitHub with:

  • What you were doing when it happened
  • Your platform (Windows/Linux/Android) and app version
  • A screenshot if possible
Where to get help

Join our Discord server for questions and discussions.

What is the ScreenScraper gallery on game detail screens?

ScreenScraper is a community database with extra game artwork that IGDB doesn't have - original box art (front/back, 3D), wheel/marquee art, title screens, in-game screenshots, fan art, mix renders. It covers 52 retro and modern platforms.

To enable it, register a free account on screenscraper.fr and enter your ssid and sspassword in Settings → API Keys → ScreenScraper. The developer credentials are already built into the app. Free members get 20,000 requests/day; results are cached for 30 days. See API Keys Setup#screenscraper--for-extended-game-media-optional for details.

If no gallery appears, the game's platform may not be supported or the title didn't match any ScreenScraper entry.

Can I run Tonkatsu Box in a browser?

Yes - self-host it. docker compose up -d --build on your own machine or home server, then open http://<server-ip>:8080 from any device. The database, cover cache and API keys live on the server, so every device works with the same library. Desktop-only features (VGMaps, Discord Rich Presence, Kodi, gamepad, LAN sync, profiles) are hidden in the browser. See Self-Hosting (Web).

There are no accounts or passwords in the web build - keep it on your LAN.

Is the app dark-only?

No. Settings → Appearance → Theme offers Dark and Sakura, a soft light theme with its own palette, wallpaper and accents. Switching applies instantly.

Why does the same film appear twice?

Movies are multi-source since 0.42: the same title can come from TMDB and from TheTVDB, and the two are tracked as separate entries with their own ids and covers. Switch off the provider you do not want in the Sources row on the Search screen.

Why were my movie covers re-downloaded after updating to 0.42?

The cover cache is now namespaced per provider, so a TheTVDB poster cannot overwrite the TMDB one for a film with the same number. Existing covers are fetched once more after the upgrade and then cached as before.


🇷🇺 Русский

Нужен ли интернет?

Только для поиска и добавления новых элементов. Когда элементы в коллекции - всё работает оффлайн: обложки, метаданные, оценки, доски Canvas.

Нужно ли создавать аккаунт?

Нет. Приложение хранит всё локально на вашем устройстве. Без регистрации, без облака, без сбора данных.

API ключи бесплатные?

Да. IGDB (через Twitch), TMDB, TheTVDB и SteamGridDB предоставляют бесплатные ключи. VNDB, Kitsu, AniList, MangaDex, MangaBaka, TVmaze, OpenLibrary и Fantlab вообще не требуют ключа. Подробнее: Настройка API ключей.

Какие есть языки интерфейса?

English, Русский, 中文 (упрощённый), Español, Português (Brasil) и Français. Переключается в Настройки → Язык приложения, интерфейс меняется сразу. Язык описаний фильмов и сериалов - отдельная настройка (Язык контента, около 45 вариантов).

Можно ли пользоваться без API ключей?

Да! Можно импортировать готовые коллекции (.xcollx файлы), организовывать элементы, оценивать, использовать Canvas и экспортировать - всё без ключей. Ключи нужны только для поиска новых элементов.

Скачать готовые коллекции: tonkatsu-collections

Можно ли смешивать разные типы медиа в одной коллекции?

Да. Одна коллекция может содержать игры, фильмы, сериалы, аниме, визуальные новеллы, мангу, книги, альбомы и подкасты вместе.

Как перенести данные на другое устройство?

Экспортируйте коллекции как .xcollx файлы (Коллекции → Экспорт) и импортируйте на новом устройстве. Для настроек: Настройки → База данных → Экспорт/Импорт конфигурации.

Мои данные в безопасности?

Все данные хранятся локально на вашем устройстве. Приложение не отправляет данные куда-либо. Регулярно делайте резервную копию через экспорт.

Как сделать резервную копию данных?

Все данные приложения хранятся в папке Application Support:

Платформа Путь
Windows %APPDATA%\tonkatsu_box\
Linux ~/.local/share/tonkatsu_box/
Android /data/data/com.hacan359.tonkatsu_box/files/tonkatsu_box/

Полная копия: скопируйте всю папку tonkatsu_box. В ней лежит файл данных (tonkatsu_box.db) и сохранённые обложки.

Только данные: скопируйте файл tonkatsu_box.db. В нём все коллекции, тайтлы, оценки, раскладки Canvas и настройки.

Чтобы восстановить, замените папку или файл и перезапустите приложение.

Примечание: API ключи хранятся отдельно в системных настройках, не в этой папке. После чистой установки их нужно ввести заново.

Какие платформы поддерживаются?

Windows, Linux, Android и macOS (экспериментально - сборка без подписи и пока не проверена мейнтейнерами). iOS не поддерживается.

Можно ли делиться коллекциями с друзьями?

Да. Экспортируйте коллекцию как .xcollx файл и отправьте. Получатель импортирует в свой Tonkatsu Box - все элементы, обложки и раскладка Canvas переносятся.

Приложение вылетает / что-то не работает

Пожалуйста, создайте issue на GitHub:

  • Что вы делали когда это произошло
  • Платформа (Windows/Linux/Android) и версия приложения
  • Скриншот если возможно
Контакты

Discord server

Что за галерея ScreenScraper на экране деталей игры?

ScreenScraper - это коммьюнити-база с дополнительным игровым артом, которого нет в IGDB: оригинальные обложки коробок (лицо/тыл, 3D), wheel/marquee, тайтл-экраны, скриншоты, фан-арт, mix-рендеры. Покрывает 52 ретро- и современные платформы.

Чтобы включить - зарегистрируйтесь бесплатно на screenscraper.fr и введите ssid и sspassword в Настройки → API ключи → ScreenScraper. Ключи разработчика уже зашиты в приложение. Бесплатным участникам доступно 20 000 запросов в сутки; результаты кешируются на 30 дней. Подробнее: Настройка API ключей.

Если галереи нет, либо платформа игры не поддерживается, либо название не сопоставилось ни с одной записью ScreenScraper.

Можно ли запустить Tonkatsu Box в браузере?

Да - через selfhost. docker compose up -d --build на своей машине или домашнем сервере, затем откройте http://<ip-сервера>:8080 с любого устройства. База, кеш обложек и API-ключи живут на сервере, поэтому все устройства работают с одной библиотекой. Десктопные возможности (VGMaps, Discord Rich Presence, Kodi, геймпад, синхронизация по локальной сети, профили) в браузере скрыты. См. Selfhost (веб).

В веб-сборке нет аккаунтов и паролей - держите её в локальной сети.

Приложение только тёмное?

Нет. Настройки → Оформление → Тема предлагает Тёмную и Сакуру - мягкую светлую тему с собственной палитрой, обоями и акцентами. Переключение применяется мгновенно.

Почему один и тот же фильм появляется дважды?

С версии 0.42 фильмы мультиисточниковые: один и тот же тайтл может прийти из TMDB и из TheTVDB, и они ведутся как отдельные записи со своими id и обложками. Выключите ненужный источник в ряду «Источники» на экране поиска.

Почему после обновления до 0.42 обложки фильмов перекачались?

Кеш обложек теперь разделён по источникам, чтобы постер из TheTVDB не перезаписал постер из TMDB для фильма с тем же номером. Существующие обложки один раз скачиваются заново, а дальше кешируются как обычно.

🏠 Home


🇬🇧 English


🇷🇺 Русский


🇨🇳 中文


💬 Discord

Clone this wiki locally