Fika-Tarkov/mods/Better Keys NG/user/mods/flir-betterkeysng/README.md

41 lines
1.7 KiB
Markdown

# BetterKeys-Updated
Better key information for SPT-AKI.
Originally by https://github.com/SirTyler/BetterKeys
updated by maxloo2 https://github.com/maxloo2/betterkeys-updated
then ported to 3.10 by flir https://github.com/flir063/betterkeys-ng
## Downloads
The releases can be found [here](https://gitlab.com/flir063-spt/betterkeys-ng/-/packages), just click on the desired
version and then scroll to the bottom of the page to the "assets" section
you will find a zipfile with the content of the tagged version.
## Features & Changes
- Colored background for keys and keycards according to which map they belongs to.
- Maps, Extracts, Quests and Loot information in the item descriptions.
- **[New]** Add description for junk keys (previously keys that are not used anywhere are not indicated as such by the mod)
- **[New]** All features can be toggled on/ off in `config.json` (see below).
- **[Updated]** Auto-update from GitHub: key information and locales can be updated without redownloading the whole mod.
- **[Removed]** Key Tier List (I don't think it was actually enabled anyway).
Please refer to the original mod for more/ legacy descriptions: https://hub.sp-tarkov.com/files/file/895-better-keys/
## config.json
```JSON
{
"enableAutoUpdate": false, // enable auto update from GitHub (disabled by default)
"backgroundColor": true, // toggle background colors
"descriptionInfo": true, // toggle item descriptions
"yellowMarkedKeys": false, // when true, marked keys are always yellow (vanilla behavior)
"requiredInQuests": true, // Toggle Quests Info
"requiredForExtracts": true, // toggle Extracts Info
"behindTheLock": true, // toggle Loot Info
"backgroundColors": {...} // Please refer to config/README.md
}
```