server/pod/dmcommand_help.pod

=begin comment
***
*** WARNING: THIS IS A GENERATED FILE - CHANGES WILL BE LOST
*** The source for this file is in CFPlus/pod/dmcommand_help.pod
*** Make any changes there and then run ./copy_doc
***
=end comment

=head1 Crossfire TRT 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 observe

   observe <playername>

Observes the given object (currently players only). This means that the
map and stats of the observed object will be displayed instead of ones
own map and stats. Using observe without argument will switch bakc to
displaying your own map and stats.

=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

Temporarily moves off all characters from the current map, then resets it.
This will NOT reset any per-player maps, such as apartments, or remove
unique items or items on unique floors. I.e. it works exactly as if the
map reached its reset time prematurely.

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