-
-
Notifications
You must be signed in to change notification settings - Fork 47
/
admin.rst
368 lines (326 loc) · 7.52 KB
/
admin.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
Admin
=====
Information
-----------
Name:
``pyplanet.apps.contrib.admin``
Depends on:
``core.maniaplanet``
Game:
TrackMania, ShootMania
Features
--------
This app includes the main admin features PyPlanet has to offer.
It's features can be seperated in to these three areas:
* Maps: skip, restart
* Players: mute, kick, ban
* Server: set server/spectator password
Commands
--------
PyPlanet
^^^^^^^^
Reboot PyPlanet Pool Process
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Command:
``//reboot``
Parameters:
None.
Functionality:
Reboot pyplanet pool process.
Required permission:
``admin:reboot``, requires admin level 3.
Maps
^^^^
Skip map
~~~~~~~~
Command:
``//next`` / ``//skip``
Parameters:
None.
Functionality:
Skips to the next map.
Required permission:
``admin:next``, requires admin level 1.
Restart map
~~~~~~~~~~~
Command:
``//restart`` / ``//res`` / ``//rs``
Parameters:
None.
Functionality:
Restarts the current map.
Required permission:
``admin:restart``, requires admin level 1.
Replay map
~~~~~~~~~~
Command:
``//replay``
Parameters:
None.
Functionality:
Queue the current map to be replayed
Required permission:
``admin:replay``, requires admin level 1.
Add Local map
~~~~~~~~~~~~~
Command:
``//add local``
Parameters:
* Local file name or path.
Functionality:
Add map from local server disk.
Required permission:
``admin:add_local``, requires admin level 2.
Write Map list
~~~~~~~~~~~~~~
Command:
``//writemaplist`` / ``//wml``
Parameters:
* Optional match settings file. Will use the file from your settings if not provided!
Functionality:
Write maplist to match settings file.
Required permission:
``admin:write_map_list``, requires admin level 2.
Read Map list
~~~~~~~~~~~~~
Command:
``//readmaplist`` / ``//rml``
Parameters:
* Match settings file.
Functionality:
Read maplist from the match settings file.
Required permission:
``admin:read_map_list``, requires admin level 2.
Shuffle Map list
~~~~~~~~~~~~~~~~
Command:
``//shuffle``
Parameters:
-
Functionality:
Shuffle and reload map list from disk!
Required permission:
``admin:shuffle``, requires admin level 2.
Remove Map
~~~~~~~~~~
Command:
``//remove``
Parameters:
* Map number given, the ID column from database. If not given, the current map will be removed!
Functionality:
Remove map from loadedd map list. (Doesn't write the maplist to disk!). This command doesn't remove the actual map file!
Required permission:
``admin:remove_map``, requires admin level 2.
Erase Map
~~~~~~~~~
Command:
``//erase``
Parameters:
* Map number given, the ID column from database. If not given, the current map will be removed!
Functionality:
Remove map from loadedd map list. (Doesn't write the maplist to disk!). Also removes the map file from the disk!
Required permission:
``admin:remove_map``, requires admin level 2.
Players
^^^^^^^
Force player to spec
~~~~~~~~~~~~~~~~~~~~
Command:
``//forcespec``
Parameters:
* Player login.
Functionality:
Force player into spectator.
Required permission:
``admin:force_spec``, requires admin level 1.
Force player to team
~~~~~~~~~~~~~~~~~~~~
Command:
``//forceteam``
Parameters:
* Player login.
* Team identifier (0/blue or 1/red)
Functionality:
Force player into a specific team.
Required permission:
``admin:force_team``, requires admin level 1.
Switch player to team
~~~~~~~~~~~~~~~~~~~~~
Command:
``//switchteam``
Parameters:
* Player login.
Functionality:
Switches the player into the other team.
Required permission:
``admin:switch_team``, requires admin level 1.
Warn player
~~~~~~~~~~~
Command:
``//warn`` / ``//warning``
Parameters:
* Player login.
Functionality:
Displays a warning message in chat for the player
Required permission:
``admin:warn``, requires admin level 1.
Mute player
~~~~~~~~~~~
Command:
``//mute`` / ``//ignore``
Parameters:
* Player login.
Functionality:
Mutes the player, messages won't appear in server chat.
Required permission:
``admin:ignore``, requires admin level 1.
Unmute player
~~~~~~~~~~~~~
Command:
``//unmute`` / ``//unignore``
Parameters:
* Player login.
Functionality:
Unmutes the player, messages will appear in server chat again.
Required permission:
``admin:unignore``, requires admin level 1.
Kick player
~~~~~~~~~~~
Command:
``//kick``
Parameters:
* Player login.
Functionality:
Kicks the player from the server.
Required permission:
``admin:kick``, requires admin level 1.
Ban player
~~~~~~~~~~
Command:
``//ban``
Parameters:
* Player login.
Functionality:
Bans the player from the server.
Required permission:
``admin:ban``, requires admin level 2.
Unban player
~~~~~~~~~~~~
Command:
``//unban``
Parameters:
* Player login.
Functionality:
Unbans the player from the server.
Required permission:
``admin:unban``, requires admin level 2.
Change user admin level
~~~~~~~~~~~~~~~~~~~~~~~
Command:
``//level``
Parameters:
* Player login.
* (Optional) Level: 0 = player, 1 = operator, 2 = admin, 3 = master admin. Leave empty to remove level (0).
Functionality:
Changes the admin permission level of the player.
Required permission:
``admin:manage_admins``, requires admin level 2.
Game Flow
^^^^^^^^^
Force round to end
~~~~~~~~~~~~~~~~~~
Command:
``//endround``
Parameters:
None
Functionality:
Force the trackmania round to an end.
Required permission:
``admin:end_round``, requires admin level 2.
Force WarmUp round to end
~~~~~~~~~~~~~~~~~~~~~~~~~
Command:
``//endwuround``
Parameters:
None
Functionality:
Force the trackmania WarmUp round to an end.
Required permission:
``admin:end_round``, requires admin level 2.
Force WarmUp to an end
~~~~~~~~~~~~~~~~~~~~~~
Command:
``//endwu``
Parameters:
None
Functionality:
Force the whole WarmUp to an end.
Required permission:
``admin:end_round``, requires admin level 2.
Set rounds points (Points repartition)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Command:
``//pointsrepartition`` / ``//pointsrep``
Parameters:
* Points per place, top to bottom, separated with either spaces or commas.
Functionality:
Set the rounds points (points per player and place it ends in an round).
Required permission:
``admin:points_repartition``, requires admin level 2.
Server
^^^^^^
Set server name
~~~~~~~~~~~~~~~
Command:
``//servername``
Parameters:
* Server name.
Functionality:
Changes the server name.
Required permission:
``admin:servername``, requires admin level 2.
Set game mode
~~~~~~~~~~~~~
Command:
``//mode``
Parameters:
* Game mode 'ta', 'laps', 'rounds', 'cup' or any script name (e.g. 'Rounds.Script.txt')
Functionality:
Changes the server game mode script.
Required permission:
``admin:mode``, requires admin level 2.
Get/set game mode settings
~~~~~~~~~~~~~~~~~~~~~~~~~~
Command:
``//modesettings``
Parameters:
None, or:
* Setting name
* New setting value
Functionality:
Displays a list of current mode settings (no parameters) or changes a setting according with the given parameters.
Required permission:
``admin:mode``, requires admin level 2.
Set server password
~~~~~~~~~~~~~~~~~~~
Command:
``//setpassword`` / ``//srvpass``
Parameters:
* Server password (none or empty for no password).
Functionality:
Changes the server password.
Required permission:
``admin:password``, requires admin level 2.
Set server password
~~~~~~~~~~~~~~~~~~~
Command:
``//setspecpassword`` / ``//spectpass``
Parameters:
* Spectator password (none or empty for no password).
Functionality:
Changes the spectator password.
Required permission:
``admin:password``, requires admin level 2.
Signal handlers
---------------
None.