Skip to content

Commit

Permalink
3.3.2 Update (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Aciz
Aciz authored Jan 5, 2025
1 parent 291db51 commit 92f8b48
Show file tree
Hide file tree
Showing 12 changed files with 139 additions and 82 deletions.
2 changes: 1 addition & 1 deletion docs/basic_features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Keyset | Value
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.

```{note}
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)
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.
```

---
Expand Down
18 changes: 18 additions & 0 deletions docs/client/client_commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ Saves the current temp demo recorded with [`etj_autoDemo`](etjump_cvars.md/#etj_

---

## adminChat
`adminChat`

Opens the chat interface with admin chat selected as the message destination.

---

## await
`await <frames> <command1> | [command2] | [command3]...`

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

---

## toggleETJumpSettings
`toggleETJumpSettings`

Toggles the ETJump settings menu.

```{hint}
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.
```

---

## tracker_print
`tracker_print [index1|all] [index2] [index3]...`

Expand Down
95 changes: 35 additions & 60 deletions docs/client/etjump_cvars.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ Toggles shadow on the acceleration meter.
---

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

Sets the size of the acceleration meter.

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

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

Scales the chat size.

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

## etj_checkpointsPopupDuration
Cvar | Values | Default
-----------------------------|:---------------------|-------------
:----------------------------|:---------------------|:------------
etj_checkpointsPopupDuration | any positive integer | 1000

How long in milliseconds a checkpoint popup stays on screen.

---

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

Sets size of a checkpoint popup.

---

## etj_checkpointsPopupShadow
Cvar | Values | Default
---------------------------|:--------------|:------------
:--------------------------|:--------------|:------------
etj_checkpointsPopupShadow | 0 or 1 | 1

Toggles drawing shadow on checkpoint popups.
Expand Down Expand Up @@ -541,9 +541,9 @@ Toggles shadow on the checkpoint timer.
---

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

Sets size of the checkpoint timer.

Expand Down Expand Up @@ -716,32 +716,6 @@ Toggles drawing of outline on ETJump crosshairs.

---

## etj_crosshairScaleX
Cvar | Values | Default
:-----------------------|:--------------|:------------
etj_crosshairScaleX | -5 - 5 | 1.0

Sets the horizontal scaling of the crosshair.

```{tip}
This works on all crosshairs, not just the ETJump-exclusive crosshairs.
```

---

## etj_crosshairScaleY
Cvar | Values | Default
:-----------------------|:--------------|:------------
etj_crosshairScaleY | -5 - 5 | 1.0

Sets the vertical scaling of the crosshair.

```{tip}
This works on all crosshairs, not just the ETJump-exclusive crosshairs.
```

---

## etj_crosshairThickness
Cvar | Values | Default
:-----------------------|:--------------|:------------
Expand Down Expand Up @@ -1744,9 +1718,9 @@ Toggles drawing of shadow on the pressed keys view.
---

## etj_keysSize
Cvar | Values | Default
:-----------------------|:---------------------|:------------
etj_keysSize | any positive integer | 48
Cvar | Values | Default
:-----------------------|:------------------------------------------------------------|:------------
etj_keysSize | [size (0 - 256)](../getting_started.md/#size--scale-system) | 48

Sets the size of the pressed keys view.

Expand Down Expand Up @@ -2016,9 +1990,9 @@ Sets color of the OB watcher.
---

## etj_obWatcherSize
Cvar | Values | Default
:-----------------------|:-------------------|:------------
etj_obWatcherSize | any positive value | 3
Cvar | Values | Default
:-----------------------|:-----------------------------------------------------------|:------------
etj_obWatcherSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3

Sets size of the OB watcher.

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

---

## etj_spectatorInfoSize
Cvar | Values | Default
:-----------------------|:-------------------|:------------
etj_spectatorInfoSize | any positive value | 2.3
## etj_spectatorInfoScale
Cvar | Values | Default
:-----------------------|:-----------------------------------------------------------|:------------
etj_spectatorInfoScale | [scale (0 - 5)](../getting_started.md/#size--scale-system) | 1.0

Sets font size of spectator info list.
Scales the font size of spectator info list.

---

Expand Down Expand Up @@ -2780,9 +2754,9 @@ Toggles drawing shadow on the ETJump speed meter.
---

## etj_speedSize
Cvar | Values | Default
:-----------------------|:-------------------|:------------
etj_speedSize | any positive value | 3
Cvar | Values | Default
:-----------------------|:-----------------------------------------------------------|:------------
etj_speedSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3

Sets size of the ETJump speed meter.

Expand Down Expand Up @@ -2847,9 +2821,9 @@ Toggles drawing shadow on the strafe quality display.
---

## etj_strafeQualitySize
Cvar | Values | Default
:-----------------------|:-------------------|:------------
etj_strafeQualitySize | any positive value | 3
Cvar | Values | Default
:-----------------------|:-----------------------------------------------------------|:------------
etj_strafeQualitySize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 3

Sets the size of the strafe quality display.

Expand Down Expand Up @@ -3063,9 +3037,10 @@ Toggles drawing shadow on upmove meter text.
---

## etj_upmoveMeterTextSize
Cvar | Values | Default
--------------------------|:-------------------|:------------
etj_upmoveMeterTextSize | any positive value | 2
Cvar | Values | Default
:-----------------------|:-----------------------------------------------------------|:------------
etj_upmoveMeterTextSize | [size (0 - 10)](../getting_started.md/#size--scale-system) | 2


Sets size of the upmove meter text elements.

Expand Down
6 changes: 3 additions & 3 deletions docs/client/etmain_cvars.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ ETJump has removed cheat protection from this cvar.
---

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

Sets size of the crosshair.

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
project = 'ETJump'
copyright = f'{date.today().year}, ETJump Team'
author = 'ETJump Team'
release = '3.3.1'
release = '3.3.2'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
15 changes: 15 additions & 0 deletions docs/getting_started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,18 @@ This color system will work with any mod-sided cvar (generally anything that sta
```{note}
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).
```

---

## Size & scale system
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.

Cvar | Values | Explanation
:-----------------------|:--------------|:----------------------------------------------------------------
cg_crosshairSize | 32 | `cg_crosshairSize` is set to `32x32` size
etj_keysSize | 32 24 | `etj_keysSize` is set to `32x24` size
etj_chatScale | 0.7 0.8 | `etj_chatScale` is scaled by `0.7` on X axis and `0.8` on Y axis

```{note}
Unless mentioned otherwise, all size and scale values accept floating point values.
```
6 changes: 3 additions & 3 deletions docs/mapping/getting_started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ Both [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=mj

---

## ETJump mapping assets
## Assets

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

---

## ETJump mapping entities
## Mapping entities

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>`.
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).
35 changes: 27 additions & 8 deletions docs/mapping/mapping_entities.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ When a button is used, it moves some distance in the direction of it's angles, t

**Spawnflags**

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

---

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

**Spawnflags**

| Spawnflag | Description |
| :-------: | :-------------------------------- |
| 8 | Pass activator data to mapscript. |
| Spawnflag | Description |
| :-------: | :----------------------------------------------------------------------- |
| 8 | Pass activator data to mapscript. |
| 16 | Displays a progress bar with cursorhint until re-activation is possible. |

---

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

---

## target_delay

Fires off targets after a delay.

**Keys**

*None*

**Spawnflags**

| Spawnflag | Description |
| :-------: | :------------------------------- |
| 1 | `wait` is unique to each client. |

---

## target_give

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).
Expand Down Expand Up @@ -263,7 +282,7 @@ Initalizes player into a freshly spawned state

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

---

## weapon_fg42, weapon_flamethrower, weapon_magicammo, weapon_magicammo2, weapon_mobile_mg42, weapoon_mortar
## weapon_fg42, weapon_flamethrower, weapon_magicammo, weapon_magicammo2, weapon_mobile_mg42, weapon_mortar

**Keys**

Expand Down Expand Up @@ -788,7 +807,7 @@ This entity does not disappear when picked up, and does not need to be manually
| Key | Value | Default | Description |
| :-------------- | :------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| nodrop | 0 or 1 | 0 | Enable/disable nodrop. **0** Items are not dropped inside `surfaceparm nodrop`. **1** items are only dropped inside `surfaceparm nodrop`. |
| noexplosives | 0 - 2 | 0 | Disables explosives. **0** explosives are allowed. **1** no explosive weapons. **2** no dynamite. |
| noexplosives | 0 - 2 | 0 | Disables explosives. **0** explosives are allowed. **1** no explosive weapons. **2** no explosive weapons or dynamite. |
| 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. |
| noftnoghost | 0 or 1 | 0 | Disable players' ability to toggle collision between fireteam members. |
| noghost | 0 or 1 | 0 | Disables player ghosting (nonsolid players). Overrides `g_ghostPlayers` server cvar. |
Expand Down
9 changes: 9 additions & 0 deletions docs/mapping/mapscripting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ Changes the entitys model to the given model.
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.
```

---

## changeskin
`changeskin <path/to/file.skin>`

Changes the entitys skin to the given skin.

---

## create

```
Expand Down
Loading

0 comments on commit 92f8b48

Please sign in to comment.