Hud sobpak12

README

Essobie's sobpak12
Russell "Essobie" O'Henly
essobie@planetquake.com


Terms of Use
============
By unzipping the contents of the zip file you downloaded from our page into your WolfET/etf directory, you agree to not hold me liable for any damages these graphic alterations cause you, your computer system, or any children you may parent in the future.


Descriptions:
=============
Default
-------
This the preferred version of the SOBPak12 HUD used by Essobie (the creator of the HUD). This version of the HUD will function with all things shown without having to alter any lines in sobhud.cfg, but lacks the customizability of the "Customizable" variation of this HUD. Included in this HUD are:

- Weapon icon
- Clip Counter
  - For weapons that need reloading, the value is the number of shots you have remaining in that clip alone.
  - For weapons that do not need reloading, the value is the number of total shots you have left.
- Engineer Specific
  - The counter for the Engineer's Wrench shows the number of Cells available (which is what is used for building Sentries).
  - Sentry Gun Camera Display with Health, Rockets and Shells.
  - Sentry Gun Health Display near crosshair.
- Extra Wide health and armor bars.
- Inlarged timelimit.
- Minimalistic scoreboard and team color highlight.
- Grenadier detpipe status (shows yours and your team's available pipes).
- Sharp green dot "static crosshair" with black background.*

*This crosshair does not move when concussed. See Static Crosshair Help for more information.


Customizable
------------
This is the same HUD as Default with the exception that the following elements in the HUD that can be altered via console commands. All of these settings can be found in your ETF folder in a file called "sobhud.cfg" and simply executed from the console (or your autoexec.cfg file).

- Engineer Cell Count Always Center Screen: Cvar: sobhud_cellcount
  0 = Disabled
  1 = Enabled

- Chat Area Backgrounds. Cvar: sobhud_chatbg
  0 = No background
  1 = Translucent Black Background

- Sharp dot "static crosshair" can be disabled or given a custom color*. Cvar: sobhud_crosshair
  0 = Disabled
  1 = White
  2 = Green (same as Default)
  3 = Cyan
  4 = Magenta
  5 = Yellow
  6 = Blue
  7 = Red

*This crosshair does not move when concussed. See Static Crosshair Help for more information.

- Healthbar Variations. Cvar: sobhud_healthbar
  0 = Numbers Only (with Health and Armor Icons)
  1 = Short
  2 = Long and Skinny
  3 = Long and Fat (same as Default)

- Sentry Health Status under Crosshair. Cvar: sobhud_sentrystatus
  0 = Disabled
  1 = Enabled

- Types of Weapon Status Shown. Cvar: sobhud_weapons
  Add up all desired options together for the value of sobhud_weapons (Example: for Crosshair Status, Crosshair Status Background, and Class Specific, add up 1, 2 and 8 for a total of 11)
  0 = None
  1 = Crosshair Ammo Counter (Number Only)
  2 = Crosshair Ammo Counter Background
  4 = Botton Center Ammo Counter
  8 = Class Specific Primary Ammo Counter


Installation Instructions:
==========================
1) Unrar the contents of this rar file into your "etf" folder.

2) Join a server that either has this pak installed, is running with "Pure Server" turned off (sv_pure 0), or start your own local game.
   
3) Edit the sobhud.cfg file in your ETF folder to choose the type of HUD options you'd like to use if you are going to use the Customizable HUD. WARNING!!! If you do not execute this file and use the Customizable HUD, you will NOT see important things on your HUD such as HEALTH and ARMOR and CURRENT WEAPONS and CHAT MESSAGES. If you are not comfortable with editing .cfg files or mucking around in the console, use the Default HUD.

4) Start up ETF.

5) Go into the Options for ETF and pick "Choose a HUD".

6) Scroll down to "sobpak12" and select it.

7) Choose either the Default (recommended) or Customizable (see instructions above on how to use this HUD correctly) and hit "Apply".

8) Now join any server you want, pure or otherwise.


Static Crosshair Help
=====================

If you are going to use the Static Crosshair included in this HUD, I recommend using a regular in game crosshair at the same time to let you know when you are concussed by those pesky Recons and Paramedics. Put the following lines in your configuration for an elegant choice:

set cg_drawCrosshair 4          // Draws the existing crosshair that features a dot and a halo around it
set cg_crosshairSize 64         // Makes existing crosshair 64 screenunits tall/wide
set cg_crosshairAlpha 1         // Makes halo section of crosshair fully opaque (although this particular crosshair it's more like 50%
set cg_crosshairAlphaAlt 0      // Makes dot section of crosshair fully transparent (you don't need it as the sobhud_crosshair will replace it)
set cg_crosshairColor white     // Makes the halo white



sobhud.cfg File
===============
In order to make using the Customizable HUD easier for the end user, a file called "sobhud.cfg" has been included and should be in your ETF folder if you have installed this HUD correctly. By simply editing that file with the values you want and executing it from the console manually (or through your autoexec.cfg), the Customizable HUD will come to life!

The following commands are in the sobhud.cfg file, but are listed here if you happen to want to change them on the fly:

set sobhud_cellcount 1          // Shows Magenta Cell Count for Engineer Class: 0=Disabled, 1=Enabled
set sobhud_chatbg 1             // Enables Background Box over Chat Areas
set sobhud_crosshair 2          // 0=Off 1=White 2=Green 3=Cyan 4=Magenta 5=Yellow 6=Blue 7=Red
set sobhud_healthbar 3          // Healthbar Variations: 0=Numbers Only, 1=Short, 2=Long and Skinny, 3=Long and Fat
set sobhud_sentrystatus 1       // Enables Crosshair Sentry Health Status: 1=On, 0=Off
set sobhud_velocity 1           // Velocity Meter Location: 0=Disabled, 1=Top Left, 2=Big in the Middle, 3=Top Right
set sobhud_weapons 11           // Location of Weapon Status: See Readme for Explaination



Any Questions? Comments? Requests? Feel free to drop me a line.
                    essobie@planetquake.com