Configuration

Everything is in shared/config.lua. Consumables are in shared/consumables.lua (see Consumables) and town names in shared/zones.lua.

⚙️ General

Option	Default	What it does
`Config.Framework`	`'auto'`	`'rsg'`, `'vorp'`, `'standalone'` or `'auto'`
`Config.Locale`	`'en'`	`en`, `fr`, `de`, `es` or `pt-br`
`Config.Debug`	`false`	Prints extra info in the console
`Config.Menu`	`/hud`, F9	Menu command and key. `false` turns one off
`Config.Commands`		Names for the toggle, photo mode and reset needs commands
`Config.AdminAce`	`'kartikhud.admin'`	Ace that counts as admin
`Config.Interval`		How often each part updates, in milliseconds
`Config.HideNativeCores`	`true`	Hides the base game cores so they don't show twice
`Config.HideWhen`		Hide the HUD in the pause menu, map, cutscenes and loading screens
`Config.AllowPlayerSettings`	`true`	`false` locks everyone to the server layout

The layout a new player starts with (unless an admin saved a server default in game).

Key	Values
`theme`	`saddle`, `parchment`, `saloon`, `tintype`, `midnight`, `ember`
`coreStyle`	`cylinder`, `halo`, `watch`, `horseshoe`, `badge`, `spur`, `ledger`, `rail`, `lantern`, `stamp`
`colorMode`	`vivid` or `theme`
`grayscale`, `streamer`, `overlays`, `sounds`, `titleCards`, `clock24`	`true` / `false`
`scale`	HUD size, `1.0` is normal
`tempUnit`	`'C'` or `'F'`
`minimap`	`mode` (`always`, `mounted`, `off`), `border` (`none`, `plain`, `stitch`, `wheel`, `star`, `barbed`, `telegraph`, `gilded`), `size`, `x`, `y`
`groups`	Position (`x`, `y` in % of the screen), `scale`, `enabled` and `layout` (`row` / `column`) for each group
`items`	`enabled`, `mode` (`pinned`, `flash`, `warn`) and an optional `color` for each element

Use the in-game Layout editor and Copy for config to get exact positions instead of guessing numbers.

Option	What it does
`enabled`	Turns the needs system on or off
`source`	`'auto'`, `'hud'` or `'framework'`. On RSG, `auto` keeps hunger and thirst in the framework metadata
`respawnReset`	Clears bad effects on respawn
`start`	Values a new character starts with
`perMinute`	How much each need changes per minute
`activity`	Multipliers for idle, walking, running, sprinting, swimming and riding
`empty`	What hunger and thirst at 0 drain, and how often
`wellFed`	Core refill when hunger and thirst are both high
`stress`	Stress from shooting, getting hurt and melee, and when the hands start to shake
`fatigue`	`enabled` and the level where the player counts as exhausted
`dirt`	How much swimming and rain clean you

Option	What it does
`enabled`	Turns temperature on or off
`comfort`	The `min` and `max` in °C where the player is fine
`clothing`	Warmth added per clothing category
`fire`	Radius, warmth and the fire and stove models that count
`interior`	Room temperature and how strongly interiors pull toward it
`wet`	How fast you get wet and dry off, and how much colder it makes you
`effects`	How often cold hurts, how much, and how often players are warned

Thresholds and screen effects for alcohol, drugs, sickness and low health. Set a postfx to '' to turn that screen effect off.

Option	What it does
`Config.Horse`	Turn the horse HUD and bonding level on or off
`Config.Money`	Currency symbol and gold decimals
`Config.Location`	Name shown in the wilderness and how often the same town title can show
`Config.Voice`	Voice system (`auto`, `pma`, `saltychat`, `yaca`, `native`) and range labels (`hush`, `talk`, `holler`)
`Config.CustomWidgets`	Your own HUD lines, see Server Widgets