Guide

TimePathrequested to merge
TimePath/guide into master

Initial menu guide implementation [TimePath].

Guide text [k9er]:

  • Most of it was based on https://gitlab.com/xonotic/xonotic/-/wikis/ (some of which is outdated I might add), cvar descriptions, and a bit of creative freedom. Weapon DPS values calculated myself.
  • If you're reading this and you have any suggestions to improve the text, feel free to comment it, or just directly push to this branch. I'm not the greatest at creative writing, so I feel some of this may need improvement before it's ready for merging.
  • Almost all guide text is defined only ifdef MENUQC so as to not make csprogs larger.

Code refactoring (not included in !1425 (merged) because the changes only affect the guide) [k9er]:

  • Relocated nt_IsNewToy from common/mutators/mutator/new_toys/sv_new_toys.qc to common/mutators/mutator/new_toys/new_toys.qc (new file), so that it could be called to dynamically generate the New Toys list in the guide.
  • Allowed REGISTER_MUTATOR to take 3 arguments, third being a classname, so that the same approach used for all other guide entries (giving classes the describe method) could also be used for mutators.
  • Standardized some key-finding functions (see _getcommandkey and XonoticKeyBinder_drawListBoxItem).

TODO list:

  • Topic icons(?)
  • Introduction & Movement topic icons(?)
  • Monsters topic icons
  • Mutators topic icons
  • Turrets topic icons
  • Improve vehicle topic icons

Screenshots:
guide_weapons guide_buffs guide_mutators
Outdated screenshots (click to expand)

xonotic20221202132142-00 xonotic20221202132142-00

Closes #1560 (closed), addresses #1198.

More detailed change log:

TimePath:

  • Main menu implementation

k9er:

  • Improved and refactored main menu implementation
  • Separated powerups from items
  • Added Gametype topic text (it was previously short and taken from gametype cvar descriptions)
  • Added Items topic text
  • Added Powerups topic text
  • Added Buffs topic text
  • Added Weapons topic text (core weapons text adapted from https://gitlab.com/xonotic/xonotic/-/wikis/)
  • Added Nades topic text
  • Added Vehicles topic text
  • Added Turrets topic text
  • Added Mutators topic text
  • Improved Items topic sorting
  • Removed the Maps topic (it already can be found in Multiplayer > Create)
  • Removed the Debug topic
  • Added weapon keybinds
  • Added weapon damage stats
  • Fixed filter not working
  • Allowed use of CTRL+F and CTRL+U in guide filter
  • Colorized names of weapons, items, etc.
  • Relocated the guide from Multiplayer > Media to Singleplayer
  • Improved guide layout
  • Made the Guide button pulse for new players and autobuild users conditionally

terencehill:

  • Implemented raw entry sorting algorithm that allows sorting Items by item type too and displaying Overkill superweapons after Overkill normal weapons
  • Implemented proper dot point lists in the descriptions and used them where possible
  • Split all text into individually translatable paragraphs
  • Added Mods topic with Overkill (moved from Mutators) and XPM (new entry)
  • Improved weapon damage stats messages for translation
  • Added direct hit damage stats for Overkill RPC
  • Moved keybinds and color codes out of the translatable text
  • Moved colors of ammo and armor / health pickup amounts out of the translatable text
  • Minor text adjustments

Halogene:

  • Added Introduction topic text
  • Added Movement topic text

Mario:

  • Removed null and hidden entries from the guide menu
  • Added Monster topic text

Antibody:

  • Added XonStat text
Edited by terencehill

Merge request reports