Skip to content

Commit 1f83d98

Browse files
author
KirillMysnik
committed
Add front end table to readme.md
1 parent 2f9dae9 commit 1f83d98

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

readme.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@
44
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.
55

66
## Front Ends
7+
Source.Python Admin lets you gain control to its features via multiple front ends.
8+
The front ends are:
9+
- **Command** Front End
10+
- **Popup/Menu** Front End
11+
- **MoTD** Front End
12+
- **Web** Front End
13+
14+
Here's a table showing what front ends are currently supported by each included plugin:
15+
16+
Plugin | Command | Popup/Menu | MoTD | Web
17+
------ | ------- | ---------- | ---- | ---
18+
Communication Management | No | **Yes** | No | No
19+
Kick/Ban | No | **Yes** | **Yes** | No
20+
Life Management | **Yes** | **Yes** | **Yes** | No
21+
Team Management | No | **Yes** | No | No
22+
Tracking | **Yes** | **Yes** | No | No
23+
724
### Command Front End
825
Command front end allows executing features through chat and client commands.
926
#### Syntax:
@@ -41,3 +58,23 @@ Where *player filter* is one of the following:
4158
- `/spa slay @all` - slays all players on the server
4259
- `/spa slay !@me` - slays all players except the player who issues the command
4360
- `/spa resurrect name iPlayer` - resurrects the player whose name matches "iPlayer"
61+
62+
### Popup/Menu Front End
63+
This front end provides access to the features via in-game radio menus.
64+
The main menu can be accessed by either running `spa menu` command in game console or typing `!spa menu` or `/spa menu` in game chat.
65+
To get this menu to show up, the client must have `admin.base` permission.
66+
67+
### MoTD Front End
68+
This front end provides allows to administrate the server from the in-game MoTD screen, providing the most impressive experience with the interactive graphical interface.
69+
Its main screen shows up after running `spa motd` in game console or typing `!spa motd` or `/spa motd` in game chat.
70+
The admin must have `admin.base` permission to open the MoTD front end.
71+
72+
### Web Front End
73+
Web front end is the only front end that allows admins to access Source.Python Admin features remotely, without even playing on the server.
74+
All it requires is a web-browser, then the admin can sign in via Steam OpenID.
75+
Web front end works in two modes: offline and online.
76+
77+
- **online** mode provides an access to the regular set of the features;
78+
- **offline** mode works directly with the server database - this is useful, for example, for banning players even when the game server is offline.
79+
80+
The switching between online and offline modes is done automatically.

0 commit comments

Comments
 (0)