Horde Gamemode

Workshop Link

https://steamcommunity.com/sharedfiles/filedetails/?id=2401598805

Full Console Command List

Client:

• horde_shop: Console variant for !shop.
• horde_ready: Console variant for !ready.
• horde_drop_weapon: Console variant for !drop.
• horde_drop_money: Console variant for !throwmoney.
• horde_item_config: Console variant for !itemconfig.
• horde_enemy_config: Console variant for !enemyconfig.
• horde_class_config: Console variant for !classconfig.
• horde_start: Console variant for !start.
• horde_enable_halo(0/1): Enable highlight for last 10 enemies. 1 by default.

Server:

You need to change these BEFORE your game/server starts to take effect.

Config settings

• horde_default_enemy_config(0/1) - Use default enemy wave config settings. 1 by default.
• horde_default_item_config(0/1) - Use default item config settings. 1 by default.
• horde_default_class_config(0/1) - Use default class config settings. 1 by default.
• horde_external_lua_config("") - Name of the lua config file to use. Leave this empty if you do not have one.

Game Settings

• horde_difficulty(0/1/2) - Difficulty. Normal, hard, realism. 0 by default.
• horde_endless(0/1) - Enable endless. 0 by default.
• horde_enable_sandbox(0/1) - Enable sandbox/cheat features or not. 0 by default.
• horde_max_wave(1-10) - Max waves. 10 by default.
• horde_break_time(10-60) - Break time between waves. 60 by default.
• horde_start_money - Money given at start. 1000 by default.
• horde_base_player_walkspeed - Base walkspeed. 180 by default.
• horde_base_player_runspeed - Base runspeed. 220 by default.
• horde_total_enemies_scaling - Forces the gamemode to multiply maximum enemy count by this. You can only INCREASE the number of enemies. 0 by default (disabled).
• horde_disable_difficulty_voting(0/1) - Disable difficulty voting. 0 by default.
• horde_enable_ammobox(0/1) - Enable ammobox respawns or not. 1 by default.
• horde_arccw_attinv_free(0/1) - Enables free ArcCW attachments or not. 1 by default.

UI Settings

• horde_enable_scoreboard(0/1) - Enables built-in scoreboard. 1 by default.
• horde_enable_shop(0/1) - Enables shop menu or not. 1 by default.
• horde_enable_client_gui(0/1) - Enables client information ui or not. 1 by default.
• horde_enable_3d2d_icon(0/1) - Enables class 3D class icon renders or not. 1 by default.

Optimization Settings

• horde_npc_cleanup(0/1) - Kills all NPCs after a wave. 1 by default.
• horde_corpse_cleanup(0/1) - Enable corpse removal or not. 0 by default. On 1, enemy corpses despawn immediately.

Spawn Settings

• horde_max_spawn_distance - Maximum enemy respawn distance. 2000 by default.

• horde_min_spawn_distance - Minimum enemy respawn distance. 400 by default.

• horde_max_spawn_z_distance - Maximum enemy respawn height difference from players. 500 by default. If your map is huge and enemies spawn in extreme positions, turn this smaller.

• horde_director_interval(>0, <10) - How often the game director checks the state of the game (e.g. spawns stuff) in seconds. Default is 5.

True maximum number of enemies alive = Minimum of (Max, Base + Scale Factor * PlayerCount)

• horde_max_enemies_alive_base - Base. Default is 20.
• horde_max_enemies_alive_scale_factor - Scale factor. Default is 5.
• horde_max_enemies_alive_max - Max. Default is 50.

Voting Settings

• horde_ready_countdown_ratio(0-1) - Ratio of players required to start the game (0-1).

Creating Config Addons

Besides the client-side GUI configs, you can create lua config addons! This allows you to create multiple configurations easily. Note that class descriptions changes are not available yet in external lua configs, because they may be subject to huge changes.

You config addons should stay in garrysmod/addons/your-config/lua/horde/gamemode/custom, and have the following (example) format:

-- Example your-custom-config.lua
-- If you just want to configure items, leave enemies as empty. Vice versa.

CONFIG = {}
CONFIG.name = "custom_config" -- YOU MUST NAME IT! Used for horde_external_lua_config.
CONFIG.items = {
    -- key and class must be the same!
    -- Weapon Entity Example:
    weapon_crowbar = {
        class="weapon_crowbar",
        category="Melee", -- You can find out the full list in !itemconfig
        name="Cheap Crowbar",
        price=50, weight=1,
        description="A cheap crowbar",
        whitelist = {Medic=true, Assault=true, Heavy=true, Demolition=true, Survivor=true, Ghost=true},
        ammo_price=0,           -- Leave it as 0 if it does not have primary ammo
        secondary_ammo_price=-1, -- Leave it as -1 if it does not have secondary ammo
        entity_properties={type=1} -- Weapon Entity type is 1.
    },
    -- Give Entity Example
    item_healthvial = {
        class="item_healthvial",
        category="Special", -- You can find out the full list in !itemconfig
        name="Health Vial",
        price=50, weight=0,
        description="Heals you",
        whitelist = {Medic=true, Assault=true, Heavy=true, Demolition=true, Survivor=true, Ghost=true},
        ammo_price=0,           -- Does not matter for entities
        secondary_ammo_price=-1, -- Does not matter for entities
        entity_properties={type=2} -- Give Entity type is 2.
    },
    -- Drop Entity Example
    item_healthvial = {
        class="item_healthvial",
        category="Equipment", -- You can find out the full list in !itemconfig
        name="Health Vial",
        price=50, weight=0,
        description="Drops onto the ground when purchased.",
        whitelist = {Medic=true, Assault=true, Heavy=true, Demolition=true, Survivor=true, Ghost=true},
        ammo_price=0,           -- Does not matter for entities
        secondary_ammo_price=-1, -- Does not matter for entities
        entity_properties={type=3, x=50, z=15, yaw=0, limit=5} -- Drop Entity type is 3.
    }
}

CONFIG.enemies = {
    -- key and name must be the same!
    -- Since key has to be unique, you can use npc name + wave for the key.
    HugeZombie1 = {
        name = "HugeZombie1",
        class = "npc_zombie",
        weight = 1, -- Relative weight to other enemies in the same wave.
        wave = 1,
        is_elite = true,
        health_scale = 2,
        damage_scale = 1,
        reward_scale = 100,
        model_scale = 2,
        color = Color(0,255,0),
        weapon = ""
    },
    HugeCombine1 = {
        name = "HugeCombine1",
        class = "npc_combine_s",
        weight = 1, -- Relative weight to other enemies in the same wave.
        wave = 1,
        is_elite = true,
        health_scale = 2,
        damage_scale = 1,
        reward_scale = 100,
        model_scale = 2,
        color = Color(255,0,0),
        weapon = ""
    },
    RaidBoss = {
        name = "RaidBoss",
        class = "npc_combine_s",
        weight = 1, -- Relative weight to other enemies in the same wave.
        wave = 2,
        is_elite = true,
        health_scale = 2,
        damage_scale = 1,
        reward_scale = 100,
        model_scale = 2,
        color = Color(255,0,0),
        weapon = "",
        spawn_limit = nil, -- optional
        boss_properties = {is_boss=true, end_wave=true, unlimited_enemies_spawn=true, enemies_spawn_threshold=0.5, music="music/hl1_song24.mp3", music_duration=105} -- optional, boss settings
    }
}

To use your config, simply set horde_external_lua_config to the name you used for the config (CONFIG.name). You can also do that directly in the gmod start menu.

Dedicated Server Instructions

Default Config

You don't need to add anything extra! Just make sure you set gamemode to horde.

Custom Config

As you might already know there are two ways of setting up custom configs:

1. Client UI. To use this on a dedicated server, you need to put

horde_default_item_config = 0
horde_default_enemy_config = 0

In autoexec.cfg and server.cfg. Then you can edit stuff in your shop. A quick way to setup the config is just to put your item.txt or enemy.txt into your server's data folder.

2. Lua Scripting, as shown above. Your autoexec.cfg and server.cfg should then look like

-- These two don't matter
-- horde_default_item_config = 0
-- horde_default_enemy_config = 0

horde_external_lua_config "custom-config"