server/pod/dmcommand_help.pod

=begin comment

***
*** WARNING:
*** This file resides in both CFPlus/pod/ and server/pod/
*** Only ever edit the version in CFPlus/pod/ and run
*** ./copy_pod inside server/pod/ to update that copy.
***

=end

=head1 Crossfire+ Dungeon Master Commands

The following commands are only available to you if you are dungeon
master, that is, a kind of server administrator with special privileges.

=head2 abil

   abil <player> <attribute> <value> 

abil will permanently change the ability scores of players. Attribute is
one of str, dex, con, int, wis, pow, cha. Value may not exceed 30.

=head2 addexp

   addexp <player> <how much> 

The player must have a skill readied. All experience added in this manner
will go directly to the skill readied.

=head2 arrest

   arrest <player>

Puts the named player into the nearest cell (corresonding to the region he is in).

=head2 banish

   banish <player> 

I<Kicks> the named player and adds their current IP address to the banish
file.  This will prevent the named player from logging into the server
(from their current IP). This is an in-game version of the ban function
meant for short term relief of persistant goons and for DMs who do not
have shell access. It is probably a good idea to clear out the banish file
(usually at F</var/crossfire/banish_file>) on a regular basis and delete
or move any entries to the ban_file if desired.

=head2 create

   create <number> <bonus> <archtype> <variable1> <value1> <variable2> <value2> ...  

Creating items is rather dangerous and tends to crash the server when
creating some items.

The number and bonus attributes may be left off, or the bonus itself may
be left off any time.  If a bonus is desired, number must be specified as
well.  Archtype must be specified in all cases. Variable and values may be
left off at any time, but specifiying a variable requires a value also be
specified.

Multipart values such as for an item name must be quoted.

Example:

   create 5 +1 sword name "Spiffy Sword" face chicken.171

This would create 5 +1 longswords named 'Spiffy Sword' that look like
chickens. See also: patch, dump

=head2 debug

   debug <level> 

Without arguments, debug will simply print the current level of
debugging. Valid debugging levels are 0-3 where: llevError = 0, llevInfo =
1, llevDebug = 2, llevMonster = 3

=head2 dump

   dump <tag> 

Using dump, you can see the attributes of any item in the game.  To find
the object number of an item you wish to view, click on it. If this item
is in your inventory, or you are standing over, click on yourself and the
item tags will be displayed. see also: patch

=head2 dumpallarchtypes

   dumpallarchtypes 
 
This prints out a list of all archtypes to stderr.

=head2 dumpallmaps

   dumpallmaps 

This prints out map information for all active maps to stderr.

=head2 dumpallobjects

   dumpallobjects 

This prints out a list of all active objects to stderr.

=head2 dumpbelow

   dumpbelow 

Will dump the attributes of the top item you are standing over. see also:
dump

=head2 dumpfriendlyobjects

   dumpfriendlyobjects

This prints out a list of all active friendly objects to stderr.

=head2 forget_spell

   forget_spell <spell name>

This will cause you to permanently lose knowledge of a spell.

=head2 free

   free <tag> 

C<free> should ONLY be used after remove.  Freeing an object that has
not been removed will cause the game to crash. For most objects, simply
removing them is sufficient and they will eventually be freed.  See Also:
remove

=head2 goto

   goto <mapname> 

Using this command will instantly move you to the start point of the map
specified.

=head2 hide

   hide

This hides the DM from being seen by other players.  This is done by
making the player perpetually invisible.  It also results in the player
not showing up in the who command, maps comamnd, or being reported as a
player on the metaserver.

Note that the DM can still do things that makes his presence known, eg,
shout, other DM actions, etc.

=head2 insert_into

   insert_into <item> <item>

This will insert the 2nd item in the first.  2nd can't be a player.

=head2 invisible

   invisible 

Makes you invisible for a short time.

=head2 kick

   kick <player> 

This command will kick a player off the server. If used without an
argument, it will kick all players off the server with the exception of
you.

=head2 learn_special_prayer

   learn_special_prayer <prayer name>

this will allow you to permanently learn a spell as a special prayer of
your god. see also: learn_spell

=head2 learn_spell

   learn_spell <spell name>

This will allow you to permanently learn a spell. <spell name> may be a
partial spell name.

It is similar to learn_special_prayer except that you will retain
knowledge of this spell regardless of changing dieties. see also:
learn_special_prayer

=head2 mon_aggr

   mon_aggr

Toggles the aggression of the monster you are currently possessing. Not
reccomended to be flipped on yourself as a player.

=head2 nodm

   nodm or nowiz 

Both of these commands will return you to normal player status.

=head2 nowiz

   nodm or nowiz 

Both of these commands will return you to normal player status.

=head2 overlay_save

   overlay_save 

This will save everything on the current map that was not originally part
of it as an overlay. The overlay will then be loaded anytime the map
itself is loaded.  Be careful with this as EVERYTHING on the map will be
saved in an overlay, such as spawned monsters and dropped objects.

=head2 patch

   patch <tag> <variable> <value> 

Using the patch command, you can radically modify the properties of
objects in the game. Simply specify the object to modify and the new
values of its variables (or completely new variables).  See Also: dump

=head2 perl-reload

Will first unload all loaded perl extensions and modules loaded from the
extension directory, followed by loading the perl part of the plugin and
all extensions found.

This is done in an as atomic way as possible so it is safe to do at
anytime.

=head2 plugin

   plugin <plugin name>

This will load a new plugin into memory. Using this with no arguments,
or invalid arguments will cause a server crash. Plugin name should be as
it appears in your plugin directory. Double check the names before using
plugins.

=head2 pluglist

   pluglist 

This shows currently loaded plugins.

=head2 plugout

   plugout <plugin name>

This will remove a loaded plugin from memory.

=head2 possess

   possess (nr)

Take over the body of a given monster. It is not suggested you try to
possess another player, as bad things will undoubtably happen. Allows DM
to control the monster directly with his client.

=head2 printlos

   printlos 

This is used for line of sight debugging.

=head2 remove

   remove <tag> 

C<remove> will, suprisingly enough, remove the object specified by the tag
supplied. see also: free

=head2 reset

   reset <mapname> 

All other characters must be off of the map at the time of reset. This
will NOT reset any unique items, such as players apartments, in the case
of unique items being on a map, it will cause them to be saved before the
map is reset.

Using C<reset .> will reset the map that the player is currently on.

=head2 server_speed

   server_speed [newspeed] 

Without arguments, this prints current server speed. If given an argument,
it will set server speed to the new speed.

=head2 set_god

   set_god <player> <diety>

This will change a players diety to the diety specified.

=head2 shutdown

   shutdown 

This will cause a Crossfire+ to shut down entirely by first kicking out
all players, saving all maps and finally exiting. Crossfire servers will
kick out players and might or might not save some players or maps.

=head2 spellreset

   spellreset 

This causes the spell table to be reinitialized.

=head2 ssdumptable

   ssdumptable 

This will print out the current hash table to stderr.

=head2 stats

   stats <player>

This displays the named players statistics.

=head2 style_info

   style_info 

This will print out information regarding current styles in use.

=head2 summon

   summon <player> 

Summoning a player will bring them immediately to your location.  There
is no 'reverse' summoning, except to go to a map yourself and summon the
player again.

=head2 teleport

   teleport <player> 

C<teleport> will bring you immediately next to the player's location.

=head2 toggle_shout

   toggle_shout <player> 

Will toggle the no_shout bit for the named player.  This will prevent or
enable the player to use the shout command.

=head2 wizcast

   wizcast [<on_off>]

This will enable/disable your ability to cast spells and prayers anywhere
as dm. Without argument it toggles between on and off.

=head2 wizlook

   wizlook

This will temporarily increase your area of sight to the maximum. It will
return to normal when lighting conditions change or when you move.

=head2 wizpass

   wizpass 

This will toggle on and off your ability to walk thru walls as dm.
Revision:	1.6
Committed:	Wed Nov 8 00:54:06 2006 UTC (17 years, 6 months ago) by root
Branch:	MAIN
Changes since 1.5:	+6 -0 lines
Log Message:	allow priviledge override for banish, kick, arrest, reset, teleport and summon
#	Content
1	=begin comment
2
3	***
4	*** WARNING:
5	*** This file resides in both CFPlus/pod/ and server/pod/
6	*** Only ever edit the version in CFPlus/pod/ and run
7	*** ./copy_pod inside server/pod/ to update that copy.
8	***
9
10	=end
11
12	=head1 Crossfire+ Dungeon Master Commands
13
14	The following commands are only available to you if you are dungeon
15	master, that is, a kind of server administrator with special privileges.
16
17	=head2 abil
18
19	abil <player> <attribute> <value>
20
21	abil will permanently change the ability scores of players. Attribute is
22	one of str, dex, con, int, wis, pow, cha. Value may not exceed 30.
23
24	=head2 addexp
25
26	addexp <player> <how much>
27
28	The player must have a skill readied. All experience added in this manner
29	will go directly to the skill readied.
30
31	=head2 arrest
32
33	arrest <player>
34
35	Puts the named player into the nearest cell (corresonding to the region he is in).
36
37	=head2 banish
38
39	banish <player>
40
41	I<Kicks> the named player and adds their current IP address to the banish
42	file. This will prevent the named player from logging into the server
43	(from their current IP). This is an in-game version of the ban function
44	meant for short term relief of persistant goons and for DMs who do not
45	have shell access. It is probably a good idea to clear out the banish file
46	(usually at F</var/crossfire/banish_file>) on a regular basis and delete
47	or move any entries to the ban_file if desired.
48
49	=head2 create
50
51	create <number> <bonus> <archtype> <variable1> <value1> <variable2> <value2> ...
52
53	Creating items is rather dangerous and tends to crash the server when
54	creating some items.
55
56	The number and bonus attributes may be left off, or the bonus itself may
57	be left off any time. If a bonus is desired, number must be specified as
58	well. Archtype must be specified in all cases. Variable and values may be
59	left off at any time, but specifiying a variable requires a value also be
60	specified.
61
62	Multipart values such as for an item name must be quoted.
63
64	Example:
65
66	create 5 +1 sword name "Spiffy Sword" face chicken.171
67
68	This would create 5 +1 longswords named 'Spiffy Sword' that look like
69	chickens. See also: patch, dump
70
71	=head2 debug
72
73	debug <level>
74
75	Without arguments, debug will simply print the current level of
76	debugging. Valid debugging levels are 0-3 where: llevError = 0, llevInfo =
77	1, llevDebug = 2, llevMonster = 3
78
79	=head2 dump
80
81	dump <tag>
82
83	Using dump, you can see the attributes of any item in the game. To find
84	the object number of an item you wish to view, click on it. If this item
85	is in your inventory, or you are standing over, click on yourself and the
86	item tags will be displayed. see also: patch
87
88	=head2 dumpallarchtypes
89
90	dumpallarchtypes
91
92	This prints out a list of all archtypes to stderr.
93
94	=head2 dumpallmaps
95
96	dumpallmaps
97
98	This prints out map information for all active maps to stderr.
99
100	=head2 dumpallobjects
101
102	dumpallobjects
103
104	This prints out a list of all active objects to stderr.
105
106	=head2 dumpbelow
107
108	dumpbelow
109
110	Will dump the attributes of the top item you are standing over. see also:
111	dump
112
113	=head2 dumpfriendlyobjects
114
115	dumpfriendlyobjects
116
117	This prints out a list of all active friendly objects to stderr.
118
119	=head2 forget_spell
120
121	forget_spell <spell name>
122
123	This will cause you to permanently lose knowledge of a spell.
124
125	=head2 free
126
127	free <tag>
128
129	C<free> should ONLY be used after remove. Freeing an object that has
130	not been removed will cause the game to crash. For most objects, simply
131	removing them is sufficient and they will eventually be freed. See Also:
132	remove
133
134	=head2 goto
135
136	goto <mapname>
137
138	Using this command will instantly move you to the start point of the map
139	specified.
140
141	=head2 hide
142
143	hide
144
145	This hides the DM from being seen by other players. This is done by
146	making the player perpetually invisible. It also results in the player
147	not showing up in the who command, maps comamnd, or being reported as a
148	player on the metaserver.
149
150	Note that the DM can still do things that makes his presence known, eg,
151	shout, other DM actions, etc.
152
153	=head2 insert_into
154
155	insert_into <item> <item>
156
157	This will insert the 2nd item in the first. 2nd can't be a player.
158
159	=head2 invisible
160
161	invisible
162
163	Makes you invisible for a short time.
164
165	=head2 kick
166
167	kick <player>
168
169	This command will kick a player off the server. If used without an
170	argument, it will kick all players off the server with the exception of
171	you.
172
173	=head2 learn_special_prayer
174
175	learn_special_prayer <prayer name>
176
177	this will allow you to permanently learn a spell as a special prayer of
178	your god. see also: learn_spell
179
180	=head2 learn_spell
181
182	learn_spell <spell name>
183
184	This will allow you to permanently learn a spell. <spell name> may be a
185	partial spell name.
186
187	It is similar to learn_special_prayer except that you will retain
188	knowledge of this spell regardless of changing dieties. see also:
189	learn_special_prayer
190
191	=head2 mon_aggr
192
193	mon_aggr
194
195	Toggles the aggression of the monster you are currently possessing. Not
196	reccomended to be flipped on yourself as a player.
197
198	=head2 nodm
199
200	nodm or nowiz
201
202	Both of these commands will return you to normal player status.
203
204	=head2 nowiz
205
206	nodm or nowiz
207
208	Both of these commands will return you to normal player status.
209
210	=head2 overlay_save
211
212	overlay_save
213
214	This will save everything on the current map that was not originally part
215	of it as an overlay. The overlay will then be loaded anytime the map
216	itself is loaded. Be careful with this as EVERYTHING on the map will be
217	saved in an overlay, such as spawned monsters and dropped objects.
218
219	=head2 patch
220
221	patch <tag> <variable> <value>
222
223	Using the patch command, you can radically modify the properties of
224	objects in the game. Simply specify the object to modify and the new
225	values of its variables (or completely new variables). See Also: dump
226
227	=head2 perl-reload
228
229	Will first unload all loaded perl extensions and modules loaded from the
230	extension directory, followed by loading the perl part of the plugin and
231	all extensions found.
232
233	This is done in an as atomic way as possible so it is safe to do at
234	anytime.
235
236	=head2 plugin
237
238	plugin <plugin name>
239
240	This will load a new plugin into memory. Using this with no arguments,
241	or invalid arguments will cause a server crash. Plugin name should be as
242	it appears in your plugin directory. Double check the names before using
243	plugins.
244
245	=head2 pluglist
246
247	pluglist
248
249	This shows currently loaded plugins.
250
251	=head2 plugout
252
253	plugout <plugin name>
254
255	This will remove a loaded plugin from memory.
256
257	=head2 possess
258
259	possess (nr)
260
261	Take over the body of a given monster. It is not suggested you try to
262	possess another player, as bad things will undoubtably happen. Allows DM
263	to control the monster directly with his client.
264
265	=head2 printlos
266
267	printlos
268
269	This is used for line of sight debugging.
270
271	=head2 remove
272
273	remove <tag>
274
275	C<remove> will, suprisingly enough, remove the object specified by the tag
276	supplied. see also: free
277
278	=head2 reset
279
280	reset <mapname>
281
282	All other characters must be off of the map at the time of reset. This
283	will NOT reset any unique items, such as players apartments, in the case
284	of unique items being on a map, it will cause them to be saved before the
285	map is reset.
286
287	Using C<reset .> will reset the map that the player is currently on.
288
289	=head2 server_speed
290
291	server_speed [newspeed]
292
293	Without arguments, this prints current server speed. If given an argument,
294	it will set server speed to the new speed.
295
296	=head2 set_god
297
298	set_god <player> <diety>
299
300	This will change a players diety to the diety specified.
301
302	=head2 shutdown
303
304	shutdown
305
306	This will cause a Crossfire+ to shut down entirely by first kicking out
307	all players, saving all maps and finally exiting. Crossfire servers will
308	kick out players and might or might not save some players or maps.
309
310	=head2 spellreset
311
312	spellreset
313
314	This causes the spell table to be reinitialized.
315
316	=head2 ssdumptable
317
318	ssdumptable
319
320	This will print out the current hash table to stderr.
321
322	=head2 stats
323
324	stats <player>
325
326	This displays the named players statistics.
327
328	=head2 style_info
329
330	style_info
331
332	This will print out information regarding current styles in use.
333
334	=head2 summon
335
336	summon <player>
337
338	Summoning a player will bring them immediately to your location. There
339	is no 'reverse' summoning, except to go to a map yourself and summon the
340	player again.
341
342	=head2 teleport
343
344	teleport <player>
345
346	C<teleport> will bring you immediately next to the player's location.
347
348	=head2 toggle_shout
349
350	toggle_shout <player>
351
352	Will toggle the no_shout bit for the named player. This will prevent or
353	enable the player to use the shout command.
354
355	=head2 wizcast
356
357	wizcast [<on_off>]
358
359	This will enable/disable your ability to cast spells and prayers anywhere
360	as dm. Without argument it toggles between on and off.
361
362	=head2 wizlook
363
364	wizlook
365
366	This will temporarily increase your area of sight to the maximum. It will
367	return to normal when lighting conditions change or when you move.
368
369	=head2 wizpass
370
371	wizpass
372
373	This will toggle on and off your ability to walk thru walls as dm.