mirror of
https://github.com/willmiao/ComfyUI-Lora-Manager.git
synced 2026-09-20 18:51:26 -03:00
chore: keep settings.json.example minimal and document the rule
The example now only carries use_portable_settings, civitai_api_key and the four core folder_paths keys (loras/checkpoints/unet/embeddings). Optional keys such as the other-model folders, default_*_root and auto_organize_exclusions are removed; their defaults live in DEFAULT_SETTINGS and reach the user's settings.json on demand. AGENTS.md now forbids adding optional/default keys to the example unless the user explicitly asks for it.
This commit is contained in:
@@ -190,6 +190,8 @@ The system runs in two modes:
|
|||||||
|
|
||||||
- `py/config.py` manages folder paths for models and handles symlink mappings
|
- `py/config.py` manages folder paths for models and handles symlink mappings
|
||||||
- Auto-saves paths to `settings.json` in ComfyUI mode
|
- Auto-saves paths to `settings.json` in ComfyUI mode
|
||||||
|
- `settings.json.example` is intentionally minimal (see Important Notes); all
|
||||||
|
other defaults live in `DEFAULT_SETTINGS` (`py/services/settings_manager.py`)
|
||||||
|
|
||||||
### Frontend UI Architecture
|
### Frontend UI Architecture
|
||||||
|
|
||||||
@@ -250,6 +252,12 @@ If a cross-layer issue ever needs a live server, the sandboxed helpers live in
|
|||||||
## Important Notes
|
## Important Notes
|
||||||
|
|
||||||
- ALWAYS use English for comments (per copilot-instructions.md)
|
- ALWAYS use English for comments (per copilot-instructions.md)
|
||||||
|
- **`settings.json.example` must stay minimal**: only `use_portable_settings`,
|
||||||
|
`civitai_api_key`, and the four core `folder_paths` keys (`loras`,
|
||||||
|
`checkpoints`, `unet`, `embeddings`). Do NOT add optional/default keys
|
||||||
|
(model-category folders, `default_*_root`, `auto_organize_exclusions`, etc.)
|
||||||
|
to this file unless the user explicitly asks for it. Defaults belong in
|
||||||
|
`DEFAULT_SETTINGS` in `py/services/settings_manager.py`.
|
||||||
- Run `python scripts/sync_translation_keys.py` after adding UI strings to `locales/en.json`
|
- Run `python scripts/sync_translation_keys.py` after adding UI strings to `locales/en.json`
|
||||||
- Symlinks require normalized paths.
|
- Symlinks require normalized paths.
|
||||||
**Business paths vs real paths**: All stored paths and operation routing use the
|
**Business paths vs real paths**: All stored paths and operation routing use the
|
||||||
|
|||||||
+1
-15
@@ -17,20 +17,6 @@
|
|||||||
"embeddings": [
|
"embeddings": [
|
||||||
"C:/path/to/your/embeddings_folder",
|
"C:/path/to/your/embeddings_folder",
|
||||||
"C:/path/to/another/embeddings_folder"
|
"C:/path/to/another/embeddings_folder"
|
||||||
],
|
|
||||||
"vae": [
|
|
||||||
"C:/path/to/your/vae_folder"
|
|
||||||
],
|
|
||||||
"upscale_models": [
|
|
||||||
"C:/path/to/your/upscale_models_folder"
|
|
||||||
],
|
|
||||||
"text_encoders": [
|
|
||||||
"C:/path/to/your/text_encoders_folder"
|
|
||||||
],
|
|
||||||
"clip_vision": [
|
|
||||||
"C:/path/to/your/clip_vision_folder"
|
|
||||||
]
|
]
|
||||||
},
|
}
|
||||||
"default_other_roots": {},
|
|
||||||
"auto_organize_exclusions": []
|
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user