hud.txt and weapon_*.txt Last edited 4 months ago2023-11-26 14:06:10 UTC

The files hud.txt as well as weapon_*.txt, located in the sprites/ folder of a game/mod, tells the GoldSrc engine how to load sprites for the HUD as well as the weapons.

Syntax

The file is formatted as follows:

<num_of_entries>
<entry1>
<entry2>
⁞
<entryN>

Where an entry is formatted as follows:

<object> <resolution> <filename> <offset_x> <offset_y> <size_w> <size_h>

Description of each field of an entry is as follows:

#	Field	Description
1	<object>	Identifies the sprite's role.
2	<resolution>	The base resolution (320 or 640), it will use 320 on resolutions lower than 640x480 and 640 on that resolution and higher.
		Half-Life's 25th Anniversary Update adds two more base resolutions: 1280 and 2560.
3	<filename>	The SPR file to load.
4	<offset_x>	The offset of this sprite object into the SPR file in the horizontal X axis.
5	<offset_y>	The offset of this sprite object into the SPR file in the vertical Y axis.
6	<size_w>	The width of the sprite object.
7	<size_h>	The height of the sprite object.

Remarks

• Comments start with the double slash (//). You can put a comment at the start of a line, or at the end of a full sprite entry. Do not comment out a part of a sprite entry and leave it incomplete.
• A sprite entry is 1 line. You cannot split it across multiple lines.
• Each field in the sprite entry is separated by one or more whitespace. A whitespace means any of a space or tab character. Please use only one type to separate a field (i.e. not mixing tabs and spaces together).
• Make sure a sprite object's entry fits in the referenced SPR file, i.e. offset_x + size_w <= sprfile_w and offset_y + size_h <= sprfile_h.
• Also make sure the sprite entry has the same number of fields as shown in the table (7), and placed in the correct order.
• An empty line, or a line comment, does not count towards num_of_entries.

References

• https://twhl.info/thread/locate-post/329508 - Sprite entry description by Shepard62700FR