Skip to content
EmergencyForgePublic

About

FiveM GUI library - Vue.js menu system, notifications, button hints

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

ef_lib - Core UI Framework für FiveM

GitHub commit activity

Das Ziel von ef_lib ist es, eine umfassende und moderne UI-Bibliothek für FiveM-Server bereitzustellen. Das Framework bietet ein vollständiges Menü-, Dialog-, Benachrichtigungs- und Interaktionssystem und dient als Alternative zu bestehenden Lösungen wie ox_lib. Die Benutzeroberfläche basiert auf Vue.js 3 mit TypeScript und lässt sich über eine einfache Konfiguration an das eigene Serverprojekt anpassen. Das System befindet sich aktuell in Entwicklung und wird stetig erweitert.

Der Vorteil - immer kostenlos & immer Open Source!

Das Projekt wird hobbymäßig von EmergencyForge entwickelt und ist für jegliche Unterstützung, Anpassungen, Wünsche & Ideen offen. Das Projekt ist vollkommen Open Source und kann von jedem angewandt, umgesetzt und verändert/angepasst werden.


Dokumentation

Anleitungen und die Referenz aller Exports und Events stehen unter docs.emergencyforge.de/ef-lib. Die Referenz lässt sich durchsuchen und nach Client, Server und Events filtern.


Features

  • Menüsystem - Dynamische Menüs mit Buttons, Checkboxen, Inputs, Selects, Nummernfeldern, Untermenüs & Bestätigungen inkl. Suchfunktion
  • Dialogsystem - Input-Dialoge mit verschiedenen Feldtypen (Input, Number, Checkbox, Select, Slider, Textarea, Farbe, Datum, Mehrfachauswahl) sowie Alert-Dialoge
  • Callback-System - Synchrone & asynchrone Client-Server-Kommunikation mit automatischem Timeout und Cleanup
  • Benachrichtigungen - Toast-Notifications mit den Typen: Success, Error, Warning & Info
  • Minispiele - Vier Skillchecks: Schloss knacken mit Spannung, Tresor mit verstecktem Code, Reaktionskette und Kabel verbinden. Vier Stufen oder eigene Werte, Klänge und Ergebnis mit Zeit und Fehlversuchen
  • Skillcheck - Timing-Ring wie bei ox_lib, mehrere Stufen hintereinander, der Spieler kann weiterlaufen
  • Anfragen - Annehmen oder Ablehnen per Taste, vom Client oder Server aus, etwa für Einladungen
  • Progressbar - Fortschrittsanzeige mit Animationen, Prop-Attachment und Steuerungssperren, als Leiste oder als Kreis
  • Ereignis-Banner - Glaskarte mit Medaille für Beförderungen, Einsatzende oder Schichtbeginn
  • Abklingzeiten & Cache - Cooldowns pro Resource auf Client und Server, Events beim Einsteigen oder Waffenwechsel
  • Versionscheck - Banner beim Serverstart und Hinweis auf neue Releases für EmergencyForge-Scripts
  • Deutsch & Englisch - Eingebaute Texte per Config.Locale umschaltbar
  • Zonen - Sphere- und Box-Zonen mit onEnter, onExit & inside-Callbacks
  • Button Hints - Interaktive Tastaturhinweise (z. B. E, F)
  • Context Menu - Kontextmenü-System (ox_lib-kompatibel)
  • Vehicle Properties - Vollständiges Fahrzeugeigenschaften-System zum Speichern & Wiederherstellen (ox_lib-kompatibel)
  • UI-Konfiguration - Anpassbare Akzentfarbe, Cursor- und Bewegungseinstellungen pro Menü oder global

Benutzte Assets & Technologien


Installation

  1. Repository klonen oder herunterladen
  2. In den web/-Ordner wechseln und npm install sowie npm run build ausführen
  3. Die Resource in den Server-Resourcen-Ordner verschieben
  4. ensure ef_lib in die server.cfg eintragen
  5. Konfiguration in config.lua nach Bedarf anpassen

Konfiguration

Einstellung Typ Standard Beschreibung
Config.AccentColor string '#f0500a' Akzentfarbe der UI (HEX)
Config.Locale string 'de' Sprache der eingebauten Texte ('de' oder 'en')
Config.RequestKeys table { accept = 'Y', decline = 'N' } Standardtasten für Anfragen
Config.ScreenBlur boolean true Spielbild hinter Dialogen, Minispielen und Radialmenü verwischen
Config.EnableDemo boolean false Demo-Menü per F2 anzeigen
Config.ShowCursor boolean false Globale Cursor-Sichtbarkeit
Config.AllowMove boolean true Spielerbewegung in Menüs erlauben

Dokumentation

Eine vollständige Dokumentation aller Exports, Funktionen und Anwendungsbeispiele befindet sich in der DOCUMENTATION.md. Zusätzlich enthält die example.lua praxisnahe Codebeispiele für alle Features.


Caution

Es handelt sich hierbei um ein kontinuierliches Entwicklungsprojekt! Es kommt zu stetigen Anpassungen. Wir garantieren nicht für Fehlerfreiheit und Datensicherheit!

About

FiveM GUI library - Vue.js menu system, notifications, button hints

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages