resources/pod/dmcommand_help.pod

=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 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
(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 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 the server to shut down entirely by first kicking out all
players, saving all maps and finally exiting.

=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 wizpass

 wizpass 

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