Skip to content

Latest commit

 

History

History
111 lines (85 loc) · 3.45 KB

README.md

File metadata and controls

111 lines (85 loc) · 3.45 KB
Raw

logo

Code Wizards Notification System

📝 Table of Contents



🖼️ ShowCase

warning success sms info general error



💡 Todo

  • Improve user-friendliness of the project
  • Add sound support
  • Introduce more features
  • Fix existing bugs


⛓️ Dependencies

  • No dependencies! It's standalone :D


🚀 Future Scope

The project is highly customizable. You can manage the main style, borders, glowing effects, and more.

  • 🔎 Configuration table for notification locations
  • 🔎 Adjustable mapping of notification locations
  • 🔰 Customizable corner radius for notifications
  • 🖼️ Background color for notifications (supports HEX and RGB formats, e.g., 'rgb(0, 0, 0)')
  • 🛳️ Divider line between header and message (supports HEX and RGB formats, e.g., 'rgb(0, 0, 0)')
  • ✨ Glowing animation for notifications
  • 📛 Minimum and maximum allowed height for notifications
  • 📛 Actual notification height
  • 📛 Minimum and maximum allowed width for notifications
  • 📛 Actual notification width
  • 📦 Icon size before the title text
  • ⌚ Default timeout duration for notifications (in milliseconds)
  • 🗨️ Default title to use when no title is provided
  • ❗ Option to force the use of the default title instead of a provided title
  • 🕶️ Border settings for notifications:
    • Adjustable border size with suffixes (e.g., 'px', '%')
    • Customizable border types
    • Enable or disable each border individually


🏁 Getting Started

This guide will help you set up the script easily!

Setting up

  1. Download the folder and remove the -main suffix from it. The folder name should be wizard-notify.

Installing

  1. Copy the folder and paste it into your resources folder.
  2. Add the following code to your server.cfg. Make sure to place it at the top of the resources list to ensure it's loaded before other resources:
ensure wizard-notify
  1. Restart your server and test the script using the command: /testnotify.


🎈 Usage

  • To send notifications from a client-side file, use the following code:
exports['wizard-notify']:Send('Title', 'Message', Time, 'type')

  • To send notifications from a server-side file, use the following code:
TriggerClientEvent('wizard-notify:Send', source, 'Title', 'Message', Time, 'type')

✍️ Authors

  • @The_Hs5