Difference between revisions of "sys.txt"
Jump to navigation
Jump to search
Technology (talk | contribs) (add control file: sys.txt) |
|||
| Line 1: | Line 1: | ||
| − | ==Syntax== | + | Openkore system configuration file. |
| + | |||
| + | == Syntax == | ||
Entries in this file follows the key-value format. The key-value format is outright simple. Each line contains a configuration key as the first word, followed by the value: | Entries in this file follows the key-value format. The key-value format is outright simple. Each line contains a configuration key as the first word, followed by the value: | ||
<sys key> <value> | <sys key> <value> | ||
| − | ==Details== | + | === Details === |
| + | ---- | ||
| + | |||
; <sys key> | ; <sys key> | ||
: This is one of the system configuration variable names used by Kore. See the system configuration list below for a list of available system config variables. | : This is one of the system configuration variable names used by Kore. See the system configuration list below for a list of available system config variables. | ||
| + | |||
; <value> | ; <value> | ||
: This sets the value for the corresponding configuration variable that will be used by Kore. The type of meaningful values vary with each configuration key. The proper values for each system config key are described in the system configuration list below. | : This sets the value for the corresponding configuration variable that will be used by Kore. The type of meaningful values vary with each configuration key. The proper values for each system config key are described in the system configuration list below. | ||
| − | |||
| − | ==System Configuration List== | + | == System Configuration List == |
; locale [<short locale name>] | ; locale [<short locale name>] | ||
: Translation setting for kore, the [http://www.loc.gov/standards/iso639-2/php/English_list.php list of short locale names using ISO 639-1] will help you choose the right short locale name. | : Translation setting for kore, the [http://www.loc.gov/standards/iso639-2/php/English_list.php list of short locale names using ISO 639-1] will help you choose the right short locale name. | ||
| − | + | ||
| + | |||
; wxHideConsole [<flag>] | ; wxHideConsole [<flag>] | ||
: Hides the perl console when using the wx interface. (not the wx console!) | : Hides the perl console when using the wx interface. (not the wx console!) | ||
| + | |||
; loadPlugins [<0|1|2|3>] | ; loadPlugins [<0|1|2|3>] | ||
: This option controls loading of plugins at startup or when the "plugin load all" command is used. | : This option controls loading of plugins at startup or when the "plugin load all" command is used. | ||
| − | {| | + | |
| − | ! | + | {|border="1" cellpadding="2" cellspacing="1" |
| + | |- style=background-color:#F9F9F9; | ||
| + | !Value | ||
| + | !Description | ||
|- | |- | ||
| − | |align=center| | + | |align=center|0 |
| + | |Do not load plugins | ||
|- | |- | ||
| − | |align=center| | + | |align=center|1 |
| + | |Load all plugins | ||
|- | |- | ||
| − | |align=center| | + | |align=center|2 |
| + | |Only load plugins that are listed in loadPlugins_list | ||
|- | |- | ||
| − | |align=center| | + | |align=center|3 |
| + | |Load all plugins except those listed in skipPlugins_list | ||
|} | |} | ||
| + | |||
; loadPlugins_list [<comma-separated list of plugin names>] | ; loadPlugins_list [<comma-separated list of plugin names>] | ||
| − | : If loadPlugins is set to 2, this comma-separated list of plugin names (filename without the extension) specifies which plugin files to load at startup or when the "plugin load all" command is used. | + | : If loadPlugins is set to '''2''', this comma-separated list of plugin names (filename without the extension) specifies which plugin files to load at startup or when the "plugin load all" command is used. |
| + | |||
; skipPlugins_list [<comma-separated list of plugin names>] | ; skipPlugins_list [<comma-separated list of plugin names>] | ||
| − | : If loadPlugins is set to 3, this comma-separated list of plugin names (filename without the extension) specifies which plugin files to skip at startup or when the "plugin load all" command is used. | + | : If loadPlugins is set to '''3''', this comma-separated list of plugin names (filename without the extension) specifies which plugin files to skip at startup or when the "plugin load all" command is used. |
| + | |||
| + | |||
| + | == Examples == | ||
| + | The following example will make Openkore run using the English translation, load only the macro plugin: | ||
| + | |||
| + | locale en | ||
| + | |||
| + | loadPlugins 2 | ||
| + | loadPlugins_list macro | ||
| + | |||
[[Category:Control]] | [[Category:Control]] | ||
Revision as of 16:09, 14 December 2009
Openkore system configuration file.
Syntax
Entries in this file follows the key-value format. The key-value format is outright simple. Each line contains a configuration key as the first word, followed by the value:
<sys key> <value>
Details
- <sys key>
- This is one of the system configuration variable names used by Kore. See the system configuration list below for a list of available system config variables.
- <value>
- This sets the value for the corresponding configuration variable that will be used by Kore. The type of meaningful values vary with each configuration key. The proper values for each system config key are described in the system configuration list below.
System Configuration List
- locale [<short locale name>]
- Translation setting for kore, the list of short locale names using ISO 639-1 will help you choose the right short locale name.
- wxHideConsole [<flag>]
- Hides the perl console when using the wx interface. (not the wx console!)
- loadPlugins [<0|1|2|3>]
- This option controls loading of plugins at startup or when the "plugin load all" command is used.
| Value | Description |
|---|---|
| 0 | Do not load plugins |
| 1 | Load all plugins |
| 2 | Only load plugins that are listed in loadPlugins_list |
| 3 | Load all plugins except those listed in skipPlugins_list |
- loadPlugins_list [<comma-separated list of plugin names>]
- If loadPlugins is set to 2, this comma-separated list of plugin names (filename without the extension) specifies which plugin files to load at startup or when the "plugin load all" command is used.
- skipPlugins_list [<comma-separated list of plugin names>]
- If loadPlugins is set to 3, this comma-separated list of plugin names (filename without the extension) specifies which plugin files to skip at startup or when the "plugin load all" command is used.
Examples
The following example will make Openkore run using the English translation, load only the macro plugin:
locale en loadPlugins 2 loadPlugins_list macro
