> For the complete documentation index, see [llms.txt](https://polars-armoury.gitbook.io/polars-armoury-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polars-armoury.gitbook.io/polars-armoury-docs/scripts/hidden-stash/configurator.md).

# Configurator

Most number boxes are either seconds, item amounts, job ranks, or percentages. If a setting says **Chance**, 0 means never and 100 means always.

### Buttons

* **Save**: Saves your changes.
* **Reset**: Resets only the page you are currently looking at.
* **Add Item / Add Job / Add Level**: Adds a new row.
* **Remove**: Deletes that row.
* **Search boxes**: Only help you find rows faster. They do not save anything.

### Settings Page

#### Durations

These are all in seconds.

* **Pack Duration**: How long it takes to make packed goods with the condom item.
* **Retrieve Duration**: How long it takes to open packed goods and get the items back.
* **Laxative Duration**: How long the laxative animation lasts when items are released.
* **Laxative Activation Min**: The shortest time before laxatives start working.
* **Laxative Activation Max**: The longest time before laxatives start working.
* **Injured Walk Duration**: How long the hurt walking style lasts after hiding packed goods.

#### Limits

* **Packed Goods Max Total**: The most items one packed goods item can hold when XP levels are turned off.
* **Wrapper Max Total**: The most items one ks\_crumpledwrap can hide in the mouth.

#### Search Minigame

* **Enable Search Minigame**: Turns on the W/A/S/D ox\_lib minigame before mouth searches or Internal Concealment Checks can find items.
* **Minigame Difficulty**: Makes that minigame Easy, Medium, or Hard.

#### Inspection Gloves

These settings control the glove clothing that appears during inspection glove actions.

* **Glove Clothing**: Turns temporary glove clothing on or off.
* **Male Hands Component**: The male clothing slot for hands. Usually 3.
* **Male Gloves Drawable**: The male glove style number.
* **Male Gloves Texture**: The male glove texture number.
* **Female Hands Component**: The female clothing slot for hands. Usually 3.
* **Female Gloves Drawable**: The female glove style number.
* **Female Gloves Texture**: The female glove texture number.

If clothing looks wrong, the drawable or texture number is probably wrong for that clothing pack.

### Experience Page

#### XP System

This is only for packed goods made with the condom system.

* **XP System**: Turns packed goods leveling on or off.
* **XP Per Use**: How much XP a player gets when they successfully hide packed goods.
* **XP Base**: Starting number used to calculate level XP.
* **XP Multiplier**: How much harder each level gets.
* **XP Notification Position**: Where the XP popup appears on the screen.

#### Level Capacity

Each level row controls how much a player can hide at that level.

* **Level Name**: The name shown for that level.
* **Capacity / Max Amount**: The total amount of items that level can hide.
* **Add Level**: Adds another level.
* **Remove Level**: Removes the last level.

Example: if Level 1 capacity is 10, a Level 1 player can hide up to 10 total items in packed goods.

### Effects Page

#### Condom / Packed Goods Effects

These settings affect packed goods hidden internally.

* **Health Loss Per Use**: Health lost as soon as someone hides packed goods.
* **Break Chance**: Chance that packed goods break after being hidden.

#### Broken Goods Damage

These settings happen when packed goods break.

* **Destroy Items on Break**: If on, the hidden items are deleted when the packed goods break.
* **Damage Per Tick**: How much health is removed each damage tick.
* **Damage Interval**: How many seconds between damage ticks.
* **Break Delay Min**: The shortest time before broken goods damage can start.
* **Break Delay Max**: The longest time before broken goods damage can start.

Example: Damage Per Tick 5 and Damage Interval 10 means the player loses 5 health every 10 seconds.

#### Treatment Effects

These settings control the dizzy/walking effects and treatment behavior for broken packed goods.

* **Laxative Fallback Treatment**: If on, laxatives can treat broken packed goods when not enough medical-help jobs are online.
* **Laxative Fade Duration**: How long the dizzy and drunk walk effects stay after laxative treatment.
* **Dizzy Screen Effect**: The GTA screen effect name.
* **Walking Animation**: The GTA walking style name.
* **Fart Smoke**: Turns fart smoke on or off during fart sounds.

#### Wrapper Effects

These settings affect items hidden with ks\_crumpledwrap.

* **Swallow Chance**: Chance that mouth-hidden wrapper items are accidentally swallowed.
* **Destroy Items on Swallow**: If on, swallowed wrapper items are deleted when swallow damage starts.

#### Swallowed Wrapper Damage

These settings happen when wrapper-hidden mouth items are swallowed.

* **Damage Per Tick**: How much health is removed each damage tick.
* **Damage Interval**: How many seconds between damage ticks.
* **Swallow Delay Min**: The shortest time before swallowed wrapper damage can start.
* **Swallow Delay Max**: The longest time before swallowed wrapper damage can start.
* **Treatment Fade Duration**: How long dizzy and walking effects fade after inspection gloves treatment.
* **Dizzy Screen Effect**: The GTA screen effect name.
* **Walking Animation**: The GTA walking style name.

Wrapper swallowed items are treated by inspection gloves, not laxatives.

### Sounds Page

#### Sound Settings

* **Use Sound Effects**: Turns synced sounds on or off.
* **Buildup Fart Sounds**: Plays random fart sounds while waiting for laxatives to activate.
* **Volume**: Sound volume. 0 is silent, 1 is max.
* **Distance**: How far away players can hear the sounds.

#### Sound Files

These must match real sound files your sound system can play.

* **Laxative Sound**: Sound played during the laxative animation.
* **Male Cough Sound**: Cough sound for male characters.
* **Female Cough Sound**: Cough sound for female characters.
* **Buildup Sound 1**: First random buildup fart sound.
* **Buildup Sound 2**: Second random buildup fart sound.
* **Buildup Sound 3**: Third random buildup fart sound.

### Items Page

#### Condom Items

These are the items players can hide using the condom system.

* **Item**: The inventory item name.
* **Max Amount**: The most of that item allowed in one packed goods action.
* **Enabled**: If off, players cannot select that item.

#### Wrapper Items

These are the items players can hide using ks\_crumpledwrap.

* **Item**: The inventory item name.
* **Max Amount**: The most of that item allowed in one wrapper action.
* **Enabled**: If off, players cannot select that item.

Wrapper items do not create packed goods. They are hidden directly in the mouth system.

### Jobs Page

Job names must match your framework job names.

Min Rank means the lowest grade allowed. Example: if Min Rank is 2, grade 0 and 1 cannot use it.

#### Internal Concealment Check Access

Jobs that can use inspection gloves for Internal Concealment Check.

* **Job Name**: The job allowed to do it.
* **Min Rank**: The lowest grade allowed.

#### Mouth Search Access

Jobs that can use inspection gloves for mouth search.

* **Job Name**: The job allowed to do it.
* **Min Rank**: The lowest grade allowed.

#### Cough Request Access

Jobs that can ask a player to cough.

* **Job Name**: The job allowed to do it.
* **Min Rank**: The lowest grade allowed.

#### Medical Help Count

This controls whether broken packed goods need medical help.

* **Required Online**: How many medical-help workers must be online.
* **Job Name**: A job counted as medical help.
* **Min Rank**: The lowest grade counted as medical help.

Example: Required Online 1 with ambulance job means if at least one ambulance worker is online, broken packed goods need medical treatment. If nobody is online and Laxative Fallback Treatment is enabled, laxatives can treat it instead.
