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

=encoding utf-8

=head1 Deliantra 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> 

B<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 dm

   dm <password>

Try to become dungeon master.

=head2 dmhide

   dmhide <password>

Same as becoming dm and hiding at the same time. See B<hide>.

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

Removes (if necessary) and destroys the given object.

=head2 goto

   goto <mapname> [<x> <y>]

Using this command will instantly move you to the start point of the map
and position specified. If the position is omitted, the map entry point
will be used instead.

=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 back to
displaying your own map and stats.

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

   password <playername> [<new password>]

Will set a new password for the player. If no new password
is given a random password will be generated (and printed).

=head2 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, but it will freeze the swerver for multiple seconds.

=head2 possess

   possess <tag>

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.
It works exactly as if the map reached its reset time prematurely.

=head2 set_god

   set_god <player> <diety>

This will change a players diety to the diety specified.

=head2 shutdown

   shutdown 

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

=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 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 [<on_off>]

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