Skip to content

Commit

Permalink
Documentation wording tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAlaux committed Feb 24, 2024
1 parent c248a8c commit e5856ea
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For these settings, their CVAR names are provided alongside the _CFG-Only_ label
- **_Move Over/Under Things_** setting [partially p.f. Crispy Doom, DSDA-Doom]
- **Jumping** (default key: <kbd>Alt</kbd>, must be enabled first) [p.f. Crispy Doom]
- **Crouching/ducking** (default key: <kbd>C</kbd>, must be enabled first) [i.b. ZDoom]
- **_View Height_** setting, which allows to enter a custom height value between 32 and 56 for the player's POV [i.b. Brutal Doom]
- **_View Height_** setting, which allows to enter a custom POV height value in the [32, 56] range [i.b. Brutal Doom]
- **_View Bobbing Percentage_** setting [i.b. Crispy Doom, ZDoom]
- **Flinching** setting, to flinch upon landing and/or taking damage
- **_Explosion Shake Effect_** setting [i.b. Doom Retro]
Expand All @@ -50,12 +50,12 @@ For these settings, their CVAR names are provided alongside the _CFG-Only_ label
- **_Disable palette tint in menus_** setting [i.b. Crispy Doom]
- **_Disable Berserk Tint_** setting
- **_Disable Radiation Suit Tint_** setting
- **_Damage Tint Cap_** and **_Bonus Tint Cap_**, to attenuate or disable the red and yellow screen tints
- **_Damage Tint Cap_** and **_Bonus Tint Cap_**, to attenuate or disable said screen tinting
- **_Fake Contrast_** setting
- Toggle for **Diminished Lighting** (CFG-Only: `diminished_lighting`)
- **_Screen Wipe speed percentage_** setting
- **_Alternative Intermission Background_** setting, to replace the intermission graphic with a darkened spinning camera view
- **_Sound Clipping Distance_** selection, to optionally double the distance at which SFX become audible
- **_Sound Clipping Distance_** selection, to optionally double the distance at which sound effects become audible
- **_One-Key Quick Save/Load_** setting, to skip the confirmation prompt
- **Rewinding** [i.b. DSDA-Doom]
- **_Play Internal Demos_** setting
Expand All @@ -78,7 +78,7 @@ For these settings, their CVAR names are provided alongside the _CFG-Only_ label
- **_Squat Weapon Down On Impact_** setting [p.f. Crispy Doom]
- **_Translucent Flashes_** setting [i.b. Crispy Doom]
- **Show Berserk availability** setting [partially p.f. Crispy Doom]
- **"Correct" first person sprite centering** setting, to toggle the 1px first person sprite misalignment (CFG-Only: `sx_fix`)
- **"Correct" first person sprite centering** setting, to toggle the 1px first-person sprite misalignment (CFG-Only: `sx_fix`)

### Status Bar/HUD

Expand Down
10 changes: 5 additions & 5 deletions docs/nughud.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ names and values, optionally separated by blank or comment lines.

The following properties are shared across all widgets:

- `_x`: **X position**, which can be any integer in the [0-320] range.
- `_y`: **Y position**, which can be any integer in the [0-200] range.
- `_x`: **X position**, which can be any integer in the [0, 320] range.
- `_y`: **Y position**, which can be any integer in the [0, 200] range.
- `_wide`: **Widescreen shift**, with the following possible values:
- `-2` to shift the element left forcefully;
- `-1` to shift the element left only when in widescreen mode;
Expand All @@ -49,13 +49,13 @@ The following widgets are available:
| `nughud_ammoicon` | Yes | Yes | Ammo icon, which changes depending on the ammo type of the current weapon |
| `nughud_health` | Yes | Yes | Health count |
| `nughud_healthicon` | Yes | Yes | Health icon, which changes depending on whether the player has Berserk |
| `nughud_arms#` | Yes | No | Arms (weapon) number, where `#` is an integer in the [1-9] range |
| `nughud_arms#` | Yes | No | Arms (weapon) number, where `#` is an integer in the [1, 9] range |
| `nughud_frags` | Yes | Yes | Frag count, only shown during Deathmatch games |
| `nughud_face` | Yes | No | Face (mugshot) |
| `nughud_armor` | Yes | Yes | Armor count |
| `nughud_armoricon` | Yes | Yes | Armor icon, which changes depending on the current armor type |
| `nughud_key#` | Yes | No | Key display, where `#` is an integer in the [0-2] range (in order: Blue Key; Yellow Key; Red Key) |
| `nughud_ammo#` | Yes | Yes | Ammo count for each type, where `#` is an integer in the [0-3] range (in order: Bullets; Shells; Cells; Rockets) |
| `nughud_key#` | Yes | No | Key display, where `#` is an integer in the [0, 2] range (in order: Blue Key; Yellow Key; Red Key) |
| `nughud_ammo#` | Yes | Yes | Ammo count for each type, where `#` is an integer in the [0, 3] range (in order: Bullets; Shells; Cells; Rockets) |
| `nughud_maxammo#` | Yes | Yes | Same as the above, but for Max. Ammo |
| `nughud_time` | No | Yes | Time display, only shown if enabled by the user |
| `nughud_sts` | No | Yes | Stats (Kills/Items/Secrets) display, only shown if enabled by the user |
Expand Down

0 comments on commit e5856ea

Please sign in to comment.