Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync with Q2PRO: Docs #388

Merged
merged 5 commits into from
Mar 26, 2024
Merged

Sync with Q2PRO: Docs #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ce69a5
Enable dynamic lights by default.
skullernet Nov 15, 2022
a69fb8a
Update client documentation.
skullernet Dec 12, 2022
29d3a71
Add link to pakserve in server docs.
skullernet Dec 26, 2022
4f42352
Update client documentation.
skullernet Jan 6, 2023
1d2e733
Document filesystem commands.
skullernet Jan 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 28 additions & 9 deletions doc/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1217,9 +1217,6 @@ Controls dynamic lightmap updates. Default value is 1.
- 2 — most dynamic lights are disabled, but lightmap updates are still
allowed for switchable lights to work

*NOTE*: Dynamic lights may noticeably hurt rendering performance on some video
cards and drivers, therefore they are disabled by default.

#### `gl_dlight_falloff`
Makes dynamic lights look a bit smoother, opposed to original jagged Quake
2 style. Default value is 1 (enabled).
Expand Down Expand Up @@ -1359,6 +1356,11 @@ Default value is 1.
#### `allow_download_textures`
Enables automatic downloading of map textures. Default value is 1.

##### Ignoring downloads
It is possible to specify a list of paths in `download-ignores.txt` file that
are known to be non-existent and should never be downloaded from server. This
file accepts wildcard patterns one per line. Empty lines and lines starting
with `#` or `/`s characters are ignored.

### HTTP Downloads

Expand Down Expand Up @@ -1805,7 +1807,7 @@ flag. _Value_ may be composed from multiple tokens.
Sets the specified _cvar_ to _value_, and marks the cvar with `archive`
flag. _Value_ may be composed from multiple tokens.

#### `cvarlist [-achlmnrstuvw:] [wildcard]`
#### `cvarlist [-achlmnrstuv:] [wildcard]`
Display the list of registered cvars and their current values with
filtering by cvar name or by cvar flags. If no options are given,
all cvars are listed. Optional _wildcard_ argument filters cvars by name.
Expand Down Expand Up @@ -1902,7 +1904,8 @@ screen. Specify `all` to remove all objects.
Standard command to take a screenshot. If `format` argument is given,
takes the screenshot in this format. Otherwise, takes in the format
specified by `gl_screenshot_format` variable. File name is picked up
automatically from the `screenshots/quakeNNN.EXT` template.
automatically from template specified by `gl_screenshot_template`
variable.

#### `screenshotpng [filename] [compression]`
Takes the screenshot in PNG format. If `filename` argument is given, saves
Expand Down Expand Up @@ -1952,10 +1955,9 @@ restart the file system and reload the current level.
Flush and reload all media registered by the renderer (textures and models).
Weaker form of `fs_restart`.

*TIP*: In Q2PRO, you don't have to issue `vid_restart` after changing most of the
settings, a `fs_restart` or `r_reload` usually suffice. This helps to avoid
main window recreation and changing video modes back and forth, and is much
faster.
*TIP*: In Q2PRO, you don't have to issue `vid_restart` after changing graphics
settings. Changes to console variables are detected, and appropriate subsystem
is restarted automatically.

#### `passive`
Toggle passive connection mode. When enabled, client waits for the first
Expand Down Expand Up @@ -1989,6 +1991,23 @@ Execute OGG subcommand. Available subcommands:
- `stop`:
Stop playing background music track.

#### `whereis <path> [all]`
Search for _path_ and print the name of packfile or directory where it is
found. If _all_ is specified, prints all found instances of path, not just
the first one.

#### `softlink <name> <target>`
Create soft symbolic link to _target_ with the specified _name_. Soft
symbolic links are only effective when _name_ was not found as regular
file.

#### `softunlink [-ah] <name>`
Deletes soft symbolic link with the specified _name_, or all soft symbolic
links. Supported options are reproduced below.
* `-a` or `--all`: delete all links
* `-h` or `--help`: display help message


### Renderer

#### `reload_shader`
Expand Down
5 changes: 5 additions & 0 deletions doc/server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ Specifies the URL clients should use for HTTP downloading. URL must begin
with a `http://` prefix and end with a trailing slash. Default value is
empty (no download URL).

TIP: It is highly advisable to setup HTTP downloading on any public Quake 2
server. The easiest way to do so is to run
[pakserve](https://github.com/skullernet/pakserve) on the same machine as Quake 2
server.

#### `sv_show_name_changes`
Broadcast player name changes to everyone. You should probably enable this
unless game mod already shows name changes. Default value is 0 (don't
Expand Down
Loading