5 .. Copyright (c) 2004-2020 mudpy authors. Permission to use, copy,
6 modify, and distribute this software is granted under terms
7 provided in the LICENSE file distributed with this software.
17 Each item in the dict identifies options for the default backing
18 file of the group named in its key. The value is itself a dict with
19 its keys and values corresponding to those options (for now, only
20 ``flags`` is implemented, with a value of ``private`` indicating it
21 should be readable only by the system user under which the mudpy
36 This is the root path beneath which all relative file references,
37 including directories comprising the search path, are assumed to be
38 found. The default value of ``.`` indicates the current working
39 directory at the time the service was initially started.
43 .mudpy.filing.prefix: .
50 Directories to search for expected data files. If not a fully
51 canonical path, this is assumed to be relative to the ``prefix``.
66 This is the default directory where new data files will be written
67 if their full paths are not specified and they aren't already found
68 in the ``search`` list. If not a fully canonical path, this is
69 assumed to be relative to the ``prefix``.
73 .mudpy.filing.stash: data
78 .mudpy.linguistic.actions
79 ~~~~~~~~~~~~~~~~~~~~~~~~~
83 This is used to tailor the appearance of output generated by the
84 ``say`` command and its relatives, so as to add some readability and
85 flavor. It matches a visible action to punctuation (ask, exclaim, et
90 .mudpy.linguistic.actions:
100 .mudpy.linguistic.default_punctuation
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105 Unpunctuated statements made by actors should be assumed to
106 terminate with this value.
110 .mudpy.linguistic.default_punctuation: .
112 .mudpy.linguistic.typos
113 ~~~~~~~~~~~~~~~~~~~~~~~
117 Replacements for common typographical and capitalization errors.
121 .mudpy.linguistic.typos:
138 The first users to create accounts with names in this list will
139 automatically be given full administrative privileges.
151 This is the maximum number of avatars allowed for each account.
155 .mudpy.limit.avatars: 7
162 This is the number of backups to keep and rotate when overwriting
163 data files. If unspecified or set to 0, no backup copies will be
168 .mudpy.limit.backups: 10
175 Whether unsafe debugging functionality is enabled. If unspecified or
176 set to false, unsafe debugging functions will be disabled.
180 .mudpy.limit.debug: true
182 .mudpy.limit.password_tries
183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
187 This is the maximum number of password failures allowed during the
188 login process. Once exceeded, the user will be disconnected.
192 .mudpy.limit.password_tries: 3
202 If set, log messages will be recorded to this file.
206 .mudpy.log.file: var/mudpy.log
213 Number of log entries to keep in memory (the oldest are
214 discarded)... If unset or 0, none will be written to mudpy's
219 .mudpy.log.lines: 1000
226 If set to ``yes``, messages will be logged to the standard output of
227 the mudpy process. If unspecified, the default is ``no``.
231 .mudpy.log.stdout: true
238 If set, mudpy will send messages to the system log, and under the
239 name specified by this value (Unix derivatives only).
243 .mudpy.log.syslog: mudpy
248 .mudpy.movement.*.enter_term
249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
253 Word or words describing the direction from where you are seen to
254 enter the next room when moving.
258 .mudpy.movement.down.enter_term: above
259 .mudpy.movement.east.enter_term: the west
260 .mudpy.movement.north.enter_term: the south
261 .mudpy.movement.south.enter_term: the north
262 .mudpy.movement.up.enter_term: below
263 .mudpy.movement.west.enter_term: the east
265 .mudpy.movement.*.exit_term
266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
270 Word or words describing the direction where you are seen to exit
271 the current room when moving.
275 .mudpy.movement.down.exit_term: downward
276 .mudpy.movement.east.exit_term: to the east
277 .mudpy.movement.north.exit_term: to the north
278 .mudpy.movement.south.exit_term: to the south
279 .mudpy.movement.up.exit_term: upward
280 .mudpy.movement.west.exit_term: to the west
282 .mudpy.movement.*.vector
283 ~~~~~~~~~~~~~~~~~~~~~~~~
287 Vector of signed integer units for use in vector addition to derive
288 the destination coordinates from the current coordinates when moving
289 through a gridlink exit. The example coordinate system used is left
290 handed (east, north and up are positive, west, south and down are
291 negative) and three-dimensional with a tuple component order of
292 (longitude, latitude, altitude).
296 .mudpy.movement.down.vector: [0, 0, -1]
297 .mudpy.movement.east.vector: [1, 0, 0]
298 .mudpy.movement.north.vector: [0, 1, 0]
299 .mudpy.movement.south.vector: [0, -1, 0]
300 .mudpy.movement.up.vector: [0, 0, 1]
301 .mudpy.movement.west.vector: [-1, 0, 0]
311 The IP address on which to listen. If unspecified, the default is
312 all available addresses.
316 .mudpy.network.host: ::1
323 The TCP port on which to listen.
327 .mudpy.network.port: 4000
332 .mudpy.process.daemon
333 ~~~~~~~~~~~~~~~~~~~~~
337 If set to ``yes``, mudpy will immediately fork and detach a child to
338 become a daemon process, then close all open file descriptors and
339 terminate the parent process (Unix derivatives only). The default
344 .mudpy.process.daemon: true
346 .mudpy.process.pidfile
347 ~~~~~~~~~~~~~~~~~~~~~~
351 If set, this filename will contain the daemon's process ID (Unix
356 .mudpy.process.pidfile: var/mudpy.pid
361 .mudpy.timing.idle.disconnect.*
362 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
366 This value indicates the number of increments allowed to pass
367 without input on a socket connection before it is terminated. This
368 avoids accumulation of dead sockets which could otherwise max out
369 allowed file descriptors. The differentiators are either ``default``
370 or a state name used to override the default value for that specific
371 state (``active``, ``entering_account_name``, et cetera).
375 .mudpy.timing.idle.disconnect.active: 6048000
376 .mudpy.timing.idle.disconnect.default: 6000
377 .mudpy.timing.idle.disconnect.entering_account_name: 600
379 .mudpy.timing.idle.warn.*
380 ~~~~~~~~~~~~~~~~~~~~~~~~~
384 This value indicates the number of increments allowed to pass
385 without input on a socket connection before it is warned that
386 termination is imminent. The differentiators are either
387 ``default`` or a state name used to override the default value
388 for that specific state. It is recommended that this be less than
389 the corresponding ``.mudpy.timing.idle.disconnect.*`` value.
393 .mudpy.timing.idle.warn.active: 5040000
394 .mudpy.timing.idle.warn.default: 5000
395 .mudpy.timing.idle.warn.entering_account_name: 500
397 .mudpy.timing.increment
398 ~~~~~~~~~~~~~~~~~~~~~~~
402 This value indicates the number of real system clock seconds (or
403 more commonly, fraction thereof) each pass through the main loop is
404 intended to take. This roughly sets the frequency with which queued
405 socket I/O operations are performed, pending events are triggered,
406 and directly impacts the speed at which virtual time passes within
411 .mudpy.timing.increment: 0.1
418 Number of increments between updates of changed persistent data
423 .mudpy.timing.save: 600
430 Number of increments to wait between logging mudpy status messages.
431 If unspecified or set to 0, no mudpy status messages will be
436 .mudpy.timing.status: 6000
441 .mudpy.user.pref_admin
442 ~~~~~~~~~~~~~~~~~~~~~~
446 This can be used to list facets an administrative user is allowed to
447 set or override on their own ``account`` element, in addition to any
448 in the `.mudpy.user.pref_allow`_ list. Note that this is merely a
449 convenience, as an administrator is already able to call the ``set``
450 command to set values for facets of any element.
454 .mudpy.user.pref_admin:
457 .mudpy.user.pref_allow
458 ~~~~~~~~~~~~~~~~~~~~~~
462 This can be used to list facets any user is allowed to set or
463 override on their own ``account`` element with the ``preference``
468 .mudpy.user.pref_allow: