diff --git a/conf.py b/conf.py index d07aab6..1bc7de7 100644 --- a/conf.py +++ b/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'ET: Legacy' -copyright = '2012-2020, ET: Legacy Team' +copyright = '2012-2023, ET: Legacy Team' author = 'ET: Legacy Team' # The full version, including alpha/beta/rc tags diff --git a/hudeditor.rst b/hudeditor.rst new file mode 100644 index 0000000..63dfef3 --- /dev/null +++ b/hudeditor.rst @@ -0,0 +1,141 @@ +=================== +HUD Editor +=================== + +Introduction +^^^^^^^^^^^^ +Since the 2.81.0, ET:Legacy introduced a new way to fully customize all HUD components by using the in-game editor and using the extended json hud file. + +50 components are currently customizable, + +In-game editor +^^^^^^^^^^^^^^ +Overview +"""""""" + +The in-game editor is reachable by using the menu UI ``Menu`` -> ``Options`` -> ``View`` -> ``HUD Editor`` or by typing in console the edithud command. + +**Note**: The HUD editor is not available from main menu. + +HUD view window +""""""""""""""" + +Components selection panel +"""""""""""""""""""""""""" + +Parameters customization panel +"""""""""""""""""""""""""""""" + +Usage +""""" + +New hud.dat json file +^^^^^^^^^^^^^^^^^^^^^ + +Overview +"""""""" + +Usage +""""" + +Annexe +^^^^^^ + +Components list +""""""""""""""" + +:: + + crosshair + compass + staminabar + breathbar + healthbar + weaponchargebar + healthtext + xptext + ranktext + statsdisplay + weaponicon + weaponammo + fireteam + popupmessages + powerups + objectives + hudhead + cursorhints + weaponstability + livesleft + roundtimer + reinforcement + spawntimer + localtime + votetext + spectatortext + limbotext + followtext + demotext + missilecamera + sprinttext + breathtext + weaponchargetext) + fps + snapshot + ping + speed + lagometer + disconnect + chat + spectatorstatus + pmitemsbig + warmuptitle + warmuptext + objectivetext + centerprint + banner + crosshairtext + crosshairbar + stats + +Parameters list +""""""""""""""" + ++--------------------+-----------------------------------------+--------------------------------------+ +| Parameter | Description | Range | ++====================+=========================================+======================================+ +| X | X coordinate | | ++--------------------+-----------------------------------------+--------------------------------------+ +| W | Component Width | | ++--------------------+-----------------------------------------+--------------------------------------+ +| H | Component Height | | ++--------------------+-----------------------------------------+--------------------------------------+ +| visible | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| style | | See Style Section | ++--------------------+-----------------------------------------+--------------------------------------+ +| scale | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| ColorMain | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| colorSecondary | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| showBackGround | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| colorBackground | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| showBorder | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| colorBorder | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| styleText | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| alignText | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| autoAdjust | | | ++--------------------+-----------------------------------------+--------------------------------------+ +| styleText | | | ++--------------------+-----------------------------------------+--------------------------------------+ + + +Component Style +""""""""""""""" \ No newline at end of file diff --git a/index.rst b/index.rst index d512b91..09b35c3 100644 --- a/index.rst +++ b/index.rst @@ -30,3 +30,4 @@ There are two aspects to this project: vsays resources skillrating + hudeditor