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

   wizpass 

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