Features & Details
Edit your server configs directly ingame without alt-tabbing!
## ✨ Why CY Config Editor?
Tired of constantly switching between your game and file explorer to edit configs? **CY Config Editor** lets you edit ANY resource's config files directly from ingame with a beautiful, modern UI.
Perfect for:
-
🎮 **Server Owners** - Quick config changes without server restarts
-
🛠️ **Developers** - Test config values in real-time
-
👥 **Admin Teams** - Easy access without FTP/file access needed
---
## 🚀 Features
### 💻 Professional Code Editor
- Full syntax highlighting for Lua, JSON, and more
- Line numbers with cursor position tracking
- **Search function (Ctrl+F)** with navigation
- Auto-detects file types
- Character and line counter
### 🎛️ Visual Editor *(Unique Feature!)*
- **Automatically generates GUI controls** from your config values
- Sliders for numbers, toggles for booleans
- Text inputs for strings
- Vector editors for coordinates
- **Perfect for non-technical admins!**
### 🗺️ Location Editor
- Get your current player coordinates instantly
- Supports Vector3, Vector4, table, and array formats
- Preview locations with map markers
- One-click copy to clipboard
### 📦 Smart Resource Detection
- Auto-detects ALL server resources
- Shows file structure from fxmanifest.lua
- Filter by Started/Stopped status
- Search resources by name
- Customizable blacklist
### 💾 Automatic Backup System
- Creates timestamped backups before every save
- Never lose your original configs
- Configurable backup settings
### 🔒 Security First
- ACE permission system
- Standalone permission mode
- File extension whitelist
- Restricted files blacklist
- **Escrow files are protected**
---
## 📄 Supported File Types
✅ `.lua` - Lua scripts & configs
✅ `.json` - JSON configuration files
✅ `.cfg` / `.ini` - Server configs
✅ `.txt` - Text files
✅ `.html` / `.css` / `.js` - NUI files
✅ `.xml` / `.yml` / `.yaml` - Data files
✅ `.md` - Markdown files
---
## 🖥️ How It Works
-
**Select a resource** from the sidebar
-
**Choose a file** to edit
-
**Make your changes** in the code or visual editor
-
**Save** - Changes are applied automatically!
-
**Reload the resource** with one click
### ⚠️ Important Note About Saving
Due to RedM/FiveM platform security, scripts cannot directly write to other resource folders. This is a **security feature**, not a limitation of this script.
**Our Solution:**
- Run `auto_apply_configs.bat` (Windows) or `auto_apply_configs.sh` (Linux) in the background
- The watcher automatically copies your saved files to the correct locations
- Seamless experience - just keep the watcher running while you edit!
*This is the cleanest solution possible within FiveM/RedM's security model.*
---
## 📦 What's Included
```
CY-configeditor/
├── client/main.lua
├── server/main.lua
├── shared/framework.lua
├── html/
│ ├── index.html
│ ├── style.css
│ └── script.js
├── config.lua
├── fxmanifest.lua
├── auto_apply_configs.bat ← Windows auto-watcher
├── auto_apply_configs.sh ← Linux auto-watcher
└── README.md ← Full documentation
```
---
## ⚙️ Easy Configuration
```lua
Config = {}
-- Debug Mode (shows detailed logs with rate-limiting)
Config.Debug = false
-- Framework Detection
Config.Framework = 'standalone' -- 'auto', 'standalone'
-- Permission System
Config.UseAcePermissions = true
Config.AcePermission = 'configeditor.admin'
-- Alternative: Framework-Based Permissions
Config.AllowedGroups = {
['admin'] = true,
['owner'] = true,
['developer'] = true
}
-- Security
Config.RestrictedFiles = {
'server.cfg',
'password',
'key',
'license',
'token',
'secret',
'credentials',
'.env'
}
-- ERWEITERT: Alle editierbaren Dateitypen
Config.AllowedExtensions = {
-- Lua
'.lua',
-- Web/NUI
'.html',
'.htm',
'.css',
'.js',
'.jsx',
'.ts',
'.tsx',
'.vue',
-- Data/Config
'.json',
'.xml',
'.yml',
'.yaml',
'.ini',
'.cfg',
'.conf',
'.config',
'.toml',
-- Text
'.txt',
'.md',
'.log',
-- SQL
'.sql',
-- Sonstige
'.csv',
'.properties'
}
-- Auto-Detect Mode
Config.AutoDetectResources = true -- If true, all resources are automatically detected
-- Optional: Manual Whitelist (only if AutoDetect = false)
Config.EditableResources = {
'your_job_script',
'your_shop_script',
-- Only relevant if AutoDetect = false
}
-- Blacklist for sensitive Resources (will ALWAYS be excluded)
Config.BlacklistedResources = {
-- Database
'mysql-async',
'oxmysql',
'ghmattimysql',
-- System/Core
'screenshot-basic',
'sessionmanager',
'hardcap',
'rconlog',
'monitor',
'mapmanager',
'spawnmanager',
'fivem',
'yarn',
'webpack',
'chat',
'baseevents',
'basic-gamemode',
'cron',
'money',
-- Chat/Theme
'chat-theme-gtao',
-- FiveM Maps
'fivem-map-hipster',
'fivem-map-skater',
-- Common Libraries
'bob74_ipl',
'PolyZone',
'progressbar',
'menuapi',
'warmenu',
'mythic_progbar',
'mythic_notify',
'pNotify',
-- FiveM Default
'webadmin',
'scoreboard',
'playernames'
}
-- Automatically exclude System Resources
Config.IgnoreSystemResources = true -- [fivem], [system], etc.
-- Additionally: Ignore resources with specific prefixes
Config.IgnoreResourcePrefixes = {
-- 'qb-', -- Uncomment if you don't want QB-Core standard resources
-- 'esx_', -- Uncomment if you don't want ESX standard resources
}
-- Only show Resources with specific files
Config.RequiredFiles = {
'config.lua',
'settings.lua',
'config.json',
'settings.json',
'shared.lua',
}
Config.ShowAllResources = true -- If true, ALL resources are shown (even without config files)
-- Backup System
Config.AutoBackup = true
Config.BackupInterval = 3600 -- Seconds (1 hour)
Config.MaxBackups = 10
Config.BackupPath = 'backups/'
-- Logging
Config.LogChanges = true
Config.LogPath = 'logs/config_changes.log'
Config.DiscordWebhook = '' -- Optional: Discord Webhook for change logs
-- UI Settings
Config.UIPosition = 'center' -- 'center', 'right', 'left'
Config.DefaultTheme = 'dark' -- 'dark', 'light'
Config.ShowTutorial = true
-- Editor Features
Config.EnableSyntaxCheck = true
Config.EnableAutoSave = false
Config.AutoSaveInterval = 300 -- 5 minutes
Config.EnableVersioning = true
Config.MaxVersionHistory = 50
-- Location Editor
Config.ShowMarkerPreview = true
Config.MarkerType = 1 -- GTA V Marker Type (1 = Cylinder)
Config.PreviewRadius = 100.0
-- Commands
Config.OpenCommand = 'configeditor'
Config.ReloadCommand = 'reloadconfig'
-- Keybind
Config.OpenKey = 166 -- F5 Key (GTA V Native)
-- Multi-Language Support
Config.Locale = 'de' -- 'en', 'de', 'fr', 'es'
Config.Locales = {
['de'] = {
['open_editor'] = 'Config Editor öffnen',
['save_success'] = 'Konfiguration erfolgreich gespeichert',
['save_error'] = 'Fehler beim Speichern',
['backup_created'] = 'Backup erstellt',
['no_permission'] = 'Keine Berechtigung',
['file_not_found'] = 'Datei nicht gefunden',
['invalid_syntax'] = 'Ungültige Syntax erkannt',
['confirm_changes'] = 'Änderungen bestätigen?',
['restart_required'] = 'Server-Neustart erforderlich',
},
['en'] = {
['open_editor'] = 'Open Config Editor',
['save_success'] = 'Configuration saved successfully',
['save_error'] = 'Error saving configuration',
['backup_created'] = 'Backup created',
['no_permission'] = 'No permission',
['file_not_found'] = 'File not found',
['invalid_syntax'] = 'Invalid syntax detected',
['confirm_changes'] = 'Confirm changes?',
['restart_required'] = 'Server restart required',
}
}
---
## 📋 Requirements
- ✅ RedM Server (Latest Artifact)
- ✅ OneSync (Recommended)
- ✅ Works standalone or with VORP Framework
---
## 🎯 Perfect For
| Use Case | Benefit |
|----------|---------|
| Quick config tweaks | No more alt-tabbing to file explorer |
| Testing spawn locations | Use the Location Editor to get coords |
| Training new admins | Visual Editor is beginner-friendly |
| Remote management | Edit configs without FTP access |
| Live debugging | Change values and see results instantly |
---
## 💬 Support
-
📖 **Full Documentation** included (README.md)
-
💬 **Discord Support:** [CY DevWorks]()
-
🐛 **Bug Reports:** Via Discord ticket system
-
🔄 **Free Updates:** Lifetime updates included
---
## 📝 Changelog
**v1.2.0** - Auto-Watcher Update
- NEW: `auto_apply_configs.bat` for Windows
- NEW: `auto_apply_configs.sh` for Linux
- Automatic file copying in real-time
- Improved pending file system
**v1.1.0** - RedM Update
- Full RedM/VORP compatibility
- Improved backup system
- Better error handling
**v1.0.0** - Initial Release
- Code Editor with syntax highlighting
- Visual Editor with auto-generated controls
- Location Editor
- Backup system
---
## ⚖️ License Terms
✅ Use on multiple servers you own
✅ Customize configuration
❌ Resell or redistribute
❌ Share with others
❌ Decompile or reverse engineer
---
## 🛒 Purchase Includes
- ✅ Lifetime updates
- ✅ Discord support
- ✅ Detailed documentation
- ✅ Windows & Linux support
---
**Made with ❤️ by CY DevWorks**
*Stop alt-tabbing. Start editing ingame.*