PennMUSH Community

root/1.8.3/trunk/game/txt/hlp/pennconf.hlp

Revision 846, 11.5 kB (checked in by penndev, 1 year ago)

PennMUSH 1.8.3p2 release candidate.

Line 
1 & @config parameters
2  Many of the mush's run-time options can be set from the game by
3  wizards, using @config/set <option>=<new value>. Those that can be set
4  with visible changes are listed below, grouped by category. See help
5  @config <category> for details on each.
6
7   Attribs      Chat       Cmds        Cosmetic      Costs
8   Db           Dump       Flags       Funcs         Limits
9   Log          Net        Tiny
10
11  The categories and groups are the same as those used by @config/list.
12  Values must be of the listed type for each option. They include:
13  <number>, <dbref>, <boolean> (Yes/No), <time>, or <string>.
14
15  Options which take a <time> will accept either a number of seconds
16  or a combination of numbers followed by 's' for seconds, 'm' for
17  minutes or 'h' for hours, making 1h30m and 5400 equivalent.
18
19  <dbref> options can be given with or without the leading '#', so
20  '1' and '#1' are the same.
21
22 & @config attribs
23  These options control some attribute behavior.
24
25   adestroy=<boolean>: Is the @adestroy attribute used?
26   amail=<boolean>: Is the @amail attribute used?
27   player_listen=<boolean>: Is @listen checked on players?
28   player_ahear=<boolean>: Is @ahear triggered on players?
29   room_connects=<boolean>: Are @aconnect and @adisconnect triggered on rooms?
30   read_remote_desc=<boolean>: Can anyone remotely retrieve @descs?
31   startups=<boolean>: Are @startup triggered at restart?
32   empty_attrs=<boolean>: Can attributes be set to an empty string?
33 & @config chat
34  These options control chat system settings.
35
36   chan_cost=<number>: How many pennies a channel costs to create.
37   max_channels=<number>: How many channels can exist total.
38   max_player_chans=<number>: How many channels can each non-admin
39    player create? If 0, mortals cannot create channels.
40   noisy_cemit=<boolean>: Is @cemit/noisy the default?
41 & @config cmds
42  These options affect command behavior.
43
44   noisy_whisper=<boolean>: Does whisper default to whisper/noisy?
45   possessive_get=<boolean>: Does "get container's object" work?
46   possessive_get_d=<boolean>: Does it work on disconnected players?
47   link_to_object=<boolean>: Can exits have objects as their destination?
48   owner_queues=<boolean>: Are command queues kept per-owner, or per-object?
49   full_invis=<boolean>: Should say by a dark player show up as
50    'Someone says,'?
51   wiz_noaenter=<boolean>: If yes, dark players don't trigger @aenters.
52   really_safe=<boolean>: Does SAFE prevent @nuking?
53   destroy_possessions=<boolean>: When a player is destroyed, are their objects
54    as well?
55 & @config cosmetic
56  These are cosmetic options of various sorts.
57
58   money_singular=<string>: What is one penny called?
59   money_plural=<string>: What are many pennies called?
60   player_name_spaces=<boolean>: Can player names have spaces in them?
61   ansi_names=<boolean>: Are names in look hilighted?
62   float_precision=<numbers>: How many digits after the decimal point in
63    floating point numbers are kept when formatting the result of a
64    floating point function?
65   comma_exit_list=<boolean>: Do exits show up like North, East, and West
66    or as North East West?
67   count_all=<boolean>: Does the count of connected players in WHO include
68    hidden connections for mortals?
69   blind_page=<boolean>: Does page default to page/blind?
70
71 Continued in help @config cosmetic2
72 & @config cosmetic2
73  More cosmetic options.
74
75   page_aliases=<boolean>: Are aliases included in page listings?
76    For example, Foo(F) pages: Blah
77   flags_on_examine=<boolean>: Are flag names included when examining
78    objects?
79   ex_public_attribs=<boolean>: Show visual attributes when examining objects
80    you don't control?
81   wizwall_prefix=<string>: Prefix for @wizwall messages.
82   rwall_prefix=<string>: Prefix for @rwall messages.
83   wall_prefix=<string>: Prefix for @wall messages.
84   announce_connects=<boolean>: Should (dis)connects be announced to
85     non-MONITOR players and to channels?
86   chat_strip_quote=<boolean>:  Does +chan "foo strip the "?
87   newline_one_char=<boolean>: Is strlen(%r) equal to 1?
88   only_ascii_in_names=<boolean>: Names are ascii-only or are extended
89    characters permitted?
90 & @config costs
91  These options control how many pennies various things cost.
92
93   object_cost=<number>: How many pennies it costs to create an object.
94   exit_cost=<number>: How many pennies it costs to create an exit.
95   link_cost=<number>: How many pennies it costs to use @link.
96   room_cost=<number>: How many pennies it costs to @dig a room.
97   queue_cost=<number>: How many pennies it costs to queue a command.
98    Refunded when the command executes.
99   quota_cost=<number>: How much @quota goes down by for each object.
100   find_cost=<number>: How many pennies it costs to use @search, @find,
101    @entrances, and their function versions.
102   page_cost=<number>: How many pennies it costs to use page. 
103   kill_default_cost=<number>: Default cost for kill.
104   kill_min_cost=<number>: Smallest amount of pennies for kill.
105   kill_bonus=<number>: What percent of the pennies spent for a successful
106    kill go to the victim.
107 & @config db
108  These are database options.
109
110   player_start=<dbref>: What room newly created players are in.
111   master_room=<dbref>: The location of the master room.
112   ancestor_room=<dbref>: If set to a good object, this is considered a global
113    parent for all rooms. If -1 or a nonexistant object, then disabled.
114   ancestor_exit=<dbref>: As ancestor_room for exits.
115   ancestor_thing=<dbref>: As ancestor_room for things.
116   ancestor_player=<dbref>: As ancestor_room for players.
117   base_room=<dbref>: The starting room used to determine if other rooms
118    are disconnected.
119   default_home=<dbref>: The room to send things to when they're homeless.
120   exits_connect_rooms=<boolean>: Is a room with any exit at all in not
121    considered disconnected for FLOATING checks?
122   zone_control_zmp_only=<boolean>: Do we only perform control checks on ZMPs,
123    or do we check ZMOs and ZMRs too?
124 & @config dump
125  These options affect database saves and other periodic checks.
126
127   forking_dump=<boolean>: Does the game clone itself and save in the
128    copy, or just pause while the save happens?
129   dump_message=<string>: Notification message for a database save.
130   dump_complete=<string>: Notification message for the end of a save.
131   dump_warning_1min=<string>: Notification one minute before a save.
132   dump_warning_5min=<string>: Notification five minutes before a save.
133   dump_interval=<time>: Seconds between database saves.
134   warn_interval=<time>: Seconds between automatic @wchecks.
135   purge_interval=<time>: Seconds between automatic @purges.
136   dbck_interval=<time>: Seconds between automatic @dbcks.
137 & @config flags
138   These options set the default flags for newly-created objects and channels.
139
140   player_flags=<string>: List of flags to set on newly created players
141   room_flags=<string>: List of flags to set on newly created rooms
142   thing_flags=<string>: List of flags to set on newly created things
143   exit_flags=<string>: List of flags to set on newly created exits
144   room_flags=<string>: List of flags to set on newly created rooms
145   channel_flags=<string>: List of flags to set on newly created channels
146 & @config funcs
147  These options affect the behavior of some functions.
148
149   safer_ufun=<boolean>: Are objects stopped from evaluting attributes on
150    objects with more privileges than themselves?
151   function_side_effects=<boolean>: Are function side effects (functions which
152    alter the database) allowed?
153 & @config limits
154  Limits and other constants.
155
156   max_dbref=<dbref>: The highest dbref an object can have. If 0,
157    there is no limit on database size.
158   max_attrs_per_obj=<number>: The maximum attributes an object can have.
159   max_logins=<number>: The maximum number of connected players.
160   max_guests=<number>: The maximum number of connected guests. If 0,
161    no limit. If -1, limited by the number of guest players in the db.
162   idle_timeout=<time>: The number of minutes a connection can be idle
163    before getting booted. 0 means no limit.
164   unconnected_idle_timeout=<time>: The number of minutes a connection can be
165    sitting at the login screen before getting booted. 0 means no limit.
166
167 Continued in help @config limits2
168 & @config limits2
169  Limits and constants, continued.
170
171   whisper_loudness=<number>: The percentage chance of a whisper/noisy
172    being heard.
173   starting_quota=<number>: How much quota new players get.
174   starting_money=<number>: How many pennies new players get.
175   paycheck=<number>: How many pennies players get each day they log on.
176   max_pennies=<number>: The maximum pennies an object can have.
177   mail_limit=<number>: How many @mail messages someone can have.
178   max_depth=<number>: How deep can @parent chains can go.
179   player_queue_limit=<number>: The number of commands a player can have
180    queued at once.
181   queue_loss=<number>: One in <number> times, queuing a command will cost
182    an extra penny that doesn't get refunded.
183   queue_chunk=<number>: How many queued commands get executed in a row when
184    there's no network activity pending.
185
186 Continued in help @config limits3
187 & @config limits3
188  Limits and constants, continued.
189
190   active_queue_chunk=<number>: How many queued commands get executed in a
191    row when there is network activity pending.
192   function_recursion_limit=<number>: The depth to which softcode functions
193    can call more functions.
194   function_invocation_limit=<number>: The maximum number of softcode
195    functions that can be called in one command.
196   guest_paycheck=<number>: How many pennies guests get each day.
197   max_guest_pennies=<number>: The maximum pennies a guest can have.
198   player_name_len=<number>: The maximum length of a player name.
199   queue_entry_cpu_time=<number>: The maximum number of milliseconds a
200    queue entry can take to run.
201   use_quota=<boolean>: Controls if quotas are used to limit the number
202    of objects a player can own.
203
204 Continued in help @config limits4
205 & @config limits4
206  Limits and constants, continued
207
208   max_aliases=<number>: The maximum number of aliases a player can have.
209   keepalive_timeout=<time>: How often should an 'Are you still there?' query
210    be sent to connects, to stop players' routers booting idle connections?
211   max_parents=<number>: The maximum number of levels of parenting allowed.
212   call_limit=<number>: The maximum number of times the parser can be called
213    recursively for any one expression.
214 & @config log
215  These options affect logging.
216
217   log_commands=<boolean>: Are all commands logged?
218   log_forces=<boolean>: Are @forces of wizard objects logged?
219 & @config net
220  Networking and connection-related options.
221  
222   mud_name=<string>: The name of the mush for mudname() and @version and
223    the like.
224   use_dns=<boolean>: Are IP addresses resolved into hostnames?
225   use_ident=<boolean>: Is ident information looked up for connections?
226   ident_timeout=<time>: How many seconds does the mush wait before an ident
227     request fails?
228   logins=<boolean>: Are mortal logins enabled?
229   player_creation=<boolean>: Can CREATE be used from the login screen?
230   guests=<boolean>: Are guest logins allowed?
231   pueblo=<boolean>: Is Pueblo support turned on?
232   sql_platform=<string>: What kind of SQL server are we using?
233                          ("mysql" or "disabled")
234   sql_host=<string>: What is the hostname or ip address of the SQL server
235 & @config tiny
236  Options that help control compability with TinyMUSH servers.
237
238   null_eq_zero=<boolean>: Is a null string where a number is expected
239    considered a 0?
240   tiny_booleans=<boolean>: Use Tiny-style boolean values where only
241    non-zero numbers are true.
242   tiny_trim_fun=<boolean>: Are the second and third arguments to trim()
243    reversed?
244   tiny_math=<boolean>: Is a string where a number is expected considered
245    a 0?
246   silent_pemit=<boolean>: Does @pemit default to @pemit/silent?
Note: See TracBrowser for help on using the browser.