VKBASALT-CLI(1)

📦 version 3.1.1, in ubuntu resolute, ubuntu stonking

💖 VKBASALT-CLI 💖

okay bestie, welcome to the vkbasalt-cli manual page (that's the VKBASALT-CLI(1) one, from the User Manual section, iykyk) — a whole CLI utility and library situation for your vkBasalt configuration. sit down, grab a boba, we're gonna make this make sense fr fr 🧋✨

✨ NAME ✨

vkbasalt-cli — the CLI utility and library that handles your vkBasalt configuration 🎀

🌸 SYNOPSIS 🌸

vkbasalt [OPTIONS]

that's it. that's the whole vibe. options go in, magic comes out 💅

🦋 DESCRIPTION 🦋

so vkbasalt-cli is a CLI utility and a library, and it works in conjunction with vkBasalt. think of it as the bestie that does the boring stuff for you 🫶

what's it actually doing? it makes generating configuration files or running vkBasalt with games way easier. literally its whole thing.

and the way this is mainly convenient is in environments where you're like "hmm, wouldn't it be nice if vkBasalt was integrated here" — for example, a GUI application 👀. by integrating vkbasalt-cli, a front-end can easily generate and use specific configurations on the fly, without ever asking the user to manually write a configuration file. no cap. that's the dream 💭✨

👑 OPTIONS 👑

one bullet per flag, no skips, we keep it thorough because that's what icons do 💜

  • -h, --help — shows you this help message and then dips. exit, done, bye 👋
  • -e, --effects {cas,dls,fxaa,smaa,lut} [{cas,dls,fxaa,smaa,lut} ...] — the effects you wanna use, given as a separated list of effects 🎨
  • -o, --output OUTPUT — the output file 📁
  • -d, --default — use the default configuration. yes, the defaults, they're cute 🌈
  • --toggle-key TOGGLE_KEY — the toggle key (default: Home) ⌨️
  • --disable-on-launch — disable on launch 🚫
  • --cas-sharpness CAS_SHARPNESS — adjust CAS sharpness 🔪
  • --dls-sharpness DLS_SHARPNESS — adjust DLS sharpness ✨
  • --dls-denoise DLS_DENOISE — adjust DLS denoise 🧼
  • --fxaa-subpixel-quality FXAA_SUBPIXEL_QUALITY — adjust FXAA subpixel quality 🔍
  • --fxaa-quality-edge-threshold FXAA_QUALITY_EDGE_THRESHOLD — adjust FXAA quality edge threshold 📐
  • --fxaa-quality-edge-threshold-min FXAA_QUALITY_EDGE_THRESHOLD_MIN — adjust FXAA quality edge threshold minimum 📏
  • --smaa-edge-detection {luma,color} — adjust SMAA edge detection (default: luma) 🎯
  • --smaa-threshold SMAA_THRESHOLD — adjust SMAA threshold ⚖️
  • --smaa-max-search-steps SMAA_MAX_SEARCH_STEPS — adjust SMAA max search steps 👟
  • --smaa-max-search-steps-diagonal SMAA_MAX_SEARCH_STEPS_DIAGONAL — adjust SMAA max search steps diagonal 📐
  • --smaa-corner-rounding SMAA_CORNER_ROUNDING — adjust SMAA corner rounding 🔘
  • --lut-file-path LUT_FILE_PATH — specify the LUT file path 🗂️
  • --exec EXEC — execute a command ▶️

🍓 EXAMPLES 🍓

here's where it gets fun. real commands, real vibes, copy-paste away bestie 😭💖

Apply CAS and FXAA filters; output to the current directory:

vkbasalt --effects cas fxaa --output .

Apply CAS and FXAA filters; set CAS sharpness to 0.35; output to the current directory:

vkbasalt --effects cas fxaa --cas-sharpness 0.35 --output .

Apply DLS and FXAA filters; set DLS sharpness to 1; output to ~/.config/vkBasalt:

vkbasalt --effects dls fxaa --dls-sharpness 1 --output ~/.config/vkBasalt

Apply SMAA, DLS and CAS filters; set CAS sharpness to 1, DLS sharpness to 0.5 and DLS denoise to 0.75:

vkbasalt --effects smaa dls cas --cas-sharpness 1 --dls-sharpness 0.5 --dls-denoise 0.75

🔥 SEE ALSO 🔥

go look at the big sibling, it's iconic 👑

💜 AUTHOR 💜

vkbasalt-cli was written by Hari Rana and contributors 🫶

this manual page was generated from the README.md file for Debian packaging 📦

ok that's the whole page bestie, no notes, ate and left no crumbs 💅✨

vkbasalt-cli · dated 2024-05-14 · and yes, the manual name is still VKBASALT-CLI(1) because we stay consistent 🌈💖 mwah, go generate some configs 🦋🎀

📦 where this page comes from