From 92f8b482ad5781ae4ff9f135ad79a7f010524a62 Mon Sep 17 00:00:00 2001 From: Aciz Date: Sun, 5 Jan 2025 21:11:26 +0200 Subject: [PATCH] 3.3.2 Update (#38) --- docs/basic_features.md | 2 +- docs/client/client_commands.md | 18 ++++++ docs/client/etjump_cvars.md | 95 ++++++++++++-------------------- docs/client/etmain_cvars.md | 6 +- docs/conf.py | 2 +- docs/getting_started.md | 15 +++++ docs/mapping/getting_started.md | 6 +- docs/mapping/mapping_entities.md | 35 +++++++++--- docs/mapping/mapscripting.md | 9 +++ docs/server/admin_system.md | 16 +++++- docs/server/server_cvars.md | 16 ++++-- docs/usage.md | 1 + 12 files changed, 139 insertions(+), 82 deletions(-) diff --git a/docs/basic_features.md b/docs/basic_features.md index 4a5cd9e..053f755 100644 --- a/docs/basic_features.md +++ b/docs/basic_features.md @@ -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. ``` --- diff --git a/docs/client/client_commands.md b/docs/client/client_commands.md index e231612..9fc1cd8 100644 --- a/docs/client/client_commands.md +++ b/docs/client/client_commands.md @@ -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 | [command2] | [command3]...` @@ -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]...` diff --git a/docs/client/etjump_cvars.md b/docs/client/etjump_cvars.md index d55cb57..6309f7a 100644 --- a/docs/client/etjump_cvars.md +++ b/docs/client/etjump_cvars.md @@ -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. @@ -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. @@ -488,7 +488,7 @@ 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. @@ -496,9 +496,9 @@ 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. @@ -506,7 +506,7 @@ Sets size of a checkpoint popup. ## etj_checkpointsPopupShadow Cvar | Values | Default ----------------------------|:--------------|:------------ +:--------------------------|:--------------|:------------ etj_checkpointsPopupShadow | 0 or 1 | 1 Toggles drawing shadow on checkpoint popups. @@ -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. @@ -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 :-----------------------|:--------------|:------------ @@ -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. @@ -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. @@ -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. --- @@ -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. @@ -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. @@ -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. diff --git a/docs/client/etmain_cvars.md b/docs/client/etmain_cvars.md index a917daf..4a0516d 100644 --- a/docs/client/etmain_cvars.md +++ b/docs/client/etmain_cvars.md @@ -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. diff --git a/docs/conf.py b/docs/conf.py index 8776b54..ea783bf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/getting_started.md b/docs/getting_started.md index c362354..eab739b 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -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. +``` diff --git a/docs/mapping/getting_started.md b/docs/mapping/getting_started.md index ddfb908..265780e 100644 --- a/docs/mapping/getting_started.md +++ b/docs/mapping/getting_started.md @@ -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 `. +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). diff --git a/docs/mapping/mapping_entities.md b/docs/mapping/mapping_entities.md index cdaefef..35df360 100644 --- a/docs/mapping/mapping_entities.md +++ b/docs/mapping/mapping_entities.md @@ -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. | --- @@ -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. | --- @@ -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). @@ -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. | @@ -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. | @@ -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** @@ -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. | diff --git a/docs/mapping/mapscripting.md b/docs/mapping/mapscripting.md index bd63a9d..64bb51c 100644 --- a/docs/mapping/mapscripting.md +++ b/docs/mapping/mapscripting.md @@ -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 ` + +Changes the entitys skin to the given skin. + +--- + ## create ``` diff --git a/docs/server/admin_system.md b/docs/server/admin_system.md index 385c95b..8c12bf6 100644 --- a/docs/server/admin_system.md +++ b/docs/server/admin_system.md @@ -54,6 +54,8 @@ Any player with the `S` command flag has access to admin chat. This is a chat sy Players can send messages to admin chat via the chat window by selecting "Admin" as the destination. If the player does not have permissions to send messages to admin chat, the message is simply dropped entirely. +Admin chats are excluded from standard log files - they are logged into the [admin log](#admin-system-logging). + ![adminchat box](../img/adminchat_box.png) ```{tip} @@ -64,7 +66,7 @@ Messages to admin chat can also be sent from console with the following commands ``` ```{tip} -Similar to team and fireteam chats, it's possible to create a bind that opens the chat window with "Admin" selected as destination, using the `adminChat` command. This isn't bound to anything by default. +Similar to team and fireteam chats, it's possible to create a bind that opens the chat window with "Admin" selected as destination, using the [`adminChat`](../client/client_commands.md/#adminchat) command. This isn't bound to anything by default. `bind adminChat` ``` @@ -77,6 +79,16 @@ If desired, admin chat can be disabled on the server with the [`g_adminChat`](se --- +## Admin system logging + +By default, servers log certain admin-related events to a log file specified in [`g_adminLog`](server_cvars.md/#g_adminlog) cvar (unless [`g_dailyLogs`](server_cvars.md/#g_dailylogs) is enabled, in which case a new log file will be created daily). When enabled, the following events are logged: + +* Admin chat +* Usage of admin commands with flags `b`, `C`, `A`, `k`, `m`, `P`, `R`, `s`, `T` and `c` +* Authentication related events (potential GUID/HWID spoofs, rejected connections) + +--- + ## List of admin commands Below you'll find a list of all the admin commands, with explanations on what they do and what flag is required to access them. @@ -457,7 +469,7 @@ Displays the latest maps added to the server, sorted from oldest to newest. If ` **Flag:** a ```{note} -If a map has been on the server previously but later removed, it has already been registered to the servers map database and won't be displayed as the newest map if re-added back. +If a map has been on the server previously but later removed, it has already been registered to the servers map database and won't be displayed as the newest map if re-added. ``` --- diff --git a/docs/server/server_cvars.md b/docs/server/server_cvars.md index 2e5a97f..8450a7f 100644 --- a/docs/server/server_cvars.md +++ b/docs/server/server_cvars.md @@ -21,10 +21,14 @@ Cvar | Values | Default :-----------------------|:--------------|:------------ g_adminLog | filename | adminsystem.log -Currently does nothing. +Enables logging of certain admin events to the specified log file. -```{todo} -Make this log admin commands. +```{note} +If [`g_dailyLogs`](#g_dailylogs) is enabled, the log name is ignored and the logs are created daily to `logs` directory, prefixed with `admin-`. +``` + +```{seealso} +[Admin system logging](admin_system.md/#admin-system-logging) ``` --- @@ -170,7 +174,11 @@ Cvar | Values | Default :-----------------------|:--------------|:------------ g_dailyLogs | 0 or 1 | 1 -Whether to log everything in a single file or change the file daily. +Whether to log everything in a single file or change the file daily. The log file will be written to `logs` directory. + +```{note} +When enabled, this also enables daily logging for [`g_adminLog`](#g_adminlog). +``` --- diff --git a/docs/usage.md b/docs/usage.md index 6abb881..8759c12 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -19,6 +19,7 @@ any positive value | Any floating point number equal to or higher than `0.0`. 0.0 - 5.0 | A floating point number within range `0.0 - 5.0`. bitflag | A combined value of "flags". Valid values for the flags are listed under the cvar explanation. Adding the desired flag values together represents the final value. For example, a cvar might have flags `1`, `2`, and `4`. If you want to enable flags `1` and `4`, you add them together `1 + 4 = 5`, which is the final value. any color | Takes a color string as an input, see [color system](getting_started.md/#color-system) for more information. +size/scale (range) | Takes a size or scale value as an input, see [size & scale system](getting_started.md/#size--scale-system) for more information. any string | Takes in a string literal. This might sometimes be listed with a context-specific name, such as `filename` or `directory`. ```{note}