Skip to content

Latest commit

 

History

History
85 lines (69 loc) · 4.6 KB

README.md

File metadata and controls

85 lines (69 loc) · 4.6 KB

LamasTinyHUD

Platform GitHub release (latest by date) GitHub GitHub top language GitHub language count GitHub last commit GitHub Workflow Status

A small UI Element

What does it do

Allows you to bind Weapons, Shields, Spells, Shouts, Powers and Potions/Food to a Hotkey. In order to bind it to a Hotkey the Item needs to be favorited. Before every Execute, it is checked if the Item is still avaliable or in the Inventory.

Can be Bound

  • Potions/Food will be consumed on the Hotkey
  • Powers can be equipped or instant casted with the Hotkey. Instant casting will not replace an already slotted Power or Shout.
  • Shouts can only be equipped. Equip will be skipped if it is already slotted.
  • Spells, Weapons and Shields can be combined in one Hotkey and will always just be equipped, current equipped Items will be unequipped before.
  • Spells that do not need Concentration (=Button holding) can be instant casted, they do not have an animation currently. The Spell will just appear or shoot out of the hand it was set to (still it does not equip it). It is also possible just to equip them.

Currently can not be bound/set

  • Scrolls
  • Misc Items (e.g. Mods with Traps)

UI

  • The UI can be moved around with the MCM menu it will adjust after the Setting is closed.
  • The elements are drawn with ImGui and the used pngs are loaded at the game start, if other assets are used the scaling might need to be adjusted in the Settings.

Controller

  • Yes there is Controller support, in the MCM you can choose between PS/XBOX prompts

How is the Setting saved

  • It will be saved by the MCM Helper under MCM\Settings\LamasTinyHUD.ini
  • Generated examples

Settings and Checks

  • Only favourited will be shown in the Selections in the MCM.
  • After the Setting is done, they do not need to be favorited anymore.
  • Before, equipping, casting or consuming something, there is a check if the player has the item/spell.
  • If a consumable hits 0, it will not be removed. The plugin checks, the bound Item has been looted, bought or dropped.

Nexusmods

End User Dependencies

Build Dependencies

  • CommonLibSSE NG
  • spdlog
  • simpleini
  • stb (for file reading into dx11 texture)
  • imgui (for displaying ui elements)
  • vcpkg
    • Add the environment variable VCPKG_ROOT with the value as the path to the folder containing vcpkg
    • used commit hash 01b29f6d8212bc845da64773b18665d682f5ab66
  • cmake
    • installed dir needs to be added to the PATH environment variable
  • python
    • used for auto generating sourcelist and zip file after build

Icon Sets

Icon Set Folder License Count
Xelu_Free_Controller&Key_Prompts resources/key Creative Commons 0 (CC0) 117
Game-Icons or game-icons-github resources/icon CC BY 3.0 26
none resources/hud drawn by me 3

More info for Game-Icons

Building

git clone https://github.com/mlthelama/LamasTinyHUD.git
cd LamasTinyHUD

git submodule update --init --recursive
cmake --preset vs2022-windows
cmake --build --preset vs2022-windows