Updated Some Public Modules

Author: GitHub Actions

documentation/docs/modules/advertisements/about.md

@@ -0,0 +1,25 @@
+<h1 style="text-align:center; font-size:2rem; font-weight:bold;">About</h1>
+
+**Name:**
+Advertisements
+
+**Version:**
+1.25
+
+**Description:**
+
+Implements a paid /advert command for server-wide announcements. Messages are colored, logged, and throttled by a cooldown to curb spam.
+
+<h2 style="text-align:center; font-size:1.5rem; font-weight:bold;">Features</h2>
+
+- Adds a paid /advert command players can use
+- Adds a cooldown via AdvertCooldown to limit spam
+- Adds colored broadcast messages across the server
+- Adds price control via AdvertPrice configuration
+- Adds notifications when players lack funds
+
+
+
+
+
+<p align="center"><a href="https://github.com/LiliaFramework/Modules/raw/refs/heads/gh-pages/advert.zip" style="display:inline-block;padding:12px 24px;font-size:1.5rem;font-weight:bold;text-decoration:none;color:#fff;background-color:var(--md-primary-fg-color,#007acc);border-radius:4px;">DOWNLOAD HERE</a></p>

documentation/docs/modules/advertisements/hooks.md

@@ -0,0 +1,36 @@
+# Hooks
+
+Module-specific events raised by the Advertisements module.
+
+---
+
+### `AdvertSent`
+
+**Purpose**
+
+`Fires after a player successfully sends an advertisement message.`
+
+**Parameters**
+
+* `client` (`Player`): `Player who posted the advert.`
+
+* `message` (`string`): `Text that was advertised.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil` — `This hook does not return anything.`
+
+**Example**
+
+```lua
+hook.Add("AdvertSent", "LogAdvert", function(client, message)
+    print(client:Nick() .. " advertised: " .. message)
+end)
+```
+
+---
+

documentation/docs/modules/alcoholism/about.md

@@ -0,0 +1,25 @@
+<h1 style="text-align:center; font-size:2rem; font-weight:bold;">About</h1>
+
+**Name:**
+Alcoholism
+
+**Version:**
+1.27
+
+**Description:**
+
+Adds drinkable alcohol that increases a player's intoxication level. High BAC blurs vision and slows movement until the effect wears off.
+
+<h2 style="text-align:center; font-size:1.5rem; font-weight:bold;">Features</h2>
+
+- Adds alcohol items that raise BAC and gradually wear off
+- Adds screen blur and movement effects that scale with intoxication
+- Adds player notification when reaching DrunkNotifyThreshold
+- Adds configurable BAC settings like AlcoholTickTime
+- Adds multiple drink items with varying strength
+
+
+
+
+
+<p align="center"><a href="https://github.com/LiliaFramework/Modules/raw/refs/heads/gh-pages/alcoholism.zip" style="display:inline-block;padding:12px 24px;font-size:1.5rem;font-weight:bold;text-decoration:none;color:#fff;background-color:var(--md-primary-fg-color,#007acc);border-radius:4px;">DOWNLOAD HERE</a></p>

documentation/docs/modules/alcoholism/hooks.md

@@ -0,0 +1,303 @@
+# Hooks
+
+Module-specific events raised by the Alcoholism module.
+
+---
+
+### `BACChanged`
+
+**Purpose**
+
+`Called whenever a player's Blood Alcohol Content (BAC) value is updated.`
+
+**Parameters**
+
+* `client` (`Player`): `The player whose BAC changed.`
+
+* `newBac` (`number`): `The player's new BAC value.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil` — `This hook does not return anything.`
+
+**Example**
+
+```lua
+hook.Add("BACChanged", "PrintBac", function(client, newBac)
+    print(client:Name() .. " BAC is now " .. newBac .. "%")
+end)
+```
+
+---
+
+### `BACReset`
+
+**Purpose**
+
+`Runs when a player's BAC is reset to 0.`
+
+**Parameters**
+
+* `client` (`Player`): `The player whose BAC was reset.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("BACReset", "HandleBacReset", function(client)
+    -- Additional logic when the player sobers up
+end)
+```
+
+---
+
+### `BACIncreased`
+
+**Purpose**
+
+`Fires when a player's BAC is increased through consuming alcohol.`
+
+**Parameters**
+
+* `client` (`Player`): `The affected player.`
+
+* `amt` (`number`): `Amount added to the BAC.`
+
+* `newBac` (`number`): `The resulting BAC value.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("BACIncreased", "NotifyBACIncrease", function(client, amt, newBac)
+    client:ChatPrint("BAC increased by " .. amt .. " to " .. newBac .. "%")
+end)
+```
+
+---
+
+### `AlcoholConsumed`
+
+**Purpose**
+
+`Triggered when an alcohol item is used by a player.`
+
+**Parameters**
+
+* `client` (`Player`): `Player that consumed the item.`
+
+* `item` (`Item`): `The alcohol item that was consumed.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("AlcoholConsumed", "LogDrink", function(client, item)
+    print(client:Name() .. " drank " .. item.name)
+end)
+```
+
+---
+
+### `PreBACReset`
+
+**Purpose**
+
+`Runs right before a player's BAC value is cleared.`
+
+**Parameters**
+
+* `client` (`Player`): `The player about to be reset.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("PreBACReset", "LogBeforeReset", function(client)
+    print(client:Name() .. " BAC resetting")
+end)
+```
+
+---
+
+### `PostBACReset`
+
+**Purpose**
+
+`Called after a player's BAC has been cleared.`
+
+**Parameters**
+
+* `client` (`Player`): `The player that was reset.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("PostBACReset", "AfterReset", function(client)
+    -- cleanup
+end)
+```
+
+---
+
+### `PreBACIncrease`
+
+**Purpose**
+
+`Invoked before a player's BAC value increases.`
+
+**Parameters**
+
+* `client` (`Player`): `The affected player.`
+
+* `amt` (`number`): `Amount being added.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("PreBACIncrease", "CheckIncrease", function(client, amt)
+    print("BAC will increase by", amt)
+end)
+```
+
+---
+
+### `BACThresholdReached`
+
+**Purpose**
+
+`Fires when a player's BAC crosses the drunk threshold.`
+
+**Parameters**
+
+* `client` (`Player`): `The player who crossed the threshold.`
+
+* `newBac` (`number`): `Their new BAC value.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("BACThresholdReached", "AlertAdmins", function(client, bac)
+    print(client:Name() .. " is drunk at " .. bac .. "%")
+end)
+```
+
+---
+
+### `PreBACDecrease`
+
+**Purpose**
+
+`Runs before the server lowers a player's BAC over time.`
+
+**Parameters**
+
+* `client` (`Player`): `Player whose BAC will drop.`
+
+* `bac` (`number`): `Their current BAC before drop.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("PreBACDecrease", "CheckDrop", function(client, bac)
+    -- You could modify decay here
+end)
+```
+
+---
+
+### `PostBACDecrease`
+
+**Purpose**
+
+`Runs after a player's BAC has decayed for the tick.`
+
+**Parameters**
+
+* `client` (`Player`): `Affected player.`
+
+* `newBac` (`number`): `Their BAC after decay.`
+
+**Realm**
+
+`Server`
+
+**Returns**
+
+`nil`
+
+**Example**
+
+```lua
+hook.Add("PostBACDecrease", "NotifyDrop", function(client, newBac)
+    print("BAC now", newBac)
+end)
+```
+
+---
+
+