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.

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

Add documentation of basic client commands #54

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
14 changes: 14 additions & 0 deletions _documentation/user/slash_commands/bind.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
command: bind
syntax: "<event> <press> <action>"
since: 2.4.0
category: Client
permissions: ~
---

Bind `<event>` to an `<action>`.

`<event>` can be any key, button, or combination strung together, such as `"Shift+Page Up"` double quotes are only necessary if there are spaces.
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
`<press>` can be `up`, `down`, or `both`.
`<action>` is the command to be triggered.

9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/cmds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "cmds"
syntax: ~
since: 2.4.0
category: Client
permissions: ~
---

Show a list of all client and server commands.
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/debug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "debug"
syntax: "[level]"
since: 2.4.0
category: Client
permissions: ~
---

Show or set the client debug level to `[level]`
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/diff.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "diff"
syntax: ~
since: 2.4.0
category: Client
permissions: ~
---

List all BZDB server variables that are not set to the default value
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/dumpvars.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "dumpvars"
syntax: ~
since: 2.4.0
category: Client
permissions: ~
---

Dump a list of all set variables and their values to the standard output
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/forceradar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: forceradar
syntax: ~
since: 2.4.0
category: Client
permissions: ~
---

Force the radar to be displayed (only works for observers)
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion _documentation/user/slash_commands/highlight.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
command: highlight
syntax: "[pattern]"
since: 2.4.0
category: Player
category: Client
permissions: ~
---

Expand Down
34 changes: 34 additions & 0 deletions _documentation/user/slash_commands/localset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
command: localset
syntax: "variable [value]"
since: 2.4.0
category: Client
permissions: ~
---

Read a local variable or set it to `[value]`

## Examples:
```
/localset highlightPattern "laser"
/localset highlightPattern "laser|genocide"
/localset highlightPattern "(Team Flag|Team's Flag|Genocide)"
```
*highlightPattern* highlights lines with the selected words when they appear in the console(chat box).
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
- When highlighting one word, just type the word in quotes, such as "laser."
- If one wants to highlight two or more words, the words must be separated with a '|', such as "laser|genocide" (highlights lines with laser OR genocide).
- If any of the words have spaces, all the words must be surrounded in parentheses, such as "(Team Flag|Team's Flag|Genocide)" (highlights lines with "Team Flag," "Team's Flag," OR "Genocide").

&nbsp;
```
/localset linedradarshots 60
```
*linedradarshots* sets how long shots are on the radar. While this option is set-able through the in-game GUI, you can only set this setting up to 10 via the GUI. You can hand-edit your config to give you longer shot lengths.
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved

&nbsp;
```
/localset latitude 38
/localset longitude -77
```
*latitude* and *longitude* set the latitude and longitude for BZFlag's sky rendering system.
*Hint: To always have a black sky set latitude 90 (north pole) or -90 (south pole) for winter/summer respectively.*
2 changes: 1 addition & 1 deletion _documentation/user/slash_commands/quit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
command: quit
syntax: "[message]"
since: 2.4.0
category: Player
category: Client
permissions: ~
---

Expand Down
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/retexture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "retexture"
syntax: ~
since: 2.4.0
category: Client
permissions: ~
---

Reload the textures of the game
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/roampos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "roampos"
syntax: "{reset|send|angle|x y z [theta [phi [zoom]]]}"
since: 2.4.0
category: Client
permissions: ~
---

Manipulate the observer camera (only useful in Roaming and Tracking modes). Without arguments, it shows a usage message and the current camera location. `reset` resets the camera's location to the center of the map and `send` sends information about the camera to the server. `angle` moves the camera outside the map at a certain angle, looking towards its center. `x`, `y` and `z` are used to set the camera's location, theta defines the camera's horizontal angle, `phi` defines its vertical angle and `zoom` sets the camera's zoom level. All angles are defined in degrees.
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/savemsgs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "savemsgs"
syntax: "[-s] [-t]"
since: 2.4.0
category: Client
permissions: ~
---

Save all messages to a file in your config directory. If `-s` is provided, coloring data are stripped. If `-t` is provided, timestamps are added to the messages.
RighthandSon marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 9 additions & 0 deletions _documentation/user/slash_commands/saveworld.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
command: "saveworld"
syntax: "[-g] [-m] [-o] filename"
since: 2.4.0
category: Client
permissions: ~
---

Save the current world to filename. Specify `-g` to prevent the creation of groups, `-m` to save some primitives as meshes and `-o` to create a WaveFront OBJ file instead of a BZW one.
2 changes: 1 addition & 1 deletion _documentation/user/slash_commands/silence.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
command: silence
syntax: "<callsign>"
since: 2.4.0
category: Player
category: Client
permissions: ~
---

Expand Down
2 changes: 1 addition & 1 deletion _documentation/user/slash_commands/unsilence.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
command: unsilence
syntax: "<callsign>"
since: 2.4.0
category: Player
category: Client
permissions: ~
---

Expand Down
4 changes: 4 additions & 0 deletions _pages/documentation/user/slash-commands/list.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ parent:

{% set commands = collections.slash_commands | group('category') %}
{% set categories = [
{
title: 'Client',
desc: 'These are the base commands of the BZFlag client.',
},
{
title: 'Player',
desc: 'There commands are generally available to normal players, though some servers may restrict some of them to registered players.',
Expand Down