> For the complete documentation index, see [llms.txt](https://k0ssek-scripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://k0ssek-scripts.gitbook.io/docs/scripts/halloween/configuration.md). # Configuration The config files and the options worth changing first. The config files are open, and every option has a comment that says what it does. This page covers the ones most servers change. | File | What is in it | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `config/shared.lua` | Profiles, language, the Phantom, the Mark, the séance, the Witching Hour, candy, houses, tricks, digging, the Director, the cauldron, the bear, hauntings, decorations | | `config/server.lua` | Admin groups, default altars, cauldrons and graves, the schedule, webhooks, the bears' hunger and payouts | | `config/rewards.lua` | Item names, loot tables, milestones, trophy, brew stages, shop, daily limits | | `config/letterboxes.lua` | The 349 built-in houses | | `locales/*.json` | Every text players see | ## General | Option | Default | What it does | | --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `Config.Locale` | `'en'` | `en`, `pl`, `de`, `fr`, `es`, `it`, `cs`, `sv`. One language for the whole server. | | `Config.TextSet` | `'supernatural'` | `'mundane'` tells the same game without ghosts: an infection passed by touch, a Stalker in a burning car, a gathering at a shrine | | `Config.Profile` | `'balanced'` | How rough the event is, see below | | `Config.BlipCategory` | `13` | The map legend group of all the event's blips, "Halloween". Pick another number from 10 up if a script already uses 13, `false` = no group. | | `Config.Debug` | `false` | Test commands. Keep it off on a live server. | ### Profiles | Switch | casual | balanced | serious | | ---------------------------------------------------------------- | ------ | -------- | ------------------------ | | Jump scares and flashes | yes | yes | no | | Knocked down by a hit, a tackle, a trick, a bite | yes | yes | no | | How the Mark passes | tackle | tackle | the other player accepts | | A hit spills carried candy | no | yes | yes | | Penalties (running away, the mime, the bite takes carried candy) | no | yes | no | | Bear hauntings | all | all | sounds only | | UFO trick | yes | yes | no | `Config.Profiles` holds these switches. Change a value to make your own mix. The passing switch also takes `'vessels'`: the Mark never goes to a player, only to vessels. ## The Phantom and the Mark | Option | Default | What it does | | ------------------------------------ | ----------------------------- | ----------------------------------------------------------------------------------------- | | `Config.Phantom.look` | `'car'` | `'car'`, `'rider'` (a burning motorbike whose rider has a flame for a head) or `'random'` | | `Config.Phantom.model` | `'tornado5'` | The car | | `Config.Phantom.driving.mode` | `'ai'` | `'player'`: a participant is drawn to drive it | | `Config.Mark.zoneRadius` | `250.0` | Metres around the place where the hunt started | | `Config.Mark.maxTime` | `600` | Seconds before a living Phantom drives off | | `Config.Mark.hp` | base 6, 2 per player, 8 to 40 | The Phantom's health | | `Config.Mark.escape` | grace 12, penalty 15 | Seconds out of the hunt before the Mark jumps, candy it costs | | `Config.Participation.excludedZones` | Pillbox hospital, Mission Row | Areas where nobody gets the Mark | | `Config.Participation.excludedJobs` | police, ambulance | Jobs left out while on duty | ## Séance and announcements | Option | Default | What it does | | -------------------------- | ------------ | ------------------------------------------------------------------------------------------- | | `Config.Seance.quietTime` | `20` | Seconds without a new candle before the ritual completes | | `Config.Seance.minCircle` | `2` | Players a circle needs (1 at an altar with 4 vessels) | | `Config.Seance.cooldown` | `1800` | Seconds an altar rests after its hunt | | `Config.Seance.lootTiers` | 1, 4, 8 | Circle sizes for loot tiers 1, 2 and 3 | | `Config.Announce.channel` | `'world'` | `'world'` (big message, sound, flashing blip), `'notification'` or `'none'` | | `Config.Announce.audience` | `'everyone'` | `'participants'` or `'everyone'` | | `Config.Announce.bigRange` | `400.0` | Metres from the altar for the big message; the rest get a notification. `false` = everyone. | ## Houses, tricks and graves | Option | Default | What it does | | ----------------------------- | --------------------- | --------------------------------------------------------- | | `Config.Doors.safeKnocks` | `2` | Safe knocks a day per house | | `Config.Doors.treat` | 2 to 5 | Candy per treat | | `Config.Doors.greed` | 0.30, +0.20, max 0.90 | Trick chance after the safe knocks | | `Config.Doors.resetHour` | `6` | Hour of the server clock at which every house opens again | | `Config.Tricks..weight` | | How often each trick is picked, 0 = never | | `Config.Dig.safeDigs` | `1` | Safe digs a day per grave | ## The bear `Config.Bears` in `config/server.lua`: | Option | Default | What it does | | -------------------------- | ------------------- | ------------------------------------------------------------------------ | | `perPlayers`, `min`, `max` | 25, 1, 3 | One bear per 25 players online, between 1 and 3 (never more than graves) | | `full` | `2400` | Seconds from full to starving | | `stages` | 1, 2, 4, 8 a minute | Cursed candy per minute in each hunger stage, and the hauntings | | `transfer.minHold` | `120` | Seconds before the holder can give it on | | `bite` | half, max 100 | Share of carried candy a bite takes | | `collector` | on, 8 players, 30 % | The priest on a quiet server | ## Rewards `config/rewards.lua`: | Option | Default | What it does | | ---------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------- | | `Config.Loot.preset` | `'safe'` | `'safe'`: food, materials and the event's items, no cash or weapons. `'classic'`: adds cash and weapons. | | `Config.Pumpkins.cost` | `40` | Banked candy per Cursed Pumpkin | | `Config.Ash.required` | `15` | Ash for one Relic | | `Config.Milestones` | 60, 200, 450, 800, 1500 | Banked candy at which each character gets pumpkins and Relics | | `Config.Brew.stages` | 10 000 to 100 000 | The server's brew and what each stage pays | | `Config.Shop.items` | | The shop, priced in banked candy | | `Config.Caps` | per source | Daily limits with diminishing returns | Rewards take three forms: `{ item = 'name', count = 1 }`, `{ banked = 50 }` or `{ money = 1000 }`. An item that does not fit in a player's inventory waits at the cauldron. {% hint style="info" %} No cosmetic item exists on every server, so none is built in. Add your clothing script's items as loot lines. {% endhint %} ## Players' keys All keys can be rebound by each player in the GTA settings (Key Bindings, FiveM). | Key | Action | | ----- | --------------------------------------------------------------------------------------- | | E | Light a candle, pass the Mark, knock, dig, use the cauldron, take or hand back the bear | | G | Give the bear to the player next to you | | H / X | Phantom driver: come again from behind / stop driving | `Config.Interaction.mode` picks between your target script and keys: `'auto'` (default, target when one runs), `'target'` or `'prompt'` (always keys with a line on screen).