Config Hotkeys
In addition to Config Presets, Simple Config supports an even faster way to modify config values.
Config Hotkeys are not only easier to use, as you can trigger them at any time, but also more powerful than config presets, as they can modify values from multiple config files at once.
In addition, rather than simply setting a value, config hotkeys support some advanced actions for some types of entries, such as incrementing a numeric entry or cycling an entry with multiple options.
The easiest way to create a config hotkey is from a config menu. When holding the Ctrl key, the reset buttons beside all entries will turn into a hotkey button. Clicking any of them will enter the Hotkey Editing mode for a brand new hotkey.
While editing a hotkey, the background will turn blueish, and the hotkey buttons beside entries will let you cycle over supported hotkey actions for the entry. The most common action is the assign one, which is denoted by the equals symbol, and lets you assign a value of your choice to the entry when your hotkey is triggered.
Once you've selected which actions will the hotkey trigger, you can save the hotkey, but, before that, you may want to give it a name (by editing the title of the menu, which is replaced by the hotkey name), and assign it an actual key combination in the top right corner.
After saving a config hotkey, you might be wondering were it went, or how can you assign it entries from multiple mods. The answer to those questions is the Hotkey Menu, which is the long way to define config hotkeys.
You may open the hotkey menu with the top right corner button of the config menu, or you may assign it a hotkey in Simple Config's client config.
Any hotkeys you have created will appear in the hotkey menu. Here you can easily rebind any hotkeys you've previously made. It is also possible to sort your hotkeys by dragging them around, or even organize them in groups, which you can create with the buttons on the top.
Additionally, you can even save/load hotkey groups from files or even save them in a server (if you have permission) to share them with other players, similar to Config Presets.
Expanding an entry will display a list of the mods it has actions for, letting you edit those actions, or assign actions for entries of other mods.
You can also quickly disable/enable hotkeys with the checkboxes on the right. Hotkey groups can even be assigned a hotkey to toggle their enabled status, so you can have hotkeys that enable/disable other hotkeys (if a group is disabled, its entries are naturally too).
Available hotkey actions depend on the entry type.
- Assign: Assigns a value
- Add: Adds a number (can be negative) to the entry. Caps at the limits
- Cycle Add: Adds a number to the entry, but cycles when passing the limits.
- Multiply: Scales the number by a given scale. Caps at the limits
- Divide: Divides the number by a given scale. Caps at the limits
- Toggle: Alternate values.
- Cycle: Cycles the available options with the given step (by default 1). Use step -1 to cycle backwards.
At the moment, there are no special actions for complex types, like lists/maps/pairs.
In the future, the hotkey action system may be redesigned to support even more flexible custom expressions/scripts.
Your config hotkeys are stored in the simpleconfig-hotkeys.yaml file, under the config folder of the game directory.
This file is not meant for manual editing, as the YAML tags it uses to serialize hotkey actions are not documented, and syntax errors can potentially destroy (overwrite) any saved hotkeys. However, if you really know what you're doing, or as long as you only cut and paste stuff around the file, nothing stops you from manually editing this file. The format in which hotkeys are saved in is likely to change in the future.
Saved hotkey groups are stored in individual YAML files (using the same format, not meant for manual editing), under the config/saved-hotkeys folder of the game directory. Config Hotkeys stored in a remote server are stored under the serverconfig/saved-hotkeys directory.
Additionally, mods and resource packs may define default hotkey groups, that can even be enabled by default (see Built-in Presets and Hotkeys).