Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 3.83 KB

README.md

File metadata and controls

85 lines (54 loc) · 3.83 KB

Project Sloth GitHub Project PS-HUD Banner

ps-hud

Ultra customizable hud featuring a unique and robust settings menu. Change eveything about your experience!

Project Sloth Buttons 2

Optional:

⚠️Important:

  • If the minimap is pulsating or flickering, make sure if you are using custom maps that you ensure ps-hud BEFORE map resource.
  • Do not rename this resource from ps-hud or you will encounter issues.
  • Locale is now supported. Make sure that your qb-core is update. You can update it here.
  • This script is fully open source, it has no obfuscation. Svelte compiled the js when it gets build and original source code is here svelte-source.


Project Sloth GitHub Project PS-HUD Install Banner

Start installing now

We will now provide you with a step-by-step guide for the installation process. Shouldn't take too long and it shouldn't be too confusing either!

Step 1:

Go ahead and start by dragging and dropping ps-hud into your designated resources folder.

If you are still lost, Slothy has created a few GIF's to help guide you through all the installation steps.

chrome_KpjdUnvhgV



Admin Only Setting:

If you don't want your community to be able to access the customizability options within the menu; make sure to change Config.AdminOnly to true instead of false. Keep in mind as well, while true, the changes you save will override for everyone on the server.

This configuration setting is found in ps-hud/config.lua as shown in the GIF below.

chrome_ZwsidhP73y



Project Sloth GitHub Project PS-HUD Features Banner

Some features to mention within this ps-hud:

  • Custom icon shapes
  • Alter icon size, position and color
  • Customize settings for individual icons
  • Endless options for icon position and orientation


Project Sloth GitHub Project PS-HUD Showcase Banner

Time to show you what it looks like!

Here's a few showcased examples while using ps-hud.

Design mode and shapes:

DesignModeandShapes.mp4

Icon state and color:

IconStateandColors.mp4

Icon size and position:

IconSizeandPosition.mp4

Change progress color:

ColorChanges.mp4

Individually edit icons:

IndividualEdits.mp4

Icon layout and spacing:

IconLayoutandSpacing.mp4

Credits:

Inspiration and some code snippets from Svelte & Lua Boilerplate by Project Error

Copyright © 2022 Project Sloth.