Tankōbon / shared/settings / AppSettings
Interface: AppSettings
Defined in: shared/settings.ts:142
Preferences, persisted key by key (see SettingsRepository): per user in the user_settings table, except the SHARED_SETTINGS, which every user shares in the settings table.
Properties
addOpenedBooksToLibrary
addOpenedBooksToLibrary:
boolean
Defined in: shared/settings.ts:153
Whether opening a book adds it to the library when it isn't there yet. Off, a book that isn't in the library is read anonymously: nothing is saved, and it reopens from its first page.
askUserOnStartup
askUserOnStartup:
boolean
Defined in: shared/settings.ts:199
Whether the app starts on a screen where the user picks who is reading. Shared, since it is read before anyone is chosen; the screen's "don't ask again" box turns it off.
checkUpdatesOnStartup
checkUpdatesOnStartup:
boolean
Defined in: shared/settings.ts:201
Whether the app asks GitHub at every start if a newer release exists, and offers to download it.
comicVineApiKey
comicVineApiKey:
string
Defined in: shared/settings.ts:188
Personal Comic Vine API key (free, from comicvine.gamespot.com/api); Comic Vine refuses requests without one.
comicVineEnabled
comicVineEnabled:
boolean
Defined in: shared/settings.ts:186
Whether metadata lookups query Comic Vine (only when comicVineApiKey is set too).
googleBooksApiKey
googleBooksApiKey:
string
Defined in: shared/settings.ts:192
Optional Google Books API key; without one, requests share Google's anonymous quota.
googleBooksEnabled
googleBooksEnabled:
boolean
Defined in: shared/settings.ts:190
Whether metadata lookups query Google Books.
homeEnabled
homeEnabled:
boolean
Defined in: shared/settings.ts:169
Whether the home page exists: off, the sidebar has no "Accueil" entry and the app starts on the library.
homeSections
homeSections:
HomeSectionSetting[]
Defined in: shared/settings.ts:174
The home page's blocks in display order, each shown or hidden. A block missing from the list (added by a later release) is appended, shown; see isHomeSections.
language
language:
LanguageSetting
Defined in: shared/settings.ts:144
Interface language: one forced by the user, or system to follow the OS (English when it isn't supported).
lastResyncAt
lastResyncAt:
string
Defined in: shared/settings.ts:203
When the last resynchronization finished (ISO 8601); empty when there has been none.
lastScanFolder
lastScanFolder:
string
Defined in: shared/settings.ts:231
Folder last added with "Ajouter un dossier…" (empty before the first one): where the next folder dialog opens.
libraryFileName
libraryFileName:
string
Defined in: shared/settings.ts:229
Name given to the files the organization moves, without the extension: text with {series}, {volume}, {title}, {year} and {author} fields (see fillFileNameTemplate()), for example {series} - T{volume} - {title}. Empty (the default), a file keeps its original name. Like libraryStructure, changing it renames nothing by itself.
libraryGroupBySeries
libraryGroupBySeries:
boolean
Defined in: shared/settings.ts:159
Whether the library list is grouped by series, each series behind a heading that can be folded.
libraryOrganization
libraryOrganization:
LibraryOrganization
Defined in: shared/settings.ts:210
Library organization: off leaves the files where they are; otherwise the comics added (a file, a folder, a resynchronization) can be moved into libraryOrganizationFolder, laid out as libraryStructure says: ask offers it after each addition, always does it without asking. A comic found directly in that folder is always moved, unless off.
libraryOrganizationFolder
libraryOrganizationFolder:
string
Defined in: shared/settings.ts:215
Folder the library organization moves the comics into (empty until one is chosen). Set only by the main process, through a folder dialog (library:pick-organization-folder): settings:set refuses it.
librarySort
librarySort:
"lastOpened"|"addedDesc"|"addedAsc"|"releaseDesc"|"releaseAsc"|"titleAsc"|"titleDesc"
Defined in: shared/settings.ts:164
Order of the library list when it isn't grouped by series: lastOpened (most recently opened first), by date added, by release date (books without one last) or by title, each both ways.
libraryStructure
libraryStructure:
LibraryLevel[]
Defined in: shared/settings.ts:222
Tree of the organized folder, from its first level down (see isLibraryStructure): for example ['letter', 'series'] puts Tintin T01.cbz in T/Tintin/. Empty (the default), each comic gets its own subfolder named after the file and its library id. Changing it moves nothing by itself: "Organiser toute la bibliothèque…" moves the comics to their new place.
libraryView
libraryView:
LibraryView
Defined in: shared/settings.ts:155
How the library shows its books: how much each row shows, or a grid of covers (see LibraryView).
pageSpacing
pageSpacing:
number
Defined in: shared/settings.ts:182
Gap in pixels between pages in continuous mode (0 = pages touch).
readerBackground
readerBackground:
string
Defined in: shared/settings.ts:184
CSS color behind the pages in the reader (any <input type="color"> value, i.e. #rrggbb).
readingDirection
readingDirection:
"ltr"|"rtl"
Defined in: shared/settings.ts:148
Page-turn direction: left-to-right (BD/comics) or right-to-left (manga).
readingListView
readingListView:
BookRowView
Defined in: shared/settings.ts:157
How much each row of a reading list's page shows, set apart from the library's (see BookRowView).
readingMode
readingMode:
"single"|"continuous"
Defined in: shared/settings.ts:180
single: one page at a time. continuous: pages flow one after another in a vertical scroll.
resyncOnStartup
resyncOnStartup:
boolean
Defined in: shared/settings.ts:194
Whether the library is resynchronized with its folders in the background at every start.
scrollDirection
scrollDirection:
"standard"|"inverted"
Defined in: shared/settings.ts:178
Mouse/trackpad wheel direction in the reader: scrolling down advances or retreats a page.
sidebarCollapsed
sidebarCollapsed:
boolean
Defined in: shared/settings.ts:176
Whether the sidebar is collapsed to an icon-only rail.
theme
theme:
"system"|"light"|"dark"
Defined in: shared/settings.ts:146
Color scheme of the interface (the reader's background has its own setting, AppSettings.readerBackground).