Installation - rbjaxter/budhud GitHub Wiki

Installation of the hud remains the same regardless of what you intend on using (stream/players hud, etc).

Video Guide

Here's a video explaining how to install the HUD (Updated November 11th, 2023): Video Explanation And here is the old video explanation (January 1st, 2021)

Download

Click this link to find the latest release.

Other places you can download it:

Installation (TL;DR)

  1. Find your TF2 install location
    • The fastest way is to open Steam -> Select Games -> View Games Library -> right click Team Fortress 2 -> Properties... -> Under Installed Files, click Browse...
  2. Navigate to ..steamapps/common/Team Fortress 2/tf/custom
    • If you don't have a custom folder, create it
    • Ensure you don't have any other huds installed, as these may cause issues
  3. Download the latest release
    • You just need the first zipped file (typically called budhud.zip), not any of the "source" files
  4. Extract the zipped file into your ..steamapps/common/Team Fortress 2/tf/custom folder
    • You can use Windows' built in extraction (right click > Extract All...) or a program like 7-Zip
    • Ensure you don't have two folders within each other (see below)

Important

The path to the HUD should be ../tf/custom/budhud-master, NOT ../tf/custom/budhud-master/budhud-master.

TF2 looks inside ../tf/custom/<your_hud_name> for resource and scripts. If it does not find those there, it will fail.

This is the most common mistake people make when installing a hud.

Installation

Note

This guide refers to the zipped file/folder as being called budhud-master, but please just be aware it could be called budhud or something else depending on where you download it from.

  1. Ensure that you have a custom folder in your TF2 directory. The default Team Fortress 2 directory is located in C:/Program Files (x86)/Steam/steamapps/common/Team Fortress 2/tf/. If you do not have a custom folder in this directory, create one.
    • For linux, this path is located at: ~/.steam/steam/steamapps/common/Team Fortress 2/tf/custom/

The easiest way to find your Team Fortress 2 directory is through Steam.

1. Open up Steam
2. Click on `LIBRARY`
3. Right click `Team Fortress 2` and click on `Properties...`
4. Navigate to the `Installed Files` tab on the left
5. Next to "Size of installation:", click `Browse...`

File Explorer

  1. Extract the hud with your preferred extraction program (I personally use 7zip). Once extracted, you should have a folder called budhud-master.

Tip

If you're on Windows and don't have an extraction program already, you can also right click on the compressed zip folder -> select "Extract all..."

  1. Move budhud-master into your custom folder.

Your file directory should now look similar to this picture: File Directory

Important

The installation path for any TF2 HUD is ..\tf\custom\<HUD_NAME>\<HUD_FILES>, where <HUD_FILES> are the typical folders/files you would see in a hud:

  • cfg*
  • materials*
  • resource
  • scripts
  • sound*
  • info.vdf REQUIRED

*HUDs may not always have all of these folders

Having these files/folders anywhere else (such as within a nested folder like ..\tf\custom\budhud-master\budhud-master) will result in the hud not working.

For budhud:

  • Incorrect: ..\tf\custom\budhud-master\budhud-master
  • Incorrect: ..\tf\custom\_budhud
  • Correct: ..\tf\custom\budhud-master

Troubleshooting

Check out HUD Troubleshooting.

Required Files

99% of people do not need to worry about this, but here is a breakdown of what files are required and which are not if you really want to remove unneeded files/folders: File Directory Breakdown


⚠️ **GitHub.com Fallback** ⚠️