sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-03-20 12:11:28 -07:00
Code Issues Packages Projects Releases Wiki Activity

Clarify Yomitan external profile path for Linux GSM overlay

Browse Source 
- Document Linux GameSentenceMiner overlay default: `~/.config/gsm_overlay`
- Add inline example for `yomitan.externalProfilePath` in integration option docs
This commit is contained in:
Kyle Yasuda
2026-03-11 02:13:01 -07:00
parent 3ee71139a6
commit a64af69365
4 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
config.example.jsonc
View File

@@ -340,7 +340,7 @@
// Yomitan // Yomitan
// Optional external Yomitan profile integration. // Optional external Yomitan profile integration.
// Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode. // Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode.
// For GameSentenceMiner, the default Linux overlay profile is usually ~/.config/gsm_overlay. // For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay.
// In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings. // In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings.
// ========================================== // ==========================================
"yomitan": { "yomitan": {

2
docs-site/public/config.example.jsonc
View File

@@ -340,7 +340,7 @@
// Yomitan // Yomitan
// Optional external Yomitan profile integration. // Optional external Yomitan profile integration.
// Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode. // Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode.
// For GameSentenceMiner, the default Linux overlay profile is usually ~/.config/gsm_overlay. // For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay.
// In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings. // In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings.
// ========================================== // ==========================================
"yomitan": { "yomitan": {

2
src/config/definitions/options-integrations.ts
View File

@@ -216,7 +216,7 @@ export function buildIntegrationConfigOptionRegistry(
kind: 'string', kind: 'string',
defaultValue: defaultConfig.yomitan.externalProfilePath, defaultValue: defaultConfig.yomitan.externalProfilePath,
description: description:
'Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings.', 'Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay',
}, },
{ {
path: 'jellyfin.enabled', path: 'jellyfin.enabled',

1
src/config/definitions/template-sections.ts
View File

@@ -132,6 +132,7 @@ const INTEGRATION_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
description: [ description: [
'Optional external Yomitan profile integration.', 'Optional external Yomitan profile integration.',
'Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode.', 'Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode.',
'For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay.',
'In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings.', 'In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings.',
], ],
key: 'yomitan', key: 'yomitan',