config.lua
The configuration file has been updated to include all options with detailed information about what they actually do. These settings are default settings and can be overridden by the user in their client. There are not a lot of options of but they are well detailed.
Config = {}
--[[
================================================================================
CORNERSTONE NOTIFY
Configuration Guide
================================================================================
This configuration file controls the default notification appearance and behavior.
Players can override these settings in-game using the /notify command.
================================================================================
]]
--------------------------------------------------------------------------------
-- POSITION SETTINGS
--------------------------------------------------------------------------------
--[[
If true, the configured position below overrides any position passed to
sendNotification. Set to false to allow per-notification positioning.
]]
Config.usePosition = true
--[[
Default screen position for notifications.
+-----------------------------------------------------------------------------+
| Value | Description |
+-----------------------------------------------------------------------------+
| top-left | Upper left corner of the screen |
| top-center | Upper center of the screen |
| top-right | Upper right corner of the screen |
| left | Middle left side of the screen |
| right | Middle right side of the screen |
| bottom-left | Lower left corner of the screen |
| bottom-center | Lower center of the screen |
| bottom-right | Lower right corner of the screen |
+-----------------------------------------------------------------------------+
]]
Config.Position = 'top-center'
--------------------------------------------------------------------------------
-- THEME SETTINGS
--------------------------------------------------------------------------------
--[[
Visual theme for notifications. Each theme has unique colors, backgrounds,
borders, and effects.
+-----------------------------------------------------------------------------+
| Theme | Background | Accent Colors | Style |
+-----------------------------------------------------------------------------+
| dark | Blue-gray gradient | Rainbow multi-color | Default, vibrant |
| light | White gradient | Blue | Clean, bright |
| ocean | Deep navy-blue | Cyan to blue | Cool, calm |
| forest | Dark green | Green gradient | Natural, earthy |
| sunset | Warm brown-red | Coral to peach | Warm, cozy |
| midnight | Deep purple | Purple to lavender | Dreamy, elegant |
| blossom | Dark magenta | Pink to magenta | Feminine, playful |
| glass | Translucent gray | Clean blue | Modern, minimal |
| neon | Near black | Pink and cyan | Cyberpunk, gaming |
| ember | Dark red-brown | Red to orange-yellow | Fire, intense |
| arctic | Slate blue | White to ice blue | Cold, crisp |
| gold | Dark brown | Gold to amber | Luxury, premium |
| mono | Neutral gray | White to gray | Minimalist, clean |
| vapor | Dark purple | Pink-cyan-purple | Vaporwave, retro |
| toxic | Dark green-black | Lime to yellow | Radioactive, tech |
| blood | Dark red-black | Deep red to crimson | Dark, dramatic |
+-----------------------------------------------------------------------------+
]]
Config.Theme = 'dark'
--------------------------------------------------------------------------------
-- LAYOUT SETTINGS
--------------------------------------------------------------------------------
--[[
Notification layout style determines the structure and size of notifications.
+-----------------------------------------------------------------------------+
| Layout | Description |
+-----------------------------------------------------------------------------+
| card | Full-sized card with icon, title, message, and progress bar. |
| | Best for detailed notifications with longer messages. |
+-----------------------------------------------------------------------------+
| compact | Single-line slim notification with inline elements. |
| | Icon, title, and message appear on one row. Great for rapid |
| | notifications that shouldn't obstruct gameplay. |
+-----------------------------------------------------------------------------+
| minimal | Streamlined design with reduced visual elements. |
| | Clean and unobtrusive, focuses on the message content. |
+-----------------------------------------------------------------------------+
]]
Config.Layout = 'card'
--------------------------------------------------------------------------------
-- ANIMATION SETTINGS
--------------------------------------------------------------------------------
--[[
Entry and exit animation style for notifications.
+-----------------------------------------------------------------------------+
| Animation | Description |
+-----------------------------------------------------------------------------+
| slide | Slides in from the side with a subtle overshoot bounce. |
| | Classic, professional feel. |
+-----------------------------------------------------------------------------+
| fade | Fades in and out with opacity transition. |
| | Subtle and non-distracting. |
+-----------------------------------------------------------------------------+
| zoom | Scales up from small to full size. |
| | Attention-grabbing entrance. |
+-----------------------------------------------------------------------------+
| bounce | Bounces in with elastic movement. |
| | Playful and energetic. |
+-----------------------------------------------------------------------------+
| flip | 3D flip rotation effect. |
| | Unique and eye-catching. |
+-----------------------------------------------------------------------------+
| elastic | Springy overshoot with multiple wobbles. |
| | Satisfying, smooth bounce effect. |
+-----------------------------------------------------------------------------+
| glitch | Cyberpunk-style with RGB shifts and visual artifacts. |
| | Edgy, perfect for tech/hacker themes. |
+-----------------------------------------------------------------------------+
| swing | Pendulum rotation swinging into place from corner. |
| | Elegant, natural movement. |
+-----------------------------------------------------------------------------+
| drop | Falls from above with realistic gravity and bounce. |
| | Physics-based, playful feel. |
+-----------------------------------------------------------------------------+
| blur | Fades in from heavily blurred state, coming into focus. |
| | Cinematic, smooth appearance. |
+-----------------------------------------------------------------------------+
| morph | Expands from a small pill shape into full notification. |
| | Modern, fluid transformation. |
+-----------------------------------------------------------------------------+
]]
Config.AnimationStyle = 'slide'
--------------------------------------------------------------------------------
-- STACKING SETTINGS
--------------------------------------------------------------------------------
--[[
How multiple notifications are arranged when displayed simultaneously.
+-----------------------------------------------------------------------------+
| Stacking | Description |
+-----------------------------------------------------------------------------+
| cascade | Notifications scale down and fade as they stack. |
| | Newest is full size, older ones get progressively smaller. |
| | Clean hierarchy showing importance. |
+-----------------------------------------------------------------------------+
| stack | Cards pile with diagonal offset like stacked papers. |
| | Each notification slightly offset to show depth. |
| | Visual indicator of multiple notifications. |
+-----------------------------------------------------------------------------+
| overlay | Notifications overlap with slight vertical offset. |
| | Compact stacking, saves screen space. |
| | Good for high-frequency notifications. |
+-----------------------------------------------------------------------------+
| list | Notifications arranged in a straight vertical list. |
| | No overlap, each notification fully visible. |
| | Traditional, clear separation. |
+-----------------------------------------------------------------------------+
| fan | Notifications fan out at angles like a hand of cards. |
| | Dramatic, spreads notifications across more space. |
| | Eye-catching for important alerts. |
+-----------------------------------------------------------------------------+
]]
Config.Stacking = 'cascade'
--------------------------------------------------------------------------------
-- HISTORY PANEL SETTINGS
--------------------------------------------------------------------------------
--[[
The history panel shows the last 3 notifications received. Players can toggle
it with a keybind to review missed messages. Panel auto-closes after 15 seconds.
Set the default keybind below. Players can rebind this in their FiveM settings.
]]
Config.historyHotkey = 'H'
Last updated