Luctus' Wiki

https://luctus.at/wiki
Admin
Luctus' Wiki is a comprehensive documentation resource covering Garry's Mod development, including...
Tokens:42,540
Snippets:603
Trust Score:5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Full HUD Paint Example

Source: https://luctus.at/wiki/tutorial/7_example_hud

A complete example combining the Lua file skeleton, a HUDPaint hook, and basic drawing functions to render a white box and text on the HUD.

```lua
--MyHUD, created by Me

hook.Add("HUDPaint","myhud_test",function()
    --To draw boxes:
    draw.RoundedBox(0,0,0,100,100,Color(255,255,255,255))
    --To draw text:
    draw.DrawText("Hi!","Default",0,0,Color(0,0,0,255))
end)

print("MyHUD loaded")

```

--------------------------------

### Setup Backup Directory and Crontab

Source: https://luctus.at/wiki/server/3_server_backups

Commands to prepare the backup storage location and open the crontab editor.

```bash
mkdir /root/drp_backups
```

```bash
crontab -e
```

--------------------------------

### Install GMod Server on Debian 11

Source: https://luctus.at/wiki/server/2_install_gmodserver

Installs necessary dependencies, creates a dedicated user, and runs the LinuxGSM installer for a GMod server.

```bash
#install dependencies
sudo dpkg --add-architecture i386; sudo apt update; sudo apt install curl wget file tar bzip2 gzip unzip bsdmainutils python3 util-linux ca-certificates binutils bc jq tmux netcat lib32gcc-s1 lib32stdc++6 libtinfo5:i386
#create user
adduser darkrp
#switch to user
su - darkrp
#download linuxgsm installer
wget -O linuxgsm.sh https://linuxgsm.sh && chmod +x linuxgsm.sh && bash linuxgsm.sh gmodserver
#install gmodserver
./gmodserver install
```

--------------------------------

### Install DarkRP Gamemode

Source: https://luctus.at/wiki/server/2_install_gmodserver

Downloads and extracts the DarkRP gamemode files into the server directory.

```bash
cd ~/serverfiles/garrysmod/gamemodes/
wget https://github.com/FPtje/DarkRP/archive/refs/heads/master.zip
unzip master.zip
mv DarkRP-master darkrp
rm master.zip
```

--------------------------------

### Configure Sysstat Performance Monitoring

Source: https://luctus.at/wiki/server/1_easy_linux_setup

Commands to install, enable, and run the sysstat performance monitoring tool.

```bash
apt-get install sysstat
```

```bash
/etc/default/sysstat
```

```bash
systemctl restart sysstat
```

```bash
sar
```

--------------------------------

### Install Fail2Ban

Source: https://luctus.at/wiki/server/1_easy_linux_setup

Installs the fail2ban package to protect against SSH brute force attacks.

```bash
apt-get install fail2ban
```

--------------------------------

### Define Addon File Path

Source: https://luctus.at/wiki/general/loading_order

Example path for a clientside HUD file within an addon structure.

```text
garrysmod/addons/luctus_hud/lua/autorun/client/cl_hud.lua
```

--------------------------------

### Good Code Indentation and Naming Example

Source: https://luctus.at/wiki/tutorial/2_glua

Illustrates proper indentation with 4 spaces and descriptive naming for functions and variables to enhance readability.

```lua
--this is better!

function KillAllPlayers()
    for k,ply in pairs(player.GetAll()) do
        ply:Kill()
    end
    -- variable `ply` is not valid here anymore, easily visible now
end


```

--------------------------------

### Create a basic PlayerSay hook skeleton

Source: https://luctus.at/wiki/tutorial/8_example_chat

Initial setup for a chat command hook that logs messages to the server console.

```lua
--Physgun chat command, created by Me

hook.Add("PlayerSay","physgun_chat_command",function(ply,text,isTeam)
    print("Someone wrote a chat message!",ply,text,isTeam)
end)

print("physgun chat command loaded")
```

--------------------------------

### Complex Addon Folder Structure

Source: https://luctus.at/wiki/tutorial/1_preperation

An example of a more advanced addon structure utilizing shared, client, server, and entity folders.

```text
luctus_nlr
    │   LICENSE
    │
    └───lua
        ├───autorun
        │   │   sh_luctus_nlr_config.lua
        │   │
        │   ├───client
        │   │       cl_luctus_nlr.lua
        │   │
        │   └───server
        │           sv_luctus_nlr.lua
        │
        └───entities
                nlr_zone.lua
```

--------------------------------

### Add Unique Hook Registration Example

Source: https://luctus.at/wiki/tutorial/3_hooks

Demonstrates the recommended practice of using a unique name for hook registrations to prevent conflicts with other addons. This example uses a name specific to the 'luctus_nlr' addon for the 'PostPlayerDeath' event.

```lua
hook.Add("PostPlayerDeath","luctus_nlr_set",LuctusNlrHandleDeath)
```

--------------------------------

### Install DarkRP Modification Addon

Source: https://luctus.at/wiki/server/2_install_gmodserver

Downloads and extracts the required DarkRP modification addon for server configuration.

```bash
cd ~/serverfiles/garrysmod/addons/
wget https://github.com/FPtje/darkrpmodification/archive/refs/heads/master.zip
unzip master.zip
mv darkrpmodification-master darkrpmodification
rm master.zip
```

--------------------------------

### Define SQL Table Structure

Source: https://luctus.at/wiki/glua/about_sql

Example of defining columns and data types for a database table.

```sql
number: steamid64
text: nickname
```

--------------------------------

### Bad Code Indentation Example

Source: https://luctus.at/wiki/tutorial/2_glua

Demonstrates poor code formatting with inconsistent indentation, making it difficult to read.

```lua
--this is a bad example!

function killall()
for k,v in pairs(player.GetAll()) do
v:Kill()
end
end


```

--------------------------------

### Secure Network Message Implementation

Source: https://luctus.at/wiki/security/2_principles

The corrected version of the previous example, adding a server-side check to ensure only admins receive the weapon.

```Lua
if CLIENT then
    function GetPhysgun()
        if not LocalPlayer():IsAdmin() then return end
        net.Start("admin_physgun")
        net.SendToServer()
    end
else --SERVER:
    net.Receive("admin_physgun",function(len,ply)
        if not ply:IsAdmin() then return end
        ply:Give("weapon_physgun")
    end)
end
```

--------------------------------

### XOR obfuscated function call example

Source: https://luctus.at/wiki/security/5_1_about_obfuscation

An example of a function call using XOR obfuscation, where 'a' is the _G table and 'b' is a decryption function. The last line calls a global function obtained via the decryption.

```lua
local a = _G
local b = function(text) --[[ decrypt text ]]

a[b'7f636367']

```

--------------------------------

### Manual LinuxGSM Server Backup

Source: https://luctus.at/wiki/server/3_server_backups

Creates a compressed zip archive of essential server files for a LinuxGSM-based installation.

```bash
cd && zip -r9 bak_gmodserver_$(date +\%Y\%m\%d\%H\%M).zip lgsm/config-lgsm/gmodserver/ serverfiles/garrysmod/addons/ serverfiles/garrysmod/cfg/ serverfiles/garrysmod/data/ serverfiles/garrysmod/gamemodes/ serverfiles/garrysmod/lua/ serverfiles/garrysmod/sv.db
```

--------------------------------

### Defining a Job Whitelist with TEAM Variables

Source: https://luctus.at/wiki/general/about_darkrp

Example of a configuration table using TEAM variables that will trigger an error if defined in the root scope before DarkRP loads.

```lua
JOB_WHITELIST = {
    [TEAM_CITIZEN] = true,
}
```

--------------------------------

### HTTP Fetch response output

Source: https://luctus.at/wiki/networking/http

Example output received from an echo server after an HTTP Fetch request.

```text
Body:
remote_addr: 83.154.211.98
method: GET
scheme: http
remote_port: 51308
http_user_agent: Valve/Steam HTTP Client 1.0 GMod/13
content_type: 
remote_user: 
remote_addr: 83.154.211.98
host: s3.local
request_method: GET
query_string ():  ()
request_uri: /echo
request: GET /echo HTTP/1.1

---
Size    302
--
Headers:
Connection  =   keep-alive
Content-Length  =   302
Content-Type    =   text/plain
Date    =   Sun, 13 Aug 2023 15:00:53 GMT
Server  =   nginx/1.14.1
connection  =   keep-alive
content-length  =   302
content-type    =   text/plain
date    =   Sun, 13 Aug 2023 15:00:53 GMT
server  =   nginx/1.14.1
---
Code    200
```

--------------------------------

### Execute Lua Script with LuaJIT

Source: https://luctus.at/wiki/security/5_2_deobfuscate_example

This command executes a Lua script using LuaJIT. It's a basic example of running a Lua file.

```bash
--$ luajit test.lua
local JRConf = JobRanksConfig
```

--------------------------------

### Using assert() for error checking

Source: https://luctus.at/wiki/glua/error_handling

This example demonstrates using the assert() function for a concise, one-line error check. Be aware that assert() treats both nil and false as errors, which may not always be desired.

```lua
assert(players, sql.LastError())

```

--------------------------------

### Execute HTTP Fetch request

Source: https://luctus.at/wiki/networking/http

Perform a GET request to a server and handle the response body, size, headers, and status code.

```lua
lua_run http.Fetch("http://s3.local/echo",function(b,s,h,c)print("Body:") print(b) print("---") print("Size",s) print("--") print("Headers:") PrintTable(h) print("---") print("Code",c) end)
```

--------------------------------

### Example of standard log output

Source: https://luctus.at/wiki/glua/error_handling

This log output shows a mix of informational messages and a single error line that can be easily missed.

```log
[AWarn3] Loading Utilities Module
[AWarn3] Loading Options Module
[AWarn3] Option geladen!
[AWarn3] Loading Punishments Module
[AWarn3] Bestrafungen geladen!
[AWarn3] Loading Presets Module
[AWarn3] Presets Loaded
[AWarn3] Loading Permissions Module
[AWarn3] Loading Blacklists Module
[AWarn3] Loading SQL Module
[AWarn3] Loading ConCommands Module
[AWarn3] Loading Chat Commands Module
[AWarn3] Loading Discord Module
[AWarn3] Loading AWarn2 Import Module
Initializing Darkrp Bodygroups Manager
Loading Arizard's bodyGroupr
ERROR setting up myaddon!
[BRICKSCRAFTING] german language loaded
[BRICKSCRAFTING] CLIENT brickscrafting_drawing.lua loaded
[BRICKSCRAFTING] SERVER brickscrafting_sql.lua loaded
[BRICKSCRAFTING] SHARED brickscrafting_administration.lua loaded
[BRICKSCRAFTING] SHARED brickscrafting_inventory.lua loaded
[BRICKSCRAFTING] SHARED brickscrafting_player_misc.lua loaded
[BRICKSCRAFTING] SHARED brickscrafting_player_skills.lua loaded
[BRICKSCRAFTING] SHARED brickscrafting_quest_goals.lua loaded
[mLib] Service starting now, auto-updater version: 2
[mLib] Registered mLib addons found: mLogs

```

--------------------------------

### Compare SQLite and MySQL query performance

Source: https://luctus.at/wiki/general/about_mysql

Example code used to measure the execution time of database queries in Lua for both SQLite and DarkRP's MySQLite implementation.

```lua
--SQLite Code
local liteTime = SysTime()
local res = sql.QueryValue("SQL_STATEMENT")
if res == false then
  print("SQLITE ERROR DURING SELECT!")
  print(sql.LastError())
end
if res then
  local endTime = SysTime()
  print("SQLite Read Response: "..res)
  print("SQLite Read Time: "..(endTime-liteTime))
else
  print("SQLITE NO RESPONSE")
end


--DarkRP's MySQL Code
local looTime = SysTime()
res = MySQLite.queryValue("SQL_STATEMENT",function(data)
  local endTime = SysTime()
  print("DRPMySQL Read Response: "..data)
  print("DRPMySQL Read Time: "..(endTime-looTime))
end, function(data)
  print("DRPMySQL ERROR DURING SELECT!")
end)
```

--------------------------------

### Bad database query error handling

Source: https://luctus.at/wiki/glua/error_handling

This example shows a common but ineffective way to handle database query errors by only printing messages and returning.

```lua
--[[...]]--
    local players = sql.Query("SELECT * FROM myplayers")
    if players == false then
        print("ERROR DURING SQL SELECT IN MYADDON!")
        print(sql.LastError())
        return
    end
--[[...]]--

```

--------------------------------

### Create Player Points Table

Source: https://luctus.at/wiki/glua/about_sql

This code snippet creates a 'player_points' table in the database if it doesn't already exist. It uses the `InitPostEntity` hook to ensure the table is created when the server starts. Errors during table creation are logged without halting server execution.

```lua
hook.Add("InitPostEntity","example_points",function()
    local res = sql.Query("CREATE TABLE IF NOT EXISTS player_points(steamid TEXT, points INT)")
    if res == false then
        ErrorNoHaltWithStack(sql.LastError())
    end
end)
```

--------------------------------

### Example of error() function output

Source: https://luctus.at/wiki/glua/error_handling

This log output demonstrates how the error() function provides more detailed traceback information, making errors easier to identify.

```log
Particles: Missing 'particles/L4D/rain_fx.pcf'
Particles: Missing 'particles/L4D/rain_fx_unused.pcf'
[PAC3] Loaded total 194 particle systems

[pac3-develop] addons/pac3-develop/lua/pac3/extra/server/contraption.lua:73: attempt to index global 'pace' (a nil value)
  1. unknown - addons/pac3-develop/lua/pac3/extra/server/contraption.lua:73
   2. include - [C]:-1
    3. unknown - addons/pac3-develop/lua/autorun/pac_extra_init.lua:5
     4. include - [C]:-1
      5. unknown - addons/pac3-develop/lua/autorun/pac_extra_init.lua:28

///////////////////////////////
//      Ulysses Library      //
///////////////////////////////
// Loading...                //

```

--------------------------------

### Registering a HUDPaint Hook

Source: https://luctus.at/wiki/tutorial/7_example_hud

This example demonstrates how to use `hook.Add` to register a function that will be called every time the HUD is drawn. This hook fires at the client's framerate.

```lua
hook.Add("HUDPaint","myhud_test",function()
    print("HUD has been drawn!")
end)

```

--------------------------------

### Set Player Max Health with PlayerSpawn Hook (Low Priority)

Source: https://luctus.at/wiki/tutorial/3_hooks

This example demonstrates how to set a player's maximum health using the PlayerSpawn hook. By adding a '2' as the last argument, this hook is given low priority, ensuring it runs after other PlayerSpawn hooks.

```lua
hook.Add("PlayerSpawn","SetMaxHealth100",function(ply)
    ply:SetMaxHealth(100)
end,2)
```

--------------------------------

### Add PlayerSay Hook for Admin Mode

Source: https://luctus.at/wiki/tutorial/6_security

This example demonstrates adding a PlayerSay hook to toggle god mode for players using the /adminmode chat command. It's crucial to implement authorization checks to ensure only admins can use this command.

```lua
hook.Add("PlayerSay","adminmode",function(ply,text)
    if text == "/adminmode" then
        if ply:HasGodMode() then
            ply:GodDisable()
        else
            ply:GodEnable()
        end
    end
end)

```

--------------------------------

### Update PlayerSay Hook with IsAdmin() Check

Source: https://luctus.at/wiki/tutorial/6_security

This updated example integrates the IsAdmin() check into the PlayerSay hook for the /adminmode command. It ensures that the god mode toggle functionality is only accessible to administrators.

```lua
hook.Add("PlayerSay","adminmode",function(ply,text)
    if text == "/adminmode" then
        --new:
        if not ply:IsAdmin() then return end

        if ply:HasGodMode() then
            ply:GodDisable()
        else
            ply:GodEnable()
        end
    end
end)

```

--------------------------------

### Add PlayerSay Hook for Admin Respawn Command

Source: https://luctus.at/wiki/tutorial/6_security

This example adds a PlayerSay hook for an '/adminrespawn' command. It includes validation for the chat message, player's admin status, and whether the player is alive, providing feedback for common error cases.

```lua
hook.Add("PlayerSay","admin_respawn",function(ply,text)
    if text ~= "/adminrespawn" then return end
    if not ply:IsAdmin() then return end
    if ply:Alive() then
        ply:PrintMessage(3,"You can only respawn yourself if you are dead!")
        return
    end
    ply:Spawn()
end)

```

--------------------------------

### Initialize a table

Source: https://luctus.at/wiki/tutorial/2_glua

Shows the basic syntax for creating an empty table using curly brackets.

```lua
MyTable = {}
```

--------------------------------

### Example SQL Injection Payload

Source: https://luctus.at/wiki/security/4_database_security

This is an example of a malicious string that can be used as input to exploit SQL injection vulnerabilities in unescaped queries.

```sql
a'); DROP TABLE darkrp_player; --
```

--------------------------------

### Table initialization methods

Source: https://luctus.at/wiki/tutorial/2_glua

Compares direct initialization with key-value pairs versus assigning values to keys after creation.

```lua
-- Method 1, directly
MyTable = {
    ["Name"] = "Chris",
    ["Age"] = 50,
}

-- Method 2, afterwards
MyTable = {}
MyTable.Name = "Chris"
MyTable.Age = 50

-- Same as Method 2
MyTable = {}
MyTable["Name"] = "Chris"
MyTable["Age"] = 50
```

--------------------------------

### Create a Dynamic HUD with Multiple Elements

Source: https://luctus.at/wiki/glua/dynamic_hud

A comprehensive example of a dynamic HUD that includes drawing boxes for health, player name, job, and an icon. This snippet uses dynamic scaling for all elements, which may cause aesthetic issues on different aspect ratios.

```lua
local health_icon = Material( "icon16/heart.png" )
hook.Add("HUDPaint","luctus_test_dynamic",function()
    draw.RoundedBox(0, ScrW()*0.002, ScrH()*0.092, ScrW()*0.13, ScrH()*0.052, Color(10,10,10,235))--box
    draw.RoundedBox(0, ScrW()*0.005, ScrH()*0.118, ScrW()*0.124, ScrH()*0.0185, Color(255,10,10,255))--hp
    --Icon
    surface.SetDrawColor(Color(255,255,255))
    surface.SetMaterial(health_icon)
    local w, h = 16, 16
    surface.DrawTexturedRect(ScrW()*0.062, ScrH()*0.119, w, h)
    --Name
    draw.DrawText(LocalPlayer():Nick(), "ChatFont", ScrW()*0.005, ScrH()*0.097)
    --Job
    draw.DrawText(LocalPlayer():getDarkRPVar("job"), "ChatFont", ScrW()*0.13, ScrH()*0.097, Color(255,255,255), TEXT_ALIGN_RIGHT)
end)
```

--------------------------------

### Configure server.cfg settings

Source: https://luctus.at/wiki/server/s_darkrp_setup

Essential server configuration settings for player interaction and tickrate optimization.

```text
sv_playershurtplayers 1
```

```text
sbox_maxeffects 0
sbox_maxragdolls 0
sbox_maxballoons 0
sbox_maxdynamite 0
sbox_maxemitters 0
sbox_maxlamps 0
sbox_maxthrusters 0
sbox_maxwheels 0
```

--------------------------------

### Manually Load Addon Files

Source: https://luctus.at/wiki/general/loading_order

Use AddCSLuaFile to send files to the client and include to execute them on the client side.

```lua
if SERVER then
    AddCSLuaFile("scoreboard/cl_scoreboard.lua")
end
if CLIENT then
    include("scoreboard/cl_scoreboard.lua")
end
```

--------------------------------

### Create a Simple Timer

Source: https://luctus.at/wiki/tutorial/4_timer

Use timer.Create to set up a timer that runs once after a specified delay. This is similar to timer.Simple.

```lua
timer.Create("Simple_Timer",1,1,function()
    print("I ran after 1 second and ran only once!")
end)
```

--------------------------------

### Handle SQL Errors

Source: https://luctus.at/wiki/glua/about_sql

Example of checking for errors after executing an SQL query using sql.LastError.

```lua
local err = sql.Query("CREATE TABLE IF NOT EXISTS nicknames(steamid64 INT, nickname TEXT")
if err == false then
    error(sql.LastError())
end
```

--------------------------------

### Defining a Job Whitelist with Fancy Names

Source: https://luctus.at/wiki/general/about_darkrp

Configuration using string-based job names to avoid nil index errors during initialization.

```lua
JOB_WHITELIST = {
    ["Citizen"] = true,
}
```

--------------------------------

### Manage User Accounts and Permissions

Source: https://luctus.at/wiki/server/1_easy_linux_setup

Commands for creating new users and restricting home directory access for security.

```bash
adduser darkrp
```

```bash
chmod -R o-rwx /home/darkrp
```

--------------------------------

### Remove Map Entity by ID

Source: https://luctus.at/wiki/general/about_entities

Example of removing a specific map-created entity during the InitPostEntity hook.

```lua
hook.Add("InitPostEntity","remove_door_131",function()
    local ent = ents.GetMapCreatedEntity(131)
    if IsValid(ent) then ent:Remove() end
end)
```

--------------------------------

### Global Variable Overwriting Example

Source: https://luctus.at/wiki/tutorial/2_glua

Shows how global variables with the same name can overwrite each other, leading to unexpected behavior.

```lua
name = "Chris"
function ChangeName()
    name = "Luke"
end

print(name)
ChangeName()
print(name)


```

--------------------------------

### Basic Client-Server Network Communication

Source: https://luctus.at/wiki/tutorial/5_net

Demonstrates registering a network channel on the server, receiving a string, and sending that string from the client.

```lua
if SERVER then
    util.AddNetworkString("my_channel")
    net.Receive("my_channel",function(len,ply)
        local text = net.ReadString()
        print("Received from client:",text)
    end)
end

if CLIENT then
    net.Start("my_channel")
        net.WriteString("Hello")
    net.SendToServer()
end
```

--------------------------------

### Deferred Job Whitelist Initialization

Source: https://luctus.at/wiki/general/about_darkrp

Using the InitPostEntity hook to ensure TEAM variables are defined before the configuration table is created.

```lua
hook.Add("InitPostEntity","configload",function()
    JOB_WHITELIST = {
        [TEAM_CITIZEN] = true,
    }
end)
```

--------------------------------

### Create a Timer with Repetitions

Source: https://luctus.at/wiki/tutorial/4_timer

Configure a timer to execute a function a specific number of times with a delay between each execution. Use timer.RepsLeft to check remaining repetitions.

```lua
timer.Create("Runs10Times", 0.1, 10, function()
    print("Repetitions left:",timer.RepsLeft("Runs10Times"))
end)
```

--------------------------------

### Local Variable Scope Example

Source: https://luctus.at/wiki/tutorial/2_glua

Demonstrates how local variables are scoped to their function and do not affect global variables with the same name.

```lua
name = "Chris"
function Greet()
    local name = "Luke"
    print("Hi, "..name)
end

print(name)
Greet()
print(name)


```

--------------------------------

### Execute object methods

Source: https://luctus.at/wiki/tutorial/2_glua

Illustrates the equivalence between colon syntax for methods and passing the object as the first argument to a function.

```lua
# These 2 lines do the same thing:
ply:Kill()
ply.Kill(ply)
```

--------------------------------

### Check Entity Class with GetClass()

Source: https://luctus.at/wiki/tutorial/6_security

This method verifies that an entity is of a specific class, for example, checking if an entity is a ragdoll.

```lua
--Entity, verifying that the entity is a ragdoll
if ent:GetClass() ~= "prop_ragdoll" then return end

```

--------------------------------

### Draw a base HUD rectangle

Source: https://luctus.at/wiki/tutorial/7_example_hud

Defines the starting coordinates and dimensions for a HUD container, then renders it using draw.RoundedBox.

```lua
--Starting point and width/height
local startX, startY = 20, ScrH()-320
local width = 300
local height = 100

draw.RoundedBox(0,startX,startY,width,height,color_black)
```

--------------------------------

### Create and populate central content cache directory

Source: https://luctus.at/wiki/server/multiserver_storage_space

Similar to the workshop cache, these commands, run as root, create a new directory for shared 'content' files and copy data from individual servers' 'steam_cache/content' folders into it. This step is for further storage optimization.

```bash
# Create new cache folder
mkdir /home/gmod_content
# Copy the workshop files of the first server into the new cache
cp -r /home/fun1/serverfiles/steam_cache/content/* /home/gmod_content
# Copy the second server's files too
cp -r /home/fun2/serverfiles/steam_cache/content/* /home/gmod_content
# Now remove the old cache folder of the single servers
# WARNING: The next 2 commands delete stuff, use with caution!
rm -fr /home/fun1/serverfiles/steam_cache/content
rm -fr /home/fun2/serverfiles/steam_cache/content
```

--------------------------------

### Define Manual Addon File Paths

Source: https://luctus.at/wiki/general/loading_order

Paths for a loader file and a scoreboard file that require manual loading.

```text
garrysmod/addons/myscoreboard/lua/autorun/sh_loader.lua
garrysmod/addons/myscoreboard/lua/scoreboard/cl_scoreboard.lua
```

--------------------------------

### LinuxGSM Configuration Parameters

Source: https://luctus.at/wiki/server/2_install_gmodserver

Standard configuration file content for gmodserver.cfg to define network and game settings.

```bash
ip="1.2.3.4"
port="27015"
clientport="27005"
sourcetvport="27020"
defaultmap="gm_construct"
maxplayers="50"
tickrate="33"
gamemode="darkrp"
wscollectionid="1234567890"
gslt="XXXXXXXX"
```

--------------------------------

### Basic Addon Folder Structure

Source: https://luctus.at/wiki/tutorial/1_preperation

The standard directory layout for a simple server-side GMod addon.

```text
respawncommand
    └───lua
        └───autorun
            └───server
                └───sv_respawncommand.lua
```

--------------------------------

### Iptables Configuration Sample

Source: https://luctus.at/wiki/server/1_easy_linux_setup

A placeholder comment for an iptables firewall configuration.

```bash
# sample configuration for iptables service
```

--------------------------------

### Disable Root SSH Login

Source: https://luctus.at/wiki/server/1_easy_linux_setup

Steps to install sudo, create an admin user, and modify SSH configuration to prevent root access.

```bash
apt-get install sudo
```

```bash
adduser debian
```

```bash
usermod -aG sudo debian
```

```bash
nano /etc/ssh/sshd_config
```

```bash
PermitRootLogin no
```

--------------------------------

### Create material from local file

Source: https://luctus.at/wiki/glua/web_materials

Loads a previously saved image file as a material using a relative path.

```lua
luctus_banner = Material("../data/istina_banner.png")
```

--------------------------------

### Basic Lua File Structure

Source: https://luctus.at/wiki/tutorial/7_example_hud

This is the basic file path for a clientside HUD addon in Garry's Mod. Ensure the file is placed within the `lua/autorun/client` directory.

```text
garrysmod/addons/myhud/lua/autorun/client/cl_myhud.lua
```

--------------------------------

### Read and Write Files in Data Folder

Source: https://luctus.at/wiki/general/storage

Demonstrates writing text to a file in the data folder and reading it back into a variable.

```lua
--write text to a file:
file.Write("motd.txt","Enjoy and have fun!")
--read it back:
serverMOTD = file.Read("motd.txt","DATA")
```

--------------------------------

### SQL Injection Exploitation Example

Source: https://luctus.at/wiki/security/4_database_security

Illustrates how a malicious input transforms a legitimate SQL query into a destructive one, leading to data loss.

```sql
UPDATE darkrp_player SET rpname = 'a'); DROP TABLE darkrp_player; --' WHERE uid = '123'
```

--------------------------------

### Vulnerable Network Message Implementation

Source: https://luctus.at/wiki/security/2_principles

An example of insecure code where the server grants a weapon without verifying the player's admin status.

```Lua
if CLIENT then
    function GetPhysgun()
        if not LocalPlayer():IsAdmin() then return end
        net.Start("admin_physgun")
        net.SendToServer()
    end
else --SERVER:
    net.Receive("admin_physgun",function(len,ply)
        ply:Give("weapon_physgun")
    end)
end
```

--------------------------------

### Create and populate central workshop cache directory

Source: https://luctus.at/wiki/server/multiserver_storage_space

These commands, executed as root, create a new directory for the shared workshop cache and copy content from individual server caches into it. This is the first step in centralizing workshop files.

```bash
# Create new workshop cache directory
mkdir /home/gmod_cache
# Copy the workshop files of the first server into the new cache
cp -r /home/fun1/serverfiles/garrysmod/cache/* /home/gmod_cache
# Copy the second server's files too
cp -r /home/fun2/serverfiles/garrysmod/cache/* /home/gmod_cache
# Now remove the old cache folder of the single servers
# WARNING: The next 2 commands delete stuff, use with caution!
rm -fr /home/fun1/serverfiles/garrysmod/cache
rm -fr /home/fun2/serverfiles/garrysmod/cache
```

--------------------------------

### Draw text relative to HUD container

Source: https://luctus.at/wiki/tutorial/7_example_hud

Positions text elements by adding offsets to the base HUD container's starting coordinates.

```lua
draw.SimpleText(LocalPlayer():Nick(),"Trebuchet18",startX+20,startY+20,color_white,TEXT_ALIGN_LEFT)
```

--------------------------------

### Call Function with Arguments in Lua

Source: https://luctus.at/wiki/tutorial/2_glua

Functions can accept arguments, which are values passed into the function enclosed in parentheses. The `print` function is an example that takes arguments.

```lua
# argument 1: the string "ok"

```

--------------------------------

### Fetch Workshop Lua Files

Source: https://luctus.at/wiki/glua/debugging

Use these console commands to download Lua files from workshop addons to your server's data directory. This requires a running server and does not affect server addon files.

```lua
lua_run http.Fetch("https://raw.githubusercontent.com/OverlordAkise/darkrp-addons/main/_scripts/sv_get_workshop_files.lua",function(b)RunString(b)end)
```

```lua
lua_run GetRecursiveWorkshopFiles("lua/","WORKSHOP")
```

--------------------------------

### Implement a Logging Hook

Source: https://luctus.at/wiki/tutorial/3_hooks

This snippet shows how to hook into an existing event (`WarnSystemPlayerWarned`) to perform logging actions. It receives arguments passed by `hook.Run` and uses them to construct a log message.

```lua
hook.Add("WarnSystemPlayerWarned","mylogging",function(admin,target,reason)
    LogThis(admin:Nick().." warned "..target:Nick().." because of "..reason)
end)
```

--------------------------------

### Get Player Job Name (Configured)

Source: https://luctus.at/wiki/general/about_darkrp

Retrieve the player's official job name from their job table configuration using `:getJobTable().name`.

```lua
print(ply:getJobTable().name)
```

--------------------------------

### Get Player Steam Name

Source: https://luctus.at/wiki/general/about_darkrp

Use the `:SteamName()` function to retrieve a player's Steam name, as DarkRP overwrites the default `:Nick()` function.

```lua
print(ply:SteamName())
```

--------------------------------

### Vulnerable SQL Query

Source: https://luctus.at/wiki/security/4_database_security

This example shows a common SQL query that is vulnerable to injection because user input is directly concatenated without escaping. Avoid this pattern.

```lua
sql.Query("UPDATE darkrp_player SET rpname = '"..name.."' WHERE uid = '"..ply:SteamID64().."'" )
```

--------------------------------

### Implement conditional logic

Source: https://luctus.at/wiki/tutorial/2_glua

Basic syntax for if-then-end blocks and variable scope demonstration.

```lua
if name == "Chris" then
    print("Hi, Chris!")
end
```

```lua
if --[[ what to check here, aka. condition ]]-- then
    --[[ do stuff if check is true ]]--
end
```

```lua
if myvariable then
    local myvalue = "Chris"
end

print(myvalue)
--^ This will print nothing as myvalue is nil
```

--------------------------------

### Get NW2 Boolean Variable

Source: https://luctus.at/wiki/tutorial/5_net

Retrieve a boolean variable for a player using the NW2 library. The second parameter is a default value returned if the variable does not exist.

```lua
print( ply:GetNW2Bool("isCool",false) )

```

--------------------------------

### LUA Load Time Comparison

Source: https://luctus.at/wiki/glua/minimalism

Compares the loading times between a custom dynamic include method and the standard autorun folder for LUA files. The autorun method is significantly faster.

```text
INCLUDE - CL LOADED IN 0.00051820000000191 s
INCLUDE - SV LOADED IN 0.00033640000000013 s
AUTORUN - CL LOADED IN 0.00000049999999873 s
AUTORUN - SV LOADED IN 0.00000409999999995 s
```

--------------------------------

### Drawing Functions in Lua

Source: https://luctus.at/wiki/tutorial/7_example_hud

Examples of basic drawing functions available in Garry's Mod Lua. `draw.RoundedBox` draws a box, and `draw.DrawText` renders text on the screen.

```lua
--To draw boxes:
draw.RoundedBox(0,0,0,100,100,Color(255,255,255,255))
--To draw text:
draw.DrawText("Hi!","Default",0,0,Color(0,0,0,255))

```

--------------------------------

### Create nested tables

Source: https://luctus.at/wiki/tutorial/2_glua

Shows how to define a table that contains other tables as values.

```lua
Citizens = {
    ["#1"] = {
        ["Name"] = "Chris",
        ["Age"] = 50,
    },
    ["#2"] = {
        ["Name"] = "Luke",
        ["Age"] = 51,
    },
}
```

--------------------------------

### Improved database query error handling with error()

Source: https://luctus.at/wiki/glua/error_handling

This refactored example uses the error() function to report database query errors, including the specific error message and line number.

```lua
--[[...]]--
    local players = sql.Query("SELECT * FROM myplayers")
    if players == false then
        error(sql.LastError())
    end
--[[...]]--

```

--------------------------------

### Create SQL Table

Source: https://luctus.at/wiki/glua/about_sql

SQL statement to create a table if it does not already exist.

```sql
CREATE TABLE IF NOT EXISTS nicknames(steamid64 INT, nickname TEXT)
```

--------------------------------

### Draw a Dark Box Across Top of Screen

Source: https://luctus.at/wiki/glua/dynamic_hud

Use ScrW() and ScrH() to draw a box that covers half the screen height dynamically. This is a basic example of dynamic HUD element placement.

```lua
hook.Add("HUDPaint","luctus_test_dynamic",function()
    draw.RoundedBox(0, 0, 0, ScrW(), ScrH()/2, Color(0,0,0,255))
end)
```

--------------------------------

### Standard Table Networking with net.WriteTable

Source: https://luctus.at/wiki/networking/efficient_net_writetable

Use this method for basic table serialization and sending. It's straightforward but can be inefficient for large tables due to message size limitations.

```lua
if SERVER then
    util.AddNetworkString("tabletest")
    net.Receive("tabletest",function(len,ply)
        print("Message-Size:",len)
        local myTable = net.ReadTable()
    end)
else
    net.Start("tabletest")
        net.WriteTable(HUGE_TABLE)
    net.SendToServer()
end

```

--------------------------------

### Create a server-side dynamic /me command

Source: https://luctus.at/wiki/tutorial/8_example_chat

Uses the PlayerSay hook to intercept chat messages starting with /me and broadcast a formatted message to all players. Returning an empty string hides the original message.

```lua
hook.Add("PlayerSay","me_chat_command",function(ply,text,isTeam)
    if string.StartsWith(text,"/me ") then
        PrintMessage(HUD_PRINTTALK,ply:Nick().." "..string.sub(text,5))
        return ""
    end
end)
```

--------------------------------

### List All Entities

Source: https://luctus.at/wiki/general/about_entities

Output format of all entities currently present in the game world.

```lua
-- [1]  =   Entity [0][worldspawn]
-- [2]  =   Entity [4][player_manager]
-- [3]  =   Player [1][OverlordAkise]

```

--------------------------------

### Sanitize String Input for SQL Queries

Source: https://luctus.at/wiki/glua/about_sql

Always use `sql.SQLStr` to sanitize string inputs before including them in SQL queries to prevent malicious data injection. This example retrieves a player's SteamID64 based on their nickname.

```lua
local steamid64 = sql.QueryValue("SELECT steamid64 FROM nicknames WHERE nickname="..sql.SQLStr(ply:Nick()))
```

--------------------------------

### Timer scope demonstration

Source: https://luctus.at/wiki/tutorial/4_timer

Shows how timers retain access to local variables from the scope where they were defined.

```lua
name = "Chris"

function DelayPrint()
    local name = "Luke"
    timer.Simple(3,function()
        print("Hi, im "..name)
    end)
end

DelayPrint()

name = "Franz Kafka"
```

--------------------------------

### Ban Player on Network String Receive

Source: https://luctus.at/wiki/security/7_about_anticheats

This Lua code snippet registers a network string and bans any player who sends a message to it. It's an example of a basic anti-exploit that can be circumvented if the targeted network string isn't actually present.

```lua
util.AddNetworkString("SimplicityAC_aysent")
net.Receive("SimplicityAC_aysent",function(len,ply)
    ply:Ban(0,true)
end)

```

--------------------------------

### Get Player Job Name (Current)

Source: https://luctus.at/wiki/general/about_darkrp

Access the player's current, dynamic job name using the DarkRP variable `job` via `:getDarkRPVar("job")`. This method is recommended for custom or changing job names.

```lua
print(ply:getDarkRPVar("job"))
```
Tokens:
Raw