Proposal: Support for user-defined prompts via external my_config.lua

[raffe1234]

Problem:
Currently, if a user adds their own custom prompts in configuration.lua, these edits are overwritten or lost when a new version of the file is released. Manually merging the config each time is error-prone and tedious.

Proposed solution:
Allow users to define their own prompts in a separate file — for example my_config.lua.
This file would be loaded automatically and merged into the main configuration.
It allows user-specific customization (extra prompts or override existing ones) that survives version upgrades.

How it works:

1. Users create a my_config.lua file in the same directory.

2. The config loader adds this snippet at the end of configuration.lua (right before return CONFIGURATION):

-- Optionally load user custom prompts from "my_config.lua"
-- Allows users to define their own prompts or override existing ones
-- without editing the main configuration file (which can be updated later).

local success, my_config = pcall(dofile, "my_config.lua")
if success and type(my_config) == "table" then
    if my_config.features and my_config.features.prompts then
        for k, v in pairs(my_config.features.prompts) do
            CONFIGURATION.features.prompts[k] = v
        end
    end
end

3. Example my_config.lua.sample:

-- my_config.lua
-- Custom prompts for the AI (text = button text in the UI).
-- system_prompt defaults to "You are a helpful assistant." if not set.
--
-- Available placeholders for user prompts:
-- {title}      : book title from metadata
-- {author}     : book author from metadata
-- {highlight}  : selected texts
-- {language}   : the `response_language` variable defined above

return {
    features = {
        prompts = {
            prompt_id_1 = {
                text = "Fact-check",
                order = 101, -- give order to buttons to fix the order of them
                system_prompt = "Fact check the text, is that really true?",
                user_prompt = "Tell me in {language} if this is really true: {highlight}",
                show_on_main_popup = true -- Show the button in main popup    
            },
            prompt_id_2 = {
                text = "Fun Fact",
                order = 102,
                system_prompt = "You are an assistant that provides fun facts related to the topic.",
                user_prompt = "Give me a fun fact about: {highlight} in {language}",
                show_on_main_popup = false -- Show the button in main popup 
            },
            -- Add more prompts here as needed
        }
    }
}

Benefits:

• User-defined prompts won't be overwritten by future updates
• Easy for users to maintain their own prompts
• Simple to implement (non-breaking change)

Feedback welcome!
I have yet not tested the code more than that it looks like it works. What do you say about the idea? Too complicated? Good? You have a better idea? Not needed?

[mtmello2003]

Very good idea. Make user customization easy.

[omer-faruq]

I also like the idea, but existing custom prompts are not intended to be permanent; rather, they serve as examples for the user. The user should be able to change or remove them freely. If these are considered standard prompts, perhaps we should add a new property, such as visible=true/false, to hide them.