Configuration

Creating

Enquiry will by create the configuration (./config/enquiry.conf) file after being launched for the first time.

Loading

Every time Enquiry loads, it will validate the configuration file to validate that every node it needs is there. Any nodes that it does not need will be removed. This ensures that only what it needs exists.

This has the added benefit of not requiring you to delete your configuration file if you inadvertently removed a single key or node as it will be regenerated the next time you launch your server.

Default File

Here is the default configuration output for reference...

# For details regarding this configuration file please refer to our wiki page <https://github.com/InspireNXE/Enquiry/wiki/>

engines {
    bing {
        auth {
            account-key=""
        }
        options {
            aliases=[
                bing,
                b
            ]
            style {
                line-format="&f${resultNumber}. &d${resultTitle}"
            }
        }
    }
    duckduckgo {
        options {
            aliases=[
                duckduckgo,
                ddg,
                d
            ]
            style {
                line-format="&f${resultNumber}. &d${resultTitle}"
            }
        }
    }
    google {
        auth {
            api-key=""
            search-id=""
        }
        options {
            aliases=[
                google,
                g
            ]
            style {
                line-format="&f${resultNumber}. &d${resultTitle}"
            }
        }
    }
}

Breakdown

Below is a description of what each node option is for and what type of variable it is.

Node	Description	Type
engines.bing.auth.account-key	The account key used for Bing authorization. Refer to the [[wiki page	Bing (Setup)]] for details.
engines.bing.options.aliases	The aliases to use when registering the commands for Bing's search engine.	List<String>
engines.bing.options.styles.line-format	The format to use when sending results. Supports legacy (& color codes) colors as well as ${resultTitle} and ${resultNumber}	String
engines.duckduckgo.options.aliases	The aliases to use when registering the commands for DuckDuckGo's search engine.	List<String>
engines.duckduckgo.options.styles.line-format	The format to use when sending results. Supports legacy (& color codes) colors as well as ${resultTitle} and ${resultNumber}	String
engines.google.auth.api-key	The api key used for Google authorization. Refer to the [[wiki page	Google (Setup)]] for details
engines.google.auth.search-id	The custom search engine id used for Google authorization. Refer to the [[wiki page	Google (Setup)]] for details
engines.google.options.aliases	The aliases to use when registering the commands for Google's search engine.	List<String>
engines.google.options.styles.line-format	The format to use when sending results. Supports legacy (& color codes) colors as well as ${resultTitle} and ${resultNumber}	String