From 0b943d815458edda94502f2158174dcaf03786bc Mon Sep 17 00:00:00 2001
From: Mustache Dom <123716453+Mustachedom@users.noreply.github.com>
Date: Mon, 25 Nov 2024 02:07:07 -0800
Subject: [PATCH] update readme
---
readme.md | 72 +++++++++++++++++++++++++++----------------------------
1 file changed, 36 insertions(+), 36 deletions(-)
diff --git a/readme.md b/readme.md
index 430c563..2402d22 100644
--- a/readme.md
+++ b/readme.md
@@ -4,45 +4,41 @@
- Mustache Scripts Discord
+ Mustache Scripts Discord
-# Credits
+## **Credits**
-- I used [Samuel's development](https://fivem.samueldev.shop/) Christmas script global states and prop spawning (with permission obtained prior to release) in the development process.
-- Shout out to [STACHY225](https://babiczind.tebex.io/category/2103836) for working out the meth network animations!
-- Huge credit to [Bostra](https://discord.gg/5ncbwMNq) for sharing free scripts and providing sanity checks during moments of confusion. Those cute mushrooms? His creation!
-- Special thanks to [Feisty]() for the stunning visuals. If it looks good, she probably had a hand in it.
-- Special shoutout to [Beta Testers]()Your feedback has been invaluable!
-- Big Credit to [Bostra](https://discord.gg/5ncbwMNq). if you have been around you may have seen him post some free scripts and help people, There was definetly times I dm'd him saying what the fuck am I doing and he helped keep me sane. He also made the cute mushrooms!
-- [Jim's Tebex](https://jimathy666.tebex.io/) for putting out open source resources that I was able to break and fix and learn how to code
-- [jixeltay](https://jixeltay.tebex.io/category/scripts) for putting out banger after banger. These people help the community learn so much more
-- Our partner [1of1 Servers]( https://1of1servers.com/) and their [discord](https://discord.gg/1of1servers) for their amazing server hosting! absolutely top notch.
-- Thanks to Kamaryn for this [install guide video](https://youtu.be/zvuYnUfrqaA?si=FGJuBO5krZMC14Nd) join their [discord](https://discord.gg/KPRmZqFS) for other videos updates.
+- **[Samuel's Development](https://fivem.samueldev.shop/):** Used their Christmas script global states and prop spawning (with permission).
+- **[STACHY225](https://babiczind.tebex.io/category/2103836):** Meth network animations.
+- **[Bostra](https://discord.gg/5ncbwMNq):** Free scripts, sanity checks, and those cute mushrooms!
+- **[Feisty]():** Stunning visuals that make everything look amazing.
+- **Beta Testers:** Your invaluable feedback made this possible.
+- **[Jim's Tebex](https://jimathy666.tebex.io/):** Open-source resources that helped refine coding skills.
+- **[Jixeltay](https://jixeltay.tebex.io/category/scripts):** For creating scripts that teach and inspire the community.
+- **[1of1 Servers](https://1of1servers.com/):** Top-notch hosting and support. Join their [Discord](https://discord.gg/1of1servers).
+- **[Kamaryn](https://discord.gg/KPRmZqFS):** For the [installation guide video](https://youtu.be/zvuYnUfrqaA?si=FGJuBO5krZMC14Nd).
-# Dependencies
+## **Dependencies**
-- [ox_lib](https://github.com/overextended/ox_lib/releases/tag/v3.12.0)
-
-- [qb-target](https://github.com/qbcore-framework/qb-target) **or** [ox_target](https://github.com/overextended/ox_target)
-
-- emote script that uses the animations event
- - for example one of these
- - [dpemotes](https://github.com/andristum/dpemotes) -- should use RP instead
- - [rpemotes](https://github.com/alberttheprince/rpemotes-reborn)
- - [scully_emotemenu](https://github.com/Scullyy/scully_emotemenu)
-
-- [read](https://letters.hookedonphonics.com/us/read-guaranteed-G14.html?vc=HPG1&pc=SHPGBR&tracking_id=102917836048989658da259e8c83e6&url_id=5586&oid=707&vid=1855&cid=4194&hid=14509&utm_source=1855&aff_id2={aff_id2}&utm_campaign=PracticePackHOS&utm_medium=S&utm_content=BrandDollarPacks&gc_id=184380999&h_ad_id=374941048206&src=O&qid=3&msvid=v2)
-
-- GAME BUILD 2944 OR LATER
+- **[ox_lib](https://github.com/overextended/ox_lib/releases/tag/v3.12.0)**
+- **[qb-target](https://github.com/qbcore-framework/qb-target)** or **[ox_target](https://github.com/overextended/ox_target)**
+- **Emote Scripts (supports animations):**
+ - [dpemotes](https://github.com/andristum/dpemotes)
+ - [rpemotes](https://github.com/alberttheprince/rpemotes-reborn)
+ - [scully_emotemenu](https://github.com/Scullyy/scully_emotemenu)
+- **[Read](https://letters.hookedonphonics.com/us/read-guaranteed-G14.html)**
+- **Game Build 2944 or Later**
-# Preview
-### [Preview link](https://www.youtube.com/watch?v=I_x7_oz_SAU)
+## **Preview**
-# How to install like a fuckin boss
+- **[Watch Preview](https://www.youtube.com/watch?v=I_x7_oz_SAU)**
+
+
+## **How to install like a fuckin boss**
### STEP 1
@@ -187,12 +183,12 @@
# STEP 6
- Run SQL
-
-# OPTIONAL STEPS
+
+# **OPTIONAL STEPS**
## Fivemerr
-This is NOT a requirement but something I personally use and believe in.
+This is **NOT** a requirement but something I personally use and believe in.
- to integrate with fivemerr make sure you have ```set fivemerrLogs "API_KEY"``` in your server.cfg
@@ -201,11 +197,15 @@ This is NOT a requirement but something I personally use and believe in.
- profit
-Why integrate with Fivemerr? Its a great place to store logs as it doesnt rely on discord webhooks and its far easier to search through
+Why Integrate with Fivemerr?
-As well as a place to offload images and videos from fivem that doesnt rely on discord since discord API will be automatically deleting images and videos after a certain amount of time If you need an invite to their server look below
-- [Fivemerr Discord](https://discord.com/invite/fivemerr)
-- [Fivemerr Docs](https://docs.fivemerr.com/)
+- Efficient Logging: Unlike Discord webhooks, Fivemerr provides an organized and searchable log system.
+- Media Storage: Easily store and access images or videos without relying on Discord. Discord's API often deletes media after a certain time, but Fivemerr keeps them secure and accessible.
+- As well as a place to offload images and videos from fivem that doesnt rely on discord since discord API will be automatically deleting images and videos after a certain amount of time If you need an invite to their server look below
+
+[Fivemerr Discord](https://discord.com/invite/fivemerr)
+
+[Fivemerr Docs](https://docs.fivemerr.com/)
## Radial Menu
- head to `qb-radial/config.lua` and search for the following event