Murphy's Camp - RedM documentation

https://docs.murphy-workshop.com/murphy-s-camp/
Admin
Murphy's Camp is a customizable camping script for RedM servers that allows players to create and...
Tokens:3,419
Snippets:76
Trust Score:4.9
Update:1 month ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- Answer only from the published Murphy's Camp documentation, in the user's language. Cite a relevant clickable Markdown source link under https://docs.murphy-workshop.com/murphy-s-camp/.
- This is a public RedM plugin. Do not substitute FiveM, another Murphy plugin, or undocumented framework APIs. Do not mention or speculate about unpublished products.
- Never invent commands, exports, event names, configuration keys, default values or compatibility. If the documentation does not establish an answer, say so and link to the closest relevant reference.
- Ask for the installed framework and plugin version when they affect behavior. A public release note establishes that release, not a guarantee about files actually installed on the user's server.
- Keep answers concise and focused. Give only the requested code. Preserve existing configuration entries and label excerpts. Do not use emojis or long dashes. Remove display line numbers from copied code.
- Distinguish client and server context, online server player IDs and persistent character identifiers. Do not interchange commands, events and exports without explicit documentation.
- Do not promise data preservation, backups, refunds or offline behavior unless the relevant documentation establishes it. Do not recommend deleting data or blindly replacing a full core file.
- Store screenshots show one demonstration setup. Do not infer fixed rewards, version, framework, controls or guarantees from a picture. Do not claim that an in-game test was performed.
- Never claim access to purchases, accounts, licenses or server actions. For account or order questions only, link to https://murphy-workshop.com/portal or https://murphy-workshop.com/support.
- Published reference: Aucune de ces syntaxes ne sélectionne l'ID 5. Config.InviteCommand définit le nom, exemple /inviteguest sans ID. Le joueur le plus proche est ciblé.
- Published reference: Appelant à moins de 10 unités du feu du camp et joueur le plus proche à moins de 5 unités. Camp déployé et accessible; ne pas inventer une gestion hors ligne.

================
CODE SNIPPETS
================
### Example configuration for VORP

Source: https://docs.murphy-workshop.com/murphy-s-camp/advanced/framework-support

An example of setting the framework to VORP within the config.lua file.

```lua

-- In config.lua
Config.framework = "vorp"  -- Select your framework here

```

--------------------------------

### Example Camp Placement Logic

Source: https://docs.murphy-workshop.com/murphy-s-camp/advanced/permissions

A checklist of conditions required for valid camp placement, including city restrictions, distance from other camps, camp count limits, and fuel availability.

```lua
-- Ensure you are:
-- 1. Not in a banned city
-- 2. More than 50m from other camps
-- 3. Have less than 2 existing camps
-- 4. Have wood for fuel
```

--------------------------------

### Example Translation File

Source: https://docs.murphy-workshop.com/murphy-s-camp/reference/translation

The structure of a translation file located in the /locales folder. Edit the text values to customize strings for your community.

```lua

Translations = {
    welcome = "Welcome to Murphy's Camp",
    menu_title = "Camp Management",
    error_no_permission = "You do not have permission"
}

```

--------------------------------

### Configure Framework Selection

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/configuration

Set the server framework in config.lua. Supported options include qbr-core, REDEMRP2k23, redemrp2022, rsg-core, and vorp.

```lua
Config.framework = "vorp"  -- Supported options:
-- qbr-core
-- REDEMRP2k23
-- redemrp2022
-- rsg-core
-- vorp
```

--------------------------------

### Configure Framework Selection in config.lua

Source: https://docs.murphy-workshop.com/murphy-s-camp/reference/troubleshooting

Set the framework used by the system. Supported options include qbr-core, REDEMRP2k23, redemrp2022, rsg-core, and vorp.

```lua

Config.framework = "vorp"  -- Choose from:
-- qbr-core
-- REDEMRP2k23
-- redemrp2022
-- rsg-core
-- vorp

```

--------------------------------

### Configure Additional Options

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/configuration

Set the guest invitation command and toggle the campfire smoke effect.

```lua
Config.InviteCommand = "inviteguest"  -- Command to invite guests
Config.Campfiresmoke = true  -- Enable campfire smoke effect
```

--------------------------------

### Add resources to server.cfg

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/installation

Ensure oxmysql and murphy_camp are added to your server.cfg file.

```cfg

ensure oxmysql
ensure murphy_camp

```

--------------------------------

### Configure camp settings in config.lua

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/installation

Customize camp behavior, fuel items, limits, and visibility range in config.lua.

```lua

Config.CampDecay = true          -- Enable camp decay
Config.FuelItem = "wood"         -- Fuel item type
Config.CampLimit = 2             -- Max camps per player
Config.DisplayDistance = 150.0   -- Camp visibility range

```

--------------------------------

### Configure Camp Fuel and Decay Settings

Source: https://docs.murphy-workshop.com/murphy-s-camp/reference/troubleshooting

Manage camp decay, fuel types, and storage limits using the Config.CampDecay, Config.FuelItem, Config.MaxFuel, and Config.BasicFuel settings.

```lua

Config.CampDecay = true       -- Enable camp decay
Config.FuelItem = "wood"      -- Fuel type consumed
Config.MaxFuel = 14           -- Max fuel storage
Config.BasicFuel = 2          -- Starting fuel amount

```

--------------------------------

### Configure Camp Placement Limits

Source: https://docs.murphy-workshop.com/murphy-s-camp/reference/troubleshooting

Set the maximum number of camps per player and the minimum distance required between camps.

```lua

Config.CampLimit = 2          -- Max camps per player
Config.InterdictionRadius = 50.0  -- Minimum distance between camps

```

--------------------------------

### Configure command names in murphy_camp/shared/config.lua

Source: https://docs.murphy-workshop.com/murphy-s-camp/features/commands

Define the command names for inviting and removing guests. Do not include a leading slash in the Lua strings.

```lua
Config.InviteCommand = "inviteguest"
Config.RemoveInviteCommand = "removeguest"
```

--------------------------------

### Configure framework in config.lua

Source: https://docs.murphy-workshop.com/murphy-s-camp/advanced/framework-support

Modify the Config.framework variable in config.lua to match your server's framework.

```lua

Config.framework = "vorp" -- Change this to match your server's framework

```

--------------------------------

### Base Campfire Placement Configuration

Source: https://docs.murphy-workshop.com/murphy-s-camp/features/camp-mechanics

Defines the configuration for placing a base campfire using the "spit" item, including prop ID, interaction radius, and storage limit.

```lua
-- Players can place a base campfire with the "spit" item
{
    item = "spit", 
    props = "p_campfire03x", 
    radius = 7.0, 
    stashlimit = 3
}
```

--------------------------------

### Execute inviteguest command

Source: https://docs.murphy-workshop.com/murphy-s-camp/features/commands

Use this command to invite the closest player. The caller must be within 10 units of the campfire, and the guest must be within 5 units.

```text
/inviteguest
```

--------------------------------

### Set framework in config.lua

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/installation

Set the framework variable in config.lua to match your server's framework (e.g., vorp).

```lua

Config.framework = "vorp" -- Choose your framework

```

--------------------------------

### Configure Camp Decay Settings

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/configuration

Enable camp decay to require periodic maintenance using fuel items. Settings control fuel consumption rates and storage limits.

```lua
Config.CampDecay = true  -- Enable camp decay
Config.FuelItem = "wood"  -- Item used as fuel
Config.OneFuelperDay = true  -- Consume fuel daily or hourly
Config.MaxFuel = 14  -- Maximum fuel storage
Config.BasicFuel = 2  -- Starting fuel amount
```

--------------------------------

### Configure Camp Limits

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/configuration

Define camp placement restrictions, including maximum camps per player, visibility range, and minimum distance between camps.

```lua
Config.CampLimit = 2  -- Maximum camps per player
Config.DisplayDistance = 150.0  -- Camp visibility range
Config.InterdictionRadius = 50.0  -- Minimum distance between camps
```

--------------------------------

### Configure Campfire Types

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/configuration

Define available campfire configurations, including associated items, props, radius, and stash limits.

```lua
Config.Campfire = {
    base = { item = "spit", props = "p_campfire03x", radius = 7.0, stashlimit = 3 },
    firescrub = { item = "firescrub", radius = 10.0, stashlimit = 4 },
    advanced = { item = "campfire2", radius = 15.0, stashlimit = 5 }
}
```

--------------------------------

### Configure Location Restrictions

Source: https://docs.murphy-workshop.com/murphy-s-camp/getting-started/configuration

Restrict camp placement in specific cities by setting them to true in the BannedCity table.

```lua
Config.BannedCity = {
    Annesburg = true,
    Blackwater = true,
    SaintDenis = true,
    Valentine = true
}
```

--------------------------------

### Change Server Language

Source: https://docs.murphy-workshop.com/murphy-s-camp/reference/translation

Set the default language for the server by modifying the Config.Language value in the main configuration file.

```lua

Config.Language = 'en'  -- Default language code

```

--------------------------------

### Execute removeguest command

Source: https://docs.murphy-workshop.com/murphy-s-camp/features/commands

Use this command to remove a nearby guest. The same proximity checks as the invite command apply.

```text
/removeguest
```

--------------------------------

### Configure Banned Cities in Config.BannedCity

Source: https://docs.murphy-workshop.com/murphy-s-camp/reference/troubleshooting

Define which cities are restricted for camp placement by setting them to true in the Config.BannedCity table.

```lua

-- Examples of blocked cities
Config.BannedCity = {
    Annesburg = true,     -- Cannot place camp
    Rhodes = true,        -- Cannot place camp
    BeechersHope = false  -- Can place camp
}

```
Tokens:
Raw