Skip to content
Retro Docs

Retro Goldpanning

The resource is split into protected core files and editable integration/configuration files.

  • Directoryrs_goldpanning/
    • Directorybridge/
      • Directoryframework/
        • …
      • Directoryinventory/
        • …
      • Directorytarget/
        • …
      • detect.lua
    • Directoryclient/
      • …
    • Directorydata/
      • …
    • Directoryeditable/
      • client.lua
      • progress.lua
      • server.lua
    • Directoryinstall/
      • Directoryimages/
        • …
    • Directorylocales/
      • en.json
      • tr.json
    • Directoryserver/
      • Directorystorage/
        • …
    • Directoryshared/
      • …
    • Directorystream/
      • …
    • Directoryweb/
      • Directorydist/
        • …
    • config.lua
    • fxmanifest.lua
    • README.md

Editable Files

Section titled “Editable Files”

config.lua

Section titled “config.lua”

The main configuration file.

Use it to configure:

  • Framework and inventory
  • Storage mode
  • Loot chances
  • Zone depletion
  • Panning gameplay
  • Controls
  • UI modes
  • Highbanker settings
  • Pump and hose behavior
  • Work lights
  • Buyers
  • Selling prices and limits
  • Orders
  • Prospector levels
  • Admin access
  • Blips

Most server owners only need to edit this file.

editable/client.lua

Section titled “editable/client.lua”

Client-side customization hooks.

Includes:

  • Notification integration
  • Custom hint UI
  • Custom target adapter hooks
  • Start/stop hooks
  • Client-side start conditions

Useful functions include:

Editable.Notify(message, type, duration)
Editable.OnStart()
Editable.OnStop()
Editable.CanStart()

editable/server.lua

Section titled “editable/server.lua”

Server-side integrations and security hooks.

Includes:

  • Custom framework functions
  • Custom inventory functions
  • Server-side panning conditions
  • Server-side placement conditions
  • Custom admin checks
  • Discord admin IDs
  • Discord webhook configuration
  • Collection and logging hooks

Important functions include:

Editable.CanStartServer(source)
Editable.CanPlaceServer(source, kind, coords)
Editable.IsAdmin(source)
Editable.OnCollect(source, data)
Editable.OnLog(event, payload)

editable/progress.lua

Section titled “editable/progress.lua”

Controls the progress bar backend used for actions such as filling and pouring buckets.

Built-in backends:

original
ox
qb
custom

Use the custom backend if you want to integrate another progress bar resource.

Bridge Files

Section titled “Bridge Files”

The bridge/ directory contains framework, inventory and target adapters.

Framework

Section titled “Framework”
bridge/framework/
├── custom.lua
├── esx.lua
├── qb.lua
└── qbx.lua

Inventory

Section titled “Inventory”
bridge/inventory/
├── codem.lua
├── core.lua
├── custom.lua
├── framework.lua
├── ox.lua
├── qb.lua
├── qs.lua
└── tgiann.lua

Target

Section titled “Target”
bridge/target/
├── custom.lua
├── init.lua
├── ox.lua
└── qb.lua

You normally do not need to modify these files unless your framework or inventory version uses different exports or behavior.

Locale Files

Section titled “Locale Files”
locales/
├── en.json
└── tr.json

To add another language:

  1. Copy en.json.
  2. Rename the copy, for example de.json.
  3. Translate the values without changing the keys.
  4. Set:
Config.Locale = 'de'

Data Files

Section titled “Data Files”

When JSON storage is enabled, persistent data is stored inside:

data/
├── levels.json
├── lights.json
├── rigs.json
├── sales.json
├── zone_stats.json
└── zones.json

Do not manually edit these files while the server is running.

When:

Config.Storage = 'mysql'

persistent data is stored in the configured database tables instead.

Install Files

Section titled “Install Files”

Inventory images are included in:

install/images/

Copy the required icons into your inventory’s image directory when needed.

Stream Files

Section titled “Stream Files”

The stream/ directory contains the models and textures used by the gold panning and highbanker systems.

This includes:

  • Gold pan
  • Finds
  • Rocks
  • Highbanker
  • Water pump
  • Hose parts
  • Highbanker water effect
  • Rope/hose textures

The current release intentionally excludes stream/* from Asset Escrow where required for third-party asset licensing.

Do not run another resource that streams the same gold-mining props at the same time.

The custom rope.ytd changes GTA’s rope texture while used by the resource. If you prefer the default GTA rope appearance, remove the custom rope texture as described in the resource configuration/readme.

Protected Core

Section titled “Protected Core”

The core gameplay logic is located in:

client/
server/
shared/

These files contain the main gameplay, synchronization, persistence and server validation logic and are intended to remain protected in the release build.

The editable configuration, bridge, locale and data files remain available for server owners.