> For the complete documentation index, see [llms.txt](https://sl-scritps.gitbook.io/sl-scripts-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sl-scritps.gitbook.io/sl-scripts-documentation/products/sl-prank-props.md).

# SL Prank Props

## SL Prank Props

**Code:** GAG-50\
**Resource:** `sl_prank_props`\
**Version:** v1.0.4\
**Category:** Social RP / Fun Props / Light Interaction\
**Status:** Stable

**Structured tools for serious roleplay servers.**

***

### Overview

SL Prank Props is a light roleplay prop system for FiveM servers.

It allows servers to add small prank-style props and fun world interactions that players can use during social roleplay, events or casual situations.

The resource is designed for harmless RP moments, not griefing or disruptive gameplay.

***

### What is this script for?

SL Prank Props gives players simple interactive objects that can create funny or unexpected roleplay moments.

It is useful for:

* Civilian roleplay
* Social hangouts
* Events
* Light comedy RP
* Prank scenes
* Staff-hosted activities
* Small prop interactions
* Fun environmental details
* Casual server moments

The main goal is:

```txt
Player places or uses a prank prop → nearby players notice/react → RP moment happens → prop is cleaned up
```

***

### Roleplay Experience

SL Prank Props is designed around a simple IC idea:

```txt
A player uses a small prank object.
The object appears or activates in the world.
Other players can react to it naturally.
```

The system works best when used for light, fun and non-toxic roleplay.

Examples:

```txt
A player places a harmless prank object near a hangout.
A friend reacts to a funny prop.
Staff prepares a small event with joke items.
A group uses props for a casual RP scene.
```

The focus should always be playful interaction, not blocking, harassment or abuse.

***

### Player IC Usage

For players, SL Prank Props should feel like using a small physical object inside the world.

The normal player flow is:

```txt
Get prank item → use/place prop → create funny moment → clean up or let it expire
```

Common player IC actions:

* Place a small prank object
* Use a funny item during social RP
* Create a harmless surprise
* React to another player's prank
* Use props during an event
* Add comedy to a casual scene

Example IC lines:

```txt
“Who left this here?”
“That was not there a second ago.”
“Okay, that one got me.”
“Someone is messing around again.”
```

Players should use prank props in a way that supports roleplay and does not ruin other players’ experience.

***

### Nearby Player / Victim IC Usage

Other players may be affected by or notice the prank prop depending on configuration.

Their experience should feel like a small RP reaction opportunity.

Common reactions:

* Notice the prop
* React to the surprise
* Avoid the object
* Pick it up if allowed
* Ask who placed it
* Continue the scene with humor

Example IC lines:

```txt
“Very funny.”
“I almost stepped on that.”
“Who put this here?”
“You got me.”
```

The system is meant to create a shared moment, not force a serious outcome.

***

### Player / IC Flow

#### 1. The player gets a prank prop

Depending on server setup, the player may get prank props through:

* Inventory item
* Shop item
* Staff-given item
* Event reward
* Command fallback
* Configured access

Example item names may vary depending on configuration.

***

#### 2. The player uses the prop

The player uses the item or command.

Expected result:

```txt
A prank prop is placed, activated or prepared.
```

The exact result depends on the configured prop.

***

#### 3. The prop creates a small RP moment

Nearby players can notice or interact with the prop depending on configuration.

Examples:

```txt
A small object appears on the ground.
A funny interaction is triggered.
A player reacts to the prop.
The group uses the moment for social RP.
```

***

#### 4. The prop is cleaned up

Prank props should not stay forever unless the server intentionally configures them that way.

Cleanup may happen through:

```txt
automatic timeout
manual pickup
admin cleanup
resource restart
configured limits
```

This keeps the world clean and avoids prop spam.

***

### Admin / Owner IC Usage

For admins, owners and staff, SL Prank Props can be used to create light social activity.

Common admin/owner IC uses:

* Add fun items to events
* Give players harmless prank props
* Create a comedy scene
* Add small interactive objects to social spaces
* Prepare a casual activity
* Test prop placement and cleanup
* Control who can use prank props
* Remove abused or misplaced props

Example admin/event flow:

```txt
Choose event area → give prank props → explain rules → let players use them → clean up after event
```

Example event scenario:

```txt
Staff hosts a casual city fair.
Players receive small prank props.
The props create funny moments during the event.
Staff removes leftover props afterward.
```

For server owners, the system can add fun without creating a heavy activity system.

***

### Admin / Owner Technical Flow

Admins and owners should configure limits and permissions before allowing public use.

Common admin actions may include:

* Configure available prank props
* Configure item names
* Configure interaction mode
* Configure cooldowns
* Configure max active props
* Configure cleanup time
* Configure permissions
* Configure inventory integration
* Test each prop
* Clean all active props if needed
* Review abuse prevention settings

Recommended admin checks:

```txt
1. Confirm the resource starts correctly.
2. Confirm configured items exist if inventory mode is enabled.
3. Use a test prank prop.
4. Confirm the prop appears or activates correctly.
5. Confirm nearby players can react/interact if configured.
6. Test cooldowns.
7. Test cleanup or pickup.
8. Restart the resource.
9. Confirm no broken props remain.
10. Check server console and F8.
```

***

### Example IC Scenarios

#### Social hangout

Players are gathered near a public location and someone uses a prank prop.

```txt
“Alright, who did that?”
```

#### Friend group RP

A player uses a small prank item during a casual scene.

```txt
“You really carried that around just for this?”
```

#### Staff event

Staff gives players safe prank props during a fun event.

```txt
“Use them inside the event area only.”
```

#### Business comedy scene

A shop or diner uses small prank objects during a themed night.

```txt
“The staff is clearly having too much fun today.”
```

#### Cleanup after prank

A staff member removes leftover props after the event.

```txt
“The area has been cleaned up.”
```

***

### What this resource is not

SL Prank Props is not intended to be a griefing tool, combat system or harassment system.

It is focused on:

```txt
light prank props
social RP
fun reactions
small world interactions
safe cleanup
controlled use
```

Servers should configure permissions, cooldowns and cleanup rules to prevent abuse.

***

### Main Features

* Light prank prop system
* Item-based usage when enabled
* Command fallback when enabled
* Placeable or usable prank props depending on configuration
* Configurable prop list
* Configurable cooldowns
* Configurable cleanup time
* Optional pickup/remove behavior
* Admin cleanup tools
* Inventory integration when enabled
* Target or fallback interaction when configured
* Notification support
* Permission control
* Anti-spam configuration
* ES/EN locale support
* Clean SL Scripts style
* Designed for harmless social RP

***

### Dependencies

#### Required

```txt
FiveM server
```

#### Recommended / Optional

```txt
ox_lib
ox_target
qb-target
ox_inventory
qb-inventory
qs-inventory
QBCore
Qbox
ESX
Standalone mode
```

The exact dependency setup depends on your server configuration.

Database support is usually not required unless your installed build or configuration enables persistence, logging or advanced tracking.

***

### Installation Notes

1. Place the resource folder inside your server resources folder.

Example:

```txt
resources/[sl_scripts]/sl_prank_props
```

2. Make sure the folder name is:

```txt
sl_prank_props
```

3. Configure:

```txt
config.lua
custom.lua
locales/
```

4. If using inventory item mode, create or confirm the configured items in your inventory system.
5. Add the resource to your `server.cfg`.

Example:

```cfg
ensure ox_lib
ensure ox_inventory
ensure ox_target

ensure sl_prank_props
```

If you are not using inventory or target integrations, configure fallback modes in `config.lua`.

***

### Item Setup

If item usage is enabled, every configured prank item must exist in your inventory system.

Example item names may include custom values such as:

```txt
banana_peel
prank_prop
fake_spill
```

Your actual item names depend on `config.lua`.

Important:

```txt
The item name in config.lua must match the item name in your inventory system.
```

If the item does not exist or the name does not match, the prank prop may not activate.

***

### Prop Configuration

The configured prop list defines what players can use.

A prop configuration may include:

```txt
label
item name
model
effect
duration
cooldown
placement rules
pickup rules
permission rules
cleanup behavior
```

Recommended:

```txt
Start with a small number of props.
Test each prop.
Adjust cooldowns and cleanup time before public release.
```

***

### How to Use

#### Basic Player Flow

1. The player obtains a prank prop item if item mode is enabled.
2. The player uses the item or command.
3. The prank prop is placed or activated.
4. Nearby players react to the moment.
5. The prop expires, is picked up or is removed.

#### Basic Admin Flow

1. Admin configures allowed props.
2. Admin tests each prop.
3. Admin checks cooldowns and cleanup.
4. Admin limits access if needed.
5. Admin monitors for spam or misuse.

#### IC Summary

```txt
Use prank object → funny moment happens → players react → prop gets cleaned up
```

#### OOC / Technical Summary

```txt
Item/command used → server validates permission/cooldown → prop/effect activates → cleanup timer runs
```

***

### Commands

Command names may depend on configuration.

Common command examples:

```txt
/prankprops
/sl_prankprops
```

Possible admin command examples:

```txt
/sl_prankprops_admin
/prankcleanup
```

Check `config.lua` for the exact command names used by your installed version.

Commands are useful for fallback access, testing and admin cleanup.

***

### Permissions

Permission setup depends on server configuration.

Common permission levels may include:

```txt
view
use
manage
admin
owner
```

Recommended access logic:

```txt
Players = use allowed prank props
Event staff = give/use event prank props
Admins = cleanup/manage active props
Owners = full access
```

Permissions may use:

* Ace permissions
* Framework groups
* Jobs
* Job grades
* Config admin list
* Custom permission bridge

Recommended:

```txt
Use cooldowns and limits if regular players can use prank props.
```

***

### Abuse Prevention

Because prank props can affect shared spaces, servers should configure safe limits.

Recommended protections:

```txt
cooldowns
max active props per player
max active props globally
automatic cleanup time
restricted zones if needed
admin cleanup command
permission checks
no placement in blocked areas
```

Good server rules:

```txt
Do not block doors.
Do not spam props.
Do not harass the same player repeatedly.
Do not use props to interrupt serious RP without consent.
Do not place props in areas where they break gameplay.
```

The resource is designed for fun RP, not abuse.

***

### Configuration

Open:

```txt
config.lua
```

Common settings may include:

```txt
Product information
Locale
Debug mode
Startup logs
Framework mode
Inventory mode
Target mode
Notify mode
Command settings
Prank prop list
Item names
Prop models
Cooldowns
Duration settings
Cleanup settings
Placement settings
Interaction settings
Permissions
Admin settings
Anti-spam settings
```

Recommended for production:

```lua
Config.Debug = false
```

Use debug mode only while testing or troubleshooting.

***

### Custom Integrations

Open:

```txt
custom.lua
```

Use this file for server-specific functions such as:

* Custom notifications
* Custom permission checks
* Custom framework integration
* Custom inventory checks
* Custom item removal/addition
* Custom logging
* Custom admin checks
* Custom zone restrictions

If your server uses standard systems, you may not need many changes here.

***

### Startup Logs

When the resource starts correctly, you may see logs similar to:

```txt
[sl_prank_props][INFO] Server ready: SL Prank Props v1.0.4
[sl_prank_props][INFO] Client ready: SL Prank Props v1.0.4
```

If startup logs are disabled, check `config.lua`.

***

### Troubleshooting

#### Item does not activate

Check:

```txt
- The item exists in your inventory system.
- The item name matches config.lua.
- Inventory mode is configured correctly.
- The usable item is registered if required.
- The player has the item.
- Server console has no inventory errors.
```

***

#### Prop does not appear

Check:

```txt
- The prop model exists.
- The model name is correct.
- Prop placement is enabled.
- The player is not in a blocked area.
- Client F8 console has no model loading errors.
```

***

#### Nothing happens when using the command

Check:

```txt
- Commands are enabled in config.lua.
- You are using the correct command.
- You have permission to use the command.
- Cooldown is not active.
- Server console has no validation errors.
```

***

#### Target interaction does not appear

Check:

```txt
- ox_target or qb-target is started.
- Target mode is enabled in config.lua.
- Target resource starts before sl_prank_props.
- The prop supports interaction.
- You are close enough to the prop.
```

***

#### Props stay forever

Check:

```txt
- Cleanup timer is enabled.
- Duration is configured correctly.
- Admin cleanup command is available.
- Resource did not stop before cleanup finished.
- No error occurred during cleanup.
```

***

#### Players are spamming props

Check:

```txt
- Cooldowns are enabled.
- Max active props per player is configured.
- Max active global props is configured.
- Permissions are not too open.
- Admin cleanup command is available.
```

Recommended:

```txt
Increase cooldowns and reduce max active props.
```

***

#### Players can use props in restricted areas

Check:

```txt
- Zone restrictions are configured if supported.
- Placement validation is enabled.
- custom.lua restriction logic is returning the correct result.
```

***

#### Prop effect feels too strong

Check:

```txt
- Effect settings.
- Duration settings.
- Cooldown settings.
- Whether the effect should be disabled for serious RP areas.
```

Recommended:

```txt
Keep prank effects light and short.
```

***

#### NUI or menu does not open

Check:

```txt
- web/ folder exists if a menu is used.
- ui_page is correctly declared in fxmanifest.lua.
- F8 console has no JavaScript errors.
- Another NUI is not blocking focus.
- Resource folder name is still sl_prank_props.
```

***

### Version Notes

#### v1.0.4

* Clean manifest/package fix.
* Removed references to files not included in the clean release package.
* Package starts without missing documentation/marketing file warnings.
* Maintains clean release structure for Tebex/CFX delivery.

#### v1.0.x

* Stable prank prop release line.
* Light RP prop usage supported.
* Item/command usage depending on configuration.
* Cleanup, permission and configuration behavior supported depending on server setup.

***

### Support

When asking for support, include:

```txt
Product: SL Prank Props
Resource name: sl_prank_props
Version:
Framework:
Inventory:
Target system:
Issue:
Steps to reproduce:
Configured item:
Configured prop:
Server console error:
Client F8 error:
Screenshot/video:
```

Example:

```txt
Product: SL Prank Props
Resource name: sl_prank_props
Version: v1.0.4
Framework: Qbox
Inventory: ox_inventory
Target system: ox_target
Issue: Item is used but prop does not appear
Steps to reproduce: Use configured prank item from inventory
Configured item: banana_peel
Configured prop: banana peel
Server console error: none
Client F8 error: attached
Screenshot/video: attached
```

***

### Final Notes

SL Prank Props works best when used as a light social RP system.

For best results, keep prank props harmless, configure cooldowns, limit spam and use admin cleanup tools to keep shared spaces clean.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sl-scritps.gitbook.io/sl-scripts-documentation/products/sl-prank-props.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
