https://github.com/JarateKing/TF2-Hud-Reference#readme
Some of the hud illuminati noticed that a lot of old hud tutorials were out of date, no longer being contributed to, and impossible for anyone else to add to. A lot of advanced techniques were developed in the past few years too, some never being written about at all, let alone being included in a tutorial. And certain resources, like mana's base hud git repo or doodle's file list, haven't been up to date in years. So for the past few months some of us have been working on a new hud tutorial to fix those issues.
This features:
- A tutorial to teach the basics of hud editing, that should be enough to get someone started.
- An appendix of extra info, technical elaborations, and advanced techniques that can be helpful even to experienced hud developers.
- A list of all hud files present in the default hud, with a quick description for most.
- A list of all hud animations present in the default hud, with a quick description for some.
- A reference copy of the default hud.
In addition, this hud tutorial is:
- Open to contributions from others: pull requests welcome.
- Easily updatable through scripts: when an update happens, both the reference hud and the file list can be updated with a single click each.
- Continuously being worked on: it's in a state where it can be public, but it's a WIP that has sections continuously being added or modified.
Links:
Tutorial
Appendix
File list
Animation list
Base hud reference
If you find any issue or something to contribute, either message me, create an issue on github, or fork the repo and make a pull request.
https://github.com/JarateKing/TF2-Hud-Reference#readme
Some of the hud illuminati noticed that a lot of old hud tutorials were out of date, no longer being contributed to, and impossible for anyone else to add to. A lot of advanced techniques were developed in the past few years too, some never being written about at all, let alone being included in a tutorial. And certain resources, like mana's base hud git repo or doodle's file list, haven't been up to date in years. So for the past few months some of us have been working on a new hud tutorial to fix those issues.
This features:[list]
[*] A tutorial to teach the basics of hud editing, that should be enough to get someone started.
[*] An appendix of extra info, technical elaborations, and advanced techniques that can be helpful even to experienced hud developers.
[*] A list of all hud files present in the default hud, with a quick description for most.
[*] A list of all hud animations present in the default hud, with a quick description for some.
[*] A reference copy of the default hud.
[/list]
In addition, this hud tutorial is:[list]
[*] Open to contributions from others: pull requests welcome.
[*] Easily updatable through scripts: when an update happens, both the reference hud and the file list can be updated with a single click each.
[*] Continuously being worked on: it's in a state where it can be public, but it's a WIP that has sections continuously being added or modified.
[/list]
Links:
[url=https://github.com/JarateKing/TF2-Hud-Reference#tutorial-section]Tutorial[/url]
[url=https://github.com/JarateKing/TF2-Hud-Reference#appendix]Appendix[/url]
[url=https://github.com/JarateKing/TF2-Hud-Reference/blob/master/2-LISTS/Filelist.md]File list[/url]
[url=https://github.com/JarateKing/TF2-Hud-Reference/blob/master/2-LISTS/Animlist.md]Animation list[/url]
[url=https://github.com/JarateKing/TF2-Hud-Reference/tree/master/reference]Base hud reference[/url]
If you find any issue or something to contribute, either message me, create an issue on github, or fork the repo and make a pull request.
Very useful looking from my skimming over. Found out some stuff I didn't even completely understand like the intricacies of refracts. It's been a long time since a guide this comprehensive has been accurate.
Very useful looking from my skimming over. Found out some stuff I didn't even completely understand like the intricacies of refracts. It's been a long time since a guide this comprehensive has been accurate.
It is a shame the wiki section on GitHub can't be used for documentation/help purposes in this case.
At least now you can accept pull requests for the Appendix or Tutorial sections with suggestions.
Time to add some more hud dev info, tips & tricks!
It is a shame the wiki section on GitHub can't be used for documentation/help purposes in this case.
At least now you can accept pull requests for the Appendix or Tutorial sections with suggestions.
Time to add some more hud dev info, tips & tricks!
I don't want to bump this thread every time I make a change (because I do pretty frequently) but I did add something worth updating about: a stat list that contains the amount of times stuff like minmode, #base, if_mvm, etc. appear in every hud file. It should hopefully make it a bit easier for hud devs to search for any file that's affected by these, without having to check every file. Currently it just goes over those three mentioned, but it's not too hard to change the script that generates it if anyone has any requests.
And mods, thanks for the pin!
tsarVery useful looking from my skimming over. Found out some stuff I didn't even completely understand like the intricacies of refracts. It's been a long time since a guide this comprehensive has been accurate.
Yeah, something I noticed with refracts was that nearly everyone treated them as magic that just happens to do a few seemingly unrelated things. They're not very intuitive and I wouldn't expect anyone to figure out how they work just by looking at them, but once you know what a refract actually is, all the ways they're useful make a lot of sense.
In other words it's the exact type of thing a tutorial should cover. A lot of tutorials were written before refracts were even a thing, but still, I thought there should be a tutorial for advanced techniques like that.
WiethoofdIt is a shame the wiki section on GitHub can't be used for documentation/help purposes in this case.
It would've been nice to get to use all the goodies the wiki section gives you, but it only really works well for documentation about a project and not so much a tutorial where the documentation actually is the project. I do have some plans for how to make it a bit nicer to navigate though, so hopefully it shouldn't be a problem.
WiethoofdTime to add some more hud dev info, tips & tricks!
Thank you for your contribution! Always good to see people working on this.
I don't want to bump this thread every time I make a change (because I do pretty frequently) but I did add something worth updating about: a [url=https://github.com/JarateKing/TF2-Hud-Reference/blob/master/2-LISTS/Statlist.md]stat list[/url] that contains the amount of times stuff like minmode, #base, if_mvm, etc. appear in every hud file. It should hopefully make it a bit easier for hud devs to search for any file that's affected by these, without having to check every file. Currently it just goes over those three mentioned, but it's not too hard to change the script that generates it if anyone has any requests.
And mods, thanks for the pin!
[quote=tsar]Very useful looking from my skimming over. Found out some stuff I didn't even completely understand like the intricacies of refracts. It's been a long time since a guide this comprehensive has been accurate.[/quote]
Yeah, something I noticed with refracts was that nearly everyone treated them as magic that just happens to do a few seemingly unrelated things. They're not very intuitive and I wouldn't expect anyone to figure out how they work just by looking at them, but once you know what a refract actually is, all the ways they're useful make a lot of sense.
In other words it's the exact type of thing a tutorial should cover. A lot of tutorials were written before refracts were even a thing, but still, I thought there should be a tutorial for advanced techniques like that.
[quote=Wiethoofd]It is a shame the wiki section on GitHub can't be used for documentation/help purposes in this case.[/quote]
It would've been nice to get to use all the goodies the wiki section gives you, but it only really works well for documentation about a project and not so much a tutorial where the documentation actually is the project. I do have some plans for how to make it a bit nicer to navigate though, so hopefully it shouldn't be a problem.[quote=Wiethoofd]Time to add some more hud dev info, tips & tricks![/quote]
Thank you for your contribution! Always good to see people working on this.