📝 Overview
Codex Dirty System adds a dynamic, fully synced hygiene layer to your RedM roleplay server.
Every sprint through the mud, every gunfight, every minute spent surviving in the wild slowly builds up a player’s dirt level which then triggers visible grime overlays and buzzing flies around filthy characters.
No menus, no UI clutter just environmental storytelling and automatic immersion.
⭐ Key Features
Real-Time Dirt Accumulation
Players gain dirt from configurable actions: running, shooting, taking damage, time outside, etc.
All values are adjustable in the config so you can fine-tune how fast players get dirty.
Fly FX & Visual Grime Overlays
Dirty characters attract looping fly particles.
Native damage/dirt overlays make players visibly grimy and worn out.
Environmental Clean-Up System
Rain and thunderstorms naturally reduce dirt over time.
Players can be cleaned automatically by the world — no need for commands.
Optimized Network Resync
Dirt levels and FX are synced across all clients.
When players load or stream in, their current hygiene state (clean/dirty, flies on/off) is instantly applied or removed.
Customizable Thresholds & Effects
Configure how dirty a player must be before flies or overlays appear.
Independently toggle overlays, flies, decals, or any combination.
🧰 Developer & Admin Tools
Exports for advanced control:
getPlayerDirtyLevel(source)modifyPlayerDirtyLevel(source, amount)clearPlayerDirtyLevel(source)
Perfect for:
Custom jobs (e.g. bath houses, camps, lawmen, butchers).
Admin tools that punish/reward hygiene.
Developer Mode
Built-in dev mode with:
Helpful console logs
Test commands (e.g.
/dirtydata,/effect)Visual feedback for tuning thresholds and effects
🌩 Weather-Responsive Design
Rain: Gradually washes dirt away.
Thunderstorms: Can fully clean or heavily reduce dirt levels.
Fully automatic – the environment does the work and supports natural roleplay (no “/cleanme” spam).
🧪 Example Use-Cases
Survival RP where hygiene is part of the experience
Lawman / bounty hunter servers that track “dirty outlaws”
Story-focused servers using appearance to show what characters have been through
Enhancing immersion without extra UI or menus
📦 Requirements & Dependencies
Requires:
codex_coreDependencies:
codex_corecodex-notificationsoxlib
🧱 Framework Support
Frameworks supported via Codex Core:
RSG
VORP
TPZ-CORE
🚀 Performance
Optimized, lightweight client & server logic
Designed to run continuously with minimal impact on performance.
🔧 Installation (Plug & Play)
Drop the resource into your
resourcesfolder.Add
ensure codex_dirtysystem(or your folder name) to your server config.Make sure
codex_core,codex-notifications, andoxlibare running.Configure dirt thresholds, weather behavior, and dev mode in the config file.
👉 Documentation : https://codexstudios.gitbook.io/codexstudios-store

