|
2 | 2 |
|
3 | 3 | ## Introduction
|
4 | 4 | Source.Python Admin is an open-source project that uses the [Source.Python](https://github.com/Source-Python-Dev-Team/Source.Python) framework to allow for easy Administration on Source-engine servers.
|
| 5 | + |
| 6 | +## Front Ends |
| 7 | +### Command Front End |
| 8 | +Command front end allows executing features through chat and client commands. |
| 9 | +#### Syntax: |
| 10 | +- `!spa <command and sub-commands>` - public chat command |
| 11 | +- `/spa <command and sub-commands>` - private chat command |
| 12 | +- `spa <command and sub-commands>` - client command |
| 13 | + |
| 14 | +The difference between public and private chat commands is that the private one suppresses the command string, so that nobody receives a chat message containing it. |
| 15 | +Client commands are run via player's game console. |
| 16 | + |
| 17 | +Player-based features (those have some kind of a player target) can also be executed via command front end. |
| 18 | +#### Syntax (`!spa`, `/spa` and `spa` prefixes are omitted here, but otherwise are required): |
| 19 | +`<command and sub-commands> <player filter> <filter argument>` |
| 20 | + |
| 21 | +Where *player filter* is one of the following: |
| 22 | +- `name` - this filter targets player by their name; *filter argument* is required in this case. |
| 23 | +- `steamid`, `steam` - this filter targets player by their SteamID; *filter argument* is required in this case. |
| 24 | +- `index` - this filter targets player by their entity index; *filter argument* is required in this case. |
| 25 | +- `@<built-in template filter>` - this filter targets player using one of the template player filters; *filter argument* is omitted in this case; *built-in template filter* is one of the following: |
| 26 | + - `me`, `self` - targets the command issuer. |
| 27 | + - `all` - targets all players on the server. |
| 28 | + - `bot` - targets all bots on the server (including GOTV/SourceTV). |
| 29 | + - `human` - targets all human players on the server; opposite to `bot`. |
| 30 | + - `dead` - targets all dead players on the server. |
| 31 | + - `alive` - targets all alive players on the server; opposite to `dead`. |
| 32 | + - `un` - targets all unassigned players (those who didn't select their team). |
| 33 | + - `spec` - targets all spectators. |
| 34 | + - `t` - targets all team #2 players (terrorists, rebels, RED team etc). |
| 35 | + - `ct` - targets all team #3 players (counter-terrorists, combines, BLU team etc). |
| 36 | + - depending on the game, additional team filters might be defined. |
| 37 | +- `#<userid>` - this filter targets player by their UserID (as reported by the `status` console command); *filter argument* is omitted in this case; *userid* is the target's UserID. |
| 38 | +- `!<inverted player filter>` - this filter targets all players, but only not those who would otherwise be targeted by *inverted player filter*; *filter argument* is passed to the inverted player filter. |
| 39 | + |
| 40 | +#### Examples: |
| 41 | +- `/spa slay @all` - slays all players on the server |
| 42 | +- `/spa slay !@me` - slays all players except the player who issues the command |
| 43 | +- `/spa resurrect name iPlayer` - resurrects the player whose name matches "iPlayer" |
0 commit comments