Added color codes and more info about dbibackend

This commit is contained in:
rashevskyv 2023-02-17 16:37:27 +02:00
parent 7ed5d9471e
commit 5514493da2
2 changed files with 79 additions and 13 deletions

View File

@ -14,7 +14,7 @@
1. [Интерфейс](#интерфейс)
1. [Управление](#управление)
1. [Browse SD Card/Browse USB0 Drive](#browse-sd-card--browse-usb0-drive)
1. [Install title from USB](#install-title-from-usb)
1. [Install title from DBIbackend](#install-title-from-dbibackend)
1. [Home server](#home-server)
1. [Browse installed applications](#browse-installed-applications)
* [Контекстное меню тайтла](#контекстное-меню-тайтла)
@ -30,6 +30,7 @@
1. [Уведомления и коды ошибок](#уведомления-и-коды-ошибок)
1. [Уведомления](#уведомления)
1. [Ошибки](#ошибки)
1. [Цветовые кода](#цветовые-коды)
1. [dbi.config](#dbiconfig)
1. [Другие возможности](#другие-возможности)
1. [Благодарности](#благодарности)
@ -46,7 +47,7 @@
![2021041010520200](https://user-images.githubusercontent.com/18294541/114262830-d7643e00-99ea-11eb-8dbb-c8e0996577e5.jpg)
* **Browse SD Card** — установка `NSP`/`NSZ`/`XCI`/`XCZ`-файлов из карты памяти.
* **Browse USB0 Drive** — установка `NSP`/`NSZ`/`XCI`/`XCZ`-файлов с внешнего USB-накопителя в exFAT/FAT32: флешки, жёсткого диска, проч.
* **Install title from USB** — установка `NSP`/`NSZ`/`XCI`/`XCZ` из ПК по USB 2.0 и 3.0-проводу, через прилагаемую программу dbibackend. *Горячая клавиша для этой опции*: кнопка **(Y)**.
* **Install title from DBIbackend** — установка `NSP`/`NSZ`/`XCI`/`XCZ` из ПК по USB 2.0 и 3.0-проводу, через прилагаемую программу dbibackend. *Горячая клавиша для этой опции*: кнопка **(Y)**.
* **Install title from Gamecard** — этот пункт появляется при вставленном в Switch игровом картридже, — для установки игры из имеющегося игрового картриджа в microSD-карту или внутреннюю NAND-память консоли.
* **Home server** — начиная с версии v150, есть возможность устанавливать игры по сети (HTTP), через WiFi без провода или LAN-USB-адаптер. Подробнее об этом ниже
* **Browse installed applications** — просмотр установленных игр, их общее установленное количество, посмотреть потраченное время на игру и количество её запусков, проверить (верифицировать) на ошибки, перенести игровые данные между встроенной памятью, картой памяти и обратно, возможность их выборочного или потокового удаления вместе с прилагаемыми LayeredFS-модами, просмотр наличия у них обновлений и DLC, ручное удаление DLC/обновлений/LaryeredFS (LFS) мода, функция Reset Required version для сброса системной проверки обновления у выбранной игры. *Горячая клавиша для этой опции*: кнопка **(L)**.
@ -65,7 +66,7 @@
* **(А)** - выбор, подтверждение
* **(B)** - отмена. **На главном экране** - выход из программы
* **(X)** - выделение файла. **На главном экране** - горячая клавиша для монтирования MTP (пункт меню "**Run MTP responder**")
* **(Y)** - инвертировать выделение, выделить всё, если ничего не выделено. **На главном экране** - установка по USB с помощью dbibackend (пункт меню "**Install title from USB**")
* **(Y)** - инвертировать выделение, выделить всё, если ничего не выделено. **На главном экране** - установка по USB с помощью dbibackend (пункт меню "**Install title from DBIbackend**")
* **(ZL)**, **(ZR)** - быстрое перемещение по меню
* **(L)** **на главном экране** - перейти в меню "**Browse installed applications**"
* **(R)** - изменить порядок отображения файлов/тайтлов
@ -93,17 +94,30 @@
Вы можете запускать `.NRO`-файлы кнопкой **(A)**
### Install title from USB
### Install title from DBIbackend
Через Install title from USB очень удобно устанавливать игры, обновления и DLC к ним сразу напрямую по USB-проводу с ПК на Switch, минуя необходимость вынимать карту и тратить двойное время, закачивая дистрибутивы (`NSP`/`NSZ`/`XCI`/`XCZ`-файлы) на карту памяти и устанавливая их оттуда. *Горячая клавиша для вызова этой опции из главного меню*: кнопка **(Y)**.
Через "**Install title from DBIbackend**" очень удобно устанавливать игры, обновления и DLC к ним сразу напрямую по USB-проводу с ПК на Switch, минуя необходимость вынимать карту и тратить двойное время, закачивая дистрибутивы (`NSP`/`NSZ`/`XCI`/`XCZ`-файлы) на карту памяти и устанавливая их оттуда. *Горячая клавиша для вызова этой опции из главного меню*: кнопка **(Y)**.
Для работы сперва нужно скачать на ПК dbibackend (`dbibackend.exe` для Windows или `dbibackend` для всех ОС), запустить его, выбрать игры для установки, нажать **Start server**, затем подключить USB-C кабель к ПК и Switch, выбрать пункт **Install title from USB** в dbi и установить все необходимые игры.
Для работы сперва нужно скачать на ПК dbibackend (`dbibackend.exe` для Windows или `dbibackend` для всех ОС), запустить его, выбрать игры для установки, нажать **Start server**, затем подключить USB-C кабель к ПК и Switch, выбрать пункт **Install title from DBIbackend** в dbi и установить все необходимые игры.
Для правильной работы dbibackend на Windows, необходимо поставить драйвера "**libusbK (v3.1.0.0)**". Их можно установить через программу [Zadig](https://zadig.akeo.ie/), введя DBI в режим "**Install title from DBIbackend**" и выбрав в программе появившееся устройство.
Выделение файлов, а так же их установка происходит способом идентичным способу из пункта **Browse SD Card/Browse USB0 Drive**
Для быстрой отправки файлов или папок с играми на установку, нажмите на них правой клавишей мыши, выберите `Отправить > dbibackend`, установочные файлы сразу помещаются в очередь dbibackend. Для того, чтобы это настроить в Windows, нажмите `Win+R`, введите `shell:sendto`, положите в папку ярлык для `dbibackend.exe`
Существуют альтернативные клиенты для работы с DBIbackend, например [headless-реализация](https://github.com/cyb3rwarden/dbibackend/blob/0885ef67edf28cbca30fb2c193ad7ab9a62786f7/dbibackend/dbibackend.py), [NSW-DBI 2.0.0 на nodegui](https://4pda.to/forum/index.php?showtopic=939714&st=6080#entry100701109) (требуется установка драйвера libusb для Linux или WinUSB (libusb) для Windows через Zadig).
Вы можете передавать команды скрипту путем запуска его из командной строки с последующим указанием пути к необходимой для установки игры или игр. Например:
```
python ~/dbi/dbibackend ~/Switch/File1.nsp ~/Switch/File2.nsp ~/Switch/File3.nsp
```
```
dbibackend.exe "e:\Switch\Games\File1.nsp" "e:\Switch\Games\File2.nsp" "e:\Switch\Games\File3.nsp"
```
#### Зависимости, которые могут потребоваться для работы в MacOS или Linux
```bash
@ -343,6 +357,25 @@ Unin**stalled games** — сохранения от удалённых игр,
* **SOME CONTENTS ARE MISSING. APPLICATION WILL BE UNUSABLE** — контейнер неполный, проверьте целостность установочного файла игры.
* **«Invalid personalized ticket»**, в конце установки игры при инсталлировании .tik-тикета — некорректный дамп игры, где вместо common-тикета остался персонализированный с той консоли, на которой была куплена игра; скачайте другой, корректный дамп.
* **«No ES или других sigpatches»** — не все/устаревшие/некорректно/не установлены сигпатчи на консоли, установите их самую новейшую версию.
### Цветовые коды:
* Общее
* WHITE on BLACK BG - файл в фокусе
* BLUE - выделенный файл (кнопкой (X))
* В меню "**Browse SD Card**"
* WHITE - папка
* LIGHT GREY - файл
* DARK GREY - установленная игра
* GREEN - обновление и/или DLC для уже установленной игры
* В меню "**Browse installed applications**"
* WHITE - установленная игра
* RED - установлен апдейт и/или DLC, без самой игры
* **В логах** при установке:
* GREEN - завершено без ошибок
* YELLOW - завершено без ошибок, но с предупреждениями, например, о том, что установленный файл - конверт с картриджа, или о том, что в META был исправлен хеш
* RED - [ошибка](#ошибки). Файл не был установлен.
## dbi.config
Файл dbi.config был добавлен, начиная с версии 253. Он находится рядом с DBI.nro, и заменяет прежние файлы-флаги dbi.default.ascii и dbi.network.config, а также добавляет несколько новых опций для удобной кастомизации настроек под пользователя.
@ -531,7 +564,7 @@ Screenshots=sdmc:/Nintendo/Album/
* **BrowseSystem** - возможнеость просматривать и копировать файлы из раздела SYSTEM
* **BrowseUser** - возможнеость просматривать и копировать файлы из раздела USER
* **USBHost** - пункт "**Browse USB0 Drive**, для установки игр с внешнего USB
* **BackendInstall** - пункт "**Install title from USB**, для устаноки игр с ПК через backend
* **BackendInstall** - пункт "**Install title from DBIbackend**, для устаноки игр с ПК через backend
* **GameCard** - пункт "**Install title from Gamecard**, для установки содержимого картриджа в память консоли
* **Network** - пункт "**Home server**, для установки игр с домашнего веб-сервера
* **Local** - показывать или нет ссылки на папки из раздела [Local sources](#local-sources)

View File

@ -14,7 +14,7 @@ The ultimate solution to install `NSP`, `NSZ`, `XCI` and `XCZ` and work with Nin
1. [Interface](#interface)
1. [Buttons](#buttons)
1. [Browse SD Card / Browse USB0 Drive](#browse-sd-card--browse-usb0-drive)
1. [Install title from USB](#install-title-from-usb)
1. [Install title from DBIbackend](#install-title-from-dbibackend)
1. [Home server](#home-server)
1. [Browse installed applications](#browse-installed-applications)
* [Titles Context menu](#title-context-menu)
@ -30,6 +30,7 @@ The ultimate solution to install `NSP`, `NSZ`, `XCI` and `XCZ` and work with Nin
1. [Warnings and Errors](#warnings-and-errors)
1. [Warnings](#warnings)
1. [Errors](#errors)
1. [Color codes](#color-codes)
1. [dbi.config](#dbiconfig)
1. [Other options](#other-options)
1. [Acknowledgements](#acknowledgements)
@ -46,7 +47,7 @@ Copy `dbi.nro` and `dbi.config` to your SD card at `sdmc:/switch/DBI/` DBI can b
![2021041010520200](https://user-images.githubusercontent.com/18294541/114262830-d7643e00-99ea-11eb-8dbb-c8e0996577e5.jpg)
* **Browse SD Card** - installation of NSP/NSZ/XCI/XCZ files from your SD card
* **Browse USB0 Drive** - installation of NSP/NSZ/XCI/XCZ files from an external FAT32 or exFAT formatted USB drive (will only appear if a USB drive is connected)
* **Install title from USB** - installation of NSP/NSZ/XCI/XCZ from a PC via USB 2.0 or 3.0 cable using the included dbibackend script. *Main menu hotkey for this option*: **(Y)** button
* **Install title from DBIbackend** - installation of NSP/NSZ/XCI/XCZ from a PC via USB 2.0 or 3.0 cable using the included dbibackend script. *Main menu hotkey for this option*: **(Y)** button
* **Install title from Gamecard** - install a game from gamecard to the console's internal NAND or SD card (will only appear if a gamecard is inserted)
* **Home server** - install games over your local network (HTTP) using a LAN USB adapter or WiFi network. For full details see **[Home server](#home-server)**
* **Browse installed applications** - view installed titles including base, update, DLC and whether or not a LayeredFS mod is present. Launch titles directly. Displays your total play time and how many times you've launched the title. Check file integrity for errors, transfer game data between internal NAND and SD card, delete individual or multiple titles and their LayeredFS mods with one click, individually remove updates and DLC and use the `Reset Required version` function to restore the system update check for the selected game back to base. *Main menu hotkey for this option*: **(L)** button
@ -66,7 +67,7 @@ Bottom center (dbi: XXX) is the DBI version number - you should always use the m
* **(А)** - select or confirm
* **(B)** - cancel, exits the program **from the main menu**
* **(X)** - file selection, hotkey for mounting MTP **on the main menu** (menu option "**Run MTP responder**")
* **(Y)** - invert selection (selects everything if nothing is selected), hotkey for launching USB installation via dbibackend **on the main menu** (menu option "**Install title from USB**")
* **(Y)** - invert selection (selects everything if nothing is selected), hotkey for launching USB installation via dbibackend **on the main menu** (menu option "**Install title from DBIbackend**")
* **(ZL)** and **(ZR)** - scroll pages in menus, scroll through individual games when in detailed game menu
* **(L)** - **on the main menu** the hotkey for the menu option "**Browse installed applications**"
* **(R)** - change the displayed sort order of files/titles
@ -94,18 +95,32 @@ Press the **(A)** button to confirm. A window with installation options will app
You can also navigate to your homebrew files and launch .nro files directly by highlighting them and pressing **(A)**.
### Install title from USB
### Install title from DBIbackend
If you cannot use DBI's MTP responder this is another convenient method for installing titles over USB. Installing over USB allows you to transfer files directly from your PC for example, which avoids the inconvenience and of having to first move the file to your SD card and then install it.
*Main menu hotkey for this option*: **(Y)** button
In order to use this option you will first require dbibackend (`dbibackend.exe` for Windows, or the `dbibackend` script for all operating systems). Launch dbibackend, select the files to install, select Start server, connect a USB-C cable from your PC to your Switch and select **Install title from USB** in DBI.
In order to use this option you will first require dbibackend (`dbibackend.exe` for Windows, or the `dbibackend` script for all operating systems). Launch dbibackend, select the files to install, select Start server, connect a USB-C cable from your PC to your Switch and select **Install title from DBIbackend** in DBI.
For proper operation of dbibackend on Windows, you need to install the "**libusbK (v3.1.0.0)**" drivers. They can be installed through the [Zadig program](https://zadig.akeo.ie/) by entering DBI into the "**Install title from DBIbackend**" mode and selecting the device that appears in the program.
From here you can select and install your files on the Switch in the same fashion as using Browse SD Card/Browse USB0 Drive.
To quickly send files or folders with games for installation, right-click on them, select `Send from dbibackend` and the installation files will be immediately placed in dbibackend's queue. To configure this in Windows, press `Win + R`, enter `shell: sendto` and create a shortcut for `dbibackend.exe` in the folder.
There are alternative clients for working with DBIbackend, for example [headless implementation](https://github.com/cyb3rwarden/dbibackend/blob/0885ef67edf28cbca30fb2c193ad7ab9a62786f7/dbibackend/dbibackend.py), [NSW-DBI 2.0.0 on nodegui](https://4pda.to/forum/index.php?showtopic=939714&st=6080#entry100701109) (requires installation of libusb driver for Linux or WinUSB (libusb) for Windows via Zadig).
You can pass commands to the script by running it from the command line and then specifying the path to the game or games you need to install. For example:
```
python ~/dbi/dbibackend ~/Switch/File1.nsp ~/Switch/File2.nsp ~/Switch/File3.nsp
```
```
dbibackend.exe "e:\Switch\Games\File1.nsp" "e:\Switch\Games\File2.nsp" "e:\Switch\Games\File3.nsp"
```
#### Dependencies that may be required to run on MacOS or Linux
```bash
@ -349,6 +364,24 @@ Exit - closes DBI and returns to either to hbmenu or bypasses hbmenu to go direc
* **"Invalid personalized ticket"** - a dump of the game where instead of a common-ticket a personalized ticket from the console on which the game was purchased was included, obtain a proper dump
* **"No ES or other sigpatches"** - missing, outdated or bad sigpatches, obtain and install the latest versions to the correct locations
### Color codes:
* In all menus
* WHITE on BLACK BG - focused
* BLUE - selected (with (X) button)
* In "**Browse SD Card**"
* WHITE - folder
* LIGHT GREY - file
* DARK GREY - installed game
* GREEN - update or DLC for installed game
* In "**Browse installed applications**"
* WHITE - installed game
* RED - installed update or DLC without game
* **In logs** on installation:
* GREEN - no errors
* YELLOW - no errors, but warnings (for example, installed NSP is XCI convert, or hash was fixed on meta)
* RED - [errors](#errors). File was not installed
## dbi.config
The `dbi.config` file was added starting with version 253. It is located next to DBI.nro and replaces the old flags files `dbi.default.ascii` and `dbi.network.config` and also adds several new options for easy customization of settings for the user.
@ -534,7 +567,7 @@ Screenshots=sdmc:/Nintendo/Album/
* **BrowseSystem** - browse and copy files from SYSTEM partition
* **BrowseUser** - browse and copy files from USER partition
* **USBHost** - display **Browse USB0 Drive**, to install games from a external USB drive if connected
* **BackendInstall** - display **Install title from USB**, for installing games from PC via dbibackend
* **BackendInstall** - display **Install title from DBIbackend**, for installing games from PC via dbibackend
* **GameCard** - display **Install title from Gamecard**, to install a game from an inserted gamecard to your console
* **Network** - display **Home server**, to install games from a configured home web server
* **Local** - show or not links to folders from the section [Local sources](#local-sources)