[ViewVC] Diff of: cvs/deliantra/server/pod/command

Comparing deliantra/server/pod/command_help.pod (file contents):
Revision 1.3 by root, Thu Sep 14 19:22:05 2006 UTC vs.
Revision 1.16 by root, Fri Aug 29 02:02:52 2008 UTC

…		…
1	=begin comment	1	=begin comment
2
3	***	2	***
4	*** WARNING:	3	*** WARNING: THIS IS A GENERATED FILE - CHANGES WILL BE LOST
5	*** This file resides in both CFPlus/pod/ and server/pod/	4	*** The source for this file is in CFPlus/pod/command_help.pod
6	*** Only ever edit the version in CFPlus/pod/ and run	5	*** Make any changes there and then run ./copy_doc
7	*** ./copy_pod inside server/pod/ to update that copy.
8	***	6	***
		7	=end comment
9		8
10	=end
11
12	=head1 Crossfire+ Command ListingX<command>	9	=head1 Deliantra Command ListingX<command>
13		10
14	=head2 accept-invitation	11	=head2 accept-invitation
15		12
16	Accepts an invitation previously issued by another player using the invite	13	Accepts an invitation previously issued by another player using the invite
17	command. This will transfer you to the location you were invited to.	14	command. This will transfer you to the location you were invited to.
130		127
131	=head2 chat	128	=head2 chat
132		129
133	chat <message>	130	chat <message>
134		131
135	Sends a message to all players on the server that have	132	Sends a message to all players on the server. This is the normal way to
136	L<listen\|command/listen> level B<10> or higher.	133	chat with others.
137		134
138	=head2 cast	135	=head2 cast
139		136
140	You use the cast command to set your range-weapon to the spell you	137	You use the cast command to set your range-weapon to the spell you
141	want. Example:	138	want. Example:
…		…
186	will be dropped. A collection of 5 scrolls will not be dropped.	183	will be dropped. A collection of 5 scrolls will not be dropped.
187		184
188	See also B<dropall> and mouse button control within client for dropping	185	See also B<dropall> and mouse button control within client for dropping
189	objects.	186	objects.
190		187
		188
		189	=head2 cointoss
		190
		191	Tosses a coin and reports the outcome to you and other players on the same
		192	map, much like the say command does.
		193
		194
		195	=head2 orcknuckle
		196
		197	Throws your orcknuckle set and reports the outcome to you and other
		198	players on the same map, much like the say command does. Your first
		199	three orcknuckle throws can report I<beholder>, I<ghost>, I<knight>,
		200	I<princess>, I<dragon>, while the fourth can additionally roll up to
		201	I<orc>.
		202
		203
191	=head2 dropall	204	=head2 dropall
192		205
193	dropall [type]	206	dropall [type]
194		207
195	B<dropall> drops all items in your inventory to the ground, excepting	208	B<dropall> drops all items in your inventory to the ground, excepting
…		…
263	=head2 gsay	276	=head2 gsay
264		277
265	If you are in a party (party join or party form), you will be able to message	278	If you are in a party (party join or party form), you will be able to message
266	only your party. Even people standing right next to you can't hear it.	279	only your party. Even people standing right next to you can't hear it.
267		280
268	=head2 golem
269
270	ERROR: not a command, but another help topic => move to a different file maybe?
271
272	Golems are creatures that the player has some control over. Note that many
273	summoned creatures are considered golems, even if they are not called
274	golems.
275
276	If you have a golem in control your spell type will be listed as golem,
277	with the creature name in parantheses.
278
279	To control your golem, just press the fire key in the direction you want
280	your golem to move. Your golem will then start moving in that direction,
281	and keep moving in that direction until you change its direction.
282
283	Note that once you leave the map that the golem is on, the golem will
284	disappear. Also, once you select another spell to cast, or change your
285	range type, your golem will disappear.
286
287	=head2 help	281	=head2 help
288		282
289	Gives you online help for the command or help topic specified.	283	Gives you online help for the command or help topic specified.
		284
		285	=head2 hintmode (show\|mark\|hide)
		286
		287	hintmode show\|mark\|hide
		288
		289	Sets the I<hint mode> to the given value: Throughout the game you can find
		290	hints that sometimes help you to solve a puzzle or manage a situation
		291	better than without. You can change the display of these hints with this
		292	command:
		293
		294	=over 4
		295
		296	=item show
		297
		298	Show the hints (the default mode).
		299
		300	=item mark
		301
		302	Do not show the hints themselves, but notify you when a hint would have
		303	been available.
		304
		305	=item hide
		306
		307	Hide all hints: You will not be able to tell wether there is a hint
		308	available or not.
		309
		310	=back
290		311
291	=head2 hiscore	312	=head2 hiscore
292		313
293	Shows a list of the highest level players in the game.	314	Shows a list of the highest level players in the game.
294		315
…		…
353	One can never transport from nor to an unholy place. That means, one can	374	One can never transport from nor to an unholy place. That means, one can
354	not be saved out of jail using invite.	375	not be saved out of jail using invite.
355		376
356	=head2 invoke	377	=head2 invoke
357		378
358	The invoke command is used	379	The invoke command is used to cast a spell immediately, or when it is
359	to cast a spell immediately,	380	necessary to give a parameter to the spell. Invoke will not set the range
360	or when it is necessary to give	381	weapon.
361	a parameter to the spell. Invoke
362	will not set the range weapon.
363		382
364	Examples:	383	Examples:
		384
365	'invoke restoration	385	invoke restoration
366	'invoke magic rune of large fireball	386	invoke magic rune of large fireball
367	'invoke reincarnation of Iamdead	387	invoke reincarnation of Iamdead
368	'invoke create food of waybread	388	invoke create food of waybread
369		389
370	It is very helpful to bind healing	390	It is very helpful to bind healing spells to keys, for example go to your
371	spells to keys like this:	391	I<playerbook>, tab I<spells>, the press the right mosue button on the
		392	spell I<medium healing> and choose C<bind invoke ... to a key>. It is
		393	recommended to bind a healing spell or potion to an easily-accessible-key,
		394	such as '1'.
372		395
373	'bind invoke medium healing
374	c
375
376	the c key now casts medium healing
377	instantly
378
379	=head2 keys
380
381	ERROR: not a command, but another help topic => move to a different file maybe?
382	ERROR: its wrong anyways
383
384	These are the basic movement
385	keys:
386	yku
387	h l
388	bjn
389
390	Running is done by holding
391	control and move. Running
392	is recommended.
393
394	Firing the range weapon (help range)
395	is done by holding shift and
396	move.
397
398	'help mouse for help on what the
399	mouse buttons do.
400
401	'help melee for advice on how to
402	fight
403
404	'help traps for help with finding
405	and disarming traps
406		396
407	=head2 killpets	397	=head2 killpets
		398
		399	killpets [name]
408		400
409	The killpets command is a quick and convenient way	401	The killpets command is a quick and convenient way
410	to get rid of all your pets when they are no longer	402	to get rid of all your pets when they are no longer
411	useful or are getting in the way. Any equipment	403	useful or are getting in the way. Any equipment
412	they had will be left behind, but you will get no	404	they had will be left behind, but you will get no
…		…
416	If a name is specified then only pets with that	408	If a name is specified then only pets with that
417	name will be killed, eg killpets bat will kill bats	409	name will be killed, eg killpets bat will kill bats
418	but not bees. If a number is specified, the pet	410	but not bees. If a number is specified, the pet
419	corresponding to that number is killed.	411	corresponding to that number is killed.
420		412
421	=head2 listen
422
423	Listen, sets the level of messages you will hear.
424	Priorities are defined as follows:
425
426	0 - Nothing, not even "You punch kobold." or "You say: hi".
427	1 - Only messages that have to do with yourself.
428	2 - Emergency calls from other users
429	10 - General chatter with the 'chat' command.
430	11 - See what players kill what monster with what attack/spell. Very
431	verbose - only for the fanatics.
432
433	=head2 logs
434
435	TODO
436
437	=head2 mapinfo	413	=head2 mapinfo
438		414
439	Shows some information about the map like this:	415	Shows some information about the map like this:
440		416
441	world_105_115 (/world/world_105_115) in scorn	417	world_105_115 (/world/world_105_115) in scorn
…		…
450	The rest is information the mapper may or may not provide. Often, this is	426	The rest is information the mapper may or may not provide. Often, this is
451	the mapper's name, email and map creation date as this example shows.	427	the mapper's name, email and map creation date as this example shows.
452		428
453	=head2 maps	429	=head2 maps
454		430
455	Shows a list of maps that are currently being visited or have been visited.	431	maps <mapname>
456	The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
457		432
458	Path: The last part of the map path	433	Shows a list of maps matching the regex <mapname> that are currently being
459	Pl: Players on the map.	434	known to the server. The different fields are Pl, I, Svd, Reset and Path:
460	PlM: Players on the map recounted (should be the same as Pl).	435
461	IM: In memory means whether the map is: 1) in memory, 2) swapped to disk,	436	=over 4
462	3) currently loading or 4) currently saving.	437
463	TO: Timeout, when the map is swapped to disk.	438	=item Pl: the number of players on that map currently.
464	Dif: Map difficulty.	439
465	Reset: Real server time when the map is going to reset.	440	=item I: B<I>n memory, B<S>wapped out or B<L>oading.
		441
		442	The server keeps maps in memory only for a short time (by default about
		443	40 seconds). After that time, it saves them to disk. As the server loads
		444	most maps in the background it is possible that you can see a map that is
		445	currently being loaded, but thats rare, as loading a map is fast.
		446
		447	=item Svd: the amount of seconds the map was last saved (++ means >99).
		448
		449	The server by default tries to save each map at least every 20 seconds if
		450	it changed, so in case of a disastrous crash (one where the server cannot
		451	emergency save), at most 20 seconds of gameplay are lost.
		452
		453	=item Reset: the minimum number of seconds the map will stay as is (will not reset).
		454
		455	Most maps will not reset as long as players are on it, and usually the
		456	reset counter only starts going down when all players left the map. Some
		457	maps will never reset in the common sense, these are usually marked with a
		458	very high number (sucha s C<1e+99>).
		459
		460	=item Path: the name that uniquely identifies the map, can be used for goto etc.
		461
		462	=back
		463
466		464
467	=head2 mark	465	=head2 mark
468		466
469	B<mark> is used to mark items for items that apply other items. Examples of	467	B<mark> is used to mark items for items that apply other items. Examples of
470	these are flint & steel marked for apply torches, a weapon marked for	468	these are flint & steel marked for apply torches, a weapon marked for
…		…
484		482
485	=head2 motd	483	=head2 motd
486		484
487	Shows the message of the day. It takes no arguments.	485	Shows the message of the day. It takes no arguments.
488		486
489	=head2 melee
490
491	ERROR: not a command, but another help topic => move to a different file maybe?
492
493	You fight to kill monsters. You can either use magic or weapons.
494
495	To use weapons, simply wield a weapon (and armour!) and move into the
496	monster you want to attack.
497
498	To use magic or bows, read
499	'help spells
500	and
501	'help range
502	and
503	'help cast
504	and
505	'help invoke
506
507	=head2 mode
508
509	ERROR: not a command, but another help topic => move to a different file maybe?
510
511	The mode commands are as follows:
512
513	Applymode, adjusts how items are applied
514	Bowmode, adjusts the way bows work
515	Peaceful, sets how you react to other players
516	Petmode, adjusts how your pets behave
517
518	=head2 mouse
519
520	ERROR: not a command, but another help topic => move to a different file maybe?
521
522	The mouse isn't a great way to move your character. It'll work, but you'll
523	be handicapped unless you use the keyboard for this. However, the mouse
524	has the following inventory uses:
525
526	Middle button on item: apply
527	or equip
528
529	Right button: drop or pickup
530	item on ground
531
532	Left button: info on item
533
534	=head2 move
535
536	ERROR: not a command, but another help topic => move to a different file maybe?
537	ERROR: same as "keys"?
538
539	These are the basic movement
540	keys:
541	yku
542	h l
543	bjn
544
545	Running is done by holding
546	control and move. Running
547	is recommended.
548
549	Firing the range weapon (help range)
550	is done by holding shift and
551	move.
552
553	'help mouse for help on what the
554	mouse buttons do.
555
556	'help melee for advice on how to
557	fight
558
559	'help traps for help with finding
560	and disarming traps
561
562	=head2 output-count	487	=head2 output-count
563		488
564	output-sync controls how often information is sent to the screen. Each	489	output-count [lines]
565	buffer has its own time value, and will be flushed independantly. The
566	default value is 16 ticks (about 2 seconds).
567		490
568	output-count sets after how many messages of the same type, they are	491	output-count sets after how many messages of the same type, they are
569	then printed out. If the value was 10, then after killing ten orcs, the	492	then printed out. If the value was 10, then after killing ten orcs, the
570	message '10 times you kill orc' would be printed out. The default value is	493	message '10 times you kill orc' would be printed out. The default value is
571	1 - this means that all messages get printed out as they are requested -	494	1 - this means that all messages get printed out as they are requested -
572	buffering is disabled in this regard.	495	buffering is disabled in this regard.
573		496
574	See also L<output-sync>.
575
576	=head2 output-sync
577
578	output-sync controls how often information is sent to the screen. Each	497	output-sync controls how often information is sent to the screen. Each
579	buffer has its own time value, and will be flushed independantly. The	498	buffer has its own time value, and will be flushed independantly. The
580	default value is 16 ticks (about 2 seconds).	499	default value is usually less than a second.
		500
		501	See also L<output-sync>.
		502
		503	=head2 output-rate
		504
		505	output-rate [bytes per second]
		506
		507	Show the current setting of the output-rate, or set it to the provided
		508	value. The server will try very hard not to send more than this many bytes
		509	per second to your client. If the rate is exceeded, the server tries to
		510	hold back less important information (such as new images) to increase
		511	responsiveness.
		512
		513	The server-side default is usually quite high, around 100000. If the
		514	server is running on a Linux kernel, it will adjust to the actual
		515	bandwidth available, and output-rate only sets an upper bound. That is,
		516	the server will automatically set an optimal send rate and adjusting your
		517	output-rate is not required.
		518
		519	=head2 output-sync
		520
		521	output-sync [seconds]
		522
		523	output-sync controls how often information is sent to the screen. Each
		524	buffer has its own time value, and will be flushed independantly. The
		525	default value is usually less than a second.
581		526
582	output-count sets after how many messages of the same type, they are	527	output-count sets after how many messages of the same type, they are
583	then printed out. If the value was 10, then after killing ten orcs, the	528	then printed out. If the value was 10, then after killing ten orcs, the
584	message '10 times you kill orc' would be printed out. The default value is	529	message '10 times you kill orc' would be printed out. The default value is
585	1 - this means that all messages get printed out as they are requested -	530	1 - this means that all messages get printed out as they are requested -
…		…
613	party leave	558	party leave
614	takes you out of current party	559	takes you out of current party
615		560
616	=head2 peaceful	561	=head2 peaceful
617		562
618	TODO: rework for cf.schmorp.de, intended future behaviour is to toggle	563	TODO: rework for deliantra, intended future behaviour is to toggle
619	peaceful mode with regards to npc and monsters only, not with regards to	564	peaceful mode with regards to npc and monsters only, not with regards to
620	players (which will be controlled by priests).	565	players (which will be controlled by priests).
621		566
622	The B<peaceful> command will switch you between peaceful and hostile attack	567	The B<peaceful> command will switch you between peaceful and hostile attack
623	modes.	568	modes.
…		…
694	Goldcoins have a value density of 66,	639	Goldcoins have a value density of 66,
695		640
696	Density 10 will pickup silver, gold, rings, wands, books, and scrolls.	641	Density 10 will pickup silver, gold, rings, wands, books, and scrolls.
697	Artifacts are also picked up.	642	Artifacts are also picked up.
698		643
		644
699	=head2 prepare	645	=head2 prepare
700		646
701	The same as cast. Usage:	647	The same as cast. Usage:
702		648
703	prepare <spell>	649	prepare <spell>
704		650
705	=head2 X<quests>quests (\|finished\|.*)
706
707	The quests command lists the quests you are doing or have completed.
708
709	Parameters are:
710
711	=over 4
712
713	=item no arguments: displays current quests.
714
715	=item B<finished>: displays finished quests;
716
717	=item anything else: displays details for quests (finished or not) with name containing the given string.
718
719	=back
720		651
721	=head2 quit	652	=head2 quit
722		653
723	Deletes your character from the server. If you want to quit the session	654	Deletes your character from the server. If you want to quit the session
724	without deleting your character, you must use a I<Bed to Reality>. Find a	655	without deleting your character, you must use a I<Bed to Reality>. Find a
725	bed (probably in a building close to where you entered the game), get on	656	bed (probably in a building close to where you entered the game), get on
726	top of it, and apply it using B<Tab> ro the B<apply> command.	657	top of it, and apply it using B<Tab> ro the B<apply> command.
727		658
		659
728	=head2 range	660	=head2 range
729		661
730	Your range weapon can be one of several weapons, a spell you cast, a	662	Your range weapon can be one of several weapons, a spell you cast, a
731	bow-and-arrow, a rod, or a wand, to name a few.	663	bow-and-arrow, a rod, or a wand, to name a few.
732		664
733	Your range weapon is fired when you press SHIFT-direction, and will be	665	Your range weapon is fired when you press SHIFT-direction, and will be
734	fired in that direction.	666	fired in that direction.
		667
735		668
736	=head2 ready_skill	669	=head2 ready_skill
737		670
738	ready_skill <name of skill>	671	ready_skill <name of skill>
739		672
…		…
742	readied, some need to be actively used by "firing" them.	675	readied, some need to be actively used by "firing" them.
743		676
744	If you just want to invoke a skill once, leaving your range slot	677	If you just want to invoke a skill once, leaving your range slot
745	untouched, use L<use_skill> instead.	678	untouched, use L<use_skill> instead.
746		679
		680
747	=head2 rename	681	=head2 rename
748		682
749	Changes/removes the custom name of given item (or the marked one).	683	Changes/removes the custom name of given item (or the marked one).
750		684
751	rename oldname to newname	685	rename oldname to newname
…		…
753		687
754	If either of the names contain spaces, you have to use the C<">-form,	688	If either of the names contain spaces, you have to use the C<">-form,
755	otherwise you can just write the name as-is. If you omit the old name, the	689	otherwise you can just write the name as-is. If you omit the old name, the
756	marked item will be used instead.	690	marked item will be used instead.
757		691
758	If the new name is empty (i.e. C<"">), then the custom name will be	692	If the new name is empty (i.e. C<"">), then the original (unrenamed) name
759	removed from the item.	693	will be restored.
760		694
761	Note: maximum allowed name length is 127 characters.	695	Note: maximum allowed name length is 127 characters.
762		696
763	=head2 reply
764
765	reply <message>
766
767	Similar to tell, but instead of having to supply a username, it replies
768	to the last player that sent you a tell. This is a bit racy (e.g. when
769	somebody else tells you something while you type and you do not realise
770	that), so be careful not to supply confidential information in the
771	message.
772		697
773	=head2 resistances	698	=head2 resistances
774		699
775	This shows you the resistances you have to specific attack types.	700	This shows you the resistances you have to specific attack types.
776	If you have for example "cold +20", it means you get 20% damage done	701	If you have for example "cold +20", it means you get 20% damage done
…		…
828		753
829	=head2 shout	754	=head2 shout
830		755
831	shout <message>	756	shout <message>
832		757
833	Sends a message to all players on the server that have	758	Sends a message to all players on the server. It is mainly useful for
834	L<listen\|command/listen> level B<10> or higher. It is mainly useful for
835	emergency messages ("I am trapped on xxx, can somebody help me?") and	759	emergency messages ("I am trapped on xxx, can somebody help me?") and
836	should not be used for general chat. Use L<chat\|command/chat> instead.	760	should not be used for general chat. Use L<chat\|command/chat> instead.
837		761
838	=head2 showpets	762	=head2 showpets
839		763
…		…
879	Toggles between sound enabled and disabled. This has no relevance to the	803	Toggles between sound enabled and disabled. This has no relevance to the
880	sound settings of the client, it only governs wether the server will send	804	sound settings of the client, it only governs wether the server will send
881	sound effect command to the client and is enabled if the client supports	805	sound effect command to the client and is enabled if the client supports
882	sound (i.e. always for cfplus).	806	sound (i.e. always for cfplus).
883		807
		808	=head2 sourcecode
		809
		810	This command displays the means to download the sourcecode (server code,
		811	maps and archetypes) used to implement this version of the game.
		812
		813	Every player has the right to download and modify the source code of the
		814	server, as required by both the GNU General Public License and the GNU
		815	Affero General Public license.
		816
		817	If you modify your version of the server, you will have to provide a means
		818	to download the modified sources (and resources) via this command. If you
		819	run an unmodified version of the server, the default will do.
		820
884	=head2 statistics	821	=head2 statistics
885		822
886	B<statistics> shows various useful information about your character.	823	B<statistics> shows various useful information about your character.
887	None of the information it shows is stuff that is not contained in the	824	None of the information it shows is stuff that is not contained in the
888	documentation.	825	documentation.
…		…
937	thrown away. God-given items can not be thrown. You need the skill throwing	874	thrown away. God-given items can not be thrown. You need the skill throwing
938	for this to work.	875	for this to work.
939		876
940	=head2 time	877	=head2 time
941		878
942	Shows the Crossfire in-game time, not the server time. It looks like this:	879	Shows the Deliantra in-game time, not the server time. It looks like this:
943		880
944	It is 52 minutes past 8 o'clock am, on the Day of the Bull	881	It is 52 minutes past 8 o'clock am, on the Day of the Bull
945	The 2nd Day of the Month of the Frost Giant, Year 63	882	The 2nd Day of the Month of the Frost Giant, Year 63
946	Time of Year: The Season of New Year	883	Time of Year: The Season of New Year
947		884
…		…
957	title <new title>	894	title <new title>
958	title clear # Sets your title back to your race.	895	title clear # Sets your title back to your race.
959		896
960	Dragons cannot set their title because it changes during the game.	897	Dragons cannot set their title because it changes during the game.
961		898
962	=head2 traps
963
964	ERROR: not a command, but another help topic => move to a different file maybe?
965
966	I recommend the following
967	keybindings
968	'bind search
969	s
970	'bind disarm
971	d
972	Then you can use the 's' and
973	'd' keys for searching for and
974	disarming traps.
975
976	Traps appear at random in doors and in chests. Search those before you
977	open them up. Search by going near where you suspect a trap, and type 's'
978
979	=head2 unignore	899	=head2 unignore
980		900
981	unignore <login>	901	unignore <login>
982		902
983	Cancels all ignores set for the specified login. See B<ignore>.	903	Cancels all ignores set for the specified login. See B<ignore>.
		904
		905	=head2 uptime
		906
		907	Tells you something about the time the server was started and how long ago
		908	that was.
984		909
985	=head2 use_skill	910	=head2 use_skill
986		911
987	use_skill <name of skill>	912	use_skill <name of skill>
988		913
…		…
1039		964
1040	The wimpy level is the amount of health points (hp) that may be left before you	965	The wimpy level is the amount of health points (hp) that may be left before you
1041	automatically run away. This may be useful in hand-to-hand combats but should	966	automatically run away. This may be useful in hand-to-hand combats but should
1042	not be used when the opponent attacks with spells.	967	not be used when the opponent attacks with spells.
1043		968
		969
1044	=head1 Authors	970	=head1 Authors
1045		971
1046	Parts of this document were originally taken from the crossfire server	972	Parts of this document were originally taken from the crossfire server
1047	help files with unknwon authors.	973	help files with unknown authors.
1048		974
1049	Adapted for use by I<cfplus>, enhanced and corrected by Pippijn van	975	Adapted for use by I<deliantra>, enhanced and corrected by Pippijn van
1050	Steenhoven and Marc A. Lehmann.	976	Steenhoven and Marc A. Lehmann.
1051		977

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/pod/command_help.pod (file contents): Revision 1.3 by root, Thu Sep 14 19:22:05 2006 UTC vs. Revision 1.16 by root, Fri Aug 29 02:02:52 2008 UTC

Diff Legend

Comparing deliantra/server/pod/command_help.pod (file contents):
Revision 1.3 by root, Thu Sep 14 19:22:05 2006 UTC vs.
Revision 1.16 by root, Fri Aug 29 02:02:52 2008 UTC