Skip to content

Commit 92f8b48

Browse files
AcizAciz
authored
3.3.2 Update (#38)
1 parent 291db51 commit 92f8b48

12 files changed

Lines changed: 139 additions & 82 deletions

‎docs/basic_features.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Keyset | Value
112112
You can teleport to a location of another player on the server by using the [`goto`](client/client_commands.md/#goto) command. Similarly, you can teleport other players to your location using the [`call`](client/client_commands.md/#call-iwant) command.
113113

114114
```{note}
115-
By default, you are not allowed to target any players with these commands. A player must consent to being targeted by `goto/call` by using the [`nogoto`](client/client_commands.md/#nogoto) and [`nocall`](client/client_commands.md/#nocall)
115+
By default, you are not allowed to target any players with these commands. A player must consent to being targeted by `goto/call` by using the [`nogoto`](client/client_commands.md/#nogoto) and [`nocall`](client/client_commands.md/#nocall) commands, respectively.
116116
```
117117

118118
---

‎docs/client/client_commands.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Saves the current temp demo recorded with [`etj_autoDemo`](etjump_cvars.md/#etj_
1010

1111
---
1212

13+
## adminChat
14+
`adminChat`
15+
16+
Opens the chat interface with admin chat selected as the message destination.
17+
18+
---
19+
1320
## await
1421
`await <frames> <command1> | [command2] | [command3]...`
1522

@@ -412,6 +419,17 @@ Locks/unlocks you from spectators. When locked, use `specinvite/specuninvite` to
412419

413420
---
414421

422+
## toggleETJumpSettings
423+
`toggleETJumpSettings`
424+
425+
Toggles the ETJump settings menu.
426+
427+
```{hint}
428+
This is simply a shortcut to open `ETJump -> Settings -> General/Gameplay` page. The sole purpose of this command is to be able to bind the settings menu toggle to a key.
429+
```
430+
431+
---
432+
415433
## tracker_print
416434
`tracker_print [index1|all] [index2] [index3]...`
417435

‎docs/client/etjump_cvars.md‎

Lines changed: 35 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ Toggles shadow on the acceleration meter.
8181
---
8282

8383
## etj_accelSize
84-
Cvar | Values | Default
85-
:-----------------------|:-------------------|:------------
86-
etj_accelSize | any positive value | 3
84+
Cvar | Values | Default
85+
:-----------------------|:-----------------------------------------------------------|:------------
86+
etj_accelSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3
8787

8888
Sets the size of the acceleration meter.
8989

@@ -447,9 +447,9 @@ Disabling this cvar does **not** exclude any messages you send from appearing in
447447
---
448448

449449
## etj_chatScale
450-
Cvar | Values | Default
451-
:-----------------------|:------------------|:------------
452-
etj_chatScale | any positive value| 1.0
450+
Cvar | Values | Default
451+
:-----------------------|:-----------------------------------------------------------|:------------
452+
etj_chatScale | [scale (0 - 5)](../getting_started.md/#size--scale-system) | 1.0
453453

454454
Scales the chat size.
455455

@@ -488,25 +488,25 @@ This functions independently of [`etj_drawCheckpoints`](etjump_cvars.md/#etj_dra
488488

489489
## etj_checkpointsPopupDuration
490490
Cvar | Values | Default
491-
-----------------------------|:---------------------|-------------
491+
:----------------------------|:---------------------|:------------
492492
etj_checkpointsPopupDuration | any positive integer | 1000
493493

494494
How long in milliseconds a checkpoint popup stays on screen.
495495

496496
---
497497

498498
## etj_checkpointsPopupSize
499-
Cvar | Values | Default
500-
-------------------------|:-------------------|-------------
501-
etj_checkpointsPopupSize | any positive value | 2
499+
Cvar | Values | Default
500+
:------------------------|:-----------------------------------------------------------|:------------
501+
etj_checkpointsPopupSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 2
502502

503503
Sets size of a checkpoint popup.
504504

505505
---
506506

507507
## etj_checkpointsPopupShadow
508508
Cvar | Values | Default
509-
---------------------------|:--------------|:------------
509+
:--------------------------|:--------------|:------------
510510
etj_checkpointsPopupShadow | 0 or 1 | 1
511511

512512
Toggles drawing shadow on checkpoint popups.
@@ -541,9 +541,9 @@ Toggles shadow on the checkpoint timer.
541541
---
542542

543543
## etj_checkpointsSize
544-
Cvar | Values | Default
545-
:-----------------------|:-------------------|:------------
546-
etj_checkpointsSize | any positive value | 2
544+
Cvar | Values | Default
545+
:-----------------------|:-----------------------------------------------------------|:------------
546+
etj_checkpointsSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 2
547547

548548
Sets size of the checkpoint timer.
549549

@@ -716,32 +716,6 @@ Toggles drawing of outline on ETJump crosshairs.
716716

717717
---
718718

719-
## etj_crosshairScaleX
720-
Cvar | Values | Default
721-
:-----------------------|:--------------|:------------
722-
etj_crosshairScaleX | -5 - 5 | 1.0
723-
724-
Sets the horizontal scaling of the crosshair.
725-
726-
```{tip}
727-
This works on all crosshairs, not just the ETJump-exclusive crosshairs.
728-
```
729-
730-
---
731-
732-
## etj_crosshairScaleY
733-
Cvar | Values | Default
734-
:-----------------------|:--------------|:------------
735-
etj_crosshairScaleY | -5 - 5 | 1.0
736-
737-
Sets the vertical scaling of the crosshair.
738-
739-
```{tip}
740-
This works on all crosshairs, not just the ETJump-exclusive crosshairs.
741-
```
742-
743-
---
744-
745719
## etj_crosshairThickness
746720
Cvar | Values | Default
747721
:-----------------------|:--------------|:------------
@@ -1744,9 +1718,9 @@ Toggles drawing of shadow on the pressed keys view.
17441718
---
17451719

17461720
## etj_keysSize
1747-
Cvar | Values | Default
1748-
:-----------------------|:---------------------|:------------
1749-
etj_keysSize | any positive integer | 48
1721+
Cvar | Values | Default
1722+
:-----------------------|:------------------------------------------------------------|:------------
1723+
etj_keysSize | [size (0 - 256)](../getting_started.md/#size--scale-system) | 48
17501724

17511725
Sets the size of the pressed keys view.
17521726

@@ -2016,9 +1990,9 @@ Sets color of the OB watcher.
20161990
---
20171991

20181992
## etj_obWatcherSize
2019-
Cvar | Values | Default
2020-
:-----------------------|:-------------------|:------------
2021-
etj_obWatcherSize | any positive value | 3
1993+
Cvar | Values | Default
1994+
:-----------------------|:-----------------------------------------------------------|:------------
1995+
etj_obWatcherSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3
20221996

20231997
Sets size of the OB watcher.
20241998

@@ -2656,12 +2630,12 @@ Toggles drawing shadow on the spectator info list.
26562630

26572631
---
26582632

2659-
## etj_spectatorInfoSize
2660-
Cvar | Values | Default
2661-
:-----------------------|:-------------------|:------------
2662-
etj_spectatorInfoSize | any positive value | 2.3
2633+
## etj_spectatorInfoScale
2634+
Cvar | Values | Default
2635+
:-----------------------|:-----------------------------------------------------------|:------------
2636+
etj_spectatorInfoScale | [scale (0 - 5)](../getting_started.md/#size--scale-system) | 1.0
26632637

2664-
Sets font size of spectator info list.
2638+
Scales the font size of spectator info list.
26652639

26662640
---
26672641

@@ -2780,9 +2754,9 @@ Toggles drawing shadow on the ETJump speed meter.
27802754
---
27812755

27822756
## etj_speedSize
2783-
Cvar | Values | Default
2784-
:-----------------------|:-------------------|:------------
2785-
etj_speedSize | any positive value | 3
2757+
Cvar | Values | Default
2758+
:-----------------------|:-----------------------------------------------------------|:------------
2759+
etj_speedSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3
27862760

27872761
Sets size of the ETJump speed meter.
27882762

@@ -2847,9 +2821,9 @@ Toggles drawing shadow on the strafe quality display.
28472821
---
28482822

28492823
## etj_strafeQualitySize
2850-
Cvar | Values | Default
2851-
:-----------------------|:-------------------|:------------
2852-
etj_strafeQualitySize | any positive value | 3
2824+
Cvar | Values | Default
2825+
:-----------------------|:-----------------------------------------------------------|:------------
2826+
etj_strafeQualitySize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3
28532827

28542828
Sets the size of the strafe quality display.
28552829

@@ -3063,9 +3037,10 @@ Toggles drawing shadow on upmove meter text.
30633037
---
30643038

30653039
## etj_upmoveMeterTextSize
3066-
Cvar | Values | Default
3067-
--------------------------|:-------------------|:------------
3068-
etj_upmoveMeterTextSize | any positive value | 2
3040+
Cvar | Values | Default
3041+
:-----------------------|:-----------------------------------------------------------|:------------
3042+
etj_upmoveMeterTextSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 2
3043+
30693044

30703045
Sets size of the upmove meter text elements.
30713046

‎docs/client/etmain_cvars.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ ETJump has removed cheat protection from this cvar.
3636
---
3737

3838
## cg_crosshairSize
39-
Cvar | Values | Default
40-
:-----------------------|:-------------------|:------------
41-
cg_crosshairSize | any positive value | 48
39+
Cvar | Values | Default
40+
:-----------------------|:---------------------------------------------------------------|:------------
41+
cg_crosshairSize | [size (-256 - 256)](../getting_started.md/#size--scale-system) | 48
4242

4343
Sets size of the crosshair.
4444

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
project = 'ETJump'
1212
copyright = f'{date.today().year}, ETJump Team'
1313
author = 'ETJump Team'
14-
release = '3.3.1'
14+
release = '3.3.2'
1515

1616
# -- General configuration ---------------------------------------------------
1717
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

‎docs/getting_started.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,18 @@ This color system will work with any mod-sided cvar (generally anything that sta
6464
```{note}
6565
Some elements have a separate "color" and "alpha" cvars. In these cases, the alpha component is ignored on the "color" cvar parsing. Such cases are documented in the [cvar documentation](client/etjump_cvars.md).
6666
```
67+
68+
---
69+
70+
## Size & scale system
71+
Any cvar that expects a size or scale value for drawing accepts either one or two values. If one value is given, size/scale is applied uniformly. If two values are given, size/scale is applied individually to X/Y axes, respectively. Below is a table with some examples.
72+
73+
Cvar | Values | Explanation
74+
:-----------------------|:--------------|:----------------------------------------------------------------
75+
cg_crosshairSize | 32 | `cg_crosshairSize` is set to `32x32` size
76+
etj_keysSize | 32 24 | `etj_keysSize` is set to `32x24` size
77+
etj_chatScale | 0.7 0.8 | `etj_chatScale` is scaled by `0.7` on X axis and `0.8` on Y axis
78+
79+
```{note}
80+
Unless mentioned otherwise, all size and scale values accept floating point values.
81+
```

‎docs/mapping/getting_started.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ Both [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=mj
4747

4848
---
4949

50-
## ETJump mapping assets
50+
## Assets
5151

5252
ETJump assets include entities and shaders that are useful when creating maps for ETJump.
5353
You can get the assets from [ETJump mapping repository](https://github.com/etjump/mapping).
5454

5555
---
5656

57-
## ETJump mapping entities
57+
## Mapping entities
5858

59-
While creating your map, you most likely want to use entities provided by ETJump. Along with explanations provided in entity file, you can check the documentation on how to use ETJump specific entities. See the full list {doc}`here <mapping_entities>`.
59+
While creating your map, you most likely want to use entities provided by ETJump. Along with explanations provided in entity file, you can check the documentation on how to use ETJump specific entities. See the full list [here](mapping_entities.md).

‎docs/mapping/mapping_entities.md‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,9 @@ When a button is used, it moves some distance in the direction of it's angles, t
7777

7878
**Spawnflags**
7979

80-
*None*
80+
| Spawnflag | Description |
81+
| :-------: | :----------------------------------------------------------------------- |
82+
| 16 | Displays a progress bar with cursorhint until re-activation is possible. |
8183

8284
---
8385

@@ -94,9 +96,10 @@ Uses targeted entities upon activation.
9496

9597
**Spawnflags**
9698

97-
| Spawnflag | Description |
98-
| :-------: | :-------------------------------- |
99-
| 8 | Pass activator data to mapscript. |
99+
| Spawnflag | Description |
100+
| :-------: | :----------------------------------------------------------------------- |
101+
| 8 | Pass activator data to mapscript. |
102+
| 16 | Displays a progress bar with cursorhint until re-activation is possible. |
100103

101104
---
102105

@@ -212,6 +215,22 @@ A timerun can have a maximum of **16** checkpoints attached to it.
212215

213216
---
214217

218+
## target_delay
219+
220+
Fires off targets after a delay.
221+
222+
**Keys**
223+
224+
*None*
225+
226+
**Spawnflags**
227+
228+
| Spawnflag | Description |
229+
| :-------: | :------------------------------- |
230+
| 1 | `wait` is unique to each client. |
231+
232+
---
233+
215234
## target_give
216235

217236
Gives activator targeted items. Must target actual entites in the map. Standard class restrictions apply when giving weapons (eg. cannot give `weapon_panzerfaust` to a medic).
@@ -263,7 +282,7 @@ Initalizes player into a freshly spawned state
263282

264283
| Spawnflag | Description |
265284
| :-------: | :-------------------------------- |
266-
| 1 | Keep currennt health. |
285+
| 1 | Keep current health. |
267286
| 2 | Keep current ammo. |
268287
| 4 | Keep current weapons. |
269288
| 8 | Keep portal gun. |
@@ -470,7 +489,7 @@ Starts a timerun for the activator.
470489
| 4 | Run resets only wnen reaching the end. |
471490
| 8 | Run resets if client sets `pmove_fixed 0`. |
472491
| 16 | Disables `backup` and extra save slots. |
473-
| 32 | Cannot pickup explosive weeapons. |
492+
| 32 | Cannot pickup explosive weapons. |
474493
| 64 | Cannot pickup portal gun. |
475494
| 128 | Disables `save`, run is reset if client uses `load`. |
476495
| 256 | Allow players to toggle collision between fireteam members during the timerun. |
@@ -690,7 +709,7 @@ The BSP leaf that the destination lies in will be added to the PVS whenever this
690709

691710
---
692711

693-
## weapon_fg42, weapon_flamethrower, weapon_magicammo, weapon_magicammo2, weapon_mobile_mg42, weapoon_mortar
712+
## weapon_fg42, weapon_flamethrower, weapon_magicammo, weapon_magicammo2, weapon_mobile_mg42, weapon_mortar
694713

695714
**Keys**
696715

@@ -788,7 +807,7 @@ This entity does not disappear when picked up, and does not need to be manually
788807
| Key | Value | Default | Description |
789808
| :-------------- | :------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
790809
| nodrop | 0 or 1 | 0 | Enable/disable nodrop. **0** Items are not dropped inside `surfaceparm nodrop`. **1** items are only dropped inside `surfaceparm nodrop`. |
791-
| noexplosives | 0 - 2 | 0 | Disables explosives. **0** explosives are allowed. **1** no explosive weapons. **2** no dynamite. |
810+
| noexplosives | 0 - 2 | 0 | Disables explosives. **0** explosives are allowed. **1** no explosive weapons. **2** no explosive weapons or dynamite. |
792811
| nofalldamage | 0 - 2 | 0 | Enable/disable fall damage. **0** Fall damage disabled only on `surfaceparm nodamage` **1** Fall damage enabled only on `surfaceparm nodamage` **2** Fall damage disabled everywhere. |
793812
| noftnoghost | 0 or 1 | 0 | Disable players' ability to toggle collision between fireteam members. |
794813
| noghost | 0 or 1 | 0 | Disables player ghosting (nonsolid players). Overrides `g_ghostPlayers` server cvar. |

‎docs/mapping/mapscripting.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ Changes the entitys model to the given model.
1313
This script action is present in ETMain but only works for brush entities using `model2` key. ETJump allows this to be used to change models of `misc_gamemodel` entities as well.
1414
```
1515

16+
---
17+
18+
## changeskin
19+
`changeskin <path/to/file.skin>`
20+
21+
Changes the entitys skin to the given skin.
22+
23+
---
24+
1625
## create
1726

1827
```

0 commit comments

Comments
 (0)