├── Modules ├── server │ └── main.lua └── client │ ├── Nui.lua │ ├── Notify.lua │ ├── Vehicle.lua │ ├── Functions.lua │ └── Hud.lua ├── web ├── src │ ├── vite-env.d.ts │ ├── utils │ │ ├── misc.ts │ │ ├── debugData.ts │ │ ├── LangR.tsx │ │ └── fetchNui.ts │ ├── components │ │ ├── Config.ts │ │ ├── Types.tsx │ │ ├── speed.scss │ │ ├── hud.scss │ │ ├── App.tsx │ │ ├── Hud.tsx │ │ ├── Speed.tsx │ │ └── Notification.tsx │ ├── main.tsx │ ├── index.css │ └── hooks │ │ └── useNuiEvent.ts ├── tsconfig.node.json ├── vite.config.ts ├── index.html ├── build │ ├── index.html │ └── assets │ │ └── index-B0s7CI9Y.css ├── tsconfig.json └── package.json ├── stream ├── minimap.gfx ├── minimap.ytd └── squaremap.ytd ├── fxmanifest.lua ├── Shared ├── Config.lua ├── Locale.lua └── Core.lua ├── README.md ├── readme.MD └── LICENSE /Modules/server/main.lua: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /web/src/vite-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /stream/minimap.gfx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Legacy-Scripts/LGF_Hud_V2/HEAD/stream/minimap.gfx -------------------------------------------------------------------------------- /stream/minimap.ytd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Legacy-Scripts/LGF_Hud_V2/HEAD/stream/minimap.ytd -------------------------------------------------------------------------------- /stream/squaremap.ytd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Legacy-Scripts/LGF_Hud_V2/HEAD/stream/squaremap.ytd -------------------------------------------------------------------------------- /web/tsconfig.node.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "composite": true, 4 | "module": "esnext", 5 | "moduleResolution": "node" 6 | }, 7 | "include": ["vite.config.ts"] 8 | } 9 | -------------------------------------------------------------------------------- /web/src/utils/misc.ts: -------------------------------------------------------------------------------- 1 | // Will return whether the current environment is in a regular browser 2 | // and not CEF 3 | export const isEnvBrowser = (): boolean => !(window as any).invokeNative; 4 | 5 | // Basic no operation function 6 | export const noop = () => {}; 7 | -------------------------------------------------------------------------------- /web/vite.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig } from 'vite'; 2 | import react from '@vitejs/plugin-react'; 3 | 4 | export default defineConfig({ 5 | plugins: [react()], 6 | base: './', 7 | build: { 8 | outDir: 'build', 9 | chunkSizeWarningLimit: 1000 10 | }, 11 | }); -------------------------------------------------------------------------------- /web/src/components/Config.ts: -------------------------------------------------------------------------------- 1 | export const config = { 2 | themeIconVariant: "light", // Theme Icon Variant for HUD & SPEEDOMETER Components 3 | themeBadgeVariant:"dot",// Theme Badge Variant for Street View of HUD Components 4 | badgeNotificationVariant:"dot" // Badge Type Notification 5 | }; -------------------------------------------------------------------------------- /web/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Template lgf 8 | 9 | 10 |
11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /web/src/components/Types.tsx: -------------------------------------------------------------------------------- 1 | export interface NotifyData { 2 | Title: string; 3 | Message: string; 4 | Type: "success" | "error" | "info"| "warning"; 5 | Duration: number; 6 | Position: "top" |"top-left" | "top-right" | "bottom-left" | "bottom-right"| "bottom"; 7 | NotifyID: string; 8 | Effect :"line" | "progress" 9 | } 10 | 11 | export interface NotifyTypes { 12 | NotifyData: NotifyData | null; 13 | } -------------------------------------------------------------------------------- /web/src/main.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom/client'; 3 | import { MantineProvider, } from '@mantine/core'; 4 | import App from './components/App'; 5 | import './index.css'; 6 | 7 | 8 | 9 | ReactDOM.createRoot(document.getElementById('root')!).render( 10 | 11 | 12 | 13 | 14 | 15 | ); 16 | -------------------------------------------------------------------------------- /web/src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 4 | 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 5 | sans-serif; 6 | -webkit-font-smoothing: antialiased; 7 | -moz-osx-font-smoothing: grayscale; 8 | height: 100%; 9 | } 10 | 11 | #root { 12 | height: 100%; 13 | } 14 | 15 | code { 16 | font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', 17 | monospace; 18 | } 19 | -------------------------------------------------------------------------------- /web/build/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Template lgf 8 | 9 | 10 | 11 | 12 |
13 | 14 | 15 | -------------------------------------------------------------------------------- /Modules/client/Nui.lua: -------------------------------------------------------------------------------- 1 | Nui = {} 2 | LocalPlayer.state.HudBusy = false 3 | 4 | function Nui.toggleNui(action, data) 5 | if action == "openHud" then 6 | SendNUIMessage({ action = action, data = { Visible = data.Visible, PlayerData = data.PlayerData } }) 7 | end 8 | if action == "openSpeedometer" then 9 | SendNUIMessage({ action = action, data = { Visible = data.Visible, VehicleData = data.VehicleData } }) 10 | end 11 | if action == "sendNoty" then 12 | SendNUIMessage({ action = action, data = { NotifyData = data.NotifyData, Visible = data.Visible } }) 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /web/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ESNext", 4 | "useDefineForClassFields": true, 5 | "lib": ["DOM", "DOM.Iterable", "ESNext"], 6 | "allowJs": false, 7 | "skipLibCheck": true, 8 | "esModuleInterop": false, 9 | "allowSyntheticDefaultImports": true, 10 | "strict": true, 11 | "forceConsistentCasingInFileNames": true, 12 | "module": "ESNext", 13 | "moduleResolution": "Node", 14 | "resolveJsonModule": true, 15 | "isolatedModules": true, 16 | "noEmit": true, 17 | "jsx": "react-jsx", 18 | 19 | }, 20 | "include": ["src"], 21 | "references": [{ "path": "./tsconfig.node.json" }] 22 | } 23 | -------------------------------------------------------------------------------- /web/src/components/speed.scss: -------------------------------------------------------------------------------- 1 | .speed { 2 | position: fixed; 3 | bottom: 5vh; 4 | right: 5vh; 5 | display: flex; 6 | flex-direction: column; 7 | align-items: center; 8 | gap: 2vh; 9 | } 10 | 11 | .fuel { 12 | position: absolute; 13 | bottom: 66px; 14 | right: -13px; 15 | 16 | .center { 17 | display: flex; 18 | flex-direction: column; 19 | align-items: center; 20 | } 21 | } 22 | 23 | .indicator { 24 | display: flex; 25 | flex-direction: row; 26 | justify-content: center; 27 | gap: 2vh; 28 | margin-right: -1.5vh; 29 | } 30 | 31 | .icon { 32 | color: #fff; 33 | font-size: 1.5rem; 34 | } -------------------------------------------------------------------------------- /fxmanifest.lua: -------------------------------------------------------------------------------- 1 | fx_version 'cerulean' 2 | game 'gta5' 3 | version '1.0.0' 4 | lua54 'yes' 5 | description 'Modern Hud for Various Framework (LGF/ ESX / QB OR QBOX / OX CORE )' 6 | author 'ENT510' 7 | 8 | 9 | shared_scripts { 10 | '@ox_lib/init.lua', 11 | 'Shared/Config.lua', 12 | 'Shared/Locale.lua', 13 | 'Shared/Core.lua', 14 | 15 | } 16 | 17 | client_scripts { 18 | 'Modules/client/Functions.lua', 19 | 'Modules/client/Nui.lua', 20 | 'Modules/client/Hud.lua', 21 | 'Modules/client/Vehicle.lua', 22 | 'Modules/client/Notify.lua', 23 | } 24 | 25 | server_scripts { 'server/**/*' } 26 | 27 | files { 'web/build/index.html', 'web/build/**/*', } 28 | 29 | ui_page 'web/build/index.html' 30 | -------------------------------------------------------------------------------- /web/src/utils/debugData.ts: -------------------------------------------------------------------------------- 1 | import { isEnvBrowser } from "./misc"; 2 | 3 | interface DebugEvent { 4 | action: string; 5 | data: any; 6 | } 7 | 8 | /** 9 | * Emulates dispatching an event using SendNuiMessage in the lua scripts. 10 | * This is used when developing in browser 11 | * 12 | * @param events 13 | * @param timer 14 | */ 15 | export const debugData =

(events: DebugEvent

[], timer = 1000): void => { 16 | if (import.meta.env.MODE === "development" && isEnvBrowser()) { 17 | for (const event of events) { 18 | setTimeout(() => { 19 | window.dispatchEvent( 20 | new MessageEvent("message", { 21 | data: { 22 | action: event.action, 23 | data: event.data, 24 | }, 25 | }), 26 | ); 27 | }, timer); 28 | } 29 | } 30 | }; 31 | -------------------------------------------------------------------------------- /Shared/Config.lua: -------------------------------------------------------------------------------- 1 | local Config = {} 2 | 3 | -- Language For Notification ecc 4 | Config.Lang = GetConvar("LGF_HudV2:Locale", "en") 5 | 6 | -- Notification for Loaded and Unloaded events 7 | Config.EnableNotificationEvent = false 8 | 9 | -- Disable Car HUD For Vehicle BlackListed 10 | Config.VehicleBlackListed = { 11 | joaat("bmx"), 12 | joaat("cruiser"), 13 | joaat("fixter"), 14 | joaat("scorcher"), 15 | } 16 | 17 | Config.FuelProvider = function(vehicle) 18 | if GetResourceState("ox_fuel"):find("start") then 19 | return Entity(vehicle).state.fuel 20 | 21 | -- elseif GetResourceState("custom_resource"):find("start") then 22 | -- Add your custom resource exports 23 | -- return exports["custom_resource"]:FuncName(vehicle) 24 | else 25 | return GetVehicleFuelLevel(vehicle) 26 | end 27 | end 28 | 29 | 30 | 31 | return Config 32 | -------------------------------------------------------------------------------- /web/src/utils/LangR.tsx: -------------------------------------------------------------------------------- 1 | import { useState, useEffect } from "react"; 2 | import { fetchNui } from "./fetchNui"; 3 | import { useNuiEvent } from "../hooks/useNuiEvent"; 4 | 5 | interface LangData { 6 | [key: string]: string; 7 | } 8 | 9 | const defaultLangData: LangData = { 10 | test: "Esto es un test de LANG, Toca ESC para cerrar", 11 | 12 | }; 13 | 14 | 15 | 16 | const Lang = () => { 17 | const [lang, setLang] = useState(defaultLangData); 18 | 19 | useNuiEvent('ui:Lang', (data) => { 20 | setLang(data); 21 | }); 22 | 23 | useEffect(() => { 24 | fetchNui('ui:Lang') 25 | .then(data => { 26 | setLang(data); 27 | }) 28 | .catch(error => { 29 | console.error('Error fetching language data:', error); 30 | }); 31 | }, []); 32 | 33 | return lang; 34 | }; 35 | 36 | export default Lang; 37 | -------------------------------------------------------------------------------- /web/src/utils/fetchNui.ts: -------------------------------------------------------------------------------- 1 | import { isEnvBrowser } from "./misc"; 2 | 3 | /** 4 | * Simple wrapper around fetch API tailored for CEF/NUI use. This abstraction 5 | * can be extended to include AbortController if needed or if the response isn't 6 | * JSON. Tailor it to your needs. 7 | * 8 | * @param eventName - The endpoint eventname to target 9 | * @param data - Data you wish to send in the NUI Callback 10 | * @param mockData - Mock data to be returned if in the browser 11 | * 12 | * @return returnData - A promise for the data sent back by the NuiCallbacks CB argument 13 | */ 14 | 15 | export async function fetchNui( 16 | eventName: string, 17 | data?: unknown, 18 | mockData?: T, 19 | ): Promise { 20 | const options = { 21 | method: "post", 22 | headers: { 23 | "Content-Type": "application/json; charset=UTF-8", 24 | }, 25 | body: JSON.stringify(data), 26 | }; 27 | 28 | if (isEnvBrowser() && mockData) return mockData; 29 | 30 | const resourceName = (window as any).GetParentResourceName 31 | ? (window as any).GetParentResourceName() 32 | : "nui-frame-app"; 33 | 34 | const resp = await fetch(`https://${resourceName}/${eventName}`, options); 35 | 36 | const respFormatted = await resp.json(); 37 | 38 | return respFormatted; 39 | } 40 | -------------------------------------------------------------------------------- /Modules/client/Notify.lua: -------------------------------------------------------------------------------- 1 | ---@class NotifyData 2 | ---@field Title string The title of the notification. 3 | ---@field Message string The message body of the notification. 4 | ---@field Type "success"|"error"|"info"|"warning" The type of notification. 5 | ---@field Duration number Duration of the notification in milliseconds. 6 | ---@field Position "top"|"top-left"|"top-right"|"bottom-left"|"bottom-right"|"bottom" Position of the notification 7 | ---@field NotifyID string A unique identifier for the notification. 8 | ---@field Effect "line"|"progress" The visual effect for the notification. 9 | 10 | 11 | ---@class Notify 12 | local Notify = {} 13 | 14 | ---@param data NotifyData 15 | function Notify.sendNotification(data) 16 | ---@type NotifyData 17 | local NotifyData = { 18 | Title = data.Title or "LGF_Hud", 19 | Message = data.Message or "Forza Juve", 20 | Type = data.Type or "info", 21 | Duration = data.Duration or 5000, 22 | Position = data.Position or "top-left", 23 | NotifyID = data.NotifyID or ("%s_%s"):format(cache.resource, math.random(1000, 9999)), 24 | Effect = data.Effect or "progress" 25 | } 26 | 27 | Nui.toggleNui("sendNoty", { 28 | NotifyData = NotifyData, 29 | Visible = true, 30 | }) 31 | end 32 | 33 | RegisterNetEvent("LGF_HudV2:addNotify", Notify.sendNotification) 34 | 35 | exports("sendNotify", Notify.sendNotification) 36 | 37 | return Notify 38 | 39 | -------------------------------------------------------------------------------- /web/src/hooks/useNuiEvent.ts: -------------------------------------------------------------------------------- 1 | import { MutableRefObject, useEffect, useRef } from "react"; 2 | import { noop } from "../utils/misc"; 3 | 4 | interface NuiMessageData { 5 | action: string; 6 | data: T; 7 | } 8 | 9 | type NuiHandlerSignature = (data: T) => void; 10 | 11 | /** 12 | * A hook that manage events listeners for receiving data from the client scripts 13 | * @param action The specific `action` that should be listened for. 14 | * @param handler The callback function that will handle data relayed by this hook 15 | * 16 | * @example 17 | * useNuiEvent<{visibility: true, wasVisible: 'something'}>('setVisible', (data) => { 18 | * // whatever logic you want 19 | * }) 20 | * 21 | **/ 22 | 23 | export const useNuiEvent = ( 24 | action: string, 25 | handler: (data: T) => void, 26 | ) => { 27 | const savedHandler: MutableRefObject> = useRef(noop); 28 | 29 | // Make sure we handle for a reactive handler 30 | useEffect(() => { 31 | savedHandler.current = handler; 32 | }, [handler]); 33 | 34 | useEffect(() => { 35 | const eventListener = (event: MessageEvent>) => { 36 | const { action: eventAction, data } = event.data; 37 | 38 | if (savedHandler.current) { 39 | if (eventAction === action) { 40 | savedHandler.current(data); 41 | } 42 | } 43 | }; 44 | 45 | window.addEventListener("message", eventListener); 46 | // Remove Event Listener on component cleanup 47 | return () => window.removeEventListener("message", eventListener); 48 | }, [action]); 49 | }; -------------------------------------------------------------------------------- /web/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "web", 3 | "homepage": "web/build", 4 | "private": true, 5 | "type": "module", 6 | "version": "0.1.0", 7 | "scripts": { 8 | "start": "vite", 9 | "start:game": "vite build --watch", 10 | "build": "tsc && vite build", 11 | "preview": "vite preview" 12 | }, 13 | "dependencies": { 14 | "@emotion/react": "^11.11.1", 15 | "@fortawesome/fontawesome-svg-core": "^6.5.2", 16 | "@fortawesome/free-solid-svg-icons": "^6.5.2", 17 | "@fortawesome/react-fontawesome": "^0.2.0", 18 | "@mantine/core": "^6.0.15", 19 | "@mantine/dates": "^6.0.15", 20 | "@mantine/form": "^7.9.0", 21 | "@mantine/hooks": "^6.0.15", 22 | "@mantine/styles": "^6.0.21", 23 | "@tabler/icons-react": "^2.23.0", 24 | "framer-motion": "^11.11.17", 25 | "html2canvas": "^1.4.1", 26 | "react": "^18.2.0", 27 | "react-circular-progressbar": "^2.1.0", 28 | "react-dom": "^18.2.0", 29 | "react-draggable": "^4.4.6", 30 | "react-gauge-component": "^1.2.6", 31 | "react-icons": "^5.2.0", 32 | "react-scroll-into-view": "^2.1.2", 33 | "sass": "^1.72.0", 34 | "styled-components": "^6.1.8" 35 | }, 36 | "devDependencies": { 37 | "@types/node": "^20.11.30", 38 | "@types/react": "^18.2.37", 39 | "@types/react-dom": "^18.2.15", 40 | "@typescript-eslint/eslint-plugin": "^6.11.0", 41 | "@typescript-eslint/parser": "^6.11.0", 42 | "@vitejs/plugin-react": "^4.2.0", 43 | "eslint": "^8.54.0", 44 | "eslint-plugin-react-hooks": "^4.6.0", 45 | "eslint-plugin-react-refresh": "^0.4.4", 46 | "postcss": "^8.4.38", 47 | "postcss-preset-mantine": "^1.15.0", 48 | "postcss-simple-vars": "^7.0.1", 49 | "typescript": "^5.2.2", 50 | "vite": "^5.0.0" 51 | } 52 | } -------------------------------------------------------------------------------- /web/build/assets/index-B0s7CI9Y.css: -------------------------------------------------------------------------------- 1 | body{-webkit-user-select:none;user-select:none;color:#ccc;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;overflow:hidden}.hud{position:fixed;bottom:10px;left:20px;display:flex;flex-direction:column;gap:15px}.hud-label{font-size:22px;color:#fff;margin-bottom:195px;text-transform:uppercase;letter-spacing:3px}.hud-item{display:flex;flex-direction:column;align-items:center;justify-content:center;border-radius:10px;padding:5px}.hud-item .icon{color:#fff;font-size:1.5rem}.hud-item .progress{width:100%;height:5px;background-color:#ffffff1a;border-radius:3px;overflow:hidden;margin-top:5px}.hud-item .progress .progress-bar{height:100%;transition:width .3s ease}.hud-item .progress .red{background-color:#732626}.hud-item .progress .indigo{background-color:#172554}.hud-item .progress .teal{background-color:#042f2e}.hud-item .progress .orange{background-color:#7c2d12}.hud-item .progress .lime{background-color:#65a30d}.hud-item .progress .cyan{background-color:#07b6d585}.hud-item .progress .blue{background-color:#007bff}.hud-item .progress .gray{background-color:#d3d3d3}.speed{position:fixed;bottom:5vh;right:5vh;display:flex;flex-direction:column;align-items:center;gap:2vh}.fuel{position:absolute;bottom:66px;right:-13px}.fuel .center{display:flex;flex-direction:column;align-items:center}.indicator{display:flex;flex-direction:row;justify-content:center;gap:2vh;margin-right:-1.5vh}.icon{color:#fff;font-size:1.5rem}body{margin:0;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;height:100%}#root{height:100%}code{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace} 2 | -------------------------------------------------------------------------------- /web/src/components/hud.scss: -------------------------------------------------------------------------------- 1 | $color1: #1A1B1E; 2 | $color2: #2e3036; 3 | $border: 10px; 4 | 5 | body { 6 | user-select: none; 7 | color: #ccc; 8 | font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; 9 | overflow: hidden; 10 | } 11 | 12 | .hud { 13 | position: fixed; 14 | bottom: 10px; 15 | left: 20px; 16 | display: flex; 17 | flex-direction: column; 18 | gap: 15px; 19 | } 20 | 21 | .hud-label { 22 | font-size: 22px; 23 | color: #fff; 24 | margin-bottom: 195px; 25 | text-transform: uppercase; 26 | letter-spacing: 3px; 27 | } 28 | 29 | .hud-item { 30 | display: flex; 31 | flex-direction: column; 32 | align-items: center; 33 | justify-content: center; 34 | border-radius: $border; 35 | padding: 5px; 36 | 37 | .icon { 38 | color: #fff; 39 | font-size: 1.5rem; 40 | } 41 | 42 | .progress { 43 | width: 100%; 44 | height: 5px; 45 | background-color: rgba(255, 255, 255, 0.1); 46 | border-radius: 3px; 47 | overflow: hidden; 48 | margin-top: 5px; 49 | 50 | .progress-bar { 51 | height: 100%; 52 | transition: width 0.3s ease; 53 | } 54 | 55 | .red { 56 | background-color: hsl(0, 50%, 30%); 57 | } 58 | .indigo { 59 | background-color: hsl(226.2 57% 21%); 60 | } 61 | .teal { 62 | background-color: hsl(178.6, 84.3%, 10%); 63 | } 64 | .orange { 65 | background-color: hsl(15.3 74.6% 27.8%); 66 | } 67 | .lime { 68 | background-color: hsl(84.8 85.2% 34.5%); 69 | } 70 | .cyan { 71 | background-color: hsla(189, 94%, 43%, 0.521); 72 | } 73 | 74 | 75 | .blue { 76 | background-color: #007bff; 77 | } 78 | .gray { 79 | background-color: #d3d3d3; 80 | } 81 | } 82 | } 83 | 84 | 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LGF Hud 2 | 3 | Simple HUD and Car HUD for Various Framework 4 | 5 | 6 | ## All Components 7 | ![LGF HUD1](https://i.ibb.co/qDVN2C0/2.png) 8 | 9 | ### Hud Stats 10 | ![LGF HUD2](https://i.ibb.co/mXJS9TL/image.png) 11 | 12 | ## Notifications 13 | ![LGF HUD3](https://i.ibb.co/54qn6pY/5-removebg-preview.png) 14 | ![LGF HUD4](https://i.ibb.co/LvDpLFf/3-removebg-preview.png) 15 | ![LGF HUD5](https://i.ibb.co/cQXSb3S/4-removebg-preview.png) 16 | ![LGF HUD6](https://i.ibb.co/tDSMJhH/image-removebg-preview-7.png) 17 | 18 | 19 | 20 | ## Framework Compatibility 21 | 22 | - OX Core 23 | - Legacy Core 24 | - ESX 25 | - Qbox 26 | - Qb-Core 27 | 28 | ## Exports HUD 29 | 30 | ```lua 31 | ---@param boolean | Enable or Disable HUD Components (no refering to Car HUD) 32 | exports.LGF_Hud_V2:toggleHUD(true) -- Enables the HUD 33 | exports.LGF_Hud_V2:toggleHUD(false) -- Disables the HUD 34 | ``` 35 | 36 | ## Exports Notification 37 | 38 | ```lua 39 | ---@class NotifyData 40 | ---@field Title string The title of the notification. 41 | ---@field Message string The message body of the notification. 42 | ---@field Type "success"|"error"|"info" The type of notification. 43 | ---@field Duration number Duration of the notification in milliseconds. 44 | ---@field Position "top"|"top-left"|"top-right"|"bottom-left"|"bottom-right"|"bottom" Position of the notification 45 | ---@field Effect "line"|"progress" The visual effect for the notification. 46 | 47 | exports.LGF_Hud_V2:sendNotify({ 48 | Title = "New Notification", 49 | Message = "You have received a notification!", 50 | Type = "info", 51 | Duration = 5000, 52 | Position = "top-left", 53 | Effect = "progress" 54 | }) 55 | ``` 56 | 57 | ## Events 58 | 59 | ### Client Side 60 | 61 | ```lua 62 | TriggerEvent("LGF_HudV2:addNotify", { 63 | Title = "Notification Title", 64 | Message = "This is a client-triggered notification.", 65 | Type = "success", 66 | Duration = 5000, 67 | Position = "top-left", 68 | Effect = "progress" 69 | }) 70 | ``` 71 | 72 | ### Server Side 73 | 74 | ```lua 75 | TriggerClientEvent("LGF_HudV2:addNotify", targetID, { 76 | Title = "Server Notification", 77 | Message = "This notification was triggered by the server.", 78 | Type = "info", -- Options: "success", "error", "info" 79 | Duration = 5000, -- Duration in milliseconds 80 | Position = "top-left", 81 | Effect = "progress" 82 | }) 83 | ``` 84 | -------------------------------------------------------------------------------- /readme.MD: -------------------------------------------------------------------------------- 1 | # LGF Hud 2 | 3 | Simple HUD and Car HUD for Various Framework 4 | 5 | 6 | ## All Components 7 | ![LGF HUD1](https://i.ibb.co/qDVN2C0/2.png) 8 | 9 | ### Hud Stats 10 | ![LGF HUD2](https://i.ibb.co/mXJS9TL/image.png) 11 | 12 | ## Notifications 13 | ![LGF HUD3](https://i.ibb.co/54qn6pY/5-removebg-preview.png) 14 | ![LGF HUD4](https://i.ibb.co/LvDpLFf/3-removebg-preview.png) 15 | ![LGF HUD5](https://i.ibb.co/cQXSb3S/4-removebg-preview.png) 16 | ![LGF HUD6](https://i.ibb.co/tDSMJhH/image-removebg-preview-7.png) 17 | 18 | 19 | ## Framework Compatibility 20 | 21 | - OX Core 22 | - Legacy Core 23 | - ESX 24 | - Qbox 25 | - Qb-Core 26 | 27 | ## Exports HUD 28 | 29 | ```lua 30 | ---@param boolean | Enable or Disable HUD Components (no refering to Car HUD) 31 | exports.LGF_Hud_V2:toggleHUD(true) -- Enables the HUD 32 | exports.LGF_Hud_V2:toggleHUD(false) -- Disables the HUD 33 | ``` 34 | 35 | ## Exports Notification 36 | 37 | ```lua 38 | ---@class NotifyData 39 | ---@field Title string The title of the notification. 40 | ---@field Message string The message body of the notification. 41 | ---@field Type "success"|"error"|"info" The type of notification. 42 | ---@field Duration number Duration of the notification in milliseconds. 43 | ---@field Position "top"|"top-left"|"top-right"|"bottom-left"|"bottom-right"|"bottom" Position of the notification 44 | ---@field Effect "line"|"progress" The visual effect for the notification. 45 | 46 | exports.LGF_Hud_V2:sendNotify({ 47 | Title = "New Notification", 48 | Message = "You have received a notification!", 49 | Type = "info", 50 | Duration = 5000, 51 | Position = "top-left", 52 | Effect = "progress" 53 | }) 54 | ``` 55 | 56 | ## Events 57 | 58 | ### Client Side 59 | 60 | ```lua 61 | TriggerEvent("LGF_HudV2:addNotify", { 62 | Title = "Notification Title", 63 | Message = "This is a client-triggered notification.", 64 | Type = "success", 65 | Duration = 5000, 66 | Position = "top-left", 67 | Effect = "progress" 68 | }) 69 | ``` 70 | 71 | ### Server Side 72 | 73 | ```lua 74 | TriggerClientEvent("LGF_HudV2:addNotify", targetID, { 75 | Title = "Server Notification", 76 | Message = "This notification was triggered by the server.", 77 | Type = "info", -- Options: "success", "error", "info" 78 | Duration = 5000, -- Duration in milliseconds 79 | Position = "top-left", 80 | Effect = "progress" 81 | }) 82 | ``` 83 | -------------------------------------------------------------------------------- /Modules/client/Vehicle.lua: -------------------------------------------------------------------------------- 1 | --[[REQUIRE]] 2 | local Config = require "Shared.Config" 3 | 4 | --[[VARS]] 5 | local isVehicleHudVisible = false 6 | local VehicleBlackListed = Config.VehicleBlackListed 7 | 8 | --[[NATIVES]] 9 | local GetEntityModel = GetEntityModel 10 | local CreateThread = CreateThread 11 | local Wait = Wait 12 | local GetVehicleWheelHealth = GetVehicleWheelHealth 13 | local GetEntitySpeed = GetEntitySpeed 14 | local GetVehicleFuelLevel = GetVehicleFuelLevel 15 | local GetVehicleCurrentGear = GetVehicleCurrentGear 16 | local GetVehicleEngineHealth = GetVehicleEngineHealth 17 | local GetIsVehicleEngineRunning = GetIsVehicleEngineRunning 18 | 19 | --[[FUNCTIONS]] 20 | local function isVehicleBlacklisted(model) 21 | for i = 1, #VehicleBlackListed do 22 | if VehicleBlackListed[i] == model then 23 | return true 24 | end 25 | end 26 | return false 27 | end 28 | 29 | --[[MAIN THREAD]] 30 | lib.onCache('vehicle', function(value) 31 | local SLEEP = 1000 32 | if value then 33 | local vehicleModel = GetEntityModel(value) 34 | if not isVehicleHudVisible and not isVehicleBlacklisted(vehicleModel) then 35 | isVehicleHudVisible = true 36 | CreateThread(function() 37 | while isVehicleHudVisible do 38 | Wait(SLEEP) 39 | local Vehicle = value 40 | if Vehicle then 41 | local tireHealth = 0 42 | for i = 0, 3 do 43 | tireHealth = tireHealth + GetVehicleWheelHealth(Vehicle, i) 44 | end 45 | 46 | tireHealth = tireHealth / 4 47 | 48 | Nui.toggleNui("openSpeedometer", { 49 | Visible = isVehicleHudVisible, 50 | VehicleData = { 51 | Speed = lib.math.round(GetEntitySpeed(Vehicle) * 3.6, 0), 52 | Fuel = Config.FuelProvider(Vehicle), 53 | Gear = GetVehicleCurrentGear(Vehicle), 54 | EngineHealth = GetVehicleEngineHealth(Vehicle), 55 | EngineStatus = (GetIsVehicleEngineRunning(Vehicle) == 1 and true or false), 56 | TireHealth = tireHealth 57 | } 58 | }) 59 | else 60 | isVehicleHudVisible = false 61 | end 62 | end 63 | end) 64 | end 65 | else 66 | if isVehicleHudVisible then 67 | isVehicleHudVisible = false 68 | end 69 | end 70 | end) 71 | -------------------------------------------------------------------------------- /Modules/client/Functions.lua: -------------------------------------------------------------------------------- 1 | Functions = {} 2 | 3 | DisableComponentHud = { 4 | { name = "WANTED_STARS", index = 1 }, 5 | { name = "WEAPON_ICON", index = 2 }, 6 | { name = "CASH", index = 3 }, 7 | { name = "MP_CASH", index = 4 }, 8 | { name = "MP_MESSAGE", index = 5 }, 9 | { name = "VEHICLE_NAME", index = 6 }, 10 | { name = "AREA_NAME", index = 7 }, 11 | { name = "VEHICLE_CLASS", index = 8 }, 12 | { name = "STREET_NAME", index = 9 }, 13 | { name = "HELP_TEXT", index = 10 }, 14 | { name = "FLOATING_HELP_TEXT_1", index = 11 }, 15 | { name = "FLOATING_HELP_TEXT_2", index = 12 }, 16 | { name = "CASH_CHANGE", index = 13 }, 17 | { name = "SUBTITLE_TEXT", index = 15 }, 18 | { name = "SAVING_GAME", index = 17 }, 19 | { name = "GAME_STREAM", index = 18 }, 20 | { name = "W_WHEEL", index = 19 }, 21 | { name = "W_WHEEL_STATS", index = 20 }, 22 | { name = "HUD_COMPONENTS", index = 21 }, 23 | } 24 | 25 | function Functions.loadMinimap(state) 26 | for _, component in ipairs(DisableComponentHud) do 27 | if component.index then SetHudComponentPosition(component.index, 999999.0, 999999.0) end 28 | end 29 | 30 | DisplayRadar(state) 31 | local defaultAspectRatio = 1920 / 1080 32 | local resolutionX, resolutionY = GetActiveScreenResolution() 33 | local aspectRatio = resolutionX / resolutionY 34 | local minimapOffset = 0 35 | 36 | if aspectRatio > defaultAspectRatio then 37 | minimapOffset = ((defaultAspectRatio - aspectRatio) / 3.6) - 0.008 38 | end 39 | 40 | RequestStreamedTextureDict("squaremap", false) 41 | while not HasStreamedTextureDictLoaded("squaremap") do 42 | Wait(150) 43 | end 44 | 45 | SetMinimapClipType(0) 46 | AddReplaceTexture("platform:/textures/graphics", "radarmasksm", "squaremap", "radarmasksm") 47 | AddReplaceTexture("platform:/textures/graphics", "radarmask1g", "squaremap", "radarmasksm") 48 | 49 | 50 | SetMinimapComponentPosition("minimap", "L", "B", 0.0 + minimapOffset, -0.057, 0.1638, 0.183) 51 | SetMinimapComponentPosition("minimap_mask", "L", "B", 0.0 + minimapOffset, -0.01, 0.128, 0.20) 52 | SetMinimapComponentPosition("minimap_blur", "L", "B", -0.01 + minimapOffset, 0.015, 0.262, 0.300) 53 | 54 | SetBlipAlpha(GetNorthRadarBlip(), 0) 55 | 56 | SetRadarBigmapEnabled(true, false) 57 | SetMinimapClipType(0) 58 | Wait(50) 59 | SetRadarBigmapEnabled(false, false) 60 | end 61 | 62 | function Functions.GetHashKeyStreet() 63 | local pos = GetEntityCoords(cache.ped) 64 | local street1 = GetStreetNameAtCoord(pos.x, pos.y, pos.z) 65 | return GetStreetNameFromHashKey(street1) 66 | end -------------------------------------------------------------------------------- /Shared/Locale.lua: -------------------------------------------------------------------------------- 1 | Locales = { 2 | en = { 3 | HUDLoaded = "The HUD components have been successfully loaded and are now visible. Enjoy your experience!", 4 | HUDUnloaded = "The HUD components have been successfully unloaded. You can enable them again anytime.", 5 | HUDDisabled = "The HUD has been turned off, and the minimap is hidden. You can turn it back on using the 'hud on' command.", 6 | HUDEnabled = "The HUD and minimap have been enabled. You can now see the important data on the screen.", 7 | Error = "Invalid command. Please use 'on' to enable the HUD or 'off' to disable it.", 8 | ProximityChanged = "The proximity distance has changed to: %s", 9 | Proximity = "Proximity Range", 10 | }, 11 | fr = { 12 | HUDLoaded = "Les composants de l'HUD ont été chargés avec succès et sont désormais visibles. Bonne expérience !", 13 | HUDUnloaded = "Les composants de l'HUD ont été déchargés avec succès. Vous pouvez les réactiver à tout moment.", 14 | HUDDisabled = "L'HUD a été désactivé et la minicarte est masquée. Vous pouvez le réactiver à l'aide de la commande '/hud on'.", 15 | HUDEnabled = "L'HUD et la minicarte ont été activés. Vous pouvez désormais voir les données importantes à l'écran.", 16 | Error = "Commande invalide. Veuillez utiliser 'on' pour activer le HUD ou 'off' pour le désactiver.", 17 | ProximityChanged = "La Portée de proximité à été changé à : %s", 18 | Proximity = "Portée de Proximité", 19 | }, 20 | it = { 21 | HUDLoaded = "I componenti dell'HUD sono stati caricati correttamente e sono ora visibili. Buona esperienza!", 22 | HUDUnloaded = "I componenti dell'HUD sono stati scaricati correttamente. Puoi riattivarli in qualsiasi momento.", 23 | HUDDisabled = "L'HUD è stato disattivato e la minimappa è nascosta. Puoi riattivarlo usando il comando 'hud on'.", 24 | HUDEnabled = "L'HUD e la minimappa sono stati attivati. Ora puoi vedere i dati importanti sullo schermo.", 25 | Error = "Comando non valido. Usa 'on' per abilitare l'HUD o 'off' per disabilitarlo.", 26 | ProximityChanged = "La distanza di prossimità è cambiata a: %s", 27 | Proximity = "Range Vocale", 28 | }, 29 | nl = { 30 | HUDLoaded = "De HUD-componenten zijn succesvol geladen en zijn nu zichtbaar. Veel plezier!", 31 | HUDUnloaded = "De HUD-componenten zijn succesvol uitgeschakeld. Je kunt ze op elk moment weer inschakelen.", 32 | HUDDisabled = "De HUD is uitgeschakeld en de minimap is verborgen. Je kunt deze weer inschakelen met het commando 'hud on'.", 33 | HUDEnabled = "De HUD en minimap zijn ingeschakeld. Je kunt nu de belangrijke gegevens op het scherm zien.", 34 | Error = "Ongeldig commando. Gebruik 'on' om de HUD in te schakelen of 'off' om deze uit te schakelen.", 35 | ProximityChanged = "Stem bereik is gewijzigd naar: %s", 36 | Proximity = "Bereik", 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /web/src/components/App.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState } from "react"; 2 | import { Button } from "@mantine/core"; 3 | import { useNuiEvent } from "../hooks/useNuiEvent"; 4 | import Hud from "./Hud"; 5 | import Speedometer from "./Speed"; 6 | import Notification from "./Notification"; 7 | import { NotifyData } from "./Types"; 8 | import "./hud.scss"; 9 | import "./speed.scss"; 10 | import { isEnvBrowser } from "../utils/misc"; 11 | 12 | const App: React.FC = () => { 13 | const [playerData, setPlayerData] = useState({}); 14 | const [speedometerVisible, setSpeedometerVisible] = useState(false); 15 | const [hudVisible, setHudVisible] = useState(false); 16 | const [vehicleData, setVehicleData] = useState({}); 17 | const [notification, setNotification] = useState(null); 18 | const [isNotificationVisible, setIsNotificationVisible] = useState(false); 19 | 20 | useNuiEvent("openHud", (data) => { 21 | setHudVisible(data?.Visible || false); 22 | setPlayerData(data?.PlayerData || {}); 23 | }); 24 | 25 | useNuiEvent("openSpeedometer", (data) => { 26 | setSpeedometerVisible(data?.Visible || false); 27 | setVehicleData(data?.VehicleData || {}); 28 | }); 29 | 30 | useNuiEvent("sendNoty", (data) => { 31 | if (data?.NotifyData) { 32 | setNotification(data.NotifyData); 33 | setIsNotificationVisible(data.Visible); 34 | } 35 | }); 36 | 37 | 38 | return ( 39 | <> 40 | 41 | 42 | {notification && ( 43 | 48 | )} 49 | 50 | {isEnvBrowser() && ( 51 |

52 | 60 | 68 | 88 |
89 | )} 90 | 91 | ); 92 | }; 93 | 94 | export default App; 95 | -------------------------------------------------------------------------------- /web/src/components/Hud.tsx: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import { Badge, ThemeIcon } from "@mantine/core"; 3 | import { motion } from "framer-motion"; 4 | import { 5 | IconHeartbeat, 6 | IconRun, 7 | IconBurger, 8 | IconBottle, 9 | IconShield, 10 | IconSwimming, 11 | IconMicrophone, 12 | } from "@tabler/icons-react"; 13 | import { config } from "./Config"; 14 | 15 | interface HudProps { 16 | visible: boolean; 17 | data: any; 18 | } 19 | 20 | const Hud: React.FC = ({ visible, data }) => { 21 | const hudItems = [ 22 | { icon: , label: "Health", color: "red", value: data?.Health || 0 }, 23 | { icon: , label: "Thirst", color: "indigo", value: data?.Thirst || 0 }, 24 | { icon: , label: "Hunger", color: "orange", value: data?.Hunger || 0 }, 25 | { icon: , label: "Stamina", color: "lime", value: data?.Stamina || 0 }, 26 | { 27 | icon: , 28 | label: "Microphone", 29 | color: data?.IsTalking ? "blue" : "gray", 30 | value: data?.IsTalking ? 100 : 0, 31 | }, 32 | ...(data?.Armor > 0 ? [{ icon: , label: "Armor", color: "teal", value: data?.Armor }] : []), 33 | ...(data?.Oxygen > 0 ? [{ icon: , label: "Oxygen", color: "cyan", value: data?.Oxygen }] : []), 34 | ]; 35 | 36 | let proximityPercentage = 0; 37 | 38 | if (data?.Prox <= 3) { 39 | proximityPercentage = 33; 40 | } else if (data?.Prox <= 7) { 41 | proximityPercentage = 66; 42 | } else if (data?.Prox <= 15) { 43 | proximityPercentage = 100; 44 | } 45 | 46 | const microphoneItem = hudItems.find((item) => item.label === "Microphone"); 47 | if (microphoneItem) { 48 | microphoneItem.value = proximityPercentage; 49 | } 50 | 51 | return ( 52 | 58 |
59 | 60 | {data?.Street} 61 | 62 |
63 |
64 | {hudItems.map((item, index) => ( 65 | 73 | 80 | {item.icon} 81 | 82 |
83 |
87 |
88 | 89 | ))} 90 |
91 |
92 | ); 93 | }; 94 | 95 | export default Hud; 96 | -------------------------------------------------------------------------------- /web/src/components/Speed.tsx: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import { motion } from "framer-motion"; 3 | import { RingProgress, ThemeIcon } from "@mantine/core"; 4 | import { TbAutomaticGearbox } from "react-icons/tb"; 5 | import { PiEngine, PiTire } from "react-icons/pi"; 6 | import { BiSolidGasPump } from "react-icons/bi"; 7 | import { FaPowerOff } from "react-icons/fa"; 8 | import { GaugeComponent } from 'react-gauge-component'; // https://github.com/antoniolago/react-gauge-component 9 | import { config } from "./Config"; 10 | 11 | interface SpeedometerProps { 12 | visible: boolean; 13 | vehicleData: any; 14 | } 15 | 16 | const Speedometer: React.FC = ({ visible, vehicleData }) => { 17 | 18 | const speed = vehicleData?.Speed ? Math.min(vehicleData.Speed, 350) : 0; 19 | const fuel = vehicleData?.Fuel ? Math.min(vehicleData.Fuel, 100) : 0; 20 | const gear = vehicleData?.Gear || 0; 21 | const engineHealth = vehicleData?.EngineHealth || 1000; 22 | const tireHealth = vehicleData?.TireHealth || 1000 23 | const engineHealthColor = engineHealth > 600 ? 'indigo' : engineHealth > 300 ? 'orange' : 'red'; 24 | const engineStatus = vehicleData?.EngineStatus; 25 | const engineStatusColor = engineStatus === false ? 'red' : 'green'; 26 | 27 | const hudItems = [ 28 | { 29 | label: "Speed", 30 | style: { 31 | colorArray: ['rgba(9, 146, 104, 0.3)', 'rgba(224, 49, 49, 0.3)'], 32 | padding: 0.02, 33 | subArcs: [ 34 | { limit: 40 }, 35 | { limit: 60 }, 36 | { limit: 70 }, 37 | { limit: 100 }, 38 | {} 39 | ] 40 | }, 41 | value: speed 42 | }, 43 | { 44 | icon: , 45 | label: "Fuel", 46 | color: "teal", 47 | value: fuel 48 | }, 49 | { 50 | icon: , 51 | label: "Engine Health", 52 | color: engineHealthColor, 53 | value: engineHealth 54 | }, 55 | { 56 | icon: , 57 | label: "Engine Status", 58 | color: engineStatusColor, 59 | value:engineStatus 60 | }, 61 | { 62 | icon: , 63 | label: "Tire Health", 64 | color: tireHealth > 800 ? 'violet' : tireHealth > 400 ? 'orange' : 'red', 65 | value: tireHealth 66 | }, 67 | { 68 | icon: , 69 | label: "Gear", 70 | color: "blue", 71 | value: gear 72 | }, 73 | ]; 74 | 75 | return ( 76 | 82 |
83 | `${value} KMH`, 92 | style: { 93 | fontSize: "40px", 94 | 95 | } 96 | } 97 | }} 98 | style={{ 99 | width: '300px', 100 | }} 101 | /> 102 | 103 |
104 | 111 | {hudItems[1].icon} 112 |
113 | } 114 | /> 115 |
116 | 117 |
118 | {hudItems.slice(2).map((item, index) => ( 119 |
120 | 127 | {item.icon} 128 | 129 | 130 | {item.label === "Gear" && ( 131 | 132 | {item.value} 133 | 134 | )} 135 |
136 | ))} 137 |
138 |
139 |
140 | ); 141 | }; 142 | 143 | export default Speedometer; 144 | -------------------------------------------------------------------------------- /Shared/Core.lua: -------------------------------------------------------------------------------- 1 | if not lib then return end 2 | 3 | Framework = {} 4 | local Core = nil 5 | local GetCore = promise.new() 6 | local Path = lib.context 7 | 8 | if GetResourceState("LEGACYCORE") ~= "missing" then 9 | Core = "LEGACYCORE" 10 | LGF = exports.LEGACYCORE:GetCoreData() 11 | GetCore:resolve({ "LEGACYCORE", "GetCoreData" }) 12 | elseif GetResourceState("es_extended") ~= "missing" then 13 | Core = "es_extended" 14 | ESX = exports.es_extended:getSharedObject() 15 | GetCore:resolve({ "es_extended", "getSharedObject" }) 16 | elseif GetResourceState("qb-core") ~= "missing" then 17 | Core = "qb-core" 18 | QBCore = exports['qb-core']:GetCoreObject() 19 | GetCore:resolve({ "qb-core", "GetCoreObject" }) 20 | elseif GetResourceState("qbx-core") ~= "missing" then 21 | Core = "qbx-core" 22 | elseif GetResourceState("ox_core") ~= "missing" then 23 | Core = "ox" 24 | OxCore = require '@ox_core/lib/init' 25 | else 26 | GetCore:reject("Could not find a framework!") 27 | return 28 | end 29 | 30 | 31 | if Path == 'client' then 32 | function Framework.GetPlayerThirst() 33 | if Core == "LEGACYCORE" then 34 | return exports.LEGACYCORE:GetPlayerThirst() 35 | elseif Core == "es_extended" then 36 | local p = promise:new() 37 | 38 | local thirst = nil 39 | TriggerEvent('esx_status:getStatus', "thirst", function(status) 40 | if status then 41 | thirst = (status.val / 10000) 42 | p:resolve(thirst) 43 | end 44 | end) 45 | return Citizen.Await(p) 46 | elseif Core == "qb-core" then 47 | local Data = QBCore.Functions.GetPlayerData() 48 | return Data and Data.metadata.thirst 49 | elseif Core == "qbx-core" then 50 | local Data = QBX.PlayerData 51 | return Data and Data.metadata.thirst 52 | elseif Core == "ox" then 53 | local player = OxCore.GetPlayer() 54 | return player.getStatus("thirst") 55 | end 56 | end 57 | 58 | function Framework.GetPlayerHunger() 59 | if Core == "LEGACYCORE" then 60 | return exports.LEGACYCORE:GetPlayerHunger() 61 | elseif Core == "es_extended" then 62 | local p = promise:new() 63 | 64 | local hunger = nil 65 | TriggerEvent('esx_status:getStatus', "hunger", function(status) 66 | if status then 67 | hunger = (status.val / 10000) 68 | p:resolve(hunger) 69 | end 70 | end) 71 | return Citizen.Await(p) 72 | elseif Core == "qb-core" then 73 | local Data = QBCore.Functions.GetPlayerData() 74 | return Data and Data.metadata.hunger 75 | elseif Core == "qbx-core" then 76 | local Data = QBX.PlayerData 77 | return Data and Data.metadata.hunger 78 | elseif Core == "ox" then 79 | local player = OxCore.GetPlayer() 80 | return player.getStatus("hunger") 81 | end 82 | end 83 | 84 | if Core == "LEGACYCORE" then 85 | RegisterNetEvent('LegacyCore:PlayerLoaded') 86 | AddEventHandler('LegacyCore:PlayerLoaded', function(...) 87 | TriggerEvent("LGF_Hud:PlayerLoaded", ...) 88 | end) 89 | elseif Core == "es_extended" then 90 | RegisterNetEvent('esx:playerLoaded') 91 | AddEventHandler('esx:playerLoaded', function(...) 92 | TriggerEvent("LGF_Hud:PlayerLoaded", ...) 93 | end) 94 | elseif Core == "qb-core" or Core == "qbx-core" then 95 | RegisterNetEvent('QBCore:Client:OnPlayerLoaded') 96 | AddEventHandler('QBCore:Client:OnPlayerLoaded', function(...) 97 | TriggerEvent("LGF_Hud:PlayerLoaded", ...) 98 | end) 99 | elseif Core == "ox" then 100 | RegisterNetEvent('ox:playerLoaded') 101 | AddEventHandler('ox:playerLoaded', function(...) 102 | TriggerEvent("LGF_Hud:PlayerLoaded", ...) 103 | end) 104 | end 105 | 106 | if Core == "LEGACYCORE" then 107 | AddEventHandler('LegacyCore:PlayerLogout', function(...) 108 | TriggerEvent("LGF_Hud:PlayerUnloaded", ...) 109 | end) 110 | elseif Core == "es_extended" then 111 | RegisterNetEvent('esx:onPlayerLogout') 112 | AddEventHandler('esx:onPlayerLogout', function(...) 113 | TriggerEvent("LGF_Hud:PlayerUnloaded", ...) 114 | end) 115 | elseif Core == "qb-core" or Core == "qbx-core" then 116 | RegisterNetEvent('QBCore:Client:OnPlayerUnload') 117 | AddEventHandler('QBCore:Client:OnPlayerUnload', function(...) 118 | TriggerEvent("LGF_Hud:PlayerUnloaded", ...) 119 | end) 120 | elseif Core == "ox" then 121 | RegisterNetEvent('ox:playerLogout') 122 | AddEventHandler('ox:playerLogout', function(...) 123 | TriggerEvent("LGF_Hud:PlayerUnloaded", ...) 124 | end) 125 | end 126 | end 127 | 128 | if Path == 'server' then 129 | 130 | end 131 | -------------------------------------------------------------------------------- /Modules/client/Hud.lua: -------------------------------------------------------------------------------- 1 | --[[REQUIRE]] 2 | local Notify = require "Modules.client.Notify" 3 | local Config = require "Shared.Config" 4 | 5 | --[[VARS]] 6 | local lang = Config.Lang 7 | 8 | --[[NATIVES]] 9 | local CreateThread = CreateThread 10 | local GetGameTimer = GetGameTimer 11 | local PlayerId = PlayerId 12 | local GetPlayerServerId = GetPlayerServerId 13 | local PlayerPedId = PlayerPedId 14 | local IsPedSwimming = IsPedSwimming 15 | local GetEntityHealth = GetEntityHealth 16 | local GetPedArmour = GetPedArmour 17 | local NetworkIsPlayerTalking = NetworkIsPlayerTalking 18 | local GetPlayerUnderwaterTimeRemaining = GetPlayerUnderwaterTimeRemaining 19 | local Wait = Wait 20 | 21 | --[[FUNCTIONS]] 22 | 23 | ---@param state boolean | Enable or disable the HUD. 24 | local function BuildHUD(state) 25 | LocalPlayer.state.HudBusy = state 26 | CreateThread(function() 27 | local lastUpdate = 0 28 | local lastProx = LocalPlayer.state.proximity.distance 29 | while LocalPlayer.state.HudBusy do 30 | local currentTime = GetGameTimer() 31 | if currentTime - lastUpdate >= 1000 then 32 | lastUpdate = currentTime 33 | PlayerID = cache?.playerId or PlayerId() 34 | ServerID = cache?.serverId or GetPlayerServerId(PlayerID) 35 | PlayerPed = cache?.ped or PlayerPedId() 36 | 37 | local InSwim = IsPedSwimming(PlayerPed) 38 | 39 | local playerData = { 40 | Thirst = math.ceil(Framework.GetPlayerThirst()), 41 | Hunger = math.ceil(Framework.GetPlayerHunger()), 42 | Health = GetEntityHealth(PlayerPed) / 2, 43 | PlayerID = ServerID, 44 | Armor = math.ceil(GetPedArmour(PlayerPed)), 45 | Stamina = GetPlayerStamina(PlayerID), 46 | Street = Functions.GetHashKeyStreet(), 47 | IsTalking = NetworkIsPlayerTalking(PlayerID) == 1, 48 | Prox = LocalPlayer.state.proximity.distance, 49 | } 50 | 51 | playerData.Oxygen = InSwim and GetPlayerUnderwaterTimeRemaining(PlayerID) * 10 or 0 52 | 53 | if playerData.Prox ~= lastProx then 54 | lastProx = playerData.Prox 55 | 56 | Notify.sendNotification({ 57 | Title = Locales[lang].Proximity, 58 | Message = string.format(Locales[lang].ProximityChanged, playerData.Prox), 59 | Type = "info", 60 | Duration = 3000, 61 | Position = "top-right", 62 | Effect = "progress", 63 | }) 64 | end 65 | 66 | Nui.toggleNui("openHud", { 67 | Visible = state, 68 | PlayerData = playerData, 69 | }) 70 | end 71 | 72 | Wait(500) 73 | end 74 | end) 75 | end 76 | 77 | --[[EVENTS]] 78 | RegisterNetEvent("LGF_Hud:PlayerLoaded", function() 79 | -- prevent premature loading 80 | Wait(700) 81 | BuildHUD(true) 82 | Functions.loadMinimap(true) 83 | if Config.EnableNotificationEvent then 84 | Notify.sendNotification({ Title = "HUD Loaded", Message = Locales[lang].HUDLoaded, Type = "success", Duration = 3000,Position = "top-left", Effect = "progress", }) 85 | end 86 | end) 87 | 88 | 89 | 90 | RegisterNetEvent("LGF_Hud:PlayerUnloaded", function() 91 | Nui.toggleNui("openHud", { Visible = false, PlayerData = {} }) 92 | BuildHUD(false) 93 | Functions.loadMinimap(false) 94 | if Config.EnableNotificationEvent then 95 | Notify.sendNotification({Title = "HUD Unloaded", Message = Locales[lang].HUDUnloaded, Type = "success", Duration = 3000, Position = "top-left", Effect = "progress", }) 96 | end 97 | end) 98 | 99 | --[[COMMANDS]] 100 | RegisterCommand("hud", function(source, args) 101 | local state = args[1] 102 | if state == "off" then 103 | Nui.toggleNui("openHud", { Visible = false, PlayerData = {} }) 104 | BuildHUD(false) 105 | Functions.loadMinimap(false) 106 | Notify.sendNotification({ Title = "HUD Disabled", Message = Locales[lang].HUDDisabled, Type = "info", Duration = 3000, Position = "top-right", Effect = "progress", }) 107 | elseif state == "on" then 108 | BuildHUD(true) 109 | Functions.loadMinimap(true) 110 | Notify.sendNotification({ Title = "HUD Enabled", Message = Locales[lang].HUDEnabled, Type = "warning", Duration = 3000, Position = "top-right", Effect = "progress", }) 111 | else 112 | Notify.sendNotification({ Title = "Error", Message = Locales[lang].Error, Type = "error", Duration = 3000, Position = "top-right", Effect = "progress", }) 113 | end 114 | end) 115 | 116 | --[[EXPORTS]] 117 | exports("toggleHUD", function(state) 118 | if type(state) ~= "boolean" then 119 | warn("Invalid parameter. Expected 'true' or 'false'.") 120 | return 121 | end 122 | if state then 123 | BuildHUD(true) 124 | Functions.loadMinimap(true) 125 | else 126 | Nui.toggleNui("openHud", { Visible = false, PlayerData = {} }) 127 | BuildHUD(false) 128 | Functions.loadMinimap(false) 129 | end 130 | end) 131 | -------------------------------------------------------------------------------- /web/src/components/Notification.tsx: -------------------------------------------------------------------------------- 1 | import React, { useEffect, useState, useRef } from 'react'; 2 | import { Badge, Progress } from '@mantine/core'; 3 | import { motion } from 'framer-motion'; 4 | import { NotifyData } from './Types'; 5 | import { config } from './Config'; 6 | 7 | interface PositionStyles { 8 | top?: string; 9 | bottom?: string; 10 | left?: string; 11 | right?: string; 12 | } 13 | 14 | interface NotificationProps { 15 | notifyData: NotifyData | null; 16 | visible: boolean; 17 | } 18 | 19 | const Notification: React.FC = ({ notifyData, visible }) => { 20 | const [isVisible, setIsVisible] = useState(visible); 21 | const [progress, setProgress] = useState(100); 22 | const textContainerRef = useRef(null); 23 | const [lineHeight, setLineHeight] = useState('30px'); 24 | 25 | useEffect(() => { 26 | setIsVisible(visible); 27 | }, [visible]); 28 | 29 | useEffect(() => { 30 | if (notifyData) { 31 | const durationInMs = notifyData.Duration; 32 | 33 | const progressTimer = setInterval(() => { 34 | setProgress((prevProgress) => { 35 | if (prevProgress <= 0) { clearInterval(progressTimer); return 0; } 36 | return prevProgress - 1; 37 | }); 38 | }, durationInMs / 100); 39 | 40 | const removeTimer = setTimeout(() => { 41 | setIsVisible(false); 42 | }, durationInMs + 200); 43 | 44 | const cleanupTimer = setTimeout(() => { 45 | setIsVisible(false); 46 | }, durationInMs + 500); 47 | 48 | return () => { 49 | clearTimeout(removeTimer); 50 | clearTimeout(cleanupTimer); 51 | clearInterval(progressTimer); 52 | }; 53 | } 54 | }, [notifyData]); 55 | 56 | if (!notifyData) return null; 57 | 58 | useEffect(() => { 59 | if (textContainerRef.current) { 60 | const textHeight = textContainerRef.current.getBoundingClientRect().height; 61 | setLineHeight(`${textHeight * 0.8}px`); 62 | } 63 | }, [notifyData]); 64 | 65 | const { Title: title, Message: message, Type, Position, Effect } = notifyData; 66 | 67 | let positionStyles: PositionStyles = {}; 68 | if (Position === 'top') positionStyles = { top: '20px', left: '45%' }; 69 | else if (Position === 'bottom') positionStyles = { bottom: '20px', left: '45%' }; 70 | else if (Position === 'top-left') positionStyles = { top: '20px', left: '20px' }; 71 | else if (Position === 'top-right') positionStyles = { top: '20px', right: '20px' }; 72 | else if (Position === 'bottom-left') positionStyles = { bottom: '20px', left: '20px' }; 73 | else if (Position === 'bottom-right') positionStyles = { bottom: '20px', right: '20px' }; 74 | 75 | let iconColor: string; 76 | if (Type === 'success') iconColor = 'teal'; 77 | else if (Type === 'error') iconColor = 'red'; 78 | else if (Type === 'warning') iconColor = 'yellow'; 79 | else iconColor = 'blue'; 80 | 81 | return ( 82 | 103 |
104 | 105 | {Type} 106 | 107 |
108 | {Effect === 'line' ? ( 109 |
110 |
119 |
120 | 121 | {title} 122 | 123 |

{message}

124 |
125 |
126 | ) : ( 127 | <> 128 |
129 | 130 | {title} 131 | 132 |

{message}

133 |
134 |
135 | 136 |
137 | 138 | )} 139 | 140 | ); 141 | }; 142 | 143 | export default Notification; 144 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------