etlegacy/etlegacy-docs
0
0
Fork 0
mirror of https://github.com/etlegacy/etlegacy-docs.git synced 2025-02-07 15:31:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

converted wiki page for hud editor to rtd

Browse source
This commit is contained in:
Helldembez 2023-01-20 20:11:31 +01:00
parent af2784fdcd
commit 9fb39de102
3 changed files with 143 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
conf.py
View file

@ -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

141
hudeditor.rst Normal file
View file

@ -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
"""""""""""""""

1
index.rst
View file

@ -30,3 +30,4 @@ There are two aspects to this project:
vsays
resources
skillrating
hudeditor