This is an addendum to the original tutorial series, concerning other things to consider for your mod that is not covered in previous articles, and outside the realm of actual mapping, modelling, programming, etc.

Other things you can customize

Custom music

Whereas WON GoldSrc spins up your physical CD drive looking for the soundtrack, they're included in the Steam version in the media/ folder, comprised of a bunch of mp3 files. Customizing these simply involve adding mp3 files of the same name in the same location in your mod. Consult the target_cdaudio page for the track number → filename mapping.

Custom GUI scheme – TrackerScheme.res

This file defines the UI scheme for GoldSrc's Steam UI, but you can have a custom one for your mod. Things such as UI colours, fonts for various elements, and borders, are defined here.

To customize your mod's UI scheme, copy the original from <Half-Life>/valve/resource/TrackerScheme.res (updated for HL25) or <Half-Life>/platform/resource/TrackerScheme.res (not updated for HL25) into <Half-Life>/<your_mod_here>/resource/TrackerScheme.res.

The following block, for example, defines the font properties for the game menu.

"MenuLarge"
{
    "1"
    {
        "name"      "Verdana"
        "tall"      "18" // increase this to make menu items larger
        "weight"    "1000"
        "antialias" "0"  // set to 1 to enable anti-aliasing (why wouldn't you want anti-aliased texts?)
    }
}

And the following block defines its colours and metrics:

InGameDesktop
{
    "MenuColor"              "200 200 200 255"
    "ArmedMenuColor"         "255 255 255 255"
    "DepressedMenuColor"     "192 186 80 255"
    "WidescreenBarColor"     "0 0 0 0"
    "MenuItemVisibilityRate" "0.03"  // time it takes for one menu item to appear
    "MenuItemHeight"         "28"   // should be larger than the font size
    "GameMenuInset"          "32"
}

The following block allows you to add custom fonts that doesn't require the players to install into their OS (and of course, you need to ship the .ttf files along). If you do not see this block in the file, add them towards the end of the file (before the final closing bracket }).

//////////////////////// CUSTOM FONT FILES /////////////////////////////
//
// specifies all the custom (non-system) font files that need to be loaded to service the above described fonts
CustomFontFiles
{
    "4"     "resource/linux_fonts/DejaVuSans.ttf"
    "5"     "resource/linux_fonts/DejaVuSans-Bold.ttf"
    "6"     "resource/linux_fonts/DejaVuSans-BoldOblique.ttf"
    "7"     "resource/linux_fonts/DejaVuSans-Oblique.ttf"
    "8"     "resource/linux_fonts/LiberationSans-Regular.ttf"
    "9"     "resource/linux_fonts/LiberationSans-Bold.ttf"
    "10"    "resource/linux_fonts/LiberationMono-Regular.ttf"
    "11"    "resource/linux_fonts/FiraSans-Regular.ttf"
    "12"    "resource/linux_fonts/FiraSans-Medium.ttf"
    // additional fonts go under this line. examples:
    "13"    "resource/SuperMystery.ttf"     // Super Mystery
    "14"    "resource/Growl_rounded.ttf"    // Growl_rounded
}

autoexec.cfg

This file is executed at some point in the game initialization, and is a way to have a default command list that is not managed by the game (config.cfg gets overwritten by the game when cvars and keybinds change.)

A common use case for autoexec.cfg is to ensure a certain set of CVARs are set as default. For example, if a mod's art style demands the unfiltered pixelated textures look, it can define gl_texturemode with the appropriate value.

Another use case for autoexec.cfg is to define aliases, which is not possible with config.cfg. These are strings of commands you can execute in a single command, and bindable to keys. Aliases prefixed with + or - work as a pair, and used for keybinds (the + alias is executed on key down, the - one on key up). You can use this, and some script-fu, to have, for example, the Ctrl key toggle ducking, or a "bullet time" key.

skill.cfg

This file manages the skill system, defining NPC's health, ammo pickup, and damage dealt. Although it is strongly advised against editing these, it is one way of mod​ifying the balancing of a mod without diving into code.

"LOADING" and "PAUSED" graphics, etc. – gfx.wad and cached.wad

See also: Tutorial: Creating textures with Qlumpy



These two text popups that appear in the center of the screen when transitioning between levels and paused respectively are not actual texts, rather they are actually still graphics that reside in gfx.wad. They use the non-texture qpic type which isn't widely supported by wad editors. Building WAD files containing non-texture image types like the aforementioned typically require the use of the original qlumpy.exe tool (available in Steam's HL SDK) that uses LS script files. But for gfx.wad specifically there fortunately exists a tool called GfxWad.exe (download link) that lets you recreate gfx.wad whilst retaining full compatibility with WON GoldSource which still uses the font sheet contained within gfx.wad.

For the old WON version, cached.wad contains the loading screen (which slides up the screen when it finishes loading). There's also the background screen for the Quake-style console which drops down half the screen length. You can find sources and tools (qlumpy) for this file here (same link as above).

loading conback (console background)

A Mod, or an Addon Pack? The <game>_addon folder

Post-SteamPipe GoldSrc supports the [over]loading of files without overwriting the base file through the <game>_addon folder. This is also the case for HD and server-downloaded content via the _hd and _downloads suffixes.

Thus, some circumstances where separate mods were required before, might now be a simple drop-in into the valve_addon folder, without the risk of permanently corrupting your game. To disambiguate, lets call the _addon folder use case as an Addon Pack instead of a Mod.

Is my content a Mod or an Addon Pack?
Your content might fit the case of being an Addon Pack if:

• They are multiplayer maps.
• They are edits, additions, or upgrades to another base game/mod such as new background, custom models, etc.
• It's a short mission pack (but can still be considered a mod as otherwise people can't access your maps without typing in the console.)
• It's basically Half-Life but with a gimmick that doesn't involve custom maps.
• People might want to mix and match your content with other people's content.

On the other hand, you must distribute as a Mod if:

• You have custom server/client code.
• Your content is entirely self-contained.

So, what changed?
An addon pack installs differently to a mod. Firstly you don't need the liblist.gam just to add, say, custom models to Half-Life. Secondly, players can mix and match other things in their games, and they can toggle them on or off (details below), or otherwise jump between vanilla and modded setup quickly.

Other things about addons
To toggle the loading of this folder:

• Pre-Anniversary branch: Options > Video > Enable custom content
• 25th Anniversary branch: Options > Content > Allow custom addon content

The addon system also works for mods! You can, for example, have addons for Poke646 populating the poke646_addon folder, and toggle them on and off.

The kitchen sink approach of this system is not great (compared to HL2's custom/ folder) but it beats needing to surgically remove files, or reinstalling whole mods and losing saves due to corrupted modifications.

Distributing your mod/addon pack

You have your mod (or an addon pack). You want others to play them. You need to send these files to them. This raises a question: how, where, and which files?

What to [not] include

Firstly, it depends on whether you're distributing your content as a mod or an addon pack. For a general release, you wouldn't want to include the working files or file sources (e.g. the PSDs for the textures, or the source code*); only the end products needed for the game engine would suffice. These would be the files with extensions that includes but isn't limited to: bsp, wad, res, mdl, wav, spr, tga, txt, mp3. Use a RES generator to double check that you didn't miss anything. If using a number of large WADs, consider extracting used textures and place them in a single WAD file that you reference in the maps to cut down on size.

A useful workflow to have is a mod folder for development (e.g. mymod_DEV), a separate folder for finalized mod files (e.g. mymod), and a script that copies over only relevant file formats from the former to the latter.

For a full source release that includes file sources, consider putting your mod files in an online Git repository instead.

TL;DR:

• ADD the sum of everything a resgen program reports to you, for every map
• SUBTRACT from the list files that comes with Half-Life or the base game/mod
• ADD liblist.gam (for mods only) and other modified game files

And as always, give credit to the authors whose content you used in your mod.

Packing the files

The best practice is to pack the files into a ZIP archive, as most OSes natively support it. 7z is also a popular format that achieves better compression for larger mods.

Installation

To help would-be players, include a readme file in the archive directing them to extract the archive into the correct installation folder. Also provide them information to verify what a correct installation looks like.

Hosting the files

There are several places on the Internet that can host your mod/addon files, including:

• ModDB
• GameBanana
• TWHL Vault (this site!)
• SCMapDB (Sven-Coop)

Some of these sites require you to fill a form, so have these information figured out in advance:

• General description and summary
• Installation directions
• Tools used
• Credits
• Licensing

which brings us to...

Licensing

Note: this is not legal advice. IANAL.

It's the last thing on your mind when you're in the zone. You might assume it'd be one of "here's the files, do whatever" or "credit me if you do stuff with it" and you'll be correct, but the platforms you distribute your mod under has other assumptions, and you may not want to go with the default.

The website https://choosealicense.com/ can help you decide which license you want to distribute your mod under. Then, select the appropriate license type on the hosting website's upload form.

A few pointers:

• GameBanana defaults to Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0). The "NoDerivatives" clause may not be what you want if you're putting out things like prefabs; in general preventing others from having their own take on your stuff and sharing it legally.
  • Use GameBanana's custom license checklist. It presents you with a checklist of what you want to allow.
• TWHL defaults to "All rights reserved." Use any other license, unless you're absolutely sure you want to keep it a sealed box.

*Some licenses might obligate you include source files; for others, a link to a source repository (e.g. GitHub) would be satisfactory. Read the terms of the license you end up using.
**GPL licenses are NOT compatible with Half-Life SDK license.

In The End

Hopefully the series has been helpful in assembling and getting your stuff out into the world, for other people to enjoy.