💧 Silly Springs – Mystic Sacred Springs (RedM)

An immersive mystic springs system for RedM. Players enter sacred spring zones, experience rotating visual effects, wash away dirt and blood, and summon spirit animal companions. Access is restricted to configurable jobs and grades.

✨ Features

• 💧 Zone-based springs: multiple configurable zones, each with its own radius
• 🌈 Rotating visual FX: 11 colorful post-FX effects cycling at configurable intervals
• 🧼 Wash mechanic: removes dirt, blood, and all damage decals with animation
• 🐃 Animal companions: summon / despawn spirit animals via hold prompts
• 🔁 Toggle animals: hold prompt again to despawn an already summoned companion
• 🎮 Hold-prompt system: all interactions via native RDR2 hold prompts
• 🔒 Job restriction: whitelist access by job name and minimum grade
• ⚙️ Fully configurable: zones, FX, prompts, controls, animations, animals
• 🌐 Multi-Framework: VORP + RSGCore (auto-detected)
• ⚡ Optimized: long sleep when far away, Wait(0) only while inside zone

✅ Dependencies

• RedM
• VORP Core or RSGCore (auto-detected at runtime)

No database or oxmysql required.

📦 Installation

1. Place Silly_Springs in your server resources folder.

2. Ensure it in your server.cfg:

   ensure Silly_Springs

3. Configure zones, jobs, and prompts in config.lua.

⚙️ Configuration (config.lua)

Framework

• Config.Framework — 'auto' | 'vorp' | 'rsgcore'

Job Restriction

• Config.JobRestriction.enabled — enable/disable restriction
• Config.JobRestriction.allowedJobs — list of { name, minGrade } entries

Zones

• Config.Zones — list of { coords = vector3(...), radius = number } entries

Visual FX

• Config.FX.rotationInterval — ms between effect switches
• Config.FX.effects — list of post-FX names to cycle through

Prompts

• Config.Prompts.groupLabel — label shown above the prompt group
• Config.Prompts.holdDuration — ms to hold before action triggers
• Config.Prompts.wash.control — control hash for the wash prompt
• Config.Prompts.wash.text — prompt label text
• Config.Prompts.animals — list of { control, text, model, offset } entries

Wash Animation

• Config.Wash.dict — animation dictionary
• Config.Wash.anim — animation name
• Config.Wash.duration — animation duration in ms

Animal Settings

• Config.AnimalSettings.followDistance — follow offset distance
• Config.AnimalSettings.followSpeed — follow movement speed
• Config.AnimalSettings.invincible — make animals invincible (true/false)
• Config.AnimalSettings.cooldown — cooldown ms between summon/despawn toggles

🌐 Multi-Framework Support

Silly Springs automatically detects whether your server runs VORP or RSGCore and uses the correct API calls. No manual configuration needed.

| Feature | VORP | RSGCore | |---|---|---| | Job Check | char.job / char.jobGrade | Player.PlayerData.job | | Notifications | vorp:TipBottom | RSGCore:Notify |

🎮 How It Works

1. Player walks into a configured spring zone
2. Server checks job restriction — denied players get a notification
3. Colorful post-FX effects rotate automatically
4. Hold prompts appear (Wash, Summon Buffalo, Summon Boar)
5. Holding Wash plays animation and clears all dirt/blood/decals
6. Holding an animal prompt summons the companion (hold again to despawn)
7. On zone exit: effects stop, all companion animals are removed