ETJump admin system

ETJump includes a simple admin system, with configurable levels and built-in authentication system. etkey is completely ignored by the mod, and client identities are tied to the GUID found in etjump/etguid.dat instead. This file is automatically generated when connecting to a server, if it doesn't already exist.

Important

Keep this file safe! Never share it with others, and make sure it's backed up in case you lose it.

Note

The GUID displayed as part of !userinfo and in the client's userinfo string is a SHA-1 hashed version of your actual GUID stored in etguid.dat. It is not dangerous if other players see this - it cannot be used to determine your real GUID in order to impersonate you.

Admins can configure the levels and their commands, as well as some other additional parameters, using the levels config file. A sample configuration file will be automatically generated by the mod when starting a server, if one isn't yet present.

User data is stored in the user database. The server generates a unique ETJump ID for each new player that visits the server, and stores it in this database. It also contains any bans issued on the server, and any custom, client-specific configurations, such as greeting and title.

Permission system

Access to admin commands is controlled by flags. The table below lists all available command flags, and the commands that they offer.

Note

The flags are case sensitive.


Admin chat

Any player with the S command flag has access to admin chat. This is a chat system which is isolated from the rest of the chat on the server. Anyone with the flag S can both see and send messages to the chat.

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.

adminchat box

Tip

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.

bind <key> adminChat

An admin chat is colored orange, and prefixed with a >.

adminchat example

If desired, admin chat can be disabled on the server with the g_adminChat cvar.


Admin system logging

By default, servers log certain admin-related events to a log file specified in g_adminLog cvar (unless 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.

Note

The admin system was written a long time ago, and some of the more advanced functionality is not very well implemented. The admin system will be rewritten in the future to be more robust and better to use.

Tip

Admin commands support "auto-complete", so you don't have to type in the full name of each command. For example, !admin will execute !admintest. If you're not writing the full command, you must provide enough characters from the command that it can resolve to a single command available for your level.


8ball

8ball answers all your questions with three possible answers: yes, no and maybe.

!8ball <question>

Flag: a

Option

Description

question

The question to ask.


add-customvote

Adds a new custom map vote list.

!add-customvote -n <name> -fn <callvote_text> -m <map1 map2 map3 ...>

Flag: c

Option

Description

-n, --name

Name of the custom map vote list.

-fn, --full-name

Full name of the list, displayed on the callvote.

-m, --maps

Space separated list of maps to include in the list.

Note

This command does not perform any validation on the list of maps provided, it is up to the user to provide valid map names.


add-season

Adds a new timerun season.

!add-season -n <name> -sd <YYYY-MM-DD> [-ed <YYYY-MM-DD>]

Flag: T

Option

Description

-n, --name

Name of the season.

-sd, --start-date

Start date of the season (YYYY-MM-DD).

-ed, --end-date-exclusive

Exclusive end date of the season (YYYY-MM-DD). If not set, the season stays active until an end date is added with !edit-season, or the season is deleted with delete-season.

Note

Season names are case insensitive.


addlevel

Adds a new level.

!addlevel <level> [-cmds <commands>] [-greeting <greeting>] [-title <title>]

Flag: A

Option

Description

level

The level to add.

-cmds

Commands for the level.

-greeting

Greeting for the level.

-title

Title for the level.


admintest

Prints your admin level to everyone in the chat.

Flag: a


ban

Bans a player.

!ban <name|clientnum> [time (seconds)] [reason]

Flag: b

Option

Description

name|clientnum

The name or clientnum of the player to ban.

time

Ban duration in seconds. If not given, the ban is permanent. Value 0 also means permanent.

reason

Reason for the ban, printed to the banned user. Requires time to be given.

Note

Temporary bans do not currently expire during a map. If a ban timeout has expired during current map on the server, the map must be changed for the banned client to be able to connect.


cancelvote

Cancels currently active vote.

Flag: C


comparecheckpoints

Compare checkpoint times between two runs.

!comparecheckpoints <run name> [rank-1] <rank-2>

Flag: a

Option

Description

-s, --season

Name of the season.

-m, --map

Name of the map.

-r, --run

Name of the run.

-rk1, --rank-1

The first rank to compare. Defaults to 1.

-rk2, --rank-2

The second rank to compare.

Tip

<season name>, <map name> and <run name> support partial matching.


delete-customvote

Deletes a custom map vote list.

!delete-customvote -n <name>

Flag: c

Option

Description

-n, --name

Name of the list to delete. Must be an exact match.


delete-season

Deletes a timerun season.

!delete-season -n <name>

Flag: T

Option

Description

-n, --name

Name of the season to delete. Must be an exact match.

Caution

This will delete all timerun records associated with the season!

Note

Season names are case insensitive.


deletelevel

Deletes a level.

!deletelevel <level>

Flag: A

Option

Description

level

The level to delete.

Note

Users who are currently set to deleted level will be set to level 0.


edit-customvote

Edits an existing custom map vote list.

!edit-customvote -l <list> [-n <name>] [-fn <callvote_text>] [-am <maps>] [-rm <maps>]

Flag: c

Option

Description

-l, --list

Name of the list to edit.

-n, --name

New name for the list.

-fn, --full-name

New full name of the list, displayed on the callvote.

-am, --add-maps

Space separated list of maps to add to the list.

-rm, --remove-maps

Space separated list of maps to remove from the list.


edit-season

Edits an existing timerun season.

!edit-season -n <name> [-sd <YYYY-MM-DD>] [-ed <YYYY-MM-DD>]

Flag: T

Option

Description

-n, --name

Name of the season to edit.

-sd, --start-date

New start date for the season (YYYY-MM-DD).

-ed, --end-date

New end date for the season (YYYY-MM-DD).

Note

Season names are case insensitive.


editcommands

Edits commands for a level.

!editcommands <level> [+command] [-command]

Flag: A

Option

Description

level

The level to edit.

+command

Adds the command to the level.

-command

Removes the command from the level.

This does not use command flags, but rather explicit command names.

The following example adds kick and ban to level 5 and removes 8ball from the level 5

!editcommands 5 +kick +ban -8ball

Todo

Verify that this actually works as it should. It interacts weirdly with the Commands field in the level config.


editlevel

Edits a level with given arguments.

!editlevel <level> [-cmds <flags>] [-greeting <greeting>] [-title <title>] [-clear <cmds|greeting|title>]

Flag: A

Option

Description

level

The level to edit.

-cmds

Command flags for the level.

-greeting

Greeting for the level.

-title

Title for the level.

-clear

Clears the given field(s). Accepts cmds, greeting or title.


edituser

Edits a user.

!edituser <user ID> [-cmds <flags>] [-greeting <greeting>] [-title <title>] [-clear <cmds|greeting|title>]

Flag: A

Option

Description

user ID

The user ID of the user to edit.

-cmds

Command flags for the user.

-greeting

Greeting for the user.

-title

Title for the user.

-clear

Clears the given field(s). Accepts cmds, greeting or title.

These permissions and parameters override the regular permissions and parameters that the users' level provides.

Tip

This works even if the user is not connected to the server


findmap

Lists all maps on server matching <mapname>.

!findmap <mapname> [maps per row (1-5)]

Flag: a

Option

Description

mapname

Map name to search for.

maps per row

Number of maps to print per row (1-5). Defaults to 3.


finduser

Lists users that match the name.

!finduser <name>

Flag: A

Option

Description

name

The name to search for.


finger

Prints name, original name, user ID, level and title of the targeted player.

!finger <name|clientnum>

Flag: f

Option

Description

name|clientnum

The targeted player.


help

Prints all available admin commands. If [command] is given, prints the manual for the given command.

!help [command]

Flag: a

Option

Description

command

The command to print the manual for.


kick

Kicks target player.

!kick <name|clientnum> [timeout (seconds)] [reason]

Flag: k

Option

Description

name|clientnum

The player to kick.

timeout

Duration in seconds during which the kicked player is unable to connect to the server.

reason

Reason for the kick, shown to the kicked player.


leastplayed

Lists the least played maps on the server.

!leastplayed [count (1-100)]

Flag: a

Option

Description

count

Number of maps to list (1-100). Defaults to 10.


levelinfo

Lists all levels configured on the server, or information about a specific level.

!levelinfo [level]

Flag: A

Option

Description

level

If given, prints detailed information about the given level.


listbans

Lists all active bans on the server.

!listbans [page]

Flag: L

Option

Description

page

Page to display. A single page fits 10 bans.

Error

The ban IDs may be incorrect if a player was banned or unbanned during the current map. Changing the map will sync the IDs correctly.


listcheckpoints

Lists checkpoint times from the given run.

!listcheckpoints <run name> [rank]
!listcheckpoints <map name> <run name> <rank>
!listcheckpoints <season name> <map name> <run name> <rank>

Flag: a

Option

Description

-s, --season

Name of the season. Default is the overall season.

-m, --map

Name of the map. Default is the current map.

-r, --run

Name of the run.

-rk, --rank

Rank to list checkpoints from. Default is rank 1.

Tip

<season name>, <map name> and <run name> support partial matching.


listflags

Lists command flags for each admin command.

Flag: A


listmaps

Lists all maps on the server.

!listmaps [maps per row (1-5)]

Flag: a

Option

Description

maps per row

Number of maps to print per row (1-5). Defaults to 5.


listplayers

Lists all players connected to the server, including their clientnum, user ID, level and name.

Flag: l


listusernames

Lists all usernames registered for the given <user ID> on the server.

!listusernames <user ID>

Flag: A

Option

Description

user ID

The user ID to list usernames for.

Error

The user database currently fails to record a name for a user, if the name they have has already been saved and used by another user.


listusers

Lists users that are registered on the server's user database.

!listusers [page]

Flag: A

Option

Description

page

Page to display. A single page fits 20 users.


loadcheckpoints

Loads timerun checkpoints for comparison for given timerun.

!loadcheckpoints <run name> [rank]

Flag: a

Option

Description

-r, --run

Name of the run.

-rk, --rank

Rank to load. Defaults to 1. Use -1 to clear the loaded checkpoints.

Tip

<run name> supports partial name matching, the exact run name isn't required.


map

Changes to the specified map.

!map <map name>

Flag: M

Option

Description

map name

The map to change to. Must be an full match (case insensitive)


mapinfo

Prints information about a map.

!mapinfo [map]

Flag: a

Option

Description

map

Map to print information about. Default is the current map.


mostplayed

Lists the most played maps on the server.

!mostplayed [count (1-100)]

Flag: a

Option

Description

count

Number of maps to list (1-100). Defaults to 10.


moverscale

Scales movement speed of entities following spline paths (typically vehicles) by the given value.

!moverscale <value (0.1-5.0)>

Flag: v

Option

Description

value

Movement speed scale (0.1-5.0).

See also

g_moverScale


mute

Mutes the targeted player.

!mute <name|clientnum>

Flag: m

Option

Description

name|clientnum

The name or clientnum of the player to mute.


newmaps

Displays the latest maps added to the server, sorted from oldest to newest.

!newmaps [count (1-50)]

Flag: a

Option

Description

count

Number of maps to list (1-50). Defaults to 5.

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.


noclip

Enables noclip.

!noclip [name|clientnum] [count]

Flag: N

Option

Description

name|clientnum

If given, the targeted player can use noclip once.

count

Number of times the targeted player can use noclip. Value -1 allows unlimited use until the targeted player disconnects.

Note

This command has no effect if g_noclip is set to 1.


passvote

Forces currently active vote to pass.

Flag: P

Note

Rock the Vote cannot be passed using this command.


rankings

Prints timerun rankings. If no arguments are given, prints top 20 overall rankings.

!rankings [season]

Flag: a

Option

Description

-s, --season

Season to print rankings for.

-p, --page

Page of rankings to print.

-ps, --page-size

Number of rankings per page.


ranks, records, times and top

Prints timerun records with given parameters. If no arguments are given, prints top 3 records for each run in the current map.

records [run name]
records <map name> <run name>
records <season> <map name> <run name>

Option

Description

-s, --season

Season to print records for. Default is the overall season.

-m, --map

Map to print records for. Default is the current map.

-r, --run

Run to print records for.

-p, --page

Page of records to print.

-ps, --page-size

Number of records per page. Default is 20.

Tip

<run name>, <map name> and <season> support partial name matching.

Note

ranks, reconds, times and top are all valid aliases for this command.


rename

Renames the targeted player.

!rename <name|clientnum> <new name>

Flag: R

Option

Description

name|clientnum

The name or clientnum of the player to rename.

new name

The new name for the player.

Note

This does not decrease the name change limit defined by g_nameChangeLimit, unless you're targeting yourself.


restart

Restarts the current map.

Flag: r


rtv

Calls Rock the Vote.

!rtv [list]

Flag: a

Option

Description

list

If given, limits the maps to the ones included in the specified custom map vote list.


seasons

Lists all timerun seasons on the server.

Flag: a


setlevel

Sets adminlevel of the targeted player.

!setlevel <name|clientnum> <level>
!setlevel -id <user ID> <level>

Flag: s

Option

Description

name|clientnum|-id

The player to set the level for.

level

The level to set.

Tip

When using -id <user ID>, the targeted player does not have to be connected to the server.


spectate

Switches your team to spectators.

!spectate [name|clientnum]

Flag: a

Option

Description

name|clientnum

If given, starts following the given player.


tokens

Creates, deletes or moves a collectible token with given arguments.

!tokens create <easy|e|medium|m|hard|h>
!tokens delete [easy|e|medium|m|hard|h <number (1-32)>]
!tokens move

Flag: V

Option

Description

create

Creates a token at your location with the given difficulty.

delete

Deletes the token closest to your location, or a specific token from the given difficulty.

move

Moves the token closest to you to your current location.

Note

g_tokensMode must be set to 1 for these commands to work.


unban

Removes a ban with the given <ban id>.

!unban <ban id>

Flag: b

Option

Description

ban id

The ID of the ban to remove.

Note

The unbanned player won't be able to connect to the server until the next time the map is changed.


unmute

Unmutes the targeted player.

!unmute <name|clientnum>

Flag: m

Option

Description

name|clientnum

The player to unmute.


userinfo

Prints information about the given user.

!userinfo <user ID>

Flag: A

Option

Description

user ID

The user ID of the user to print information about.


Silent command execution

Allows clients to execute any admin commands available to them silently, without having the typed command appear in chat.

/!command

Flag: /

Note

Silent commands must be typed in console instead of chat. Any output that a command might produce for other players will still be visible.